oci-cli 3.63.1__py3-none-any.whl → 3.63.3__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/multicloud/metadata/external-location-summaries-metadatum-summary-collection/list-external-location-summaries-metadata.txt

@@ -0,0 +1,162 @@
+"list-external-location-summaries-metadata"
+*******************************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+List externalLocationSummary metadata from OCI Region to the Cloud
+Service Provider region across all regions. examples:   application-
+json: |     [       {           “externalLocation”: {
+“cspRegion”: “East US”           },           “ociRegion”: “us-
+ashburn-1”       },         {           “externalLocation”: {
+“cspRegion”: “East US 2”           },           “ociRegion”: “us-
+ashburn-1”         },         {           “externalLocation”: {
+“cspRegion”: “Germany West Central”           },
+“ociRegion”: “eu-frankfurt-1”,         }       ]
+
+
+Usage
+=====
+
+   oci multicloud metadata external-location-summaries-metadatum-summary-collection list-external-location-summaries-metadata [OPTIONS]
+
+
+Required Parameters
+===================
+
+--compartment-id, -c [text]
+
+The OCID of the compartment 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.
+
+--entity-type [text]
+
+The resource type query (i.e. dbsystem, instance etc.)
+
+Accepted values are:
+
+   dbsystem
+
+--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
+
+--subscription-id [text]
+
+The OCID of the subscription in which to list resources.
+
+
+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/metadata/external-location-summaries-metadatum-summary-collection/list-external-location-summaries-metadata.html#cmdoption-compartment-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/metadata/external-location-summaries-metadatum-summary-collection/list-external-location-summaries-metadata.html#cmdoption-subscription-service-name
+
+       oci multicloud metadata external-location-summaries-metadatum-summary-collection list-external-location-summaries-metadata --compartment-id $compartment_id --subscription-service-name $subscription_service_name

oci_cli/help_text_producer/data_files/text/cmdref/multicloud/metadata/external-location-summaries-metadatum-summary-collection.txt

@@ -0,0 +1,15 @@
+external-location-summaries-metadatum-summary-collection
+********************************************************
+
+
+Description
+===========
+
+External location summary information from OCI primitives to any CSP
+across all regions
+
+
+Available Commands
+==================
+
+* list-external-location-summaries-metadata

oci_cli/help_text_producer/data_files/text/cmdref/multicloud/metadata/external-locations-metadatum-collection/list-external-location-details-metadata.txt

@@ -0,0 +1,216 @@
+"list-external-location-details-metadata"
+*****************************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+List externalLocationDetail metadata from OCI to Cloud  Service
+Provider for regions, Availability Zones, and Cluster Placement Group
+ID. examples:   application-json: |     [       {
+“externalLocation”: {             “cspRegion”: “East US”,
+“cspPhysicalAz”: “az1-xyz”,             “cspPhysicalAzDisplayName”:
+“(US) East US 2”,             “cspLogicalAz”: “az1”,
+“serviceName”: “ORACLEDBATAZURE”,             “cspZoneKeyReferenceId”:
+{               “keyName”: “AzureSubscriptionId or AwsAccountId,
+GcpProjectName”,               “keyValue”: “azure-subscriptionId-1 or
+aws-account-id-1, gcp-project-id-1”             }           },
+“ociPhysicalAd”: “ad1-xyb”,           “ociLogicalAd”: “ad2”,
+“ociRegion”: “us-ashburn-1”,           “cpgId”: “cpg-1”       },
+{           “externalLocation”: {             “cspRegion”: “East US”,
+“cspPhysicalAz”: “az2-abc”,             “cspPhysicalAzDisplayName”:
+“(US) East US 2”,             “cspLogicalAz”: “az2”,
+“serviceName”: “ORACLEDBATAZURE”,             “cspZoneKeyReferenceId”:
+{               “keyName”: “AzureSubscriptionId or AwsAccountId,
+GcpProjectName”,               “keyValue”: “azure-subscriptionId-2 or
+aws-account-id-2, gcp-project-id-2”             }           },
+“ociPhysicalAd”: “ad2-xby”,           “ociLogicalAd”: “ad1”,
+“ociRegion”: “us-ashburn-1”,           “cpgId”: “cpg-2”         },
+{           “externalLocation”: {             “cspRegion”: “East US”,
+“cspPhysicalAz”: “az3-abz”,             “cspPhysicalAzDisplayName”:
+“(US) East US 2”,             “cspLogicalAz”: “az3”,
+“serviceName”: “ORACLEDBATAZURE”,             “cspZoneKeyReferenceId”:
+{               “keyName”: “AzureSubscriptionId or AwsAccountId,
+GcpProjectName”,               “keyValue”: “azure-subscriptionId-3 or
+aws-account-id-3, gcp-project-id-3”             }           },
+“ociPhysicalAd”: “ad3-cde”,           “ociLogicalAd”: “ad3”,
+“ociRegion”: “us-ashburn-1”,           “cpgId”: “cpg-3”         },
+{           “externalLocation”: {             “cspRegion”: “East US
+2”,             “cspPhysicalAz”: “az1-def”,
+“cspPhysicalAzDisplayName”: “(US) East US 2”,
+“cspLogicalAz”: “az1”,             “serviceName”: “ORACLEDBATAZURE”,
+“cspZoneKeyReferenceId”: {               “keyName”:
+“AzureSubscriptionId or AwsAccountId, GcpProjectName”,
+“keyValue”: “azure-subscriptionId-4 or aws-account-id-4, gcp-project-
+id-4”             }           },           “ociPhysicalAd”: “ad1-bce”,
+“ociLogicalAd”: “ad2”,           “ociRegion”: “us-ashburn-1”,
+“cpgId”: “cpg-4”         },         {           “externalLocation”: {
+“cspRegion”: “East US 2”,             “cspPhysicalAz”: “az2-uvw”,
+“cspPhysicalAzDisplayName”: “(US) East US 2”,
+“cspLogicalAz”: “az2”,             “serviceName”: “ORACLEDBATAZURE”,
+“cspZoneKeyReferenceId”: {               “keyName”:
+“AzureSubscriptionId or AwsAccountId, GcpProjectName”,
+“keyValue”: “azure-subscriptionId-3 or aws-account-id-3, gcp-project-
+id-3”             }           },           “ociPhysicalAd”: “ad2-ftc”,
+“ociLogicalAd”: “ad1”,           “ociRegion”: “us-ashburn-1”,
+“cpgId”: “cpg-5”         },         {           “externalLocation”: {
+“cspRegion”: “East US 2”,             “cspPhysicalAz”: “az3-uvw”,
+“cspPhysicalAzDisplayName”: “(US) East US 2”,
+“cspLogicalAz”: “az3”,             “serviceName”: “ORACLEDBATAZURE”,
+“cspZoneKeyReferenceId”: {               “keyName”:
+“AzureSubscriptionId or AwsAccountId, GcpProjectName”,
+“keyValue”: “azure-subscriptionId-3 or aws-account-id-3, gcp-project-
+id-3”             }           },           “ociPhysicalAd”: “ad3-stc”,
+“ociLogicalAd”: “ad3”,           “ociRegion”: “us-ashburn-1”,
+“cpgId”: “cpg-6”         }       ]
+
+
+Usage
+=====
+
+   oci multicloud metadata external-locations-metadatum-collection list-external-location-details-metadata [OPTIONS]
+
+
+Required Parameters
+===================
+
+--compartment-id, -c [text]
+
+The OCID of the compartment in which to list resources.
+
+--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.
+
+--entity-type [text]
+
+The resource type query (i.e. dbsystem, instance etc.)
+
+Accepted values are:
+
+   dbsystem
+
+--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.
+
+--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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/multicloud/metadata/external-locations-metadatum-collection/list-external-location-details-metadata.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/metadata/external-locations-metadatum-collection/list-external-location-details-metadata.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/metadata/external-locations-metadatum-collection/list-external-location-details-metadata.html#cmdoption-subscription-service-name
+
+       oci multicloud metadata external-locations-metadatum-collection list-external-location-details-metadata --compartment-id $compartment_id --subscription-id $subscription_id --subscription-service-name $subscription_service_name

oci_cli/help_text_producer/data_files/text/cmdref/multicloud/metadata/external-locations-metadatum-collection.txt

@@ -0,0 +1,14 @@
+external-locations-metadatum-collection
+***************************************
+
+
+Description
+===========
+
+External location information from OCI primitives to any CSP
+
+
+Available Commands
+==================
+
+* list-external-location-details-metadata

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

@@ -0,0 +1,26 @@
+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
+==================
+
+* 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

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