From a78726ec899c6bc927c7b103b4da70c791d3427d Mon Sep 17 00:00:00 2001 From: "james.haytko" Date: Mon, 13 Nov 2023 12:37:42 -0600 Subject: [PATCH] More CLI edits --- cmd/cluster/cluster.md | 2 +- cmd/cluster/get.md | 2 +- cmd/cluster/list.md | 2 +- cmd/cluster/logConfig/set.md | 6 ++++-- cmd/report/report.md | 6 +++--- cmd/va/collect.md | 2 +- cmd/va/get.md | 2 +- cmd/va/list.md | 2 +- cmd/va/parse.md | 2 +- cmd/va/troubleshoot.md | 2 +- cmd/va/update.md | 2 +- cmd/va/va.md | 2 +- cmd/workflow/README.md | 0 cmd/workflow/delete.md | 2 +- cmd/workflow/download.md | 2 +- cmd/workflow/get.md | 2 +- cmd/workflow/list.md | 2 +- 17 files changed, 21 insertions(+), 19 deletions(-) delete mode 100644 cmd/workflow/README.md diff --git a/cmd/cluster/cluster.md b/cmd/cluster/cluster.md index 27c2269..ace7372 100644 --- a/cmd/cluster/cluster.md +++ b/cmd/cluster/cluster.md @@ -1,7 +1,7 @@ ==Long== # Cluster -Manage IdentityNow clusters. +Manage IdentityNow VA clusters. ## API Reference: - https://developer.sailpoint.com/idn/api/beta/managed-clusters diff --git a/cmd/cluster/get.md b/cmd/cluster/get.md index bd5b0fd..9b8916e 100644 --- a/cmd/cluster/get.md +++ b/cmd/cluster/get.md @@ -1,7 +1,7 @@ ==Long== # Get -Get a cluster configuration from IdentityNow. +Get a VA cluster's configuration from IdentityNow. ## API References: - https://developer.sailpoint.com/idn/api/beta/get-managed-cluster diff --git a/cmd/cluster/list.md b/cmd/cluster/list.md index d2d8fdd..f2ee426 100644 --- a/cmd/cluster/list.md +++ b/cmd/cluster/list.md @@ -1,7 +1,7 @@ ==Long== # List -List all clusters from IdentityNow. +List all VA clusters from IdentityNow. ## API References: - https://developer.sailpoint.com/idn/api/beta/get-managed-clusters diff --git a/cmd/cluster/logConfig/set.md b/cmd/cluster/logConfig/set.md index 82bb898..deeaf36 100644 --- a/cmd/cluster/logConfig/set.md +++ b/cmd/cluster/logConfig/set.md @@ -1,9 +1,11 @@ ==Long== # Set -Set a VA cluster's log configuration. +Set a VA cluster's log configuration. You can update a cluster's root logging level, the duration of its logging, and the connector logging class. -A list of connectors (can be found here)[https://community.sailpoint.com/t5/IdentityNow-Articles/Enabling-Connector-Logging-in-IdentityNow/ta-p/188107]. +This example command sets the "TRACE" root logging level, a duration of 30 minutes, and a connector logging class of "sailpoint.connector.ADLDAPConnector=TRACE". + +Refer to your respective [connector guide](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) to see which connector logging classes are available. ==== ==Example== diff --git a/cmd/report/report.md b/cmd/report/report.md index c3cf0cf..bce52cd 100644 --- a/cmd/report/report.md +++ b/cmd/report/report.md @@ -1,7 +1,7 @@ ==Long== # Report -Generate a report from IdentityNow +Generate a report from IdentityNow. ## API References: - https://developer.sailpoint.com/idn/api/v3/search @@ -9,12 +9,12 @@ Generate a report from IdentityNow ==== ==Example== -## Selecting a report +## Select a report ```bash sail report ``` -## Running a specific report +## Run a specific report ```bash sail report {report-name} ``` diff --git a/cmd/va/collect.md b/cmd/va/collect.md index 9b30474..94b7d9a 100644 --- a/cmd/va/collect.md +++ b/cmd/va/collect.md @@ -1,7 +1,7 @@ ==Long== # Collect -Collect files from a remote virtual appliance. +Collect files from a remote VA. Files are collected over SFTP. Passwords are provided via the --password (-p) flag or they will be prompted for at runtime. Server addresses can be DNS names or IP addresses, and they're provided as arguments, separated by spaces. diff --git a/cmd/va/get.md b/cmd/va/get.md index 88ac15f..14abc38 100644 --- a/cmd/va/get.md +++ b/cmd/va/get.md @@ -2,7 +2,7 @@ # Get -Get a virtual appliance configuration from IdentityNow. +Get a VA configuration from IdentityNow. ==== diff --git a/cmd/va/list.md b/cmd/va/list.md index 6bf453d..0181878 100644 --- a/cmd/va/list.md +++ b/cmd/va/list.md @@ -2,7 +2,7 @@ # List -List the clusters and virtual appliances in the configured IdentityNow tenant. +List the VAs and VA clusters in the configured IdentityNow tenant. ==== diff --git a/cmd/va/parse.md b/cmd/va/parse.md index 2a82828..b748179 100644 --- a/cmd/va/parse.md +++ b/cmd/va/parse.md @@ -1,7 +1,7 @@ ==Long== # Parse -Parse log files from SailPoint virtual appliances. +Parse log files from SailPoint VAs. ==== ==Example== diff --git a/cmd/va/troubleshoot.md b/cmd/va/troubleshoot.md index e39d2dc..59f9723 100644 --- a/cmd/va/troubleshoot.md +++ b/cmd/va/troubleshoot.md @@ -1,7 +1,7 @@ ==Long== # Troubleshoot -Perform troubleshooting operations against a virtual appliance. +Perform troubleshooting operations against a VA. ==== diff --git a/cmd/va/update.md b/cmd/va/update.md index 5ba5889..b3aacb4 100644 --- a/cmd/va/update.md +++ b/cmd/va/update.md @@ -1,7 +1,7 @@ ==Long== # Update -Update a SailPoint virtual appliance. +Update a SailPoint VA. ==== ==Example== diff --git a/cmd/va/va.md b/cmd/va/va.md index 57276b1..b7c9a1a 100644 --- a/cmd/va/va.md +++ b/cmd/va/va.md @@ -1,7 +1,7 @@ ==Long== # VA -Manage virtual appliances in IdentityNow. +Manage VAs in IdentityNow. ==== diff --git a/cmd/workflow/README.md b/cmd/workflow/README.md deleted file mode 100644 index e69de29..0000000 diff --git a/cmd/workflow/delete.md b/cmd/workflow/delete.md index e067d47..7e76fe6 100644 --- a/cmd/workflow/delete.md +++ b/cmd/workflow/delete.md @@ -1,6 +1,6 @@ ==Long== # Delete -Delete a workflow in IdentityNow. +Delete a workflow in IdentityNow. You can delete multiple workflows at once, and you can delete a set of workflows specified in a file. ## API References: - https://developer.sailpoint.com/idn/api/beta/delete-workflow diff --git a/cmd/workflow/download.md b/cmd/workflow/download.md index d700d89..ba06ffb 100644 --- a/cmd/workflow/download.md +++ b/cmd/workflow/download.md @@ -1,6 +1,6 @@ ==Long== # Download -Downloads all workflows from IdentityNow. +Downloads all workflows from IdentityNow. By default, the downloaded workflows are located in the folder, "workflows". You can specify a folder to download the workflows to, as shown in the example. ## API References: - https://developer.sailpoint.com/idn/api/beta/list-workflows diff --git a/cmd/workflow/get.md b/cmd/workflow/get.md index 1e8299d..cd9e175 100644 --- a/cmd/workflow/get.md +++ b/cmd/workflow/get.md @@ -2,7 +2,7 @@ # Get -Get workflows from IdentityNow. +Get a workflow from IdentityNow by ID. ## API References - https://developer.sailpoint.com/idn/api/beta/get-workflow diff --git a/cmd/workflow/list.md b/cmd/workflow/list.md index ef75a6c..47520a7 100644 --- a/cmd/workflow/list.md +++ b/cmd/workflow/list.md @@ -11,6 +11,6 @@ List workflows from IdentityNow. ==Example== ```bash - sail Workflow list + sail workflow list ``` ==== \ No newline at end of file