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

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

@@ -0,0 +1,169 @@
+"convert-standby-database-type"
+*******************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Performs transition from standby database into a snapshot standby and
+vice versa. The transition performed based on the current role of the
+database, if the current role is standby then this operation will
+convert it to snapshot standby and if the current role is snapshot
+standby then this operation will convert it to standby.
+
+This operation should be performed on respective standby/snapshot
+standby database.
+
+
+Usage
+=====
+
+   oci db database convert-standby-database-type [OPTIONS]
+
+
+Required Parameters
+===================
+
+--database-admin-password [text]
+
+The administrator password of the primary database in this Data Guard
+association.
+
+**The password MUST be the same as the primary admin password.**
+
+--database-id [text]
+
+The database OCID.
+
+--standby-conversion-type [text]
+
+Defines the conversion type of the standby database. Specify this to
+convert a physical standby to a snapshot standby and vice versa.
+
+Valid standbyConversionType:     - SNAPSHOT     - PHYSICAL
+
+Accepted values are:
+
+   PHYSICAL, SNAPSHOT
+
+
+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.
+
+--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.
+
+--snapshot-duration-in-days [integer]
+
+SnapshotDurationInDays is the duration in day(s) after which the
+Snapshot Standby Database will get converted back to Physical Standby.
+The minimum value of snapshotDurationInDays is 3 days and maximum
+value is 14 days. Default value will be 7 days if not provided in the
+Request.
+
+This field is only applicable if the requested database role is
+snapshot standby.
+
+--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
+=================
+
+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 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 admin_password=<substitute-value-of-admin_password> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/database/create.html#cmdoption-admin-password
+       export db_name=<substitute-value-of-db_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/database/create.html#cmdoption-db-name
+       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/convert-standby-database-type.html#cmdoption-database-admin-password
+       export standby_conversion_type=<substitute-value-of-standby_conversion_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/database/convert-standby-database-type.html#cmdoption-standby-conversion-type
+
+       db_home_id=$(oci db db-home create --db-system-id $db_system_id --query data.id --raw-output)
+
+       database_id=$(oci db database create --admin-password $admin_password --db-home-id $db_home_id --db-name $db_name --db-system-id $db_system_id --query data.id --raw-output)
+
+       oci db database convert-standby-database-type --database-admin-password $database_admin_password --database-id $database_id --standby-conversion-type $standby_conversion_type

oci_cli/help_text_producer/data_files/text/cmdref/db/database.txt

@@ -27,6 +27,8 @@ Available Commands
 
 * change-to-external-hsm-key-location
 
+* convert-standby-database-type
+
 * convert-to-new-pdb
 
 * convert-to-new-pdb-precheck

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

@@ -470,6 +470,8 @@ Available Commands
 
   * change-to-external-hsm-key-location
 
+  * convert-standby-database-type
+
   * convert-to-new-pdb
 
   * convert-to-new-pdb-precheck

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

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

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

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

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

@@ -1,5 +1,5 @@
-work-request-log-entry
-**********************
+work-request-log
+****************
 
 
 Description
@@ -11,4 +11,4 @@ A log message from the execution of a work request.
 Available Commands
 ==================
 
-* list-work-request-logs
+* list-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
+  * list-errors
 
-* work-request-log-entry
+* work-request-log
 
-  * list-work-request-logs
+  * list-logs

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

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

oci_cli/help_text_producer/data_files/text/cmdref/devops/trigger-dry-run-result/trigger-deployment-dry-run-create-deploy-pipeline-deployment-details.txt

