Moab Accounting Manager > Appendices > Appendix A: Commands Reference > gchaccount

gchaccount

Synopsis

gchaccount [-A | -I] [-o <organization_name>] [-d <description>] [-X, --extension <property>=<value>]... [--add-user(s) [^|!][+|-]<user_name>,...]... [--del-user(s) <user_name>,...]... [--mod-user(s) [^|!][+|-]<user_name>,...]... [--debug] [--site <site_name>] [--help] [--man] [--quiet] [--verbose] [--version] {[-a] <account_name>}

Overview

gchaccount modifies an account.

Options

-a
Format	[-a] <account_name>
Default	---
Description	Specifies the name of the account to modify.

-d
Format	-d <description>
Default	---
Description	Modifies the account description.

-o
Format	-o <organization_name>
Default	---
Description	Modifies the name of the organization to which the account belongs.

-X, --extension
Format	-X or --extension <property>=<value>
Default	---
Description	Modifies an extension property. You can specify any number of extra field assignments.

--add-user
Format	--add-user [^\|!][+\|-]<user_name>[,[^\|!][+\|-]<user_name>...]
Default	---
Description	Adds user members of the account. The optional caret or exclamation symbol indicates whether the user should be created as an administrator (^) or not (!) for the account. The optional plus or minus signs can precede each member to indicate whether the member should be created in the active (+) or inactive (-) state. By default, a user will be created in the active state but not an administrator. You can pass multiple users to the --add-user option in a comma-delimited list or you can specify multiple --add-user options.

--debug
Format	--debug
Default	---
Description	Logs debug information to the screen.

--del-user
Format	--del-user <user_name>[,<user_name>...]
Default	---
Description	Removes user members from the account. You can pass multiple users to the --del-user option in a comma-delimited list or specify multiple --del-user options.

--help
Format	--help
Default	---
Description	Displays a brief help message.

--man
Format	--man
Default	---
Description	Displays full documentation.

--mod-user
Format	--mod-user [^\|!][+\|-]<user_name>[,[^\|!][+\|-]<user_name>...]
Default	---
Description	Modifies user members of the account. The caret symbol or exclamation symbol indicates the user should be changed to become an administrator (^) or not (!) for the account. The plus or minus signs indicate whether the user should be changed to become active (+) or inactive (-). If you do not specify an active or admin modifier, that aspect of the user member will remain unchanged. You can pass multiple users to the --mod-user option in a comma-delimited list or you can specify multiple --mod-user options.

--quiet
Format	--quiet
Default	---
Description	Suppresses headers and success messages.

--site
Format	--site <site_name>
Default	---
Description	Obtains a response from specified site.

--verbose
Format	--verbose
Default	---
Description	Displays modified object details.

--version
Format	--version
Default	---
Description	Displays the product version.