oci-cli 3.65.0__py3-none-any.whl → 3.66.0__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/dbmulticloud/oracle-db-gcp-key-ring/update.txt

@@ -0,0 +1,174 @@
+"update"
+********
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Modifies the existing Oracle GCP Key Ring Details for a given OCID.
+
+
+Usage
+=====
+
+   oci dbmulticloud oracle-db-gcp-key-ring update [OPTIONS]
+
+
+Required Parameters
+===================
+
+--oracle-db-gcp-key-ring-id [text]
+
+The OCID of the Oracle DB GCP Key-Ring resource.
+
+
+Optional Parameters
+===================
+
+--defined-tags [complex type]
+
+Defined tags for this resource. Each key is predefined and scoped to a
+namespace. For more information, see Resource Tags.
+
+Example:
+
+   {"Operations": {"CostCenter": "42"}}
+
+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.
+
+--display-name [text]
+
+Display name of DB GCP Key Ring resource.
+
+--force
+
+Perform update without prompting for confirmation.
+
+--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
+
+--if-match [text]
+
+For optimistic concurrency control. In the PUT or DELETE call for a
+resource, set the *if-match* parameter to the value of the etag from a
+previous GET or POST response for that resource. The resource will be
+updated or deleted only if the etag you provide matches the resource’s
+current etag value.
+
+--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, NEEDS_ATTENTION, SUCCEEDED, WAITING
+
+--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 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/dbmulticloud/oracle-db-gcp-key-ring/create.html#cmdoption-compartment-id
+       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dbmulticloud/oracle-db-gcp-key-ring/create.html#cmdoption-display-name
+       export oracle_db_connector_id=<substitute-value-of-oracle_db_connector_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dbmulticloud/oracle-db-gcp-key-ring/create.html#cmdoption-oracle-db-connector-id
+
+       oracle_db_gcp_key_ring_id=$(oci dbmulticloud oracle-db-gcp-key-ring create --compartment-id $compartment_id --display-name $display_name --oracle-db-connector-id $oracle_db_connector_id --query data.id --raw-output)
+
+       oci dbmulticloud oracle-db-gcp-key-ring update --oracle-db-gcp-key-ring-id $oracle_db_gcp_key_ring_id

oci_cli/help_text_producer/data_files/text/cmdref/dbmulticloud/oracle-db-gcp-key-ring.txt

@@ -0,0 +1,26 @@
+oracle-db-gcp-key-ring
+**********************
+
+
+Description
+===========
+
+Oracle DB GCP Key Ring resource object.
+
+
+Available Commands
+==================
+
+* change-compartment
+
+* create
+
+* delete
+
+* get
+
+* list
+
+* refresh
+
+* update

oci_cli/help_text_producer/data_files/text/cmdref/dbmulticloud/oracle-db-gcp-key.txt

@@ -0,0 +1,16 @@
+oracle-db-gcp-key
+*****************
+
+
+Description
+===========
+
+Oracle DB Google Cloud Key resource.
+
+
+Available Commands
+==================
+
+* get
+
+* list

oci_cli/help_text_producer/data_files/text/cmdref/dbmulticloud/work-request.txt

@@ -5,22 +5,67 @@ work-request
 Description
 ===========
 
