batch
Batch issues commands to Chrome OS devices using a CSV file as input
Synopsis
Implements the API documented at https://developers.google.com/admin-sdk/directory/reference/rest/v1/customer.devices.chromeos/issueCommand
gsm chromeOs issueCommand batch [flags]
Options
--batchThreads int Specify the number of threads that should be used for batch commands (overrides value in config file. Max 16)
--commandType int The type of command.
Acceptable values are:
REBOOT - Reboot the device.
Can only be issued to Kiosk and managed guest session devices.
TAKE_A_SCREENSHOT - Take a screenshot of the device.
Only available if the device is in Kiosk Mode.
SET_VOLUME - Set the volume of the device.
Can only be issued to Kiosk and managed guest session devices.
WIPE_USERS - Wipe all the users off of the device.
Executing this command in the device will remove all user profile data, but it will keep device policy and enrollment.
REMOTE_POWERWASH - Wipes the device by performing a power wash.
Executing this command in the device will remove all data including user policies, device policies and enrollment policies.
Warning: This will revert the device back to a factory state with no enrollment unless the device is subject to forced or auto enrollment.
Use with caution, as this is an irreversible action!
--customerId int The unique ID for the customer's Workspace account.
As an account administrator, you can also use the my_customer alias to represent your account's customerId.
The customerId is also returned as part of the Users resource.
--delimiter string Delimiter to use for CSV columns. Must be exactly one character. Default is ';'
--deviceId int Immutable ID of Chrome OS Device.
-h, --help help for batch
--path string Path of the import file (CSV)
--payload int The payload for the command, provide it only if command supports it. The following commands support adding payload: - SET_VOLUME: Payload is a stringified JSON object in the form: { "volume": 50 }. The volume has to be an integer in the range [0,100].
--skipHeader Whether to skip the first row (header)
Options inherited from parent commands
--compressOutput By default, GSM outputs "pretty" (indented) objects. By setting this flag, GSM's output will be compressed. This may or may not improve performance in scripts.
--config string config file (default is $HOME/.config/gsm/.gsm.yaml)
--delay int This delay (plus a random jitter between 0 and 50) will be applied after every command to avoid reaching quota and rate limits. Set to 0 to disable.
--dwdSubject string Specify a subject used for DWD impersonation (overrides value in config file)
--log string Set the path of the log file. Default is either ~/gsm.log or defined in your config file
--maxElapsedTime int This is the maximum total time that will be spent retrying a request in minutes. (default 15)
--maxRetryInterval int This is the maximum interval that will be used between retry attempts in seconds. (default 320)
--redirectPort int This is the TCP port on which GSM will create web server if you authenticate with a user account for the first time. This is necessary for the OAuth flow. See https://developers.google.com/identity/protocols/oauth2/native-app#redirect-uri_loopback (default 8081)
--retryOn ints Specify the HTTP error code(s) that GSM should retry on. Note that GSM will always retry on HTTP 403 errors that indicate a quota / rate limit error
--streamOutput Setting this flag will cause GSM to output slice values to stdout one by one, instead of one large object
SEE ALSO
- gsm chromeOs issueCommand - Takes an issueCommand that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices.