oci-cli 3.63.2__py3-none-any.whl → 3.64.0__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/multicloud/omhub-resource-anchor/resource-anchor/get.txt

@@ -0,0 +1,106 @@
+"get"
+*****
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Gets information about a ResourceAnchor.
+
+
+Usage
+=====
+
+   oci multicloud omhub-resource-anchor resource-anchor get [OPTIONS]
+
+
+Required Parameters
+===================
+
+--resource-anchor-id [text]
+
+The OCID of the ResourceAnchor.
+
+--subscription-id [text]
+
+The OCID of the subscription in which to list resources.
+
+--subscription-service-name [text]
+
+The subscription service name values from [ORACLEDBATAZURE,
+ORACLEDBATGOOGLE, ORACLEDBATAWS]
+
+Accepted values are:
+
+   ORACLEDBATAWS, ORACLEDBATAZURE, ORACLEDBATGOOGLE
+
+
+Optional Parameters
+===================
+
+--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
+
+
+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 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 resource_anchor_id=<substitute-value-of-resource_anchor_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/multicloud/omhub-resource-anchor/resource-anchor/get.html#cmdoption-resource-anchor-id
+       export subscription_id=<substitute-value-of-subscription_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/multicloud/omhub-resource-anchor/resource-anchor/get.html#cmdoption-subscription-id
+       export subscription_service_name=<substitute-value-of-subscription_service_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/multicloud/omhub-resource-anchor/resource-anchor/get.html#cmdoption-subscription-service-name
+
+       oci multicloud omhub-resource-anchor resource-anchor get --resource-anchor-id $resource_anchor_id --subscription-id $subscription_id --subscription-service-name $subscription_service_name

oci_cli/help_text_producer/data_files/text/cmdref/multicloud/omhub-resource-anchor/resource-anchor-collection/list-resource-anchors.txt

@@ -0,0 +1,172 @@
+"list-resource-anchors"
+***********************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Gets a list of ResourceAnchors.
+
+
+Usage
+=====
+
+   oci multicloud omhub-resource-anchor resource-anchor-collection list-resource-anchors [OPTIONS]
+
+
+Required Parameters
+===================
+
+--subscription-id [text]
+
+The OCID of the subscription in which to list resources.
+
+--subscription-service-name [text]
+
+The subscription service name values from [ORACLEDBATAZURE,
+ORACLEDBATGOOGLE, ORACLEDBATAWS]
+
+Accepted values are:
+
+   ORACLEDBATAWS, ORACLEDBATAZURE, ORACLEDBATGOOGLE
+
+
+Optional Parameters
+===================
+
+--all
+
+Fetches all pages of results. If you provide this option, then you
+cannot provide the "--limit" option.
+
+--compartment-id, -c [text]
+
+The OCID of the compartment in which to list resources.
+
+--display-name [text]
+
+A filter to return only resources that match the given display name
+exactly.
+
+--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
+
+--id [text]
+
+The OCID of the ResourceAnchor.
+
+--is-compartment-id-in-subtree [boolean]
+
+Check the sub-compartments of a given compartmentId
+
+--lifecycle-state [text]
+
+A filter to return only resources that match the given lifecycle
+state. The state value is case-insensitive.
+
+Accepted values are:
+
+   ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING
+
+--limit [integer]
+
+For list pagination. The maximum number of results per page, or items
+to return in a paginated “List” call. For important details about how
+pagination works, see List Pagination.
+
+--linked-compartment-id [text]
+
+The OCID of the compartment in which linked to Resource.
+
+--page [text]
+
+For list pagination. The value of the opc-next-page response header
+from the previous “List” call. For important details about how
+pagination works, see List Pagination.
+
+--page-size [integer]
+
+When fetching results, the number of results to fetch per call. Only
+valid when used with "--all" or "--limit", and ignored otherwise.
+
+--sort-by [text]
+
+The field to sort by. You can provide only one sort order. Default
+order for *timeCreated* is descending. Default order for *displayName*
+is ascending.
+
+Accepted values are:
+
+   displayName, timeCreated
+
+--sort-order [text]
+
+The sort order to use, either ascending (*ASC*) or descending
+(*DESC*).
+
+Accepted values are:
+
+   ASC, DESC
+
+
+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 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 subscription_id=<substitute-value-of-subscription_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/multicloud/omhub-resource-anchor/resource-anchor-collection/list-resource-anchors.html#cmdoption-subscription-id
+       export subscription_service_name=<substitute-value-of-subscription_service_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/multicloud/omhub-resource-anchor/resource-anchor-collection/list-resource-anchors.html#cmdoption-subscription-service-name
+
+       oci multicloud omhub-resource-anchor resource-anchor-collection list-resource-anchors --subscription-id $subscription_id --subscription-service-name $subscription_service_name

oci_cli/help_text_producer/data_files/text/cmdref/multicloud/omhub-resource-anchor/resource-anchor-collection.txt

@@ -0,0 +1,15 @@
+resource-anchor-collection
+**************************
+
+
+Description
+===========
+
+Results of a resourceAnchor search. Contains both
+ResourceAnchorSummary items and other information, such as metadata.
+
+
+Available Commands
+==================
+
+* list-resource-anchors

oci_cli/help_text_producer/data_files/text/cmdref/multicloud/omhub-resource-anchor/resource-anchor.txt

@@ -0,0 +1,19 @@
+resource-anchor
+***************
+
+
+Description
+===========
+
+A ResourceAnchor is a description of a ResourceAnchor.
+
+To use any of the API operations, you must be authorized in an IAM
+policy. If you’re not authorized, talk to an administrator. If you’re
+an administrator who needs to write policies to give users access, see
+Getting Started with Policies.
+
+
+Available Commands
+==================
+
+* get

oci_cli/help_text_producer/data_files/text/cmdref/multicloud/omhub-resource-anchor.txt

@@ -0,0 +1,22 @@
+omhub-resource-anchor
+*********************
+
+
+Description
+===========
+
+Use the Oracle Multicloud CLI to retrieve resource anchors and network
+anchors, and the metadata mappings related a Cloud Service Provider.
+For more information, see <link to docs>.
+
+
+Available Commands
+==================
+
+* resource-anchor
+
+  * get
+
+* resource-anchor-collection
+
+  * list-resource-anchors

oci_cli/help_text_producer/data_files/text/cmdref/multicloud.txt

@@ -0,0 +1,58 @@
+multicloud
+**********
+
+
+Description
+===========
+
+Use the Oracle Multicloud CLI to retrieve resource anchors and network
+anchors, and the metadata mappings related a Cloud Service Provider.
+For more information, see <link to docs>.
+
+
+Available Commands
+==================
+
+* metadata
+
+  * external-location-mapping-metadatum-summary-collection
+
+    * list-external-location-mapping-metadata
+
+  * external-location-summaries-metadatum-summary-collection
+
+    * list-external-location-summaries-metadata
+
+  * external-locations-metadatum-collection
+
+    * list-external-location-details-metadata
+
+* multi-clouds-metadata
+
+  * multi-cloud-metadata
+
+    * get
+
+  * multi-cloud-metadata-collection
+
+    * list-multi-cloud-metadata
+
+* omhub-network-anchor
+
+  * network-anchor
+
+    * get
+
+  * network-anchor-collection
+
+    * list-network-anchors
+
+* omhub-resource-anchor
+
+  * resource-anchor
+
+    * get
+
+  * resource-anchor-collection
+
+    * list-resource-anchors

oci_cli/help_text_producer/data_files/text/cmdref/network/drg-route-distribution/create.txt

@@ -36,8 +36,8 @@ Required Parameters
 
 --distribution-type [text]
 
-Whether this distribution defines how routes get imported into route
-tables or exported through DRG attachments.
+States that this distribution defines how routes get imported into
+route tables.
 
 Accepted values are:
 

oci_cli/help_text_producer/data_files/text/cmdref/network/drg-route-distribution.txt

@@ -9,9 +9,9 @@ A route distribution establishes how routes get imported into DRG
 route tables and exported through the DRG attachments.
 
 A route distribution is a list of statements. Each statement consists
-of a set of matches, all of which must be *True* in order for the
-statement’s action to take place. Each statement determines which
-routes are propagated.
+of a set of matches, all of which must be *True* for the statement’s
+action to take place. Each statement determines which routes are
+propagated.
 
 You can assign a route distribution as a route table’s import
 distribution. The statements in an import route distribution specify
@@ -20,13 +20,15 @@ or all attachments of a certain type are inserted into the route
 table.
 
 You can assign a route distribution as a DRG attachment’s export
-distribution unless the attachment has the type VCN. Exporting routes
-through a VCN attachment is unsupported. Export route distribution
-statements specify how routes in a DRG attachment’s assigned table are
-advertised out through the attachment. When a DRG is created, a route
-distribution is created with a single ACCEPT statement with match
-criteria MATCH_ALL. By default, all DRG attachments (except for those
-of type VCN), are assigned this distribution.
+distribution unless the attachment has the type *VCN*. Exporting
+routes through a VCN attachment is unsupported. Export route
+distribution statements specify how routes in a DRG attachment’s
+assigned table are advertised out through the attachment. When a DRG
+is created, a route distribution is created with a single ACCEPT
+statement with match criteria MATCH_ALL. By default, all DRG
+attachments (except for those of type VCN), are assigned this
+distribution. You can’t create a new export route distribution, one is
+created for you when the DRG is created.
 
    The two auto-generated DRG route tables (one as the default for VCN
    attachments, and the other for all other types of attachments) are

oci_cli/help_text_producer/data_files/text/cmdref/network/ip-sec-connection/create.txt

@@ -71,16 +71,6 @@ The OCID of the Cpe object.
 
 The OCID of the DRG.
 
---static-routes [complex type]
-
-Static routes to the CPE. At least one route must be included. The
-CIDR must not be a multicast address or class E address. This must be
-provided in JSON format.
-
-Example:
-
-   '["10.0.0.0/16"]'
-
 
 Optional Parameters
 ===================
