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

oci_cli/bin/multicloud.psm1

@@ -0,0 +1,53 @@
+function GetOciTopLevelCommand_multicloud() {
+    return 'multicloud'
+}
+
+function GetOciSubcommands_multicloud() {
+    $ociSubcommands = @{
+        'multicloud' = 'metadata multi-clouds-metadata omhub-network-anchor omhub-resource-anchor'
+        'multicloud metadata' = 'external-location-mapping-metadatum-summary-collection external-location-summaries-metadatum-summary-collection external-locations-metadatum-collection'
+        'multicloud metadata external-location-mapping-metadatum-summary-collection' = 'list-external-location-mapping-metadata'
+        'multicloud metadata external-location-summaries-metadatum-summary-collection' = 'list-external-location-summaries-metadata'
+        'multicloud metadata external-locations-metadatum-collection' = 'list-external-location-details-metadata'
+        'multicloud multi-clouds-metadata' = 'multi-cloud-metadata multi-cloud-metadata-collection'
+        'multicloud multi-clouds-metadata multi-cloud-metadata' = 'get'
+        'multicloud multi-clouds-metadata multi-cloud-metadata-collection' = 'list-multi-cloud-metadata'
+        'multicloud omhub-network-anchor' = 'network-anchor network-anchor-collection'
+        'multicloud omhub-network-anchor network-anchor' = 'get'
+        'multicloud omhub-network-anchor network-anchor-collection' = 'list-network-anchors'
+        'multicloud omhub-resource-anchor' = 'resource-anchor resource-anchor-collection'
+        'multicloud omhub-resource-anchor resource-anchor' = 'get'
+        'multicloud omhub-resource-anchor resource-anchor-collection' = 'list-resource-anchors'
+    }
+    return $ociSubcommands
+}
+
+function GetOciCommandsToLongParams_multicloud() {
+    $ociCommandsToLongParams = @{
+        'multicloud metadata external-location-mapping-metadatum-summary-collection list-external-location-mapping-metadata' = 'all compartment-id from-json help limit page page-size sort-by sort-order subscription-id subscription-service-name'
+        'multicloud metadata external-location-summaries-metadatum-summary-collection list-external-location-summaries-metadata' = 'all compartment-id entity-type from-json help limit page page-size sort-by sort-order subscription-id subscription-service-name'
+        'multicloud metadata external-locations-metadatum-collection list-external-location-details-metadata' = 'all compartment-id entity-type from-json help limit linked-compartment-id page page-size sort-by sort-order subscription-id subscription-service-name'
+        'multicloud multi-clouds-metadata multi-cloud-metadata get' = 'compartment-id from-json help subscription-id'
+        'multicloud multi-clouds-metadata multi-cloud-metadata-collection list-multi-cloud-metadata' = 'all compartment-id from-json help limit page page-size sort-by sort-order'
+        'multicloud omhub-network-anchor network-anchor get' = 'external-location from-json help network-anchor-id subscription-id subscription-service-name'
+        'multicloud omhub-network-anchor network-anchor-collection list-network-anchors' = 'all compartment-id display-name external-location from-json help id lifecycle-state limit network-anchor-oci-subnet-id network-anchor-oci-vcn-id page page-size sort-by sort-order subscription-id subscription-service-name'
+        'multicloud omhub-resource-anchor resource-anchor get' = 'from-json help resource-anchor-id subscription-id subscription-service-name'
+        'multicloud omhub-resource-anchor resource-anchor-collection list-resource-anchors' = 'all compartment-id display-name from-json help id is-compartment-id-in-subtree lifecycle-state limit linked-compartment-id page page-size sort-by sort-order subscription-id subscription-service-name'
+    }
+    return $ociCommandsToLongParams
+}
+
+function GetOciCommandsToShortParams_multicloud() {
+    $ociCommandsToShortParams = @{
+        'multicloud metadata external-location-mapping-metadatum-summary-collection list-external-location-mapping-metadata' = '? c h'
+        'multicloud metadata external-location-summaries-metadatum-summary-collection list-external-location-summaries-metadata' = '? c h'
+        'multicloud metadata external-locations-metadatum-collection list-external-location-details-metadata' = '? c h'
+        'multicloud multi-clouds-metadata multi-cloud-metadata get' = '? c h'
+        'multicloud multi-clouds-metadata multi-cloud-metadata-collection list-multi-cloud-metadata' = '? c h'
+        'multicloud omhub-network-anchor network-anchor get' = '? h'
+        'multicloud omhub-network-anchor network-anchor-collection list-network-anchors' = '? c h'
+        'multicloud omhub-resource-anchor resource-anchor get' = '? h'
+        'multicloud omhub-resource-anchor resource-anchor-collection list-resource-anchors' = '? c h'
+    }
+    return $ociCommandsToShortParams
+}