@@ -0,0 +1,174 @@
+"trigger-deployment-dry-run-create-deploy-pipeline-deployment-details"
+**********************************************************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Sends a request to trigger a dry run, passing a
+HelmDiffArgumentCollection This is an internal-only endpoint, access
+to this endpoint is restricted.  Any request from non-internal
+tenancies will receive 403 Forbidden response.
+
+
+Usage
+=====
+
+   oci devops trigger-dry-run-result trigger-deployment-dry-run-create-deploy-pipeline-deployment-details [OPTIONS]
+
+
+Required Parameters
+===================
+
+--create-deployment-details-deploy-pipeline-id [text]
+
+The OCID of a pipeline.
+
+--helm-diff-arguments [complex type]
+
+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.
+
+
+Optional Parameters
+===================
+
+--create-deployment-details-defined-tags [complex type]
+
+Defined tags for this resource. Each key is predefined and scoped to a
+namespace. See Resource Tags. 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.
+
+--create-deployment-details-deploy-artifact-override-arguments [complex type]
+
+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.
+
+--create-deployment-details-deploy-stage-override-arguments [complex type]
+
+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.
+
+--create-deployment-details-deployment-arguments [complex type]
+
+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.
+
+--create-deployment-details-display-name [text]
+
+Deployment display name. Avoid entering confidential information.
+
+--create-deployment-details-freeform-tags [complex type]
+
+Simple key-value pair that is applied without any predefined name,
+type or scope. Exists for cross-compatibility only.  See Resource
+Tags. 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
+
+
+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 devops trigger-dry-run-result trigger-deployment-dry-run-create-deploy-pipeline-deployment-details --generate-param-json-input helm-diff-arguments > helm-diff-arguments.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 create_deployment_details_deploy_pipeline_id=<substitute-value-of-create_deployment_details_deploy_pipeline_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/devops/trigger-dry-run-result/trigger-deployment-dry-run-create-deploy-pipeline-deployment-details.html#cmdoption-create-deployment-details-deploy-pipeline-id
+
+       oci devops trigger-dry-run-result trigger-deployment-dry-run-create-deploy-pipeline-deployment-details --create-deployment-details-deploy-pipeline-id $create_deployment_details_deploy_pipeline_id --helm-diff-arguments file://helm-diff-arguments.json

oci_cli/help_text_producer/data_files/text/cmdref/devops/trigger-dry-run-result/trigger-deployment-dry-run-create-deploy-pipeline-redeployment-details.txt

@@ -0,0 +1,146 @@
+"trigger-deployment-dry-run-create-deploy-pipeline-redeployment-details"
+************************************************************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Sends a request to trigger a dry run, passing a
+HelmDiffArgumentCollection This is an internal-only endpoint, access
+to this endpoint is restricted.  Any request from non-internal
+tenancies will receive 403 Forbidden response.
+
+
+Usage
+=====
+
+   oci devops trigger-dry-run-result trigger-deployment-dry-run-create-deploy-pipeline-redeployment-details [OPTIONS]
+
+
+Required Parameters
+===================
+
+--create-deployment-details-deploy-pipeline-id [text]
+
+The OCID of a pipeline.
+
+--create-deployment-details-previous-deployment-id [text]
+
+Specifies the OCID of the previous deployment to be redeployed.
+
+--helm-diff-arguments [complex type]
+
+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.
+
+
+Optional Parameters
+===================
+
+--create-deployment-details-defined-tags [complex type]
+
+Defined tags for this resource. Each key is predefined and scoped to a
+namespace. See Resource Tags. 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.
+
+--create-deployment-details-display-name [text]
+
+Deployment display name. Avoid entering confidential information.
+
+--create-deployment-details-freeform-tags [complex type]
+
+Simple key-value pair that is applied without any predefined name,
+type or scope. Exists for cross-compatibility only.  See Resource
+Tags. 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
+
+
+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 devops trigger-dry-run-result trigger-deployment-dry-run-create-deploy-pipeline-redeployment-details --generate-param-json-input helm-diff-arguments > helm-diff-arguments.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 create_deployment_details_deploy_pipeline_id=<substitute-value-of-create_deployment_details_deploy_pipeline_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/devops/trigger-dry-run-result/trigger-deployment-dry-run-create-deploy-pipeline-redeployment-details.html#cmdoption-create-deployment-details-deploy-pipeline-id
+       export create_deployment_details_previous_deployment_id=<substitute-value-of-create_deployment_details_previous_deployment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/devops/trigger-dry-run-result/trigger-deployment-dry-run-create-deploy-pipeline-redeployment-details.html#cmdoption-create-deployment-details-previous-deployment-id
+
+       oci devops trigger-dry-run-result trigger-deployment-dry-run-create-deploy-pipeline-redeployment-details --create-deployment-details-deploy-pipeline-id $create_deployment_details_deploy_pipeline_id --create-deployment-details-previous-deployment-id $create_deployment_details_previous_deployment_id --helm-diff-arguments file://helm-diff-arguments.json