anchorectl account
Account related operations.
Every command on this page also accepts the global flags.
Subcommands
- account add — Create a new account. Only available to admin user.
- account delete — Delete the specified account, only allowed if the account is in the disabled state. All users will be deleted along with the account and all resources will be garbage collected
- account disable — Disable an account
- account enable — Enable a previously disabled account
- account get — Get info about an account. Only available to admin user. Uses the main user Id, not a username.
- account list — List account summaries. Only available to the system admin user.
- account update — Update an account. Only available to admin user.
account add
Create a new account. Only available to admin user.
anchorectl account add NAME [flags]
Arguments
| Argument | Description |
|---|---|
NAME | Name of the account to create. |
Flags
| Flag | Type | Environment variable | Default | Required | Description |
|---|---|---|---|---|---|
--email | string | ANCHORECTL_ACCOUNT_EMAIL | "" | No | The account email. |
-o, --output | string | ANCHORECTL_FORMAT | text | No | The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats. |
account delete
Delete the specified account, only allowed if the account is in the disabled state. All users will be deleted along with the account and all resources will be garbage collected.
anchorectl account delete NAME [flags]
Aliases: del
Arguments
| Argument | Description |
|---|---|
NAME | Name of the account. |
Flags
| Flag | Type | Environment variable | Default | Required | Description |
|---|---|---|---|---|---|
-o, --output | string | ANCHORECTL_FORMAT | text | No | The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats. |
account disable
Disable an account.
anchorectl account disable NAME [flags]
Arguments
| Argument | Description |
|---|---|
NAME | Name of the account. |
Flags
| Flag | Type | Environment variable | Default | Required | Description |
|---|---|---|---|---|---|
-o, --output | string | ANCHORECTL_FORMAT | text | No | The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats. |
account enable
Enable a previously disabled account.
anchorectl account enable NAME [flags]
Arguments
| Argument | Description |
|---|---|
NAME | Name of the account. |
Flags
| Flag | Type | Environment variable | Default | Required | Description |
|---|---|---|---|---|---|
-o, --output | string | ANCHORECTL_FORMAT | text | No | The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats. |
account get
Get info about an account. Only available to admin user. Uses the main user Id, not a username.
anchorectl account get NAME [flags]
Arguments
| Argument | Description |
|---|---|
NAME | Name of account. |
Flags
| Flag | Type | Environment variable | Default | Required | Description |
|---|---|---|---|---|---|
-o, --output | string | ANCHORECTL_FORMAT | text | No | The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats. |
account list
List account summaries. Only available to the system admin user.
anchorectl account list [flags]
Flags
| Flag | Type | Environment variable | Default | Required | Description |
|---|---|---|---|---|---|
-o, --output | string | ANCHORECTL_FORMAT | text | No | The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats. |
--state | string | ANCHORECTL_ACCOUNT_STATE | "" | No | Filter accounts by state. Allowable values: enabled, disabled, deleting. |
account update
Update an account. Only available to admin user.
anchorectl account update NAME [flags]
Arguments
| Argument | Description |
|---|---|
NAME | Name of the account. |
Flags
| Flag | Type | Environment variable | Default | Required | Description |
|---|---|---|---|---|---|
--email | string | ANCHORECTL_ACCOUNT_EMAIL | "" | No | The account email. |
-o, --output | string | ANCHORECTL_FORMAT | text | No | The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats. |