"get-path-analysis-persisted"
*****************************

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Example using required parameter


Description
===========

Use this method to initiate a Network Path Analyzer analysis. This
method returns an opc-work-request-id, and you can poll the status of
the work request until it either fails or succeeds.

If the work request status is successful, use ListWorkRequestResults
with the work request ID to ask for the successful analysis results.
If the work request status is failed, use ListWorkRequestErrors with
the work request ID to ask for the analysis failure information. The
information returned from either of these methods can be used to build
a final report.


Usage
=====

   oci vn-monitoring path-analysis get-path-analysis-persisted [OPTIONS]


Required Parameters
===================

--path-analyzer-test-id [text]

The OCID of the *PathAnalyzerTest* resource.


Optional Parameters
===================

--cache-control [text]

The Cache-Control HTTP header holds directives (instructions) for
caching in both requests and responses.

--from-json [text]

Provide input to this command as a JSON document from a file using the
file://path-to/file syntax.

The "--generate-full-command-json-input" option can be used to
generate a sample json file to be used with this command option. The
key names are pre-populated and match the command option names
(converted to camelCase format, e.g. compartment-id –> compartmentId),
while the values of the keys need to be populated by the user before
using the sample file as an input to this command. For any command
option that accepts multiple values, the value of the key can be a
JSON array.

Options can still be provided on the command line. If an option exists
in both the JSON document and the command line then the command line
specified value will be used.

For examples on usage of this option, please see our “using CLI with
advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--max-wait-seconds [integer]

The maximum time to wait for the work request to reach the state
defined by "--wait-for-state". Defaults to 1200 seconds.

--wait-for-state [text]

This operation asynchronously creates, modifies or deletes a resource
and uses a work request to track the progress of the operation.
Specify this option to perform the action and then wait until the work
request reaches a certain state. Multiple states can be specified,
returning on the first state. For example, "--wait-for-state"
SUCCEEDED "--wait-for-state" FAILED would return on whichever
lifecycle state is reached first. If timeout is reached, a return code
of 2 is returned. For any other error, a return code of 1 is returned.

Accepted values are:

   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, SUCCEEDED

--wait-interval-seconds [integer]

Check every "--wait-interval-seconds" to see whether the work request
has reached the state defined by "--wait-for-state". Defaults to 30
seconds.


Global Parameters
=================

Use "oci --help" for help on global parameters.

"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
defaults-file", "--endpoint", "--generate-full-command-json-input", "
--generate-param-json-input", "--help", "--latest-version", "--max-
retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
"--output", "--profile", "--proxy", "--query", "--raw-output", "--
read-timeout", "--realm-specific-endpoint", "--region", "--release-
info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"


Example using required parameter
================================

Copy and paste the following example into a JSON file, replacing the
example parameters with your own.

       oci vn-monitoring path-analyzer-test create --generate-param-json-input destination-endpoint > destination-endpoint.json
       oci vn-monitoring path-analyzer-test create --generate-param-json-input source-endpoint > source-endpoint.json

Copy the following CLI commands into a file named example.sh. Run the
command by typing “bash example.sh” and replacing the example
parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-
like shell. You need to set up the OCI configuration and appropriate
security policies before trying the examples.

       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/vn-monitoring/path-analyzer-test/create.html#cmdoption-compartment-id
       export protocol=<substitute-value-of-protocol> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/vn-monitoring/path-analyzer-test/create.html#cmdoption-protocol

       path_analyzer_test_id=$(oci vn-monitoring path-analyzer-test create --compartment-id $compartment_id --destination-endpoint file://destination-endpoint.json --protocol $protocol --source-endpoint file://source-endpoint.json --query data.id --raw-output)

       oci vn-monitoring path-analysis get-path-analysis-persisted --path-analyzer-test-id $path_analyzer_test_id
