batch
Batch applies actions on mobile devices using a CSV file as input.
Synopsis
Implements the API documented at https://developers.google.com/admin-sdk/directory/reference/rest/v1/mobiledevices/action
gsm mobileDevices action batch [flags]
Options
--action int The action to be performed on the device.
[admin_account_wipe|admin_remote_wipe|approve|approve|block|cancel_remote_wipe_then_activate|cancel_remote_wipe_then_block]
admin_account_wipe - Remotely wipes only Workspace data from the device. See the administration help center for more information.
admin_remote_wipe - Remotely wipes all data on the device. See the administration help center for more information.
approve - Approves the device. If you've selected Enable device activation, devices that register after the device activation setting is enabled will need to be approved before they can start syncing with your domain. Enabling device activation forces the device user to install the Device Policy app to sync with Workspace.
block - Blocks access to Workspace data (mail, calendar, and contacts) on the device. The user can still access their mail, calendar, and contacts from a desktop computer or mobile browser.
cancel_remote_wipe_then_activate - Cancels a remote wipe of the device and then reactivates it.
cancel_remote_wipe_then_block - Cancels a remote wipe of the device and then blocks it.
--action_ALL string Same as action but value is applied to all lines in the CSV file
--batchThreads int Specify the number of threads that should be used for batch commands (overrides value in config file. Max 16)
--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.
--customerId_ALL string Same as customerId but value is applied to all lines in the CSV file
--delimiter string Delimiter to use for CSV columns. Must be exactly one character. Default is ';'
-h, --help help for batch
--path string Path of the import file (CSV)
--resourceId int The unique ID the API service uses to identify the mobile device.
--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 mobileDevices action - Takes an action that affects a mobile device. For example, remotely wiping a device.