batch
Batch patches organizational units using a CSV file as input.
Synopsis
Implements the API documented at https://developers.google.com/admin-sdk/directory/reference/rest/v1/orgunits/patch
gsm orgUnits 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)
--blockInheritance int Determines if a sub-organizational unit can inherit the settings of the parent organization.
The default value is false, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit.
For more information on inheritance and users in an organization structure, see the administration help center.
--blockInheritance_ALL Same as blockInheritance but value is applied to all lines in the CSV file
--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 ';'
--description int Description of the organizational unit.
--description_ALL string Same as description but value is applied to all lines in the CSV file
--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
-h, --help help for batch
--name int The organizational unit's path name.
For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support.
--name_ALL string Same as name but value is applied to all lines in the CSV file
--orgUnitPath int The full path of the organizational unit or its unique ID.
--parentOrgUnitId int The unique ID of the parent organizational unit.
Required, unless parentOrgUnitPath is set.
--parentOrgUnitId_ALL string Same as parentOrgUnitId but value is applied to all lines in the CSV file
--parentOrgUnitPath int The organizational unit's parent path.
For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit.
Required, unless parentOrgUnitId is set.
--parentOrgUnitPath_ALL string Same as parentOrgUnitPath 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)
--type int Whether to return all sub-organizations or just immediate children.
Acceptable values are:
all - All sub-organizational units.
children - Immediate children only (default).
--type_ALL string Same as type but value is applied to all lines in the CSV file
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 orgUnits patch - Updates an organizational unit. This method supports patch semantics.