oci-cli 3.64.0__py3-none-any.whl → 3.65.0__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/{service-mesh → kafka}/work-request/list.txt

@@ -5,8 +5,6 @@
 
 * Usage
 
-* Required Parameters
-
 * Optional Parameters
 
 * Global Parameters
@@ -23,15 +21,7 @@ Lists the work requests in a compartment.
 Usage
 =====
 
-   oci service-mesh work-request list [OPTIONS]
-
-
-Required Parameters
-===================
-
---compartment-id, -c [text]
-
-The ID of the compartment in which to list resources.
+   oci kafka work-request list [OPTIONS]
 
 
 Optional Parameters
@@ -42,6 +32,10 @@ Optional Parameters
 Fetches all pages of results. If you provide this option, then you
 cannot provide the "--limit" option.
 
+--compartment-id, -c [text]
+
+The OCID of the compartment in which to list resources.
+
 --from-json [text]
 
 Provide input to this command as a JSON document from a file using the
@@ -66,22 +60,15 @@ nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
 
 --limit [integer]
 
-The maximum number of items to return.
-
---operation-status [text]
-
-A filter to return only resources that match the operation status
-given.
-
-Accepted values are:
-
-   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
+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]
 
-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.
+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]
 
@@ -90,12 +77,12 @@ valid when used with "--all" or "--limit", and ignored otherwise.
 
 --resource-id [text]
 
-A filter to return work requests that match the given resourceId.
+The OCID of the resource affected by the work request.
 
 --sort-by [text]
 
 The field to sort by. Only one sort order may be provided. Default
-order for timeAccepted is descending.
+order for *timeAccepted* is descending.
 
 Accepted values are:
 
@@ -103,15 +90,25 @@ Accepted values are:
 
 --sort-order [text]
 
-The sort order to use, either ‘ASC’ or ‘DESC’.
+The sort order to use, either ascending (*ASC*) or descending
+(*DESC*).
 
 Accepted values are:
 
    ASC, DESC
 
+--status [text]
+
+A filter to return only the resources that match the given lifecycle
+state.
+
+Accepted values are:
+
+   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
+
 --work-request-id [text]
 
-The ID of the asynchronous work request.
+The OCID of the asynchronous work request.
 
 
 Global Parameters
@@ -140,6 +137,4 @@ 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/service-mesh/work-request/list.html#cmdoption-compartment-id
-
-       oci service-mesh work-request list --compartment-id $compartment_id
+       oci kafka work-request list

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

@@ -0,0 +1,131 @@
+"list"
+******
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Lists the errors for a work request.
+
+
+Usage
+=====
+
+   oci kafka work-request-error list [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 *timestamp* is descending.
+
+Accepted values are:
+
+   timestamp
+
+--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", "--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/kafka/work-request-error/list.html#cmdoption-work-request-id
+
+       oci kafka work-request-error list --work-request-id $work_request_id

oci_cli/help_text_producer/data_files/text/cmdref/{anomaly-detection → kafka}/work-request-error.txt

@@ -5,7 +5,8 @@ work-request-error
 Description
 ===========
 
-An error encountered while executing a work request.
+An error encountered while performing an operation that is tracked by
+a work request.
 
 
 Available Commands

oci_cli/help_text_producer/data_files/text/cmdref/{service-mesh/work-request → kafka/work-request-log-entry}/list-work-request-logs.txt

@@ -17,13 +17,13 @@
 Description
 ===========
 
-Return a (paginated) list of logs for a given work request.
+Lists the logs for a work request.
 
 
 Usage
 =====
 
-   oci service-mesh work-request list-work-request-logs [OPTIONS]
+   oci kafka work-request-log-entry list-work-request-logs [OPTIONS]
 
 
 Required Parameters
@@ -31,7 +31,7 @@ Required Parameters
 
 --work-request-id [text]
 
-The ID of the asynchronous request.
+The OCID of the asynchronous work request.
 
 
 Optional Parameters
@@ -66,13 +66,15 @@ nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
 
 --limit [integer]
 
-The maximum number of items to return.
+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]
 
-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.
+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]
 
@@ -82,7 +84,7 @@ 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 timestamp is descending.
+order for *timestamp* is descending.
 
 Accepted values are:
 
@@ -90,7 +92,8 @@ Accepted values are:
 
 --sort-order [text]
 
-The sort order to use, either ‘ASC’ or ‘DESC’.
+The sort order to use, either ascending (*ASC*) or descending
+(*DESC*).
 
 Accepted values are:
 
@@ -123,6 +126,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/service-mesh/work-request/list-work-request-logs.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/kafka/work-request-log-entry/list-work-request-logs.html#cmdoption-work-request-id
 
-       oci service-mesh work-request list-work-request-logs --work-request-id $work_request_id
+       oci kafka work-request-log-entry list-work-request-logs --work-request-id $work_request_id

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

@@ -0,0 +1,23 @@
+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
+==================
+
+* cancel
+
+* get
+
+* list

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

@@ -0,0 +1,69 @@
+kafka
+*****
+
+
+Description
+===========
+
+Use Oracle Streaming with Apache Kafka Control Plane CLI to
+create/update/delete managed Kafka clusters.
+
+
+Available Commands
+==================
+
+* cluster
+
+  * change-compartment
+
+  * create
+
+  * delete
+
+  * disable-superuser
+
+  * enable-superuser
+
+  * get
+
+  * list
+
+  * update
+
+* cluster-config
+
+  * change-compartment
+
+  * create
+
+  * delete
+
+  * get
+
+  * list
+
+  * update
+
+* cluster-config-version
+
+  * delete
+
+  * get
+
+  * list
+
+* work-request
+
+  * cancel
+
+  * get
+
+  * list
+
+* work-request-error
+
+  * list
+
+* work-request-log-entry
+
+  * list-work-request-logs

