oci-cli 3.71.1__py3-none-any.whl → 3.71.2__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/batch/work-request-log-entry/list-work-request-logs.txt

@@ -0,0 +1,132 @@
+"list-work-request-logs"
+************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Lists the logs for a work request.
+
+
+Usage
+=====
+
+   oci batch work-request-log-entry list-work-request-logs [OPTIONS]
+
+
+Required Parameters
+===================
+
+--work-request-id [text]
+
+The OCID of the asynchronous work request.
+
+
+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
+
+--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 about 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.
+
+--sort-by [text]
+
+The field to sort by. Only one sort order may be provided. Default
+order for *timeCreated* is descending.
+
+Accepted values are:
+
+   timeCreated
+
+--sort-order [text]
+
+The sort order to use, either ascending (*ASC*) or descending
+(*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 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/batch/work-request-log-entry/list-work-request-logs.html#cmdoption-work-request-id
+
+       oci batch work-request-log-entry list-work-request-logs --work-request-id $work_request_id

oci_cli/help_text_producer/data_files/text/cmdref/batch/work-request-log-entry.txt

@@ -0,0 +1,15 @@
+work-request-log-entry
+**********************
+
+
+Description
+===========
+
+A log message from performing an operation that is tracked by a work
+request.
+
+
+Available Commands
+==================
+
+* list-work-request-logs

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

@@ -0,0 +1,21 @@
+work-request
+************
+
+
+Description
+===========
+
+An asynchronous work request. Work requests help you monitor long-
+running operations. When you start a long-running operation, the
+service creates a work request. A work request is an activity log that
+lets you track each step in the operation’s progress. Each work
+request has an OCID that lets you interact with it programmatically
+and use it for automation.
+
+
+Available Commands
+==================
+
+* get
+
+* list

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

@@ -0,0 +1,123 @@
+batch
+*****
+
+
+Description
+===========
+
+Use the Batch Control Plane CLI to encapsulate and manage all aspects
+of computationally intensive jobs.
+
+
+Available Commands
+==================
+
+* batch-context
+
+  * change-compartment
+
+  * create
+
+  * create-oci-logging-configuration
+
+  * delete
+
+  * get
+
+  * list
+
+  * start
+
+  * stop
+
+  * update
+
+* batch-context-shape-collection
+
+  * list
+
+* batch-job
+
+  * cancel
+
+  * change-compartment
+
+  * create
+
+  * get
+
+  * list
+
+  * pause
+
+  * unpause
+
+  * update
+
+* batch-job-pool
+
+  * change-compartment
+
+  * create
+
+  * delete
+
+  * get
+
+  * list
+
+  * start
+
+  * stop
+
+  * update
+
+* batch-task
+
+  * get
+
+  * list
+
+  * list-batch-tasks
+
+* batch-task-environment
+
+  * change-compartment
+
+  * create
+
+  * delete
+
+  * get
+
+  * list
+
+  * update
+
+* batch-task-profile
+
+  * change-compartment
+
+  * create
+
+  * delete
+
+  * get
+
+  * list
+
+  * update
+
+* work-request
+
+  * get
+
+  * list
+
+* work-request-error
+
+  * list
+
+* work-request-log-entry
+
+  * list-work-request-logs

oci_cli/help_text_producer/data_files/text/cmdref/ce/virtual-node-pool/create.txt

@@ -57,6 +57,18 @@ 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.
 
+--pod-configuration [complex type]
+
+The pod configuration for pods run on virtual nodes of this virtual
+node pool. 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.
+
 --size [integer]
 
 The number of Virtual Nodes that should be in the Virtual Node Pool.
@@ -152,18 +164,6 @@ 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.
 
---pod-configuration [complex type]
-
-The pod configuration for pods run on virtual nodes of this virtual
-node pool. 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.
-
 --taints [complex type]
 
 A taint is a collection of <key, value, effect>. These taints will be
@@ -238,6 +238,7 @@ Copy and paste the following example into a JSON file, replacing the
 example parameters with your own.
 
        oci ce virtual-node-pool create --generate-param-json-input placement-configurations > placement-configurations.json
+       oci ce virtual-node-pool create --generate-param-json-input pod-configuration > pod-configuration.json
 
 Copy the following CLI commands into a file named example.sh. Run the
 command by typing “bash example.sh” and replacing the example
@@ -256,4 +257,4 @@ security policies before trying the examples.
 
        cluster_id=$(oci ce cluster create --compartment-id $compartment_id --kubernetes-version $kubernetes_version --name $name --vcn-id $vcn_id --query data.id --raw-output)
 
-       oci ce virtual-node-pool create --cluster-id $cluster_id --compartment-id $compartment_id --display-name $display_name --placement-configurations file://placement-configurations.json --size $size
+       oci ce virtual-node-pool create --cluster-id $cluster_id --compartment-id $compartment_id --display-name $display_name --placement-configurations file://placement-configurations.json --pod-configuration file://pod-configuration.json --size $size

oci_cli/help_text_producer/data_files/text/cmdref/ce/virtual-node-pool/delete.txt

@@ -133,6 +133,7 @@ Copy and paste the following example into a JSON file, replacing the
 example parameters with your own.
 
        oci ce virtual-node-pool create --generate-param-json-input placement-configurations > placement-configurations.json
+       oci ce virtual-node-pool create --generate-param-json-input pod-configuration > pod-configuration.json
 
 Copy the following CLI commands into a file named example.sh. Run the
 command by typing “bash example.sh” and replacing the example
@@ -151,6 +152,6 @@ security policies before trying the examples.
 
        cluster_id=$(oci ce cluster create --compartment-id $compartment_id --kubernetes-version $kubernetes_version --name $name --vcn-id $vcn_id --query data.id --raw-output)
 
-       virtual_node_pool_id=$(oci ce virtual-node-pool create --cluster-id $cluster_id --compartment-id $compartment_id --display-name $display_name --placement-configurations file://placement-configurations.json --size $size --query data.id --raw-output)
+       virtual_node_pool_id=$(oci ce virtual-node-pool create --cluster-id $cluster_id --compartment-id $compartment_id --display-name $display_name --placement-configurations file://placement-configurations.json --pod-configuration file://pod-configuration.json --size $size --query data.id --raw-output)
 
        oci ce virtual-node-pool delete --virtual-node-pool-id $virtual_node_pool_id

oci_cli/help_text_producer/data_files/text/cmdref/ce/virtual-node-pool/get-virtual-node.txt

@@ -87,6 +87,7 @@ Copy and paste the following example into a JSON file, replacing the
 example parameters with your own.
 
        oci ce virtual-node-pool create --generate-param-json-input placement-configurations > placement-configurations.json
+       oci ce virtual-node-pool create --generate-param-json-input pod-configuration > pod-configuration.json
 
 Copy the following CLI commands into a file named example.sh. Run the
 command by typing “bash example.sh” and replacing the example
@@ -106,6 +107,6 @@ security policies before trying the examples.
 
        cluster_id=$(oci ce cluster create --compartment-id $compartment_id --kubernetes-version $kubernetes_version --name $name --vcn-id $vcn_id --query data.id --raw-output)
 
-       virtual_node_pool_id=$(oci ce virtual-node-pool create --cluster-id $cluster_id --compartment-id $compartment_id --display-name $display_name --placement-configurations file://placement-configurations.json --size $size --query data.id --raw-output)
+       virtual_node_pool_id=$(oci ce virtual-node-pool create --cluster-id $cluster_id --compartment-id $compartment_id --display-name $display_name --placement-configurations file://placement-configurations.json --pod-configuration file://pod-configuration.json --size $size --query data.id --raw-output)
 
        oci ce virtual-node-pool get-virtual-node --virtual-node-id $virtual_node_id --virtual-node-pool-id $virtual_node_pool_id

oci_cli/help_text_producer/data_files/text/cmdref/ce/virtual-node-pool/get.txt

@@ -83,6 +83,7 @@ Copy and paste the following example into a JSON file, replacing the
 example parameters with your own.
 
        oci ce virtual-node-pool create --generate-param-json-input placement-configurations > placement-configurations.json
+       oci ce virtual-node-pool create --generate-param-json-input pod-configuration > pod-configuration.json
 
 Copy the following CLI commands into a file named example.sh. Run the
 command by typing “bash example.sh” and replacing the example
@@ -101,6 +102,6 @@ security policies before trying the examples.
 
        cluster_id=$(oci ce cluster create --compartment-id $compartment_id --kubernetes-version $kubernetes_version --name $name --vcn-id $vcn_id --query data.id --raw-output)
 
-       virtual_node_pool_id=$(oci ce virtual-node-pool create --cluster-id $cluster_id --compartment-id $compartment_id --display-name $display_name --placement-configurations file://placement-configurations.json --size $size --query data.id --raw-output)
+       virtual_node_pool_id=$(oci ce virtual-node-pool create --cluster-id $cluster_id --compartment-id $compartment_id --display-name $display_name --placement-configurations file://placement-configurations.json --pod-configuration file://pod-configuration.json --size $size --query data.id --raw-output)
 
        oci ce virtual-node-pool get --virtual-node-pool-id $virtual_node_pool_id

oci_cli/help_text_producer/data_files/text/cmdref/ce/virtual-node-pool/list-virtual-nodes.txt

@@ -126,6 +126,7 @@ Copy and paste the following example into a JSON file, replacing the
 example parameters with your own.
 
        oci ce virtual-node-pool create --generate-param-json-input placement-configurations > placement-configurations.json
+       oci ce virtual-node-pool create --generate-param-json-input pod-configuration > pod-configuration.json
 
 Copy the following CLI commands into a file named example.sh. Run the
 command by typing “bash example.sh” and replacing the example
@@ -144,6 +145,6 @@ security policies before trying the examples.
 
        cluster_id=$(oci ce cluster create --compartment-id $compartment_id --kubernetes-version $kubernetes_version --name $name --vcn-id $vcn_id --query data.id --raw-output)
 
-       virtual_node_pool_id=$(oci ce virtual-node-pool create --cluster-id $cluster_id --compartment-id $compartment_id --display-name $display_name --placement-configurations file://placement-configurations.json --size $size --query data.id --raw-output)
+       virtual_node_pool_id=$(oci ce virtual-node-pool create --cluster-id $cluster_id --compartment-id $compartment_id --display-name $display_name --placement-configurations file://placement-configurations.json --pod-configuration file://pod-configuration.json --size $size --query data.id --raw-output)
 
        oci ce virtual-node-pool list-virtual-nodes --virtual-node-pool-id $virtual_node_pool_id

oci_cli/help_text_producer/data_files/text/cmdref/ce/virtual-node-pool/update.txt

@@ -250,6 +250,7 @@ Copy and paste the following example into a JSON file, replacing the
 example parameters with your own.
 
        oci ce virtual-node-pool create --generate-param-json-input placement-configurations > placement-configurations.json
+       oci ce virtual-node-pool create --generate-param-json-input pod-configuration > pod-configuration.json
 
 Copy the following CLI commands into a file named example.sh. Run the
 command by typing “bash example.sh” and replacing the example
@@ -268,6 +269,6 @@ security policies before trying the examples.
 
        cluster_id=$(oci ce cluster create --compartment-id $compartment_id --kubernetes-version $kubernetes_version --name $name --vcn-id $vcn_id --query data.id --raw-output)
 
-       virtual_node_pool_id=$(oci ce virtual-node-pool create --cluster-id $cluster_id --compartment-id $compartment_id --display-name $display_name --placement-configurations file://placement-configurations.json --size $size --query data.id --raw-output)
+       virtual_node_pool_id=$(oci ce virtual-node-pool create --cluster-id $cluster_id --compartment-id $compartment_id --display-name $display_name --placement-configurations file://placement-configurations.json --pod-configuration file://pod-configuration.json --size $size --query data.id --raw-output)
 
        oci ce virtual-node-pool update --virtual-node-pool-id $virtual_node_pool_id

oci_cli/help_text_producer/data_files/text/cmdref/compute/compute-host/apply-host-configuration.txt

@@ -0,0 +1,127 @@
+"apply-host-configuration"
+**************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Triggers the asynchronous process that applies the host’s target
+configuration
+
+
+Usage
+=====
+
+   oci compute compute-host apply-host-configuration [OPTIONS]
+
+
+Required Parameters
+===================
+
+--compute-host-id [text]
+
+The OCID of the compute host.
+
+
+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 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:
+
+   AVAILABLE, OCCUPIED, PROVISIONING, REPAIR, UNAVAILABLE
+
+--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 compute_host_id=<substitute-value-of-compute_host_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/compute/compute-host/apply-host-configuration.html#cmdoption-compute-host-id
+
+       oci compute compute-host apply-host-configuration --compute-host-id $compute_host_id

oci_cli/help_text_producer/data_files/text/cmdref/compute/compute-host/check-host-configuration.txt

@@ -0,0 +1,127 @@
+"check-host-configuration"
+**************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Marks the host to be checked for conformance to its target
+configuration
+
+
+Usage
+=====
+
+   oci compute compute-host check-host-configuration [OPTIONS]
+
+
+Required Parameters
+===================
+
+--compute-host-id [text]
+
+The OCID of the compute host.
+
+
+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 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:
+
+   AVAILABLE, OCCUPIED, PROVISIONING, REPAIR, UNAVAILABLE
+
+--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 compute_host_id=<substitute-value-of-compute_host_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/compute/compute-host/check-host-configuration.html#cmdoption-compute-host-id
+
+       oci compute compute-host check-host-configuration --compute-host-id $compute_host_id