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/iot/work-request/list.txt

@@ -0,0 +1,148 @@
+"list"
+******
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Lists work requests in the specified compartment.
+
+
+Usage
+=====
+
+   oci iot work-request list [OPTIONS]
+
+
+Required Parameters
+===================
+
+--compartment-id, -c [text]
+
+The OCID 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.
+
+--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
+
+--id [text]
+
+The OCID of the asynchronous work request.
+
+--limit [integer]
+
+For list pagination. The maximum number of results per page, or items
+to return in a paginated “List” call. For important details about how
+pagination works, see List Pagination.
+
+--page [text]
+
+For list pagination: The value of the opc-next-page response header
+from the previous “List” call. For important details on how pagination
+works, see List Pagination.
+
+--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.
+
+--resource-id [text]
+
+The OCID of the resource affected by the work request.
+
+--sort-by [text]
+
+The field to sort by. Only one sort order can be specified. Default
+order for *timeAccepted* is descending.
+
+Accepted values are:
+
+   timeAccepted
+
+--sort-order [text]
+
+Specifies sort order to use, either ASC (ascending) or DESC
+(descending).
+
+Accepted values are:
+
+   ASC, DESC
+
+--status [text]
+
+A filter to return only the resources that match the given lifecycle
+state.
+
+Accepted values are:
+
+   ACCEPTED, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
+
+
+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/iot/work-request/list.html#cmdoption-compartment-id
+
+       oci iot work-request list --compartment-id $compartment_id

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

@@ -0,0 +1,24 @@
+work-request
+************
+
+
+Description
+===========
+
+An asynchronous work request helps monitor long-running operations.
+When you initiate a long-running operation, the service creates a work
+request. This work request acts as an activity log, allowing you to
+track each step of the operation’s progress. Each work request has an
+OCID, enabling programmatic interaction and automation.
+
+
+Available Commands
+==================
+
+* get
+
+* list
+
+* list-errors
+
+* list-logs

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

@@ -0,0 +1,121 @@
+iot
+***
+
+
+Description
+===========
+
+Use the Internet of Things (IoT) CLI to manage IoT domain groups,
+domains, and digital twin resources including models, adapters,
+instances, and relationships. For more information, see Internet of
+Things.
+
+
+Available Commands
+==================
+
+* digital-twin-adapter
+
+  * create
+
+  * delete
+
+  * get
+
+  * list
+
+  * update
+
+* digital-twin-instance
+
+  * create
+
+  * delete
+
+  * get
+
+  * get-content
+
+  * invoke-raw-binary-command
+
+  * invoke-raw-json-command
+
+  * invoke-raw-text-command
+
+  * list
+
+  * update
+
+* digital-twin-model
+
+  * create
+
+  * delete
+
+  * get
+
+  * get-spec
+
+  * list
+
+  * update
+
+* digital-twin-relationship
+
+  * create
+
+  * delete
+
+  * get
+
+  * list
+
+  * update
+
+* domain
+
+  * change-compartment
+
+  * change-data-retention-period
+
+  * configure-apex-data-access
+
+  * configure-direct-data-access
+
+  * configure-ords-data-access
+
+  * create
+
+  * delete
+
+  * get
+
+  * list
+
+  * update
+
+* domain-group
+
+  * change-compartment
+
+  * configure-data-access
+
+  * create
+
+  * delete
+
+  * get
+
+  * list
+
+  * update
+
+* work-request
+
+  * get
+
+  * list
+
+  * list-errors
+
+  * list-logs

oci_cli/help_text_producer/data_files/text/cmdref/mysql/db-system/clone.txt

@@ -360,6 +360,20 @@ 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.
 
+--security-attributes [complex type]
+
+Security Attributes for this resource. Each key is predefined and
+scoped to a namespace. For more information, see ZPR Artifacts.
+Example: *{“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”:
+“audit”}}}* 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.
+
 --wait-for-state [text]
 
 This operation asynchronously creates, modifies or deletes a resource

oci_cli/help_text_producer/data_files/text/cmdref/mysql/db-system/create.txt

@@ -356,6 +356,20 @@ 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.
 
