oci-cli 3.68.1__py3-none-any.whl → 3.69.0__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/dbtools/identity/update-oracle-database-resource-principal.txt

@@ -0,0 +1,164 @@
+"update-oracle-database-resource-principal"
+*******************************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Updates the specified Database Tools identity.
+
+
+Usage
+=====
+
+   oci dbtools identity update-oracle-database-resource-principal [OPTIONS]
+
+
+Required Parameters
+===================
+
+--identity-id [text]
+
+The OCID of a Database Tools identity.
+
+
+Optional Parameters
+===================
+
+--defined-tags [complex type]
+
+Defined tags for this resource. Each key is predefined and scoped to a
+namespace. Example: *{“foo-namespace”: {“bar-key”: “value”}}* 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]
+
+A user-friendly name. Does not have to be unique, and it’s changeable.
+Avoid entering confidential information.
+
+--force
+
+Perform update without prompting for confirmation.
+
+--freeform-tags [complex type]
+
+Simple key-value pair that is applied without any predefined name,
+type or scope. Exists for cross-compatibility only. Example: *{“bar-
+key”: “value”}* 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.
+
+--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
+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 identity_id=<substitute-value-of-identity_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dbtools/identity/update-oracle-database-resource-principal.html#cmdoption-identity-id
+
+       oci dbtools identity update-oracle-database-resource-principal --identity-id $identity_id

oci_cli/help_text_producer/data_files/text/cmdref/dbtools/identity/validate-oracle-database-resource-principal-credential.txt

@@ -0,0 +1,101 @@
+"validate-oracle-database-resource-principal-credential"
+********************************************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Validates the Database Tools identity credentials by establishing a
+connection to the customer database and executing the
+dbms_cloud.send_request to validate the credential.
+
+
+Usage
+=====
+
+   oci dbtools identity validate-oracle-database-resource-principal-credential [OPTIONS]
+
+
+Required Parameters
+===================
+
+--identity-id [text]
+
+The OCID of a Database Tools identity.
+
+
+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
+
+--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.
+
+
+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 identity_id=<substitute-value-of-identity_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dbtools/identity/validate-oracle-database-resource-principal-credential.html#cmdoption-identity-id
+
+       oci dbtools identity validate-oracle-database-resource-principal-credential --identity-id $identity_id

oci_cli/help_text_producer/data_files/text/cmdref/dbtools/identity.txt

@@ -0,0 +1,32 @@
+identity
+********
+
+
+Description
+===========
+
+Manages credentials in a database to access service resources.
+
+
+Available Commands
+==================
+
+* add-lock
+
+* change-compartment
+
+* create-oracle-database-resource-principal
+
+* delete
+
+* get
+
+* list
+
+* refresh-oracle-database-resource-principal-credential
+
+* remove-lock
+
+* update-oracle-database-resource-principal
+
+* validate-oracle-database-resource-principal-credential

oci_cli/help_text_producer/data_files/text/cmdref/dbtools/private-endpoint/add-lock.txt

@@ -17,7 +17,7 @@
 Description
 ===========
 
-Adds a lock to a DatabaseToolsPrivateEndpoint resource.
+Adds a lock to a Database Tools private endpoint resource.
 
 
 Usage

oci_cli/help_text_producer/data_files/text/cmdref/dbtools/private-endpoint/change-compartment.txt

@@ -96,7 +96,7 @@ of 2 is returned. For any other error, a return code of 1 is returned.
 
 Accepted values are:
 
-   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, SUCCEEDED, WAITING
+   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
 
 --wait-interval-seconds [integer]
 

oci_cli/help_text_producer/data_files/text/cmdref/dbtools/private-endpoint/create.txt

@@ -155,7 +155,7 @@ of 2 is returned. For any other error, a return code of 1 is returned.
 
 Accepted values are:
 
-   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, SUCCEEDED, WAITING
+   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
 
 --wait-interval-seconds [integer]
 

oci_cli/help_text_producer/data_files/text/cmdref/dbtools/private-endpoint/delete.txt

@@ -93,7 +93,7 @@ of 2 is returned. For any other error, a return code of 1 is returned.
 
 Accepted values are:
 
-   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, SUCCEEDED, WAITING
+   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
 
 --wait-interval-seconds [integer]
 

