Additional command line interface configuration options

Aside from configuring the authentication provider of your Automation Orchestrator deployment, you can use command line interface (CLI) commands for:

License configuration
System properties configuration
Extension configuration
Troubleshooting
Retrieving system information
Logging configuration

For information on configuring the authentication provider with CLI commands, go to Configuring the Automation Orchestrator Appliance authentication provider with the command line interface

License configuration

You can retrieve the current Automation Orchestrator license configuration by running the following command:

vracli vro license

You can set a new license key by running the following command:

vracli vro license set <license_key>

You can reset the current license to the default license of the authentication provider by running the following command:

vracli vro license default

System property configuration

You can retrieve a list of all configured Automation Orchestrator system properties, as a JSON file, by running the following command:

vracli vro properties

You can set a system property by running the following command:

vracli vro properties set

This system property command has the following properties:


Property	Importance	Description
`-k` or `--key`	Required	This property defines the name of the system property you want to set.
`-v` or `--value`	Required	This property defines the value of the system property.
`-n` or `--noRestart`	Optional	This property defines if the set system property requires a restart of the Automation Orchestrator service. By default, setting any new system property performs a restart of the service.

The following is an example of this system property command:

vracli vro properties set -k com.vmware.o11n.property -v true

You can remove existing system properties by running the following command:

vracli vro properties remove -k <key_value>

Note: The -k or --key property must include the name of the system property you want to remove.

You can retrieve the name, value, and description of the most commonly used system properties by running the following command:

vracli vro properties advanced

Extension configuration

You can retrieve a list of all configured Automation Orchestrator extensions by running the following command:

vracli vro extensions

You can activate an extension by running the following command:

vracli vro extensions <extension_name> activate

You can deactivate an extension by running the following command:

vracli vro extensions <extension_name> deactivate

You can list all the configuration properties of a specific extension by running the following command:

vracli vro extensions <extension_name> list

You can set a extension property by running the following command:

vracli vro extensions <extension> set

This extension property command can have the following properties:


Property	Importance	Description
`-k` or `--key`	Required	This property defines the ID of the extension property.
`-v` or `--value`	Required	This property defines the value of the extension property.

For example, the workflow of activating an extension, listing all its properties, and setting a system property could look similar to this:

vracli vro extensions tokenreplay activate

vracli vro extensions tokenreplay list

vracli vro extensions tokenreplay set -k recordScripting -v true

Troubleshooting

You can cancel all active workflow runs by running the following command:

vracli vro cancel executions

You can cancel a specific workflow run by adding its ID to the following command:

vracli vro cancel workflow <workflow_id>

You can suspend all active scheduled tasks by running the following command:

vracli vro cancel tasks

You can retrieve a list of all trusted certificates by running the following command:

vracli vro keystore list

System information

You can retrieve the current system information of your Automation Orchestrator deployment by running the following command:

vracli vro info

Note: You can add the optional property of -d or --details to the system information command to all check the health status API of the Automation Orchestrator server.

Logging configuration

You can retrieve the current Automation Orchestrator logging configuration by running the following command:

vracli vro logs

You can configure the Automation Orchestrator logging server by running the following command:

vracli vro logs configure

The logging server command can have the following parameters


Parameter	Importance	Description
`-l` or `--level`	Optional	This parameter defines the server logging level.
`-sc` or `--scripting-count`	Optional	This parameter defines the number of saved scripting log rotations.
`-sl` or `--scripting-level`	Optional	This parameter defines the scripting log level.
`-ss` or `--scripting-size`	Optional	This parameter defines the scripting log size in megabytes (MB).

Note: The valid level values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL and OFF.

CLI command logs

Automation Orchestrator CLI commands print their logs in the /services-logs/prelude/vco-app/file-logs/vco-server-app_cfg-cli.log file. When a command returns a result different than zero and the standard output does not show a specific error, the exception is visible in this file.