-1. Oracle Azure Connector Resource: This is for installing Azure Arc
-   Server in ExaCS VM Cluster.
-
-   There are two way to install Azure Arc Server (Azure Identity) in
-   ExaCS VMCluster.
-      1. Using Bearer Access Token or
-
-      2. By providing Authentication token
-
-2. Oracle Azure Blob Container Resource: This is for to capture Azure
-   Container details and same will be used in multiple ExaCS VMCluster
-   to mount the Azure Container.
-
-3. Oracle Azure Blob Mount Resource: This is for to mount Azure
-   Container in ExaCS VMCluster using Oracle Azure Connector and
-   Oracle Azure Blob Container Resource.
+<b>Microsoft Azure:</b> <br> <b>Oracle Azure Connector
+Resource:</b>:&nbsp;&nbsp;The Oracle Azure Connector Resource is used
+to install the Azure Arc Server on an Exadata VM cluster in Oracle
+Exadata Database Service on Dedicated Infrastructure (ExaDB-D).
+
+   The supported method to install the Azure Arc Server (Azure
+   Identity) on the Exadata VM cluster:
+
+<ul>
+   <li>Using a Bearer Access Token</li>
+
+</ul>
+
+<b>Oracle Azure Blob Container Resource:</b>&nbsp;&nbsp;The Oracle
+Azure Blob Container Resource is used to capture the details of an
+Azure Blob Container. This resource can then be reused across multiple
+Exadata VM clusters in Oracle Exadata Database Service on Dedicated
+Infrastructure (ExaDB-D) to mount the Azure container.
+
+<b>Oracle Azure Blob Mount Resource:</b>&nbsp;&nbsp;The Oracle Azure
+Blob Mount Resource is used to mount an Azure Blob Container on an
+Exadata VM cluster in Oracle Exadata Database Service on Dedicated
+Infrastructure (ExaDB-D). It relies on both the Oracle Azure Connector
+and the Oracle Azure Blob Container Resource to perform the mount
+operation.
+
+<b>Discover Azure Vaults and Keys Resource:</b>&nbsp;&nbsp;The
+Discover Oracle Azure Vaults and Azure Keys Resource is used to
+discover Azure Vaults and the associated encryption keys available in
+your Azure project.
+
+<b>Oracle Azure Vault:</b>&nbsp;&nbsp;The Oracle Azure Vault Resource
+is used to manage Azure Vaults within Oracle Cloud Infrastructure
+(OCI) for use with services such as Oracle Exadata Database Service on
+Dedicated Infrastructure.
+
+<b>Oracle Azure Key:</b>&nbsp;&nbsp;Oracle Azure Key Resource is used
+to register and manage a Oracle Azure Key Key within Oracle Cloud
+Infrastructure (OCI) under an associated Azure Vault.
+
+<br>
+
+<b>Google Cloud:</b><br> <b>Oracle Google Cloud Connector
+Resource:</b>&nbsp;&nbsp;The Oracle Google Cloud Connector Resource is
+used to install the Google Cloud Identity Connector on an Exadata VM
+cluster in Oracle Exadata Database Service on Dedicated Infrastructure
+(ExaDB-D).
+
+<b>Discover Google Key Rings and Keys Resource:</b>&nbsp;&nbsp;The
+Discover Google Key Rings and Keys Resource is used to discover Google
+Cloud Key Rings and the associated encryption keys available in your
+Google Cloud project.
+
+<b>Google Key Rings Resource:</b>&nbsp;&nbsp;The Google Key Rings
+Resource is used to register and manage Google Cloud Key Rings within
+Oracle Cloud Infrastructure (OCI) for use with services such as Oracle
+Exadata Database Service on Dedicated Infrastructure.
+
+<b>Google Key Resource:</b>&nbsp;&nbsp;The Google Key Resource is used
+to register and manage a Google Cloud Key within Oracle Cloud
+Infrastructure (OCI) under an associated Google Key Ring.
 
 
 Available Commands

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

@@ -5,22 +5,67 @@ dbmulticloud
 Description
 ===========
 
-1. Oracle Azure Connector Resource: This is for installing Azure Arc
-   Server in ExaCS VM Cluster.
+<b>Microsoft Azure:</b> <br> <b>Oracle Azure Connector
+Resource:</b>:&nbsp;&nbsp;The Oracle Azure Connector Resource is used
+to install the Azure Arc Server on an Exadata VM cluster in Oracle
+Exadata Database Service on Dedicated Infrastructure (ExaDB-D).
 
-   There are two way to install Azure Arc Server (Azure Identity) in
-   ExaCS VMCluster.
-      1. Using Bearer Access Token or
+   The supported method to install the Azure Arc Server (Azure
+   Identity) on the Exadata VM cluster:
 
-      2. By providing Authentication token
+<ul>
+   <li>Using a Bearer Access Token</li>
 
-2. Oracle Azure Blob Container Resource: This is for to capture Azure
-   Container details and same will be used in multiple ExaCS VMCluster
-   to mount the Azure Container.
+</ul>
 
-3. Oracle Azure Blob Mount Resource: This is for to mount Azure
-   Container in ExaCS VMCluster using Oracle Azure Connector and
-   Oracle Azure Blob Container Resource.
+<b>Oracle Azure Blob Container Resource:</b>&nbsp;&nbsp;The Oracle
+Azure Blob Container Resource is used to capture the details of an
+Azure Blob Container. This resource can then be reused across multiple
+Exadata VM clusters in Oracle Exadata Database Service on Dedicated
+Infrastructure (ExaDB-D) to mount the Azure container.
+
+<b>Oracle Azure Blob Mount Resource:</b>&nbsp;&nbsp;The Oracle Azure
+Blob Mount Resource is used to mount an Azure Blob Container on an
+Exadata VM cluster in Oracle Exadata Database Service on Dedicated
+Infrastructure (ExaDB-D). It relies on both the Oracle Azure Connector
+and the Oracle Azure Blob Container Resource to perform the mount
+operation.
+
+<b>Discover Azure Vaults and Keys Resource:</b>&nbsp;&nbsp;The
+Discover Oracle Azure Vaults and Azure Keys Resource is used to
+discover Azure Vaults and the associated encryption keys available in
+your Azure project.
+
+<b>Oracle Azure Vault:</b>&nbsp;&nbsp;The Oracle Azure Vault Resource
+is used to manage Azure Vaults within Oracle Cloud Infrastructure
+(OCI) for use with services such as Oracle Exadata Database Service on
+Dedicated Infrastructure.
+
+<b>Oracle Azure Key:</b>&nbsp;&nbsp;Oracle Azure Key Resource is used
+to register and manage a Oracle Azure Key Key within Oracle Cloud
+Infrastructure (OCI) under an associated Azure Vault.
+
+<br>
+
+<b>Google Cloud:</b><br> <b>Oracle Google Cloud Connector
+Resource:</b>&nbsp;&nbsp;The Oracle Google Cloud Connector Resource is
+used to install the Google Cloud Identity Connector on an Exadata VM
+cluster in Oracle Exadata Database Service on Dedicated Infrastructure
+(ExaDB-D).
+
+<b>Discover Google Key Rings and Keys Resource:</b>&nbsp;&nbsp;The
+Discover Google Key Rings and Keys Resource is used to discover Google
+Cloud Key Rings and the associated encryption keys available in your
+Google Cloud project.
+
+<b>Google Key Rings Resource:</b>&nbsp;&nbsp;The Google Key Rings
+Resource is used to register and manage Google Cloud Key Rings within
+Oracle Cloud Infrastructure (OCI) for use with services such as Oracle
+Exadata Database Service on Dedicated Infrastructure.
+
+<b>Google Key Resource:</b>&nbsp;&nbsp;The Google Key Resource is used
+to register and manage a Google Cloud Key within Oracle Cloud
+Infrastructure (OCI) under an associated Google Key Ring.
 
 
 Available Commands