oci_cli/help_text_producer/data_files/text/cmdref/lfs/lustre-file-system.txt

@@ -7,7 +7,7 @@ Description
 
 A Lustre file system is a parallel file system that is used as a
 storage solution for HPC/AI/ML workloads. For more information, see
-File Storage with Lustre.
+[File Storage with Lustre].
 
 To use any of the API operations, you must be authorized in an IAM
 policy. If you’re not authorized, talk to an administrator. If you’re

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

@@ -6,7 +6,8 @@ Description
 ===========
 
 Use the File Storage with Lustre CLI to manage Lustre file systems and
-related resources. For more information, see File Storage with Lustre.
+related resources. For more information, see [File Storage with
+Lustre].
 
 
 Available Commands

oci_cli/help_text_producer/data_files/text/cmdref/network/ipv6/create.txt

@@ -27,6 +27,10 @@ Usage
 Optional Parameters
 ===================
 
+--cidr-prefix-length [integer]
+
+Length of cidr range. Optional field to specify flexible cidr.
+
 --defined-tags [complex type]
 
 Defined tags for this resource. Each key is predefined and scoped to a

oci_cli/help_text_producer/data_files/text/cmdref/network/vnic/assign-ipv6.txt

@@ -27,6 +27,10 @@ Usage
 Optional Parameters
 ===================
 
+--cidr-prefix-length [integer]
+
+Length of cidr range. Optional field to specify flexible cidr.
+
 --defined-tags [complex type]
 
 Defined tags for this resource. Each key is predefined and scoped to a

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

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

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

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

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

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

oci_cli/help_text_producer/data_files/text/cmdref/support/incident/create.txt

@@ -45,10 +45,10 @@ provide the results of those.
 --problem-type [text]
 
 The kind of support request (type of support request). For information
-about *ACCOUNT* support requests, see Creating a Billing Support
-Request. For information about *LIMIT* support requests, see Creating
-a Service Limit Increase Request. For information about *TECH* support
-requests, see Creating a Technical Support Request.
+about *ACCOUNT* support requests, see [Creating a Billing Support
+Request]. For information about *LIMIT* support requests, see
+[Creating a Service Limit Increase Request]. For information about
+*TECH* support requests, see [Creating a Technical Support Request].
 
 Accepted values are:
 
@@ -150,9 +150,9 @@ used when creating the support request.
 
 Technical support type (*TECH*) only: Identifier of the user group to
 assign the new support request to. To find identifiers of user groups
-that you have access to, run the ValidateUser operation. Note: The
+that you have access to, run the [ValidateUser] operation. Note: The
 Customer User Administrator (CUA) can manage user groups by name using
-My Oracle Cloud Support portal.
+[My Oracle Cloud Support portal].
 
 
 Global Parameters

oci_cli/help_text_producer/data_files/text/cmdref/support/incident/get.txt

@@ -15,8 +15,8 @@
 Description
 ===========
 
-Gets the specified support request. For more information, see Getting
-Details for a Support Request.
+Gets the specified support request. For more information, see [Getting
+Details for a Support Request].
 
 
 Usage

oci_cli/help_text_producer/data_files/text/cmdref/support/incident/list.txt

@@ -16,7 +16,7 @@ Description
 ===========
 
 Lists support requests for the specified tenancy. For more
-information, see Listing Support Requests.
+information, see [Listing Support Requests].
 
 
 Usage

oci_cli/help_text_producer/data_files/text/cmdref/support/incident/update.txt

@@ -132,10 +132,10 @@ mandatory for OCI Users and optional for Multicloud users.
 --problem-type [text]
 
 The kind of support request (type of support request). For information
-about *ACCOUNT* support requests, see Creating a Billing Support
-Request. For information about *LIMIT* support requests, see Creating
-a Service Limit Increase Request. For information about *TECH* support
-requests, see Creating a Technical Support Request.
+about *ACCOUNT* support requests, see [Creating a Billing Support
+Request]. For information about *LIMIT* support requests, see
+[Creating a Service Limit Increase Request]. For information about
+*TECH* support requests, see [Creating a Technical Support Request].
 
 Accepted values are:
 

oci_cli/help_text_producer/data_files/text/cmdref/support/incident-resource-type/list.txt

@@ -20,9 +20,9 @@ products (service groups, services, service categories, and
 subcategories) for technical support requests or lists limits and
 current usage for limit increase tickets. This operation is called
 during creation of technical support and limit increase tickets. For
-more information about listing products, see Listing Products for
-Support Requests. For more information about listing limits, see
-Listing Limits for Service Limit Increase Requests.
+more information about listing products, see [Listing Products for
+Support Requests]. For more information about listing limits, see
+[Listing Limits for Service Limit Increase Requests].
 
 
 Usage

oci_cli/help_text_producer/data_files/text/cmdref/support/validation-response/validate-user.txt

@@ -14,7 +14,7 @@ Description
 ===========
 
 Checks whether the requested user is valid. For more information, see
-Validating a User.
+[Validating a User].
 
 
 Usage