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/resource-analytics/work-request/get.txt

@@ -0,0 +1,91 @@
+"get"
+*****
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Gets the details of a work request.
+
+
+Usage
+=====
+
+   oci resource-analytics work-request get [OPTIONS]
+
+
+Required Parameters
+===================
+
+--work-request-id [text]
+
+The OCID of the asynchronous work request.
+
+
+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
+
+
+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/resource-analytics/work-request/get.html#cmdoption-work-request-id
+
+       oci resource-analytics work-request get --work-request-id $work_request_id

oci_cli/help_text_producer/data_files/text/cmdref/resource-analytics/work-request/list.txt

@@ -0,0 +1,140 @@
+"list"
+******
+
+* Description
+
+* Usage
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Lists the work requests in a compartment.
+
+
+Usage
+=====
+
+   oci resource-analytics work-request list [OPTIONS]
+
+
+Optional Parameters
+===================
+
+--all
+
+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
+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.
+
+--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 may be provided. Default
+order for *timeAccepted* is descending.
+
+Accepted values are:
+
+   timeAccepted
+
+--sort-order [text]
+
+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 OCID of the asynchronous work request.
+
+
+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.
+
+       oci resource-analytics work-request list

oci_cli/help_text_producer/data_files/text/cmdref/resource-analytics/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 resource-analytics 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/resource-analytics/work-request-error/list.html#cmdoption-work-request-id
+
+       oci resource-analytics work-request-error list --work-request-id $work_request_id

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

@@ -0,0 +1,15 @@
+work-request-error
+******************
+
+
+Description
+===========
+
+An error encountered while performing an operation that is tracked by
+a work request.
+
+
+Available Commands
+==================
+
+* list

oci_cli/help_text_producer/data_files/text/cmdref/resource-analytics/work-request-log-entry/list.txt

@@ -0,0 +1,131 @@
+"list"
+******
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Lists the logs for a work request.
+
+
+Usage
+=====
+
+   oci resource-analytics work-request-log-entry 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/resource-analytics/work-request-log-entry/list.html#cmdoption-work-request-id
+
+       oci resource-analytics work-request-log-entry list --work-request-id $work_request_id

oci_cli/help_text_producer/data_files/text/cmdref/resource-analytics/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

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

@@ -0,0 +1,68 @@
+resource-analytics
+******************
+
+
+Description
+===========
+
+Use the Resource Analytics CLI to manage Resource Analytics Instances.
+
+
+Available Commands
+==================
+
+* monitored-region
+
+  * create
+
+  * delete
+
+  * get
+
+  * list
+
+* resource-analytics-instance
+
+  * change-compartment
+
+  * create
+
+  * delete
+
+  * disable-oac
+
+  * enable-oac
+
+  * get
+
+  * list
+
+  * update
+
+* tenancy-attachment
+
+  * create
+
+  * delete
+
+  * get
+
+  * list
+
+  * update
+
+* work-request
+
+  * cancel
+
+  * get
+
+  * list
+
+* work-request-error
+
+  * list
+
+* work-request-log-entry
+
+  * list

oci_cli/help_text_producer/data_files/text/cmdref/session/authenticate.txt

@@ -56,13 +56,13 @@ singapore-1,me-abudhabi-1,eu-milan-1,eu-stockholm-1,af-johannesburg-1
 saltlake-2,sa-bogota-1,sa-valparaiso-1,ap-singapore-2,me-riyadh-1,ap-
 delhi-1,ap-batam-1,us-langley-1,us-luke-1,us-gov-ashburn-1,us-gov-
 chicago-1,us-gov-phoenix-1,uk-gov-london-1,uk-gov-cardiff-1,ap-
-chiyoda-1,ap-ibaraki-1,me-dcc-muscat-1,ap-dcc-canberra-1,eu-dcc-
-milan-1,eu-dcc-milan-2,eu-dcc-dublin-2,eu-dcc-rating-2,eu-dcc-rating-1
-,eu-dcc-dublin-1,ap-dcc-gazipur-1,eu-madrid-2,eu-frankfurt-2,eu-
-jovanovac-1,me-dcc-doha-1,us-somerset-1,us-thames-1,eu-dcc-zurich-1
-,eu-crissier-1,me-abudhabi-3,me-alain-1,me-abudhabi-2,me-abudhabi-4
-,ap-seoul-2,ap-suwon-1,ap-chuncheon-2,us-ashburn-2,us-newark-1,eu-
-budapest-1
+chiyoda-1,ap-ibaraki-1,me-dcc-muscat-1,me-ibri-1,ap-dcc-canberra-1,eu-
+dcc-milan-1,eu-dcc-milan-2,eu-dcc-dublin-2,eu-dcc-rating-2,eu-dcc-
+rating-1,eu-dcc-dublin-1,ap-dcc-gazipur-1,eu-madrid-2,eu-frankfurt-2
+,eu-jovanovac-1,me-dcc-doha-1,us-somerset-1,us-thames-1,eu-dcc-
+zurich-1,eu-crissier-1,me-abudhabi-3,me-alain-1,me-abudhabi-2,me-
+abudhabi-4,ap-seoul-2,ap-suwon-1,ap-chuncheon-2,us-ashburn-2,us-
+newark-1,eu-budapest-1
 
 --session-expiration-in-minutes [text]
 

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