GoSpace Manager

Version v0.11.0

Manage Google Workspace resources using a developer-friendly CLI written in Go

batch

Batch patches groups using a CSV file as input.

Synopsis

Implements the API documented at https://developers.google.com/admin-sdk/directory/reference/rest/v1/groups/patch

gsm groups patch batch [flags]

Options

      --batchThreads int         Specify the number of threads that should be used for batch commands (overrides value in config file. Max 16)
      --delimiter string         Delimiter to use for CSV columns. Must be exactly one character. Default is ';'
      --description int          An extended description to help users determine the purpose of a group.
                                 For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups.
                                 Maximum length is 4,096 characters.
      --description_ALL string   Same as description but value is applied to all lines in the CSV file
      --email int                Identifies the group in the API request.
                                 The value can be the group's email address, group alias, or the unique group ID.
      --fields int               Fields allows partial responses to be retrieved.
                                 See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
      --fields_ALL string        Same as fields but value is applied to all lines in the CSV file
      --groupKey int             Identifies the group in the API request.
                                 The value can be the group's email address, group alias, or the unique group ID.
  -h, --help                     help for batch
      --name int                 The group's display name.
      --name_ALL string          Same as name but value is applied to all lines in the CSV file
      --path string              Path of the import file (CSV)
      --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 groups patch - Updates a group’s properties. This method supports patch semantics