mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 20:37:47 +00:00
VA Commands
This commit is contained in:
@@ -157,15 +157,16 @@ To get your environment variables to persist across PowerShell sessions, run thi
|
|||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Run the `sail` command for an overview of the available commands and flags. You can use the `-h` flag with any available command to see additional available options for each command:
|
Run the `sail` command for an overview of available commands and flags. You can use the `-h` flag with any command to see additional options for each command:
|
||||||
|
|
||||||
The following commands are available.:
|
These commands are available:
|
||||||
|
|
||||||
- `connectors`: This command is a CLI interface for the SaaS Connectivity platform. The CLI is the best way to create and manage SaaS connectors within your tenant. For more information about the `connectors` command, refer to the CLI [Connectors guide](/idn/tools/cli/connectors). For more information about the SaaS Connectivity platform, refer to [SaaS Connectivity](/idn/docs/saas-connectivity).
|
- `connectors`: This command is a CLI interface for the SaaS Connectivity platform. The CLI is the best way to create and manage SaaS connectors within your tenant. For more information about the `connectors` command, refer to the CLI [Connectors guide](/idn/tools/cli/connectors).
|
||||||
- `search`: Run this command to access IDN search functionality within the CLI. For more information about the `search` command, refer to the CLI [Search guide](/idn/tools/cli/search). For more information about search in IDN, refer to [Search](/idn/api/v3/search).
|
- `search`: Run this command to access IDN search functionality within the CLI. For more information about the `search` command, refer to the CLI [Search guide](/idn/tools/cli/search).
|
||||||
- `set`: Run this command to configure your CLI settings. For more information about the `set` command, refer to the CLI [Set guide](/idn/tools/cli/set)
|
- `set`: Run this command to configure your CLI settings. For more information about the `set` command, refer to the CLI [Set guide](/idn/tools/cli/set).
|
||||||
- `spconfig`: Run this command to access IDN SP Config functionaly. For more information about the `spconfig` command, refer to the CLI [SPConfig guide](/idn/tools/cli/spconfig). For more information about SPConfig, refer to the [SPConfig Beta API documentation](/idn/api/beta/sp-config).
|
- `spconfig`: Run this command to access IDN SP Config functionality. For more information about the `spconfig` command, refer to the CLI [SPConfig guide](/idn/tools/cli/spconfig).
|
||||||
- `transform`: This command is a CLI interface that makes it easy to create, manage, and test transforms. For more information about the `transform` command, refer to the CLI [Transforms guide](/idn/tools/cli/transforms). For more information about transforms, refer to [Transforms](/idn/docs/transforms).
|
- `transform`: This command is a CLI interface that makes it easy to create, manage, and test transforms. For more information about the `transform` command, refer to the CLI [Transforms guide](/idn/tools/cli/transforms).
|
||||||
|
- `va`: Run this command to access VAs connected to your tenant. For more information about the `va` command, refer to the CLI [VA guide](/idn/tools/cli/va).
|
||||||
|
|
||||||
## GitHub
|
## GitHub
|
||||||
|
|
||||||
|
|||||||
109
products/idn/tools/cli/va.md
Normal file
109
products/idn/tools/cli/va.md
Normal file
@@ -0,0 +1,109 @@
|
|||||||
|
---
|
||||||
|
id: cli-va
|
||||||
|
title: VA
|
||||||
|
pagination_label: CLI VA
|
||||||
|
sidebar_label: VA
|
||||||
|
sidebar_position: 7
|
||||||
|
sidebar_class_name: cli-va
|
||||||
|
keywords: ['cli', 'va']
|
||||||
|
description: Learn about the CLI commands you can use to interact with VAs in this guide.
|
||||||
|
slug: /tools/cli/va
|
||||||
|
tags: ['CLI']
|
||||||
|
---
|
||||||
|
# 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](https://community.sailpoint.com/t5/IdentityNow-Connectors/Virtual-Appliance-Reference-Guide/ta-p/74641?_ga=2.265747530.43742715.1681135659-1245631791.1680185785&_gl=1*1bevvkq*_ga*MTI0NTYzMTc5MS4xNjgwMTg1Nzg1*_ga_SS72Z4HXJM*MTY4MTMwOTc1MC4yOS4xLjE2ODEzMDk5MzkuMjguMC4w).
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
To use the CLI to interact with VAs connected to your tenant, run these commands:
|
||||||
|
- [Collect]
|
||||||
|
- [Flags]
|
||||||
|
- [Example]
|
||||||
|
- [Parse]
|
||||||
|
- [Flags]
|
||||||
|
- [Example]
|
||||||
|
- [Update]
|
||||||
|
- [Flags]
|
||||||
|
|
||||||
|
### Collect
|
||||||
|
|
||||||
|
To collect all files from a VA, run this command:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
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:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
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:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
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:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
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:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
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.
|
||||||
|
|
||||||
Reference in New Issue
Block a user