oci_cli/help_text_producer/data_files/text/cmdref/db/database/create-standby-database.txt

@@ -36,6 +36,10 @@ association.
 
 * The password MUST be the same as the primary admin password.
 
+--db-home-id [text]
+
+The OCID of the Database Home.
+
 --source-database-id [text]
 
 The OCID of the source (primary) database for the Data Guard group.
@@ -48,10 +52,95 @@ Optional Parameters
 
 Specifies the *DB_UNIQUE_NAME* of the standby database to be created.
 
+--db-version [text]
+
+A valid Oracle Database version. For a list of supported versions, use
+the ListDbVersions operation.
+
+This cannot be updated in parallel with any of the following:
+licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel,
+adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode,
+permissionLevel, dbWorkload, privateEndpointLabel, nsgIds,
+isRefreshable, dbName, scheduledOperations, dbToolsDetails,
+isLocalDataGuardEnabled, or isFreeTier.
+
+--defined-tags [complex type]
+
+Defined tags for this resource. Each key is predefined and scoped to a
+namespace. For more information, see Resource Tags. This is a complex
+type whose value must be valid JSON. The value can be provided as a
+string on the command line or passed in as a file using the
+file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--freeform-tags [complex type]
+
+Free-form tags for this resource. Each tag is a simple key-value pair
+with no predefined name, type, or namespace. For more information, see
+Resource Tags.
+
+Example:
+
+   {"Department": "Finance"}
+
+This is a complex type whose value must be valid JSON. The value can
+be provided as a string on the command line or passed in as a file
+using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--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
+
 --is-active-data-guard-enabled [boolean]
 
 True if active Data Guard is enabled.
 
+--kms-key-id [text]
+
+The OCID of the key container that is used as the master encryption
+key in database transparent data encryption (TDE) operations.
+
+--kms-key-version-id [text]
+
+The OCID of the key container version that is used in database
+transparent data encryption (TDE) operations KMS Key can have multiple
+key versions. If none is specified, the current key version (latest)
+of the Key Id is used for the operation. Autonomous Database
+Serverless does not use key versions, hence is not applicable for
+Autonomous Database Serverless instances.
+
+--max-wait-seconds [integer]
+
+The maximum time to wait for the resource to reach the lifecycle state
+defined by "--wait-for-state". Defaults to 1200 seconds.
+
 --protection-mode [text]
 
 The protection mode to set up between the primary and standby
@@ -88,6 +177,27 @@ Accepted values are:
 
    ASYNC, SYNC
 
+--wait-for-state [text]
+
+This operation creates, modifies or deletes a resource that has a
+defined lifecycle state. Specify this option to perform the action and
+then wait until the resource reaches a given lifecycle 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:
+
+   AVAILABLE, BACKUP_IN_PROGRESS, CONVERTING, FAILED, PROVISIONING, RESTORE_FAILED, TERMINATED, TERMINATING, UPDATING, UPGRADING
+
+--wait-interval-seconds [integer]
+
+Check every "--wait-interval-seconds" to see whether the resource has
+reached the lifecycle state defined by "--wait-for-state". Defaults to
+30 seconds.
+
 
 Global Parameters
 =================