oci_cli/help_text_producer/data_files/text/cmdref/dbtools/private-endpoint/list.txt

@@ -31,7 +31,7 @@ Required Parameters
 
 --compartment-id, -c [text]
 
-The ID of the compartment in which to list resources.
+The OCID of the compartment in which to list resources.
 
 
 Optional Parameters

oci_cli/help_text_producer/data_files/text/cmdref/dbtools/private-endpoint/remove-lock.txt

@@ -17,7 +17,7 @@
 Description
 ===========
 
-Removes a lock from a DatabaseToolsPrivateEndpoint resource.
+Removes a lock from a Database Tools private endpoint resource.
 
 
 Usage

oci_cli/help_text_producer/data_files/text/cmdref/dbtools/private-endpoint/update.txt

@@ -141,7 +141,7 @@ of 2 is returned. For any other error, a return code of 1 is returned.
 
 Accepted values are:
 
-   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, SUCCEEDED, WAITING
+   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
 
 --wait-interval-seconds [integer]
 

oci_cli/help_text_producer/data_files/text/cmdref/dbtools/private-endpoint.txt

@@ -5,7 +5,8 @@ private-endpoint
 Description
 ===========
 
-Description of Database Tools private endpoint.
+Allows the Database Tools service to connect to databases in a
+customer’s virtual cloud network (VCN).
 
 
 Available Commands

oci_cli/help_text_producer/data_files/text/cmdref/dbtools/work-request/get.txt

@@ -31,7 +31,7 @@ Required Parameters
 
 --work-request-id [text]
 
-The ID of the asynchronous request.
+The OCID of the asynchronous request.
 
 
 Optional Parameters

oci_cli/help_text_producer/data_files/text/cmdref/dbtools/work-request/list.txt

@@ -31,7 +31,7 @@ Required Parameters
 
 --compartment-id, -c [text]
 
-The ID of the compartment in which to list resources.
+The OCID of the compartment in which to list resources.
 
 
 Optional Parameters
@@ -90,7 +90,7 @@ timeAccepted is default.
 
 Accepted values are:
 
-   timeAccepted
+   timeAccepted, timeUpdated
 
 --sort-order [text]
 

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

@@ -31,7 +31,7 @@ Required Parameters
 
 --work-request-id [text]
 
-The ID of the asynchronous request.
+The OCID of the asynchronous request.
 
 
 Optional Parameters

oci_cli/help_text_producer/data_files/text/cmdref/dbtools/work-request-log-entry/list.txt

@@ -31,7 +31,7 @@ Required Parameters
 
 --work-request-id [text]
 
-The ID of the asynchronous request.
+The OCID of the asynchronous request.
 
 
 Optional Parameters

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

@@ -54,6 +54,28 @@ Available Commands
 
   * list
 
+* identity
+
+  * add-lock
+
+  * change-compartment
+
+  * create-oracle-database-resource-principal
+
+  * delete
+
+  * get
+
+  * list
+
+  * refresh-oracle-database-resource-principal-credential
+
+  * remove-lock
+
+  * update-oracle-database-resource-principal
+
+  * validate-oracle-database-resource-principal-credential
+
 * private-endpoint
 
   * add-lock

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

@@ -1,5 +1,5 @@
-"list-errors"
-*************
+"list"
+******
 
 * Description
 
@@ -24,7 +24,7 @@ given ID.
 Usage
 =====
 
-   oci delegate-access-control work-request work-request-error list-errors [OPTIONS]
+   oci delegate-access-control work-request work-request-error 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-error/list-errors.html#cmdoption-work-request-id
+       export work_request_id=<substitute-value-of-work_request_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/delegate-access-control/work-request/work-request-error/list.html#cmdoption-work-request-id
 
-       oci delegate-access-control work-request work-request-error list-errors --work-request-id $work_request_id
+       oci delegate-access-control work-request work-request-error list --work-request-id $work_request_id

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

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

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

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

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

@@ -1,5 +1,5 @@
-work-request-log
-****************
+work-request-log-entry
+**********************
 
 
 Description
@@ -11,4 +11,4 @@ A log message from the execution of a work request.
 Available Commands
 ==================
 
-* list-logs
+* list-work-request-logs

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

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

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

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