+--security-attributes [complex type]
+
+Security Attributes for this resource. Each key is predefined and
+scoped to a namespace. For more information, see ZPR Artifacts.
+Example: *{“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”:
+“audit”}}}* 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.
+
 --source [complex type]
 
 This is a complex type whose value must be valid JSON. The value can

oci_cli/help_text_producer/data_files/text/cmdref/mysql/db-system/import.txt

@@ -361,6 +361,20 @@ 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.
 
+--security-attributes [complex type]
+
+Security Attributes for this resource. Each key is predefined and
+scoped to a namespace. For more information, see ZPR Artifacts.
+Example: *{“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”:
+“audit”}}}* 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.
+
 --wait-for-state [text]
 
 This operation asynchronously creates, modifies or deletes a resource

oci_cli/help_text_producer/data_files/text/cmdref/mysql/db-system/update.txt

@@ -368,6 +368,20 @@ 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.
 
+--security-attributes [complex type]
+
+Security Attributes for this resource. Each key is predefined and
+scoped to a namespace. For more information, see ZPR Artifacts.
+Example: *{“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”:
+“audit”}}}* 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.
+
 --shape-name [text]
 
 The shape of the DB System. The shape determines resources allocated

oci_cli/help_text_producer/data_files/text/cmdref/opensearch/cluster/create.txt

@@ -133,6 +133,17 @@ 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.
 