@@ -180,6 +170,16 @@ nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
 The maximum time to wait for the resource to reach the lifecycle state
 defined by "--wait-for-state". Defaults to 1200 seconds.
 
+--static-routes [complex type]
+
+Static routes to the CPE. At least one route must be included. The
+CIDR must not be a multicast address or class E address. This must be
+provided in JSON format.
+
+Example:
+
+   '["10.0.0.0/16"]'
+
 --tunnel-configuration [complex type]
 
 Information for creating the individual tunnels in the IPSec
@@ -239,11 +239,6 @@ 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 network ip-sec-connection create --generate-param-json-input static-routes > static-routes.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.
@@ -259,4 +254,4 @@ security policies before trying the examples.
 
        drg_id=$(oci network drg create --compartment-id $compartment_id --query data.id --raw-output)
 
-       oci network ip-sec-connection create --compartment-id $compartment_id --cpe-id $cpe_id --drg-id $drg_id --static-routes file://static-routes.json
+       oci network ip-sec-connection create --compartment-id $compartment_id --cpe-id $cpe_id --drg-id $drg_id

oci_cli/help_text_producer/data_files/text/cmdref/ocvs/work-request-error/{list-errors.txt → list.txt}

@@ -1,5 +1,5 @@
-"list-errors"
-*************
+"list"
+******
 
 * Description
 
@@ -23,7 +23,7 @@ Lists the errors for the specified work request.
 Usage
 =====
 
-   oci ocvs work-request-error list-errors [OPTIONS]
+   oci ocvs work-request-error list [OPTIONS]
 
 
 Required Parameters
@@ -108,6 +108,6 @@ 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 work_request_id=<substitute-value-of-work_request_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/work-request-error/list-errors.html#cmdoption-work-request-id
+       export work_request_id=<substitute-value-of-work_request_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/work-request-error/list.html#cmdoption-work-request-id
 
-       oci ocvs work-request-error list-errors --work-request-id $work_request_id
+       oci ocvs work-request-error list --work-request-id $work_request_id

oci_cli/help_text_producer/data_files/text/cmdref/ocvs/work-request-error.txt

@@ -12,4 +12,4 @@ work request.
 Available Commands
 ==================
 
-* list-errors
+* list

oci_cli/help_text_producer/data_files/text/cmdref/ocvs.txt

@@ -80,7 +80,7 @@ Available Commands
 
 * work-request-error
 
-  * list-errors
+  * list
 
 * work-request-log
 

oci_cli/help_text_producer/data_files/text/cmdref/organizations/work-request-error/{list-errors.txt → list.txt}

@@ -1,5 +1,5 @@
-"list-errors"
-*************
+"list"
+******
 
 * Description
 
@@ -23,7 +23,7 @@ Return a (paginated) list of errors for a given work request.
 Usage
 =====
 
-   oci organizations work-request-error list-errors [OPTIONS]
+   oci organizations work-request-error list [OPTIONS]
 
 
 Required Parameters
@@ -113,6 +113,6 @@ 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 work_request_id=<substitute-value-of-work_request_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/organizations/work-request-error/list-errors.html#cmdoption-work-request-id
+       export work_request_id=<substitute-value-of-work_request_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/organizations/work-request-error/list.html#cmdoption-work-request-id
 
-       oci organizations work-request-error list-errors --work-request-id $work_request_id
+       oci organizations work-request-error list --work-request-id $work_request_id

oci_cli/help_text_producer/data_files/text/cmdref/organizations/work-request-error.txt

@@ -11,4 +11,4 @@ An error encountered while executing a work request.
 Available Commands
 ==================
 
-* list-errors
+* list

oci_cli/help_text_producer/data_files/text/cmdref/organizations/{work-request-log → work-request-log-entry}/list.txt

@@ -11,8 +11,6 @@
 
 * Global Parameters
 
-* Example using required parameter
-
 
 Description
 ===========
@@ -23,7 +21,7 @@ Return a (paginated) list of logs for a given work request.
 Usage
 =====
 
-   oci organizations work-request-log list [OPTIONS]
+   oci organizations work-request-log-entry list [OPTIONS]
 
 
 Required Parameters
@@ -100,19 +98,3 @@ 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 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 work_request_id=<substitute-value-of-work_request_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/organizations/work-request-log/list.html#cmdoption-work-request-id
-
-       oci organizations work-request-log list --work-request-id $work_request_id

oci_cli/help_text_producer/data_files/text/cmdref/organizations/{work-request-log.txt → work-request-log-entry.txt}

@@ -1,5 +1,5 @@
-work-request-log
-****************
+work-request-log-entry
+**********************
 
 
 Description

oci_cli/help_text_producer/data_files/text/cmdref/organizations.txt

@@ -141,8 +141,8 @@ Available Commands
 
 * work-request-error
 
-  * list-errors
+  * list
 
-* work-request-log
+* work-request-log-entry
 
   * list