@@ -122,6 +167,44 @@ Available Commands
 
   * update
 
+* oracle-db-gcp-identity-connector
+
+  * change-compartment
+
+  * create
+
+  * delete
+
+  * get
+
+  * list
+
+  * refresh
+
+  * update
+
+* oracle-db-gcp-key
+
+  * get
+
+  * list
+
+* oracle-db-gcp-key-ring
+
+  * change-compartment
+
+  * create
+
+  * delete
+
+  * get
+
+  * list
+
+  * refresh
+
+  * update
+
 * work-request
 
   * cancel

oci_cli/help_text_producer/data_files/text/cmdref/delegate-access-control/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 delegate-access-control work-request work-request-log-entry list-logs [OPTIONS]
+   oci delegate-access-control work-request work-request-log list [OPTIONS]
 
 
 Required Parameters
@@ -123,6 +123,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/delegate-access-control/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/delegate-access-control/work-request/work-request-log/list.html#cmdoption-work-request-id
 
-       oci delegate-access-control work-request work-request-log-entry list-logs --work-request-id $work_request_id
+       oci delegate-access-control work-request work-request-log list --work-request-id $work_request_id

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

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

oci_cli/help_text_producer/data_files/text/cmdref/delegate-access-control/work-request.txt

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

oci_cli/help_text_producer/data_files/text/cmdref/delegate-access-control.txt

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

oci_cli/help_text_producer/data_files/text/cmdref/email/domain/add.txt

@@ -0,0 +1,148 @@
+"add"
+*****
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Adds a lock to a resource.
+
+
+Usage
+=====
+
+   oci email domain add [OPTIONS]
+
+
+Required Parameters
+===================
+
+--email-domain-id [text]
+
+The OCID of this email domain.
+
+--type [text]
+
+Lock type.
+
+Accepted values are:
+
+   DELETE, FULL
+
+
+Optional Parameters
+===================
+
+--compartment-id, -c [text]
+
+The lock compartment ID.
+
+--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
+
+--if-match [text]
+
+Used for optimistic concurrency control. In the update or delete call
+for a resource, set the *if-match* parameter to the value of the etag
+from a previous get, create, or update response for that resource.
+The resource will be updated or deleted only if the etag you provide
+matches the resource’s current etag value.
+
+--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.
+
+--message [text]
+
+A message added by the lock creator. The message typically gives an
+indication of why the resource is locked.
+
+--related-resource-id [text]
+
+The resource ID that is locking this resource. Indicates that deleting
+this resource removes the lock.
+
+--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:
+
+   ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING
+
+--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
+=================
+
+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 email_domain_id=<substitute-value-of-email_domain_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/email/domain/add.html#cmdoption-email-domain-id
+       export type=<substitute-value-of-type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/email/domain/add.html#cmdoption-type
+
+       oci email domain add --email-domain-id $email_domain_id --type $type

oci_cli/help_text_producer/data_files/text/cmdref/email/domain/change-compartment.txt

@@ -77,6 +77,10 @@ from a previous get, create, or update response for that resource.
 The resource will be updated or deleted only if the etag you provide
 matches the resource’s current etag value.
 
+--is-lock-override [boolean]
+
+Whether to override locks (if any exist).
+
 --max-wait-seconds [integer]
 
 The maximum time to wait for the work request to reach the state

oci_cli/help_text_producer/data_files/text/cmdref/email/domain/delete.txt

@@ -71,6 +71,10 @@ from a previous get, create, or update response for that resource.
 The resource will be updated or deleted only if the etag you provide
 matches the resource’s current etag value.
 
+--is-lock-override [boolean]
+
+Whether to override locks (if any exist).
+
 --max-wait-seconds [integer]
 
 The maximum time to wait for the work request to reach the state