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

oci_cli/help_text_producer/data_files/text/cmdref/ocvs/datastore-cluster/remove-datastore.txt

@@ -0,0 +1,147 @@
+"remove-datastore"
+******************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Remove the specified Datastore from the provided Datastore Cluster.
+
+
+Usage
+=====
+
+   oci ocvs datastore-cluster remove-datastore [OPTIONS]
+
+
+Required Parameters
+===================
+
+--datastore-cluster-id [text]
+
+The OCID of the Datastore Cluster.
+
+--datastore-ids [complex type]
+
+A list of datastores to be removed. 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
+===================
+
+--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", "--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 datastore-cluster remove-datastore --generate-param-json-input datastore-ids > datastore-ids.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 availability_domain=<substitute-value-of-availability_domain> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/datastore-cluster/create.html#cmdoption-availability-domain
+       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/datastore-cluster/create.html#cmdoption-compartment-id
+       export datastore_cluster_type=<substitute-value-of-datastore_cluster_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/datastore-cluster/create.html#cmdoption-datastore-cluster-type
+       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/datastore-cluster/create.html#cmdoption-display-name
+
+       datastore_cluster_id=$(oci ocvs datastore-cluster create --availability-domain $availability_domain --compartment-id $compartment_id --datastore-cluster-type $datastore_cluster_type --display-name $display_name --query data.id --raw-output)
+
+       oci ocvs datastore-cluster remove-datastore --datastore-cluster-id $datastore_cluster_id --datastore-ids file://datastore-ids.json

oci_cli/help_text_producer/data_files/text/cmdref/ocvs/datastore-cluster/update.txt

@@ -0,0 +1,182 @@
+"update"
+********
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Updates the specified Datastore Cluster.
+
+**Important:** Updating a Datastore Cluster affects only certain
+attributes in the *Datastore Cluster* object and does not affect the
+VMware environment currently running.
+
+
+Usage
+=====
+
+   oci ocvs datastore-cluster update [OPTIONS]
+
+
+Required Parameters
+===================
+
+--datastore-cluster-id [text]
+
+The OCID of the Datastore Cluster.
+
+
+Optional Parameters
+===================
+
+--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 Datastore Cluster. It must be unique within
+a SDDC, 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", "--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 availability_domain=<substitute-value-of-availability_domain> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/datastore-cluster/create.html#cmdoption-availability-domain
+       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/datastore-cluster/create.html#cmdoption-compartment-id
+       export datastore_cluster_type=<substitute-value-of-datastore_cluster_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/datastore-cluster/create.html#cmdoption-datastore-cluster-type
+       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/datastore-cluster/create.html#cmdoption-display-name
+
+       datastore_cluster_id=$(oci ocvs datastore-cluster create --availability-domain $availability_domain --compartment-id $compartment_id --datastore-cluster-type $datastore_cluster_type --display-name $display_name --query data.id --raw-output)
+
+       oci ocvs datastore-cluster update --datastore-cluster-id $datastore_cluster_id

oci_cli/help_text_producer/data_files/text/cmdref/ocvs/datastore-cluster.txt

@@ -0,0 +1,37 @@
+datastore-cluster
+*****************
+
+
+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
+==================
+
+* add-datastore
+
+* attach-to-cluster
+
+* attach-to-esxi-host
+
+* change-compartment
+
+* create
+
+* delete
+
+* detach-from-cluster
+
+* detach-from-esxi-host
+
+* get
+
+* list
+
+* remove-datastore
+
+* update

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

@@ -0,0 +1,27 @@
+datastore
+*********
+
+
+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
+==================
+
+* add-block-volume
+
+* change-compartment
+
+* create
+
+* delete
+
+* get
+
+* list
+
+* update

oci_cli/help_text_producer/data_files/text/cmdref/ocvs/esxi-host/create.txt

@@ -87,7 +87,7 @@ via the file:// syntax.
 --display-name, --name [text]
 
 A descriptive name for the ESXi host. It’s changeable. Esxi Host name
-requirements are 1-16 character length limit, Must start with a
+requirements are 1-25 character length limit, Must start with a
 letter, Must be English letters, numbers, - only, No repeating
 hyphens, Must be unique within the Cluster.
 