@@ -115,7 +225,10 @@ 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 db_system_id=<substitute-value-of-db_system_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/db-home/create.html#cmdoption-db-system-id
        export database_admin_password=<substitute-value-of-database_admin_password> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/database/create-standby-database.html#cmdoption-database-admin-password
        export source_database_id=<substitute-value-of-source_database_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/database/create-standby-database.html#cmdoption-source-database-id
 
-       oci db database create-standby-database --database-admin-password $database_admin_password --source-database-id $source_database_id
+       db_home_id=$(oci db db-home create --db-system-id $db_system_id --query data.id --raw-output)
+
+       oci db database create-standby-database --database-admin-password $database_admin_password --db-home-id $db_home_id --source-database-id $source_database_id

oci_cli/help_text_producer/data_files/text/cmdref/email-data-plane/email-raw-submitted-response/submit-raw-email.txt

@@ -0,0 +1,128 @@
+"submit-raw-email"
+******************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Submits a raw email.
+
+
+Usage
+=====
+
+   oci email-data-plane email-raw-submitted-response submit-raw-email [OPTIONS]
+
+
+Required Parameters
+===================
+
+--compartment-id, -c [text]
+
+The OCID of the compartment that contains the approved sender
+resource.
+
+--content-type [text]
+
+The media type of the body.
+
+Accepted values are:
+
+   message/global, message/rfc822
+
+--raw-message [text]
+
+This should be formatted in valid MIME format. Message can include
+attachments. MIME libraries should be used to convert the content into
+the appropriate format.
+
+--recipients [text]
+
+The destination for the email, all recipients including to, cc and bcc
+addresses.
+
+--sender [text]
+
+The envelope and the header from email address, that is sending the
+email. Email address must be an approved sender.
+
+
+Optional Parameters
+===================
+
+--content-length [integer]
+
+The content length of the body.
+
+--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 and paste the following example into a JSON file, replacing the
+example parameters with your own.
+
+       oci email-data-plane email-raw-submitted-response submit-raw-email --generate-param-json-input recipients > recipients.json
+       oci email-data-plane email-raw-submitted-response submit-raw-email --generate-param-json-input sender > sender.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/email-data-plane/email-raw-submitted-response/submit-raw-email.html#cmdoption-compartment-id
+       export content_type=<substitute-value-of-content_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/email-data-plane/email-raw-submitted-response/submit-raw-email.html#cmdoption-content-type
+       export raw_message=<substitute-value-of-raw_message> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/email-data-plane/email-raw-submitted-response/submit-raw-email.html#cmdoption-raw-message
+
+       oci email-data-plane email-raw-submitted-response submit-raw-email --compartment-id $compartment_id --content-type $content_type --raw-message $raw_message --recipients file://recipients.json --sender file://sender.json

oci_cli/help_text_producer/data_files/text/cmdref/email-data-plane/email-raw-submitted-response.txt

@@ -0,0 +1,15 @@
+email-raw-submitted-response
+****************************
+
+
+Description
+===========
+
+Response object that is returned to sender upon successfully
+submitting the email request.
+
+
+Available Commands
+==================
+
+* submit-raw-email

oci_cli/help_text_producer/data_files/text/cmdref/email-data-plane.txt

@@ -13,6 +13,10 @@ Delivery Service.
 Available Commands
 ==================
 
+* email-raw-submitted-response
+
+  * submit-raw-email
+
 * email-submitted-response
 
   * submit-email

oci_cli/help_text_producer/data_files/text/cmdref/governance-rules-control-plane/work-request/{work-request-log-entry/list-logs.txt → work-request-log/list.txt}

@@ -1,5 +1,5 @@
-"list-logs"
-***********
+"list"
+******
 
 * Description
 
