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

oci_cli/help_text_producer/data_files/text/cmdref/ocvs/management-appliance/management-appliance/update.txt

@@ -0,0 +1,217 @@
+"update"
+********
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Updates management appliance specified.
+
+
+Usage
+=====
+
+   oci ocvs management-appliance management-appliance update [OPTIONS]
+
+
+Required Parameters
+===================
+
+--management-appliance-id [text]
+
+The OCID of the management appliance.
+
+
+Optional Parameters
+===================
+
+--configuration [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.
+
+--connections [complex type]
+
+Array of connections for management appliance.
+
+This option is a JSON list with items of type
+ManagementApplianceConnection.  For documentation on
+ManagementApplianceConnection please see our API reference: https://d
+ocs.cloud.oracle.com/api/#/en/managementappliance/20230701/datatypes/
+ManagementApplianceConnection. 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
+namespace. For more information, see Resource Tags.
+
+Example:
+
+   {"Operations": {"CostCenter": "42"}}
+
+This is a complex type whose value must be valid JSON. The value can
+be provided as a string on the command line or passed in as a file
+using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--display-name [text]
+
+A descriptive name for the management appliance. It must be unique,
+start with a letter, and contain only letters, digits, whitespaces,
+dashes and underscores. Avoid entering confidential information.
+
+--force
+
+Perform update without prompting for confirmation.
+
+--freeform-tags [complex type]
+
+Free-form tags for this resource. Each tag is a simple key-value pair
+with no predefined name, type, or namespace. For more information, see
+Resource Tags.
+
+Example:
+
+   {"Department": "Finance"}
+
+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 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
+
+--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 and paste the following example into a JSON file, replacing the
+example parameters with your own.
+
+       oci ocvs sddc create --generate-param-json-input initial-configuration > initial-configuration.json
+
+       oci ocvs management-appliance management-appliance create --generate-param-json-input configuration > configuration.json
+       oci ocvs management-appliance management-appliance create --generate-param-json-input connections > connections.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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/sddc/create.html#cmdoption-compartment-id
+       export hcx_mode=<substitute-value-of-hcx_mode> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/sddc/create.html#cmdoption-hcx-mode
+       export ssh_authorized_keys=<substitute-value-of-ssh_authorized_keys> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/sddc/create.html#cmdoption-ssh-authorized-keys
+       export vmware_version=<substitute-value-of-vmware_version> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/sddc/create.html#cmdoption-vmware-version
+       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/management-appliance/management-appliance/create.html#cmdoption-display-name
+
+       sddc_id=$(oci ocvs sddc create --compartment-id $compartment_id --hcx-mode $hcx_mode --initial-configuration file://initial-configuration.json --ssh-authorized-keys $ssh_authorized_keys --vmware-version $vmware_version --query data.id --raw-output)
+
+       management_appliance_id=$(oci ocvs management-appliance management-appliance create --configuration file://configuration.json --connections file://connections.json --display-name $display_name --sddc-id $sddc_id --query data.id --raw-output)
+
+       oci ocvs management-appliance management-appliance update --management-appliance-id $management_appliance_id

oci_cli/help_text_producer/data_files/text/cmdref/ocvs/management-appliance/management-appliance.txt

@@ -0,0 +1,22 @@
+management-appliance
+********************
+
+
+Description
+===========
+
+Information about management appliance.
+
+
+Available Commands
+==================
+
+* create
+
+* delete
+
+* get
+
+* list
+
+* update

oci_cli/help_text_producer/data_files/text/cmdref/ocvs/management-appliance.txt

@@ -0,0 +1,25 @@
+management-appliance
+********************
+
+
+Description
+===========
+
+Use the Oracle Cloud VMware CLI to create SDDCs and manage ESXi hosts
+and software. For more information, see Oracle Cloud VMware Solution.
+
+
+Available Commands
+==================
+
+* management-appliance
+
+  * create
+
+  * delete
+
+  * get
+
+  * list
+
+  * update

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

@@ -88,6 +88,20 @@ Available Commands
 
   * update
 
+* management-appliance
+
+  * management-appliance
+
+    * create
+
+    * delete
+
+    * get
+
+    * list
+
+    * update
+
 * sddc
 
   * cancel-downgrade-hcx

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

@@ -212,6 +212,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.
 
+--load-balancer-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.
+
 --maintenance-details [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/opensearch/cluster/update.txt

@@ -123,6 +123,17 @@ 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.
 
+--load-balancer-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.
+
 --maintenance-details [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/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
@@ -114,6 +114,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/queue/channels/list-channels.txt

@@ -52,6 +52,10 @@ cannot provide the "--limit" option.
 
 Optional parameter to filter the channels.
 
+--consumer-group-id [text]
+
+Optional parameter to specify a consumer group.
+
 --from-json [text]
 
 Provide input to this command as a JSON document from a file using the

oci_cli/help_text_producer/data_files/text/cmdref/queue/messages/delete-message.txt

@@ -45,6 +45,10 @@ The unique queue identifier.
 Optional Parameters
 ===================
 
+--consumer-group-id [text]
+
+Optional parameter to specify a consumer group.
+
 --force
 
 Perform deletion without prompting for confirmation.

oci_cli/help_text_producer/data_files/text/cmdref/queue/messages/delete-messages.txt

@@ -54,6 +54,10 @@ The unique queue identifier.
 Optional Parameters
 ===================
 
+--consumer-group-id [text]
+
+Optional parameter to specify a consumer group.
+
 --from-json [text]
 
 Provide input to this command as a JSON document from a file using the

oci_cli/help_text_producer/data_files/text/cmdref/queue/messages/get-messages.txt

@@ -50,6 +50,10 @@ Optional Parameters
 
 Optional parameter to filter the channels.
 
+--consumer-group-id [text]
+
+Optional parameter to specify a consumer group.
+
 --from-json [text]
 
 Provide input to this command as a JSON document from a file using the

oci_cli/help_text_producer/data_files/text/cmdref/queue/messages/get-stats.txt

@@ -45,6 +45,10 @@ Optional Parameters
 
 Id to specify channel.
 
+--consumer-group-id [text]
+
+Optional parameter to specify a consumer group.
+
 --from-json [text]
 
 Provide input to this command as a JSON document from a file using the

oci_cli/help_text_producer/data_files/text/cmdref/queue/messages/update-message.txt

@@ -50,6 +50,10 @@ the clock of the server receiving the request).
 Optional Parameters
 ===================
 
+--consumer-group-id [text]
+
+Optional parameter to specify a consumer group.
+
 --from-json [text]
 
 Provide input to this command as a JSON document from a file using the

oci_cli/help_text_producer/data_files/text/cmdref/queue/messages/update-messages.txt

@@ -54,6 +54,10 @@ The unique queue identifier.
 Optional Parameters
 ===================
 
+--consumer-group-id [text]
+
+Optional parameter to specify a consumer group.
+
 --from-json [text]
 
 Provide input to this command as a JSON document from a file using the

oci_cli/help_text_producer/data_files/text/cmdref/queue/queue-admin/consumer-group/create.txt

@@ -0,0 +1,169 @@
+"create"
+********
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Creates a new consumer group.
+
+
+Usage
+=====
+
+   oci queue queue-admin consumer-group create [OPTIONS]
+
+
+Required Parameters
+===================
+
+--display-name [text]
+
+The user-friendly name of the consumer group.
+
+--queue-id [text]
+
+The OCID of the associated queue.
+
+
+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.
+
+--dlq-delivery-count [integer]
+
+The number of times a message can be delivered to a consumer before
+being moved to the dead letter queue. A value of 0 indicates that the
+DLQ is not used. If the value isn’t specified, it will be using the
+value defined at the queue level.
+
+--filter [text]
+
+The filter used by the consumer group. Only messages matching the
+filter will be available by consumers of the group.
+
+--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
+
+--is-enabled [boolean]
+
+Used to enable or disable the consumer group. An enabled consumer
+group will have a lifecycle state of ACTIVE, while a disabled will
+have its state as INACTIVE.
+
+--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
+
+--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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/queue/queue-admin/queue/create.html#cmdoption-compartment-id
+       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/queue/queue-admin/queue/create.html#cmdoption-display-name
+
+       queue_id=$(oci queue queue-admin queue create --compartment-id $compartment_id --display-name $display_name --query data.id --raw-output)
+
+       oci queue queue-admin consumer-group create --display-name $display_name --queue-id $queue_id