oci_cli/help_text_producer/data_files/text/cmdref/ocvs/esxi-host/update.txt

@@ -39,7 +39,11 @@ Optional Parameters
 
 --billing-donor-host-id [text]
 
-The OCID of the deleted ESXi Host with LeftOver billing cycle.
+The OCID of the deleted ESXi Host with leftover billing cycle.
+
+**Note:** This option also requires the *nextCommitment* parameter to
+be populated with a value other than *HOUR*. Otherwise, any update
+request fails with the error “Next SKU can’t be NULL or Hourly.”
 
 --defined-tags [complex type]
 
@@ -62,7 +66,7 @@ via the file:// syntax.
 --display-name, --name [text]
 
 A descriptive name for the ESXi host. It’s changeable. Esxi Host name
-requirements are 1-16 character length limit, Must start with a
+requirements are 1-25 character length limit, Must start with a
 letter, Must be English letters, numbers, - only, No repeating
 hyphens, Must be unique within the Cluster.
 

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

@@ -1,5 +1,5 @@
-"list"
-******
+"list-errors"
+*************
 
 * Description
 
@@ -23,7 +23,7 @@ Lists the errors for the specified work request.
 Usage
 =====
 
-   oci ocvs work-request-error list [OPTIONS]
+   oci ocvs work-request-error list-errors [OPTIONS]
 
 
 Required Parameters
@@ -108,6 +108,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/ocvs/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/ocvs/work-request-error/list-errors.html#cmdoption-work-request-id
 
-       oci ocvs work-request-error list --work-request-id $work_request_id
+       oci ocvs work-request-error list-errors --work-request-id $work_request_id

oci_cli/help_text_producer/data_files/text/cmdref/ocvs/work-request-error.txt

@@ -12,4 +12,4 @@ work request.
 Available Commands
 ==================
 
-* list
+* list-errors

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

@@ -28,6 +28,48 @@ Available Commands
 
     * list-clusters
 
+* datastore
+
+  * add-block-volume
+
+  * change-compartment
+
+  * create
+
+  * delete
+
+  * get
+
+  * list
+
+  * update
+
+* datastore-cluster
+
+  * add-datastore
+
+  * attach-to-cluster
+
+  * attach-to-esxi-host
+
+  * change-compartment
+
+  * create
+
+  * delete
+
+  * detach-from-cluster
+
+  * detach-from-esxi-host
+
+  * get
+
+  * list
+
+  * remove-datastore
+
+  * update
+
 * esxi-host
 
   * create
@@ -80,7 +122,7 @@ Available Commands
 
 * work-request-error
 
-  * list
+  * list-errors
 
 * work-request-log
 

oci_cli/help_text_producer/data_files/text/cmdref/resource-analytics/monitored-region/create.txt

@@ -0,0 +1,127 @@
+"create"
+********
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Creates a MonitoredRegion.
+
+
+Usage
+=====
+
+   oci resource-analytics monitored-region create [OPTIONS]
+
+
+Required Parameters
+===================
+
+--region-id [text]
+
+The Region Identifier of this MonitoredRegion.
+
+--resource-analytics-instance-id [text]
+
+The OCID of the ResourceAnalyticsInstance associated with this
+MonitoredRegion.
+
+
+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
+
+--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, NEEDS_ATTENTION, 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", "--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 adw_admin_password_secret_id=<substitute-value-of-adw_admin_password_secret_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/resource-analytics/resource-analytics-instance/create.html#cmdoption-adw-admin-password-secret-id
+       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/resource-analytics/resource-analytics-instance/create.html#cmdoption-compartment-id
+       export subnet_id=<substitute-value-of-subnet_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/resource-analytics/resource-analytics-instance/create.html#cmdoption-subnet-id
+       export region_id=<substitute-value-of-region_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/resource-analytics/monitored-region/create.html#cmdoption-region-id
+
+       resource_analytics_instance_id=$(oci resource-analytics resource-analytics-instance create --adw-admin-password-secret-id $adw_admin_password_secret_id --compartment-id $compartment_id --subnet-id $subnet_id --query data.id --raw-output)
+
+       oci resource-analytics monitored-region create --region-id $region_id --resource-analytics-instance-id $resource_analytics_instance_id