@@ -24,7 +24,7 @@ ID.
 Usage
 =====
 
-   oci governance-rules-control-plane work-request work-request-log-entry list-logs [OPTIONS]
+   oci governance-rules-control-plane work-request work-request-log list [OPTIONS]
 
 
 Required Parameters
@@ -124,6 +124,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/governance-rules-control-plane/work-request/work-request-log-entry/list-logs.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/governance-rules-control-plane/work-request/work-request-log/list.html#cmdoption-work-request-id
 
-       oci governance-rules-control-plane work-request work-request-log-entry list-logs --work-request-id $work_request_id
+       oci governance-rules-control-plane work-request work-request-log list --work-request-id $work_request_id

oci_cli/help_text_producer/data_files/text/cmdref/governance-rules-control-plane/work-request.txt

@@ -23,6 +23,6 @@ Available Commands
 
   * list-errors
 
-* work-request-log-entry
+* work-request-log
 
-  * list-logs
+  * list

oci_cli/help_text_producer/data_files/text/cmdref/governance-rules-control-plane.txt

@@ -79,6 +79,6 @@ Available Commands
 
     * list-errors
 
-  * work-request-log-entry
+  * work-request-log
 
-    * list-logs
+    * list

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

@@ -0,0 +1,167 @@
+"list-external-location-mapping-metadata"
+*****************************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+List externalLocation metadata from OCI to the Cloud Service Provider
+for regions, Physical Availability Zones. examples:   application-
+json: |     [       {         “externalLocation”: {
+“cspRegion”: “eastus”,           “cspPhysicalAz”: “eastus-az1”,
+“cspPhysicalAzDisplayName”: “(US) East US 1”,           “serviceName”:
+“ORACLEDBATAZURE”         },         “ociPhysicalAd”: “iad-ad-1”,
+“ociLogicalAd”: “ad1”,         “ociRegion”: “us-ashburn-1”     },
+{         “externalLocation”: {           “cspRegion”: “eastus”,
+“cspPhysicalAz”: “eastus-az1”,           “cspPhysicalAzDisplayName”:
+“(US) East US 1”,           “serviceName”: “ORACLEDBATAZURE”
+},         “ociPhysicalAd”: “iad-ad-1”,         “ociLogicalAd”: “ad1”,
+“ociRegion”: “us-ashburn-1”       },       {
+“externalLocation”: {           “cspRegion”: “eastus2”,
+“cspPhysicalAz”: “eastus2-az3”,           “cspPhysicalAzDisplayName”:
+“(US) East US 1”,           “serviceName”: “ORACLEDBATAZURE”
+},         “ociPhysicalAd”: “iad-ad-2”,         “ociLogicalAd”: “ad1”,
+“ociRegion”: “us-ashburn-1”       },       {
+“externalLocation”: {           “cspRegion”: “eastus”,
+“cspPhysicalAz”: “eastus-az3”           “cspPhysicalAzDisplayName”:
+“(US) East US 1”,           “serviceName”: “ORACLEDBATAZURE”
+},         “ociPhysicalAd”: “iad-ad-333”,         “ociLogicalAd”:
+“ad1”,         “ociRegion”: “us-ashburn-1”       }     ]
+
+
+Usage
+=====
+
+   oci multicloud metadata external-location-mapping-metadatum-summary-collection list-external-location-mapping-metadata [OPTIONS]
+
+
+Required Parameters
+===================
+
+--compartment-id, -c [text]
+
+The OCID of the compartment in which to list resources.
+
+--subscription-service-name [text]
+
+The subscription type 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.
+
+--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-mapping-metadatum-summary-collection/list-external-location-mapping-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-mapping-metadatum-summary-collection/list-external-location-mapping-metadata.html#cmdoption-subscription-service-name
+
+       oci multicloud metadata external-location-mapping-metadatum-summary-collection list-external-location-mapping-metadata --compartment-id $compartment_id --subscription-service-name $subscription_service_name

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

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