oci-cli 3.73.1__py3-none-any.whl → 3.73.2__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/gdd/sharded-database/fetch-connection-string.txt

@@ -1,100 +0,0 @@
-"fetch-connection-string"
-*************************
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Gets the Sharded Database Connection Strings.
-
-
-Usage
-=====
-
-   oci gdd sharded-database fetch-connection-string [OPTIONS]
-
-
-Required Parameters
-===================
-
---sharded-database-id [text]
-
-Sharded Database identifier
-
-
-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", "--enable-dual-stack", "--enable-propagation", "--
-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 sharded_database_id=<substitute-value-of-sharded_database_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/gdd/sharded-database/fetch-connection-string.html#cmdoption-sharded-database-id
-
-       oci gdd sharded-database fetch-connection-string --sharded-database-id $sharded_database_id

oci_cli/help_text_producer/data_files/text/cmdref/gdd/sharded-database/generate-gsm-certificate-signing-request.txt

@@ -1,133 +0,0 @@
-"generate-gsm-certificate-signing-request"
-******************************************
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Generate the certificate signing request for GSM instances of the
-sharded database. Once certificate signing request is generated, then
-customers can download the certificate signing request using
-‘downloadGsmCertificateSigningRequest’ api call.
-
-
-Usage
-=====
-
-   oci gdd sharded-database generate-gsm-certificate-signing-request [OPTIONS]
-
-
-Required Parameters
-===================
-
---sharded-database-id [text]
-
-Sharded Database identifier
-
-
-Optional Parameters
-===================
-
---ca-bundle-id [text]
-
-The ID of the Ca Bundle.
-
---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, 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", "--enable-dual-stack", "--enable-propagation", "--
-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 sharded_database_id=<substitute-value-of-sharded_database_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/gdd/sharded-database/generate-gsm-certificate-signing-request.html#cmdoption-sharded-database-id
-
-       oci gdd sharded-database generate-gsm-certificate-signing-request --sharded-database-id $sharded_database_id

oci_cli/help_text_producer/data_files/text/cmdref/gdd/sharded-database/generate-wallet.txt

@@ -1,113 +0,0 @@
-"generate-wallet"
-*****************
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Generate the wallet associated with sharded database.
-
-
-Usage
-=====
-
-   oci gdd sharded-database generate-wallet [OPTIONS]
-
-
-Required Parameters
-===================
-
---file [filename]
-
-The name of the file that will receive the response data, or ‘-‘ to
-write to STDOUT.
-
---password [text]
-
-The password to encrypt the keys inside the wallet. The password must
-be at least 8 characters long and must include at least 1 letter and
-either 1 numeric character or 1 special character.
-
---sharded-database-id [text]
-
-Sharded Database identifier
-
-
-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", "--enable-dual-stack", "--enable-propagation", "--
-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 file=<substitute-value-of-file> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/gdd/sharded-database/generate-wallet.html#cmdoption-file
-       export password=<substitute-value-of-password> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/gdd/sharded-database/generate-wallet.html#cmdoption-password
-       export sharded_database_id=<substitute-value-of-sharded_database_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/gdd/sharded-database/generate-wallet.html#cmdoption-sharded-database-id
-
-       oci gdd sharded-database generate-wallet --file $file --password $password --sharded-database-id $sharded_database_id

oci_cli/help_text_producer/data_files/text/cmdref/gdd/sharded-database/get.txt

@@ -1,106 +0,0 @@
-"get"
-*****
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Gets the details of the Sharded database identified by given id.
-
-
-Usage
-=====
-
-   oci gdd sharded-database get [OPTIONS]
-
-
-Required Parameters
-===================
-
---sharded-database-id [text]
-
-Sharded Database identifier
-
-
-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-none-match [text]
-
-For conditional requests. In the GET call for a resource, set the *If-
-None-Match* header to the value of the ETag from a previous GET (or
-POST or PUT) response for that resource. The server will return with
-either a 304 Not Modified response if the resource has not changed, or
-a 200 OK response with the updated representation.
-
---metadata [text]
-
-Comma separated names of argument corresponding to which metadata need
-to be retrived, namely VM_CLUSTER_INFO, ADDITIONAL_RESOURCE_INFO. An
-example is metadata=VM_CLUSTER_INFO,ADDITIONAL_RESOURCE_INFO.
-
-
-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", "--enable-dual-stack", "--enable-propagation", "--
-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 sharded_database_id=<substitute-value-of-sharded_database_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/gdd/sharded-database/get.html#cmdoption-sharded-database-id
-
-       oci gdd sharded-database get --sharded-database-id $sharded_database_id

oci_cli/help_text_producer/data_files/text/cmdref/gdd/sharded-database/patch.txt

@@ -1,145 +0,0 @@
-"patch"
-*******
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Patch operation to add, remove or update shards to the sharded
-database topology. In single patch operation, multiple shards can be
-either added, or removed or updated. Combination of inserts, update
-and remove in single operation is not allowed.
-
-
-Usage
-=====
-
-   oci gdd sharded-database patch [OPTIONS]
-
-
-Required Parameters
-===================
-
---sharded-database-id [text]
-
-Sharded Database identifier
-
-
-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.
-
---items [complex type]
-
-List of patch instructions.
-
-This option is a JSON list with items of type PatchInstruction.  For
-documentation on PatchInstruction please see our API reference: https
-://docs.cloud.oracle.com/api/#/en/shardeddatabaseservice/20230301/dat
-atypes/PatchInstruction. 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.
-
---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, 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", "--enable-dual-stack", "--enable-propagation", "--
-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 sharded_database_id=<substitute-value-of-sharded_database_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/gdd/sharded-database/patch.html#cmdoption-sharded-database-id
-
-       oci gdd sharded-database patch --sharded-database-id $sharded_database_id