+--certificate-config [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.
+
 --data-node-host-bare-metal-shape [text]
 
 The bare metal shape for the cluster’s data nodes.
@@ -225,6 +236,10 @@ The node shape for the cluster’s master nodes.
 The maximum time to wait for the work request to reach the state
 defined by "--wait-for-state". Defaults to 1200 seconds.
 
+--nsg-id [text]
+
+The OCID of the NSG where the private endpoint vnic will be attached.
+
 --opendashboard-node-host-shape [text]
 
 The node shape for the cluster’s OpenSearch Dashboard nodes.
@@ -281,6 +296,24 @@ Accepted values are:
 The amount of storage in GB, to configure per node for the cluster’s
 search nodes.
 
+--security-attributes [complex type]
+
+Security attributes for this resource. Each key is predefined and
+scoped to a namespace. For more information, see Resource Tags.
+
+Example:
+
+   {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}
+
+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.
+
 --security-master-user-name [text]
 
 The name of the master user that are used to manage security config

oci_cli/help_text_producer/data_files/text/cmdref/opensearch/cluster/shapes-details/list.txt

@@ -5,6 +5,8 @@
 
 * Usage
 
+* Required Parameters
+
 * Optional Parameters
 
 * Global Parameters
@@ -24,6 +26,14 @@ Usage
    oci opensearch cluster shapes-details list [OPTIONS]
 
 
+Required Parameters
+===================
+
+--compartment-id, -c [text]
+
+The ID of the compartment in which to list resources.
+
+
 Optional Parameters
 ===================
 
@@ -80,4 +90,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.
 
-       oci opensearch cluster shapes-details list
+       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/opensearch/cluster/shapes-details/list.html#cmdoption-compartment-id
+
+       oci opensearch cluster shapes-details list --compartment-id $compartment_id

oci_cli/help_text_producer/data_files/text/cmdref/opensearch/cluster/update.txt

@@ -52,6 +52,17 @@ 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.
 
+--certificate-config [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.
+
 --defined-tags [complex type]
 
 Defined tags for this resource. Each key is predefined and scoped to a
@@ -151,6 +162,24 @@ 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.
 
+--security-attributes [complex type]
+
+Security attributes for this resource. Each key is predefined and
+scoped to a namespace. For more information, see Resource Tags.
+
+Example:
+
+   {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}
+
+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.
+
 --security-master-user-name [text]
 
 The name of the master user that are used to manage security config

oci_cli/help_text_producer/data_files/text/cmdref/opensearch/cluster/upgrade.txt

@@ -120,6 +120,24 @@ provided version.
 The maximum time to wait for the work request to reach the state
 defined by "--wait-for-state". Defaults to 1200 seconds.
 
+--security-attributes [complex type]
+
+Security attributes for this resource. Each key is predefined and
+scoped to a namespace. For more information, see Resource Tags.
+
+Example:
+
+   {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}
+
+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.
+
 --system-tags [complex type]
 
 Usage of system tag keys. These predefined keys are scoped to

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

@@ -1,5 +1,5 @@
-"list-errors"
-*************
+"list"
+******
 
 * Description
 
@@ -23,7 +23,7 @@ Return a (paginated) list of errors for a given work request.
 Usage
 =====
 
-   oci organizations work-request-error list-errors [OPTIONS]
+   oci organizations work-request-error list [OPTIONS]
 
 
 Required Parameters
@@ -113,6 +113,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/organizations/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/organizations/work-request-error/list.html#cmdoption-work-request-id
 
-       oci organizations work-request-error list-errors --work-request-id $work_request_id
+       oci organizations work-request-error list --work-request-id $work_request_id

oci_cli/help_text_producer/data_files/text/cmdref/organizations/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/organizations.txt

@@ -141,7 +141,7 @@ Available Commands
 
 * work-request-error
 
-  * list-errors
+  * list
 
 * work-request-log
 

oci_cli/help_text_producer/data_files/text/cmdref/redis/redis-cluster/redis-cluster/create.txt

@@ -135,6 +135,24 @@ via the file:// syntax.
 
 The ID of the corresponding OCI Cache Config Set for the cluster.
 
+--security-attributes [complex type]
+
+Security attributes for redis cluster resource. Each key is predefined
+and scoped to a namespace. For more information, see Resource Tags.
+
+Example:
+
+   {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}
+
+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.
+
 --shard-count [integer]
 
 The number of shards in sharded cluster. Only applicable when

oci_cli/help_text_producer/data_files/text/cmdref/redis/redis-cluster/redis-cluster/update.txt

@@ -135,6 +135,24 @@ via the file:// syntax.
 
 The ID of the corresponding OCI Cache Config Set for the cluster.
 
+--security-attributes [complex type]
+
+Security attributes for redis cluster resource. Each key is predefined
+and scoped to a namespace. For more information, see Resource Tags.
+
+Example:
+
+   {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}
+
+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.
+
 --shard-count [integer]
 
 The number of shards in sharded cluster. Only applicable when

oci_cli/help_text_producer/data_files/text/cmdref/resource-manager/associated-resource-summary/list-job-associated-resources.txt

@@ -17,7 +17,8 @@
 Description
 ===========
 
-Gets the list of resources associated with the specified job.
+Gets the list of resources associated with the specified job. For more
+information, see Listing Job Resources.
 
 
 Usage

oci_cli/help_text_producer/data_files/text/cmdref/resource-manager/associated-resource-summary/list-stack-associated-resources.txt

@@ -17,7 +17,8 @@
 Description
 ===========
 
-Gets the list of resources associated with the specified stack.
+Gets the list of resources associated with the specified stack. For
+more information, see Listing Stack Resources.
 
 
 Usage

oci_cli/help_text_producer/data_files/text/cmdref/resource-manager/configuration-source-provider/change-compartment.txt

@@ -18,8 +18,8 @@ Description
 ===========
 
 Moves a configuration source provider into a different compartment
-within the same tenancy. For information about moving resources
-between compartments, see Moving Resources to a Different Compartment.
+within the same tenancy. For more information, see Moving a
+Configuration Source Provider.
 
 
 Usage

oci_cli/help_text_producer/data_files/text/cmdref/resource-manager/configuration-source-provider/create-bitbucket-cloud-username-app-password-provider.txt

@@ -18,7 +18,7 @@ Description
 ===========
 
 Creates a configuration source provider in the specified compartment.
-For more information, see To create a configuration source provider.
+For more information, see Creating a Configuration Source Provider.
 
 
 Usage
@@ -73,8 +73,8 @@ confidential information.
 
 --display-name [text]
 
-Human-readable name of the configuration source provider. Avoid
-entering confidential information.
+A user-friendly name. Does not have to be unique, and it’s changeable.
+Avoid entering confidential information.
 
 --freeform-tags [complex type]