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/start.txt

@@ -1,126 +0,0 @@
-"start"
-*******
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Start the shards, catalog and GSMs of Sharded Database.
-
-
-Usage
-=====
-
-   oci gdd sharded-database start [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.
-
---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/start.html#cmdoption-sharded-database-id
-
-       oci gdd sharded-database start --sharded-database-id $sharded_database_id

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

@@ -1,126 +0,0 @@
-"stop"
-******
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Stop the shards, catalog and GSM instances for the sharded database.
-
-
-Usage
-=====
-
-   oci gdd sharded-database stop [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.
-
---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/stop.html#cmdoption-sharded-database-id
-
-       oci gdd sharded-database stop --sharded-database-id $sharded_database_id

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

@@ -1,160 +0,0 @@
-"update"
-********
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Updates the configuration of sharded database.
-
-
-Usage
-=====
-
-   oci gdd sharded-database update [OPTIONS]
-
-
-Required Parameters
-===================
-
---sharded-database-id [text]
-
-Sharded Database identifier
-
-
-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]
-
-Display name of the sharded database.
-
---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.
-
---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.
-
---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, INACTIVE, NEEDS_ATTENTION, UNAVAILABLE, 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", "--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/update.html#cmdoption-sharded-database-id
-
-       oci gdd sharded-database update --sharded-database-id $sharded_database_id

oci_cli/help_text_producer/data_files/text/cmdref/gdd/sharded-database/upload-signed-certificate-and-generate-wallet.txt

@@ -1,134 +0,0 @@
-"upload-signed-certificate-and-generate-wallet"
-***********************************************
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Upload the CA signed certificate to the GSM instances and generate
-wallets for GSM instances of the sharded database. Customer shall
-provide the CA signed certificate key details by adding the
-certificate in request body.
-
-
-Usage
-=====
-
-   oci gdd sharded-database upload-signed-certificate-and-generate-wallet [OPTIONS]
-
-
-Required Parameters
-===================
-
---ca-signed-certificate-file [filename]
-
-A file containing CA signed certificate.
-
---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.
-
---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 ca_signed_certificate_file=<substitute-value-of-ca_signed_certificate_file> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/gdd/sharded-database/upload-signed-certificate-and-generate-wallet.html#cmdoption-ca-signed-certificate-file
-       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/upload-signed-certificate-and-generate-wallet.html#cmdoption-sharded-database-id
-
-       oci gdd sharded-database upload-signed-certificate-and-generate-wallet --ca-signed-certificate-file $ca_signed_certificate_file --sharded-database-id $sharded_database_id

oci_cli/help_text_producer/data_files/text/cmdref/gdd/sharded-database-collection/list-sharded-databases.txt

@@ -1,144 +0,0 @@
-"list-sharded-databases"
-************************
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-List of Sharded databases.
-
-
-Usage
-=====
-
-   oci gdd sharded-database-collection list-sharded-databases [OPTIONS]
-
-
-Required Parameters
-===================
-
---compartment-id, -c [text]
-
-The ID of the compartment in which to list resources.
-
-
-Optional Parameters
-===================
-
---all
-
-Fetches all pages of results. If you provide this option, then you
-cannot provide the "--limit" option.
-
---display-name [text]
-
-A filter to return only sharded databases that match the entire name
-given. The match is not case sensitive.
-
---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
-
---lifecycle-state [text]
-
-A filter to return only resources their lifecycleState matches the
-given lifecycleState.
-
-Accepted values are:
-
-   ACTIVE, CREATING, DELETED, DELETING, FAILED, INACTIVE, NEEDS_ATTENTION, UNAVAILABLE, UPDATING
-
---limit [integer]
-
-The maximum number of items to return.
-
---page [text]
-
-A token representing the position at which to start retrieving
-results. This must come from the *opc-next-page* header field of a
-previous response.
-
---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. Only one sort order may be provided. Default
-order for timeCreated is descending. Default order for displayName is
-ascending.
-
-Accepted values are:
-
-   timeCreated, timeUpdated
-
---sort-order [text]
-
-The sort order to use, either ‘ASC’ or ‘DESC’.
-
-Accepted values are:
-
-   ASC, DESC
-
-
-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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/gdd/sharded-database-collection/list-sharded-databases.html#cmdoption-compartment-id
-
-       oci gdd sharded-database-collection list-sharded-databases --compartment-id $compartment_id