System
backup-create
Usage: backup-create [options]
Backup product configuration and metadata
| Options | Description |
|---|---|
| --async | Causes the command to be executed asynchronously. A reference task identifier will be returned |
| --help | Display this help and exit |
| *--ip | IP address of the backup volume |
| --now | Create an immediate product backup. Required unless "--schedule-name" is specified |
| *--path | The NFS export path to the backup volume |
| --schedule-name | Name for the periodic product backup schedule. Required unless "--now" is specified |
backup-list
Usage: backup-list [options]
List the names of the product configuration and metadata backups in the backup volume
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| *--ip | IP address of the backup volume |
| *--path | The NFS export path to the backup volume |
backup-restore
Usage: backup-restore [options]
Restore product configuration and metadata backup
| Options | Descriptions |
|---|---|
| --async | Causes the command to be executed asynchronously. A reference task identifier |
| --backup-name | The name of the backup. If not specified, the most recent backup is restored |
| --cluster-uuid | The UUID of the cluster that created the backup from which you would like to restore |
| --help | Display this help and exit |
| *--ip | IP address of the backup volume |
| *--path | The NFS export path to the backup volume |
backup-schedule-list
Usage: backup-schedule-list [options]
List the product's backup schedule
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
backup-update
Usage: backup-update [options]
Update the product's backup schedule
| Options | Descriptions |
|---|---|
| *--ip | IP address of the backup volume |
| *--path | The NFS export path to the backup volume |
| --remove-schedule | Remove a schedule. Required unless "--schedule-name" is specified |
| --schedule-name | Name for the periodic product backup schedule. Required unless "--remove-schedule" is specified |
cluster-update
Usage: cluster-update [options]
Update Cluster configuration
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| *--online-activation-support | Determines whether online license activation is allowed. Allowed values:[YES, NO]. Required unless "--timezone" is specified |
| *--timezone | Specifies the timezone.. Required unless "--online-activation-support" is specified |
cluster-view
Usage: cluster-view [options]
View the cluster configuration
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
dns-list
Usage: dns-list [options]
List the DNS configuration
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
dns-update
Usage: dns-update [options]
Update the DNS configuration
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| --servers | Set DNS server(s) |
| --servers-clear | Clear DNS servers |
dp-update
Usage: dp-update [options]
Update data portal
| Options | Descriptions |
|---|---|
| --data-portal-id | The data portal UUID. Required unless "--data-portal-type" or "--node-name" is specified |
| --data-portal-type | The data portal type (NFS or SMB). Required unless "--data-portal-id" or "--node-name" is specified |
| --disable | Set the data portal admin state to DOWN |
| --enable | Set the data portal admin state to UP |
| --help | Display this help and exit |
| --node-name | The node name. Required unless "--data-portal-type" or "--data-portal-id" is specified |
event-list
Usage: event-list [options]
List events generated by the system
| Options | Descriptions |
|---|---|
| --from-date | List events after "from-date", in the format [yyyy-MM-dd|dd-MMM-yyyy] [HH:mm:ss] |
| --full | Print extra information fore each element |
| --help | Display this help and exit |
| --id | The ID of the event to list |
| --last-emitted | List last emitted events |
| --severity | List all events with severity greater than the given severity. Possible values: DEBUG | INFORMATIONAL | NOTICE | WARNING | ERROR | CRITICAL | ALERT | EMERGENCY. |
| -type | List all events of a given type. e.g., SHARE_CREATED |
| -until-date | List events before "until-date", in the format [yyyy-MM-dd|dd-MMM-yyyy] [HH:mm:ss] |
event-smtpgw-define
Usage: event-smtpgw-define [options]
Add an SMTP gateway which will be used for events and call home through a mail server
| Options | Descriptions |
|---|---|
| --from-address | Source email address from which the events will be sent |
| --help | Display this help and exit |
| --host | SMTP host |
| --no-ssl | Disable SSL secured connection |
| --password | SMTP password |
| --port | SMTP port |
| --ss | Enable SSL secured connection |
| --username | SMTP username |
event-smtpgw-list
Usage: event-smtpgw-list [options]
View SMTP configuration
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
ha-node-add
Usage: ha-node-add [options]
HA node add
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| --IP | HA node IP address to be added |
ha-node-decommission
Usage: ha-node-decommission [options]
HA node decommission
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| *--id | HA node ID to be decommissioned. Required unless "--name" is specified |
| *--name | HA node name to be decommissioned. Required unless "--id" is specified |
heartbeat-list
Usage: heartbeat-list [options]
List the configured heartbeats
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
heartbeat-send
Usage: heartbeat-send [options]
Sends the specified heartbeat type to support
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| * --id | The ID of the heartbeat to send. Required unless "--type" or "--name" is specified |
| * --name | The name of the heartbeat to send. Required unless "--type" or "--id" is specified |
| * --type | The type of the heartbeat to send. Required unless "--name" or "--id" is specified Possible values: HEALTH | CAPACITY. |
heartbeat-update
Usage: heartbeat-update [options]
Update the heartbeat configuration
| Options | Descriptions |
|---|---|
| --disable | Disables periodic heartbeat sending. Required unless "--enable" or "--interval" is specified |
| --enable | Required unless "--disable" or "--interval" is specified |
| --help | Display this help and exit |
| * --id | The ID of the heartbeat configuration to be updated. Required unless "--type" or "--name" is specified |
| --interval | Periodic heartbeat sending interval. (default units: seconds, otherwise specify units, e.g. "5 minutes"). Required unless "--enable" or "--disable" is specified |
| * --name | The name of the heartbeat configuration to be updated. Required unless "--type" or "--id" is specified |
| * --type | The type of the heartbeat configuration to be updated. Required unless "--name" or "--id" is specified Possible values: HEALTH | CAPACITY. |
kms-add
Usage: kms-add [options]
Add a key management system (KMS)
| Options | Descriptions |
|---|---|
| --client-certificate | An X.509 certificate in Base64-encoded PEM format (with the BEGIN and END tags) that identifies the client to the server (* required for NCIPHER_WSOP) |
| --client-private-key | An RSA private key in Base64-encoded PEM format (with the BEGIN and END tags) that is paired with the client-certificate (* required for NCIPHER_WSOP) |
| --comment | Any comment to be associated with the KMS |
| --endpoint | The endpoint (URI or host:port) of the KMS (* required for NCIPHER_WSOP) |
| --help | Display this help and exit |
| --key-id | The key identifier to use with the KMS (* required for NCIPHER_WSOP) |
| * --name | A name for the KMS |
| --server-certificate-chain | An X.509 certificate with optional CA chain in Base64-encoded PEM format (with the BEGIN and END tags) that identifies the KMS server to the client (* required for NCIPHER_WSOP)` |
| --type | The type of KMS system being added. Possible values: NCIPHER_WSOP |
kms-list
Usage: kms-list [options]
List the key management systems
| Options | Descriptions |
|---|---|
| --full | Print extra information for each element |
| --help | Display this help and exit |
| --id | KMS ID |
| --internal-id | KMS internal ID |
| --name | KMS name |
kms-remove
Usage: kms-remove [options]
Remove a key management systems
| Options | Descriptions |
|---|---|
| --force | Force the removal of a KMS, even if object storage volumes exist |
| --help | Display this help and exit |
| *--id | KMS ID. Required unless "--name" or "--internal-id" is specified |
| * --internal-id | KMS internal ID. Required unless "--id" or "--name" is specified |
| *--name | KMS name. Required unless "--id" or "--internal-id" is specified |
kms-update
Usage: kms-update [options]
Update a key management system (KMS)
| Options | Descriptions |
|---|---|
| --client-certificate | An X.509 certificate in Base64-encoded PEM format (with the BEGIN and END tags) that identifies the client to the server |
| --client-private-key | An RSA private key in Base64-encoded PEM format (with the BEGIN and END tags) that is paired with the client-certificate |
| --comment | Any comment to be associated with the KMS |
| --endpoint | The endpoint (URI or host:port) of the KMS |
| --help | Display this help and exit |
| *--id | KMS ID. Required unless "--name" or "--internal-id" is specified |
| * --internal-id | KMS internal ID. Required unless "--id" or "--name" is specified |
| --key-id | The key identifier to use with the KMS |
| * --name | KMS name. Required unless "--id" or "--internal-id" is specified |
| --new-name | A new name for the KMS |
| --server-certificate-chain | An X.509 certificate with optional CA chain in Base64-encoded PEM format (with the BEGIN and END tags) that identifies the KMS server to the client |
local-site-update
Usage: local-site-update [options]
Update the local site
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| --name | The new name of the local site |
local-site-view
Usage: local-site-view [options]
View the local site
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
ldap-clear
Usage: ldap-clear [options]
Clear the LDAP configuration
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
ldap-list
Usage: ldap-list [options]
List the LDAP configuration
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
ldap-update
Usage: ldap-update [options]
Update the LDAP configuration
| Options | Descriptions |
|---|---|
| *--base | LDAP base DN |
| --help | Display this help and exit |
| *--url | LDAP base URL (example ldap://host:port) |
license-add
Usage: license-add [options]
Add and activate a license
| Options | Descriptions |
|---|---|
| * --activation-id | The license activation ID |
| --async | Causes the command to be executed asynchronously. A reference task identifier will be returned |
| --capacity | Number of 1TB units of storage capacity to allocate to this license. Only applicable with capacity-based licenses |
| --help | Display this help and exit |
license-list
Usage: license-list [options]
List all licenses
| Options | Descriptions |
|---|---|
| --activation-id | The activation ID of the license to list |
| --help | Display this help and exit |
license-offline-add
Usage: license offline-add [options]
Add and activate a license via an offline process. A request file is generated and obtained via one of the export parameters. The request file is then exchanged for a response file by the license administrator or at the license portal. The response file is then uploaded to complete the process.
| Options | Descriptions |
|---|---|
| * --activation-id | The license activation ID |
| * --capacity | Number of 1TB units of storage capacity to allocate to this license. Only applicable with capacity-based licenses |
| * --export-uri | Causes an activation request to be copied to an ftp, scp, or mailto location. Examples: ftp://example.com/uploads, scp://example.com/uploads, mailTo:john.doe@example.com Required unless "--import-uri" is specified |
| --help | Display this help and exit |
| *--import-uri | The location of the activation- response file to be uploaded which will complete the offline license add process. Examples: ftp://example.com/uploads/capabilityResponse.bin, scp://example.com/uploads/capabilityResponse.bin Required unless "--export-uri" is specified |
license-offline-remove
Usage: license offline-remove [options]
Deactivate and remove a license via an offline process. A request.bin file is generated and obtained via one of the export parameters. The request file is then exchanged for a response file by the license administrator or at the license portal. The response file is then uploaded to complete the update process.
| Options | Descriptions |
|---|---|
| --activation-id | The license activation ID |
| --export-uri | Causes a remove request file to be copied to an ftp, scp, or mailto location. Examples: ftp://example.com/uploads, scp://example.com/uploads, mailTo:john.doe@example.com. Required unless "--import-uri" is specified |
| --help | Display this help and exit |
| --import-uri |
The location of the activation response file to be uploaded which will complete the offline license add process. Examples: ftp://example.com/uploads/capabilityResponse.bin, scp://example.com/uploads/capabilityResponse.bin Required unless "--export-uri" is specified |
license-offline-update
Usage: license-offline-update [options]
Update the allocated capacity for a capacity-based license via an offline process. A request file is generated and obtained via one of the export parameters. The request file is then exchanged for a response file by the license administrator or at the license portal. The response file is then uploaded to complete the update process.
| Options | Descriptions |
|---|---|
| * --activation-id | The license activation ID |
| --capacity | New number of 1TB units of storage capacity to allocate to this license |
| --export-uri | Causes an update request file to be copied to an ftp, scp, or mailto location. Examples: ftp://example.com/uploads, scp://example.com/uploads, mailTo:john.doe@example.com. Required unless "--import-uri" is specified |
| --help | Display this help and exit |
| --import-uri | The location of the activation response file to be uploaded which will complete the offline license add process. Examples: ftp://example.com/uploads/capabilityResponse.bin, scp://example.com/uploads/capabilityResponse.bin Required unless "--export-uri" is specified |
license-remove
Usage: license-remove [options]
Deactivate and remove a license
| Options | Descriptions |
|---|---|
| * --activation-id | The license activation ID |
| --async | Causes the command to be executed asynchronously. A reference task identifier will be returned |
| --help | Display this help and exit |
license-update
Usage: license-update [options]
Update the allocated capacity for a capacity-based license
| Options | Descriptions |
|---|---|
| * --activation-id | The license activation ID |
| --async | Causes the command to be executed asynchronously. A reference task identifier will be returned |
| * --capacity | New number of 1TB units of storage capacity to allocate to this license |
| --help | Display this help and exit |
metric-list
Usage: metric-list [options]
List metrics
| Options | Descriptions |
|---|---|
| * --field | Field names in the format: <table-name>.<column-name> (e.g., network.bytesSent) |
| --from-date | Shows metrics after date "from-date" (default: now - 1h) |
| --func | Computational aggregate function. Possible values: MIN | MAX | MEAN | MEDIAN. |
| --group-by | Time grouping interval. For example, 60s (seconds), 60m (minutes), 24h (hours), 7d (days), 52w (weeks) |
| --help | Display this help and exit |
| --limit | Total number of samples per column (default: 1000) |
| --name | Name criteria on the metrics |
| --objec-type | Object type criteria on the metrics |
| --until-date | Shows metrics before date "until-date" |
| --uuid | Shows metrics on an object with the specified UUID |
nis-config
Usage: nis-config [options]
Configure NIS servers
| Options | Descriptions |
|---|---|
| --disable | disable NIS service |
| --enable | ensable NIS service |
| --help | Display this help and exit |
| --servers | NIS servers configuration in the form domain:server, example: --servers |
| --servers-clear | Clear NIS servers |
nis-view
Usage: nis-view [options]
View NIS configuration
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
notification-rule-create
Usage: notification-rule-create [options]
Create a notification rule
| Options | Descriptions |
|---|---|
| *--format | Notification format Possible values: XML | DEBUG. |
| --help | Display this help and exit |
| *--name | Rule name |
| *--threshold | Severity threshold Possible values: DEBUG | INFORMATIONAL | NOTICE | WARNING | ERROR | CRITICAL | ALERT | EMERGENCY. |
| --users | Destination users (each must have an email address) |
notification-rule-list
Usage: notification-rule-list [options]
List notification rules
| Options | Descriptions |
|---|---|
| --full | Print extra information for each element |
| --help | Display this help and exit |
| --id | Notification rule identifier |
| --name | Notification rule name |
notification-rule-remove
Usage: notification-rule-remove [options]
Remove a notification rule
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| *--id | Notification rule identifier. Required unless "--name" is specified |
| *--name | Notification rule name. Required unless "--id" is specified |
notification-rule-update
Usage: notification-rule-update [options]
Update a notification rule
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| *--id | Notification rule identifier. Required unless "--name" is specified |
| *--name | Notification rule name. Required unless "--id" is specified |
| *--new format | New notification format Possible values: XML | DEBUG. Required unless "--new-threshold" or "--new-name" is specified |
| *--new-name | New name. Required unless "--new-format" or "--new-threshold" is specified |
| *--new-threshold | New severity threshold. Required unless "--new-format" or "--new-name" is specified. Possible values: DEBUG | INFORMATIONAL | NOTICE | WARNING | ERROR | CRITICAL | ALERT | EMERGENCY. |
ntp-list
Usage: ntp-list [options]
List the NTP configuration
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
ntp-update
Usage: ntp-update [options]
Update the NTP configuration
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| --servers | Set NTP sync server(s) |
| --servers-clear | Clear NTP sync servers |
support-bundle
Usage: support-bundle [options]
Collect logs and information from all nodes
| Options | Descriptions |
|---|---|
| *--all | Collect from all available nodes. Required unless "--current" or "--push" or "--node" is specified |
| *--current | Collect from current node (default). Required unless "--all" or "--push" or "--node" is specified |
| --dest | Save output file into a specific folder |
| --help | Display this help and exit |
| --local | Collect locally |
| *--node | Collect from specific node. Required unless "--current" or "--all" or "--push" is specified |
| *--push | Collect and push to Support Center. Required unless "--current" or "--all" or "--node" is specified |
remote-site-add
Usage: remote-site-add [options]
Add a remote site
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| * --mgmt-address | The management address of the remote site |
| --trust-client-certificate | Automatically trust the remote site's client certificate |
remote-site-discover
Usage: remote-site-discover [options]
Discover a remote site and, optionally, synchronize data on the local instance of the remote site
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| * --mgmt-address | The management address of the remote site |
| --sync | Synchronize data on the local site instance with discovered remote values |
remote-site-list
Usage: remote-site-list [options]
List known remote sites
| Options | Descriptions |
|---|---|
| --full | Print extra information for each element |
| --help | Display this help and exit |
| --id | The ID of the site to be listed |
| --internal-id | The internal ID of the site to be listed |
| --name | The name of the site to be listed |
remote-site-remove
Usage: remote-site-remove [options]
Remove a remote site
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| --id | The ID of the site to be removed. Required unless "--name" or "— internal-id" is specified |
| *--internal-id | The internal ID of the site to be removed. Required unless "--id" or "--name" is specified |
| *--name | The name of the site to be removed. Required unless "--id" or "--internal-id" is specified |
remote-site-update
Usage: remote-site-update [options]
Update a remote site
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
| * --id | The ID of the site to be updated. Required unless "--internal-id" or "--name" is specified |
| * --internal-id | The internal ID of the site to be updated. Required unless "--name" or "--id" is specified |
| * --name | The remote site's name. Required unless "--internal-id" or "--id" is specified |
| * --no-trust-client-certificate | certificate Do not automatically trust the remote site's client certificate. Required unless "--trust-client-certificate" is specified |
| * --trust-client-certificate | Automatically trust the remote site's client certificate. Required unless "--no-trust-client-certificate" is specified |
proxy-clear
Usage: proxy-clear [options]
Clear the proxy configuration for the support-bundle and heartbeat
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
proxy-set
Usage: proxy-set [options]
Configure the support-bundle and heartbeat sender to use proxy
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| --proxy-url | The proxy URL to be used for support-bundle push and heartbeats (in the form http://a.b.c.d:pp) |
schedule-create
Usage: schedule-create [options]
Create a schedule
Expression values follow cron syntax where:
',' Commas separate lists
'-' Hyphens define ranges
'*' Wildcard matches all cases
'/' Slashes define step values i.e. */5 = every 5 minutes
Example: To create a schedule at 1:30 AM, 12:30 PM and 6:30 PM, Monday-Friday schedule-create --name schedule_name --minute 30 --hour 1,12,18 --day-of-week MON-FRI
| Options | Descriptions |
|---|---|
| --day-of-month | The day of month for schedule. Allowed values are: 1-31,-*/ (default value: *) |
| --day-of-week | The day of week for schedule. Allowed values are: 1-7,SUN-SAT-*/ (default value: *) |
| --help | Display this help and exit |
| --hour | The hour for schedule. Allowed values are: 0-23,-*/ (default value: *) |
| --minute | The minute for schedule. Allowed values are: 0-59,-*/ (default value: *) |
| --month | The month for schedule. Allowed values are: 1-12,-*/ (default value: *) |
| *--name | The name of the schedule |
schedule-delete
Usage: schedule-delete [options]
Delete a schedule
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| *--id | The ID of the schedule to delete. Required unless "--name" is specified |
| *--name | The name of the schedule to delete. Required unless "--id" is specified |
schedule-list
Usage: schedule-list [options]
List schedules
| Options | Descriptions |
|---|---|
| --full | Print extra information for each element |
| --help | Display this help and exit |
| --id | The ID of the schedule to list |
| --name | The name of the schedule to list |
schedule-update
Usage: schedule-update [options]
Update a schedule
Expression values follow cron syntax where:
',' Commas separate lists
'-' Hyphens define ranges
'*' Wildcard matches all cases
'/' Slashes define step values i.e. */5 = every 5 minutes
Example: To update a schedule to 1:30 AM, 12:30 PM and 6:30 PM, Monday-Friday
schedule-update --name schedule_name --minute 30 --hour 1,12,18 --day-of-week MON-FRI
| Options | Descriptions |
|---|---|
| --day-of-month | The day of month for schedule. Allowed values are: 1-31,-*/ (default value: *) |
| --day-of-week | The day of week for schedule. Allowed values are: 1-7,SUN-SAT-*/ (default value: *) |
| --help | Display this help and exit |
| --hour | The hour for schedule. Allowed values are: 0-23,-*/ (default value: *) |
| *--id | ID to identify the schedule. Required unless "--name" is specified |
| --minute | The minute for schedule. Allowed values are: 0-59,-*/ (default value: *) |
| --month | The month for schedule. Allowed values are: 1-12,-*/ (default value: *) |
| *--name | The name of the schedule |
snmp-clear
Usage: snmp-clear [options]
Clear SNMP configuration
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
snmp-config
Usage: snmp-config [options]
Configure SNMP service
| Options | Descriptions |
|---|---|
| --contact | The textual identification of the contact person for this managed node, together with information on how to contact this person |
| --description | A textual description of the entity |
| --dest | SNMP trap destination configuration. A 3-tuple including <IP>,<version>,<community>. For example: 172.31.12.216,V2C,public |
| --help | Display this help and exit |
| --location | The physical location of this node |
| --manager | SNMP manager configuration. A 3-tuple including <subnet>,<version>,<community>. For example: 172.31.0.0/16,V2C,public |
| --name | An administratively-assigned name for this managed node |
snmp-disable
Usage: snmp-disable [options]
Disable SNMP service
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
snmp-enable
Usage: snmp-enable [options]
Enable SNMP service
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
snmp-view
Usage: snmp-view [options]
View SNMP configuration
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
software-apply
Usage: software-apply [options]
Apply software version
| Options | Descriptions |
|---|---|
| *--all | Update all nodes, mutually exclusive with "--node-name". "". Required unless "--node-name" is specified |
| --help | Display this help and exit |
| --node-name | Node name, mutually exclusive with "--all". Required unless "--all" is specified * --version Version |
| *--version | Version |
software-list
Usage: software-list [options]
List software versions
| Options | Descriptions |
|---|---|
| --full | Print extra information for each element |
| --help | Display this help and exit |
software-package-delete
Usage: software-package-delete [options]
Delete software update packages
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
| *--package-name | Package name to delete |
software-update-cancel
Usage: software-update-cancel [options]
Cancel software update task
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
| *--task-id | Task ID |
software-update-status
Usage: software-update-status [options]
Monitor update status
| Options | Descriptions |
|---|---|
| --full | Print extra information for each element |
| --help |
Display this help and exit |
| --task-id | Update task id |
software-upload
Usage: software-upload [options]
Upload a software package with UPD format
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
| *--package-location | The path to the UPD software package |
syslog-clear
Usage: syslog-clear [options]
Clear Syslog configuration
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
syslog-config
Usage: syslog-config [options]
Configure Syslog servers
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
| --server | Syslog server configuration. A 3-tuple including <IP>,<port>,<transport>, example: 192.168.1.23,514,TCP. Can be used multiple times when configuring more than one server |
syslog-disable
Usage: syslog-disable [options]
Disable Syslog Event forwarding
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
syslog-enable
Usage: syslog-enable [options]
Enable Syslog Event forwarding
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
syslog-view
Usage: syslog-view [options]
View Syslog configuration
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
system-shutdown
Usage: system-shutdown [options]
Use this command to perform a clean system shutdown of the Anvil system that recalls all layouts.
| Options | Descriptions |
|---|---|
| *--force | Confirm shutdown execution |
| --help |
Display this help and exit |
| --reason | Shutdown reason |
system-view
Usage: system-view [options]
Show an overview of the system Options:
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
| --summary | Show only a short summary of the system |
task-list
Usage: task-list [options]
List all running tasks in the system. The command can also be used to list completed tasks using the status filter, showing both successful and failed tasks . When no time-based filter is specified, tasks created over the past 5 days are returned.
| Options | Descriptions |
|---|---|
| --ended-after | List tasks that ended at or after (>=) the specified time, in the format [yyyy-MM-dd|dd-MMM-yyyy] [HH:mm:ss] |
| --ended-before | List tasks that ended before (<) the specified time, in the format [yyyy-MM-dd|dd-MMM-yyyy] [HH:mm:ss] |
| --full | Print extra information |
| --help |
Display this help and exit |
| --id | The task ID |
| --name | The task name |
| --started-after | List tasks that started at or after (>=) the specified time, in the format [yyyy-MM-dd|dd-MMM-yyyy] [HH:mm:ss] |
| --started-before | List tasks that started before (<) the specified time, in the format [yyyy-MM-dd|dd-MMM-yyyy] [HH:mm:ss] |
| --status | Filter by the status of the task, possible statuses are: Possible values: NONE | QUEUED | VALIDATING | VALIDATED EXECUTING, STOPPED, FAILED, COMPLETED | ABANDONED. |
task-purge
Usage: task-purge [options]
Purge a task that FAILED or STOPPED to allow other tasks to execute that cannot currently complete
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
| --id | The task ID |
task-resume
Usage: task-resume [options]
Resume a task that had FAILED or STOPPED
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
| --id | The task ID |