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/multi-clouds-metadata/multi-cloud-metadata/get.txt

@@ -0,0 +1,96 @@
+"get"
+*****
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Gets information about multicloud base compartment
+
+
+Usage
+=====
+
+   oci multicloud multi-clouds-metadata multi-cloud-metadata get [OPTIONS]
+
+
+Required Parameters
+===================
+
+--compartment-id, -c [text]
+
+The OCID of the compartment in which to list resources.
+
+--subscription-id [text]
+
+The OCID of the OCI subscription.
+
+
+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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/multicloud/multi-clouds-metadata/multi-cloud-metadata/get.html#cmdoption-compartment-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/multi-clouds-metadata/multi-cloud-metadata/get.html#cmdoption-subscription-id
+
+       oci multicloud multi-clouds-metadata multi-cloud-metadata get --compartment-id $compartment_id --subscription-id $subscription_id

oci_cli/help_text_producer/data_files/text/cmdref/multicloud/multi-clouds-metadata/multi-cloud-metadata-collection/list-multi-cloud-metadata.txt

@@ -0,0 +1,133 @@
+"list-multi-cloud-metadata"
+***************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Gets a list of multicloud metadata with multicloud base compartment
+and subscription across Cloud Service Providers.
+
+
+Usage
+=====
+
+   oci multicloud multi-clouds-metadata multi-cloud-metadata-collection list-multi-cloud-metadata [OPTIONS]
+
+
+Required Parameters
+===================
+
+--compartment-id, -c [text]
+
+The OCID of the compartment in which to list resources.
+
+
+Optional Parameters
+===================
+
+--all
+
+Fetches all pages of results. If you provide this option, then you
+cannot provide the "--limit" option.
+
+--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
+
+--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.
+
+--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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/multicloud/multi-clouds-metadata/multi-cloud-metadata-collection/list-multi-cloud-metadata.html#cmdoption-compartment-id
+
+       oci multicloud multi-clouds-metadata multi-cloud-metadata-collection list-multi-cloud-metadata --compartment-id $compartment_id

oci_cli/help_text_producer/data_files/text/cmdref/multicloud/multi-clouds-metadata/multi-cloud-metadata-collection.txt

@@ -0,0 +1,14 @@
+multi-cloud-metadata-collection
+*******************************
+
+
+Description
+===========
+
+Multicloud metadata information across clouds.
+
+
+Available Commands
+==================
+
+* list-multi-cloud-metadata

oci_cli/help_text_producer/data_files/text/cmdref/multicloud/multi-clouds-metadata/multi-cloud-metadata.txt

@@ -0,0 +1,15 @@
+multi-cloud-metadata
+********************
+
+
+Description
+===========
+
+Multicloud metadata information including base multicloud compartments
+information.
+
+
+Available Commands
+==================
+
+* get

oci_cli/help_text_producer/data_files/text/cmdref/multicloud/multi-clouds-metadata.txt

@@ -0,0 +1,22 @@
+multi-clouds-metadata
+*********************
+
+
+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
+==================
+
+* multi-cloud-metadata
+
+  * get
+
+* multi-cloud-metadata-collection
+
+  * list-multi-cloud-metadata

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

@@ -0,0 +1,111 @@
+"get"
+*****
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Gets information about a NetworkAnchor.
+
+
+Usage
+=====
+
+   oci multicloud omhub-network-anchor network-anchor get [OPTIONS]
+
+
+Required Parameters
+===================
+
+--network-anchor-id [text]
+
+The OCID of the NetworkAnchor.
+
+--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
+===================
+
+--external-location [text]
+
+OMHub Control Plane must know underlying CSP CP Region External
+Location Name.
+
+--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 network_anchor_id=<substitute-value-of-network_anchor_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/multicloud/omhub-network-anchor/network-anchor/get.html#cmdoption-network-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-network-anchor/network-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-network-anchor/network-anchor/get.html#cmdoption-subscription-service-name
+
+       oci multicloud omhub-network-anchor network-anchor get --network-anchor-id $network_anchor_id --subscription-id $subscription_id --subscription-service-name $subscription_service_name

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

@@ -0,0 +1,180 @@
+"list-network-anchors"
+**********************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Gets a list of NetworkAnchors.
+
+
+Usage
+=====
+
+   oci multicloud omhub-network-anchor network-anchor-collection list-network-anchors [OPTIONS]
+
+
+Required Parameters
+===================
+
+--external-location [text]
+
+OMHub Control Plane must know underlying CSP CP Region External
+Location Name.
+
+--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 NetworkAnchor.
+
+--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.
+
+--network-anchor-oci-subnet-id [text]
+
+A filter to return only NetworkAnchor resources that match the given
+OCI subnet Id.
+
+--network-anchor-oci-vcn-id [text]
+
+A filter to return only NetworkAnchor resources that match the given
+OCI Vcn Id.
+
+--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 external_location=<substitute-value-of-external_location> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/multicloud/omhub-network-anchor/network-anchor-collection/list-network-anchors.html#cmdoption-external-location
+       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-network-anchor/network-anchor-collection/list-network-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-network-anchor/network-anchor-collection/list-network-anchors.html#cmdoption-subscription-service-name
+
+       oci multicloud omhub-network-anchor network-anchor-collection list-network-anchors --external-location $external_location --subscription-id $subscription_id --subscription-service-name $subscription_service_name

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

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

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

@@ -0,0 +1,19 @@
+network-anchor
+**************
+
+
+Description
+===========
+
+A NetworkAnchor is a description of a NetworkAnchor.
+
+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-network-anchor.txt

@@ -0,0 +1,22 @@
+omhub-network-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
+==================
+
+* network-anchor
+
+  * get
+
+* network-anchor-collection
+
+  * list-network-anchors