Skip to main content

VA

Learn about the CLI commands you can use to interact with VAs in this guide.

A virtual appliance (VA) is a Linux-based virtual machine that connects to your sources and applications in IDN by using APIs, connectors, and other integrations SailPoint has made available.

For more information about VAs, refer to the Virtual Appliance Reference Guide.

Commands​

To use the CLI to interact with VAs connected to your tenant, run these commands:

Collect​

To collect all files from a VA, run this command: 

sail va collect {VA IP address} {flags}

This command gets all files from the VA and saves them to the current working directory (the directory you're in), unless you specify flags.

Flags​

You can add these flags to the the collect command:

  • -o, --Output: Set the path to save the files to. If the directory doesn't exist, the CLI creates it. The default directory is the current working directory.
  • -c, --config: Only get config files.
  • -h, --help: View the command's help with examples within the CLI.
  • -l, --logs: Only get log files.

Example​

Here is an example command and response: 

sail va collect 10.10.10.10, 10.10.10.11 (-l only collect log files) (-c only collect config files) (-o /path/to/save/files)

Log Files: 
/home/sailpoint/log/ccg.log
/home/sailpoint/proxy.yaml
/home/sailpoint/stuntlog.txt

Config Files: 
/home/sailpoint/proxy.yaml
/etc/systemd/network/static.network
/etc/resolv.conf

Parse​

This command converts log files into a human-readable format. It's helpful when you want to troubleshoot VA issues.

To parse log files, run this command: 

sail va parse {log file} {flags}

By default, this command parses all errors in the log files, not all log traffic - you can use flags to parse all log traffic.

Flags​

You can add these flags to the parse command:

  • --canal: Specify that the provided files are CANAL files.
  • --ccg: Specify that the provided files are CCG files.
  • -e, --everything: Parse all log traffic, not just errors.
  • -h, --help: View the command's help with examples within the CLI.

Example​

Here is an example command: 

sail va parse ./path/to/ccg.log ./path/to/ccg.log ./path/to/canal.log ./path/to/canal.log

Update​

To update a VA, run this command: 

sail va update {VA IP address} {flags}

Flags​

You can add these flags to the update command:

  • -h, --help: View the command's help with examples within the CLI.

Example​

Here is an example command: 

sail va update 10.10.10.10 10.10.10.11