oci-cli 3.70.0__py3-none-any.whl → 3.70.1__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/dif/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 dif 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, CANCELLED, CANCELLING, 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 dif work-request list

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

@@ -17,13 +17,13 @@
 Description
 ===========
 
-Return a (paginated) list of logs for a given work request.
+Lists the errors for a work request.
 
 
 Usage
 =====
 
-   oci organizations work-request-log list [OPTIONS]
+   oci dif work-request-error list [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,21 +66,34 @@ 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]
 
-The page token representing the page at which to start retrieving
-results. This is usually retrieved from a previous list call.
+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, whether ‘asc’ or ‘desc’.
+The sort order to use, either ascending (*ASC*) or descending
+(*DESC*).
 
 Accepted values are:
 
@@ -113,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/organizations/work-request-log/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/dif/work-request-error/list.html#cmdoption-work-request-id
 
-       oci organizations work-request-log list --work-request-id $work_request_id
+       oci dif work-request-error list --work-request-id $work_request_id

oci_cli/help_text_producer/data_files/text/cmdref/dif/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/dif/work-request-log-entry/list-work-request-logs.txt

@@ -0,0 +1,131 @@
+"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 dif 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", "--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/dif/work-request-log-entry/list-work-request-logs.html#cmdoption-work-request-id
+
+       oci dif work-request-log-entry list-work-request-logs --work-request-id $work_request_id

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

@@ -0,0 +1,49 @@
+dif
+***
+
+
+Description
+===========
+
+Use the DataIntelligences Control Plane CLI to manage
+dataIntelligences.
+
+
+Available Commands
+==================
+
+* stack
+
+  * add
+
+  * change-compartment
+
+  * create
+
+  * delete
+
+  * deploy-artifacts
+
+  * get
+
+  * update
+
+* stack-collection
+
+  * list-stacks
+
+* 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/fleet-apps-management/compliance/get.txt

@@ -0,0 +1,99 @@
+"get"
+*****
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Retrieve compliance for a fleet.
+
+
+Usage
+=====
+
+   oci fleet-apps-management compliance get [OPTIONS]
+
+
+Required Parameters
+===================
+
+--fleet-id [text]
+
+Unique Fleet identifier.
+
+
+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 and paste the following example into a JSON file, replacing the
+example parameters with your own.
+
+       oci fleet-apps-management fleet create --generate-param-json-input resource-selection > resource-selection.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/fleet-apps-management/fleet/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/fleet-apps-management/fleet/create.html#cmdoption-display-name
+
+       fleet_id=$(oci fleet-apps-management fleet create --compartment-id $compartment_id --display-name $display_name --resource-selection file://resource-selection.json --query data.id --raw-output)
+
+       oci fleet-apps-management compliance get --fleet-id $fleet_id

oci_cli/help_text_producer/data_files/text/cmdref/fleet-apps-management/compliance.txt

@@ -0,0 +1,14 @@
+compliance
+**********
+
+
+Description
+===========
+
+Compliance Summary
+
+
+Available Commands
+==================
+
+* get

oci_cli/help_text_producer/data_files/text/cmdref/fleet-apps-management/fleet/create-fleet-dynamic-resource-selection.txt

@@ -178,10 +178,11 @@ The OCID of the fleet that would be the parent for this fleet.
 
 --products [complex type]
 
-Products associated with the Fleet. 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.
+Products associated with the Fleet. Provide PlatformConfiguration Ids
+corresponding to all the Products that need to be managed. 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

oci_cli/help_text_producer/data_files/text/cmdref/fleet-apps-management/fleet/create-fleet-environment-fleet-details.txt

@@ -167,10 +167,11 @@ The OCID of the fleet that would be the parent for this fleet.
 
 --products [complex type]
 
-Products associated with the Fleet. 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.
+Products associated with the Fleet. Provide PlatformConfiguration Ids
+corresponding to all the Products that need to be managed. 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

oci_cli/help_text_producer/data_files/text/cmdref/fleet-apps-management/fleet/create-fleet-generic-fleet-details.txt

@@ -167,10 +167,11 @@ The OCID of the fleet that would be the parent for this fleet.
 
 --products [complex type]
 
-Products associated with the Fleet. 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.
+Products associated with the Fleet. Provide PlatformConfiguration Ids
+corresponding to all the Products that need to be managed. 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

oci_cli/help_text_producer/data_files/text/cmdref/fleet-apps-management/fleet/create-fleet-group-fleet-details.txt

@@ -167,10 +167,11 @@ The OCID of the fleet that would be the parent for this fleet.
 
 --products [complex type]
 
-Products associated with the Fleet. 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.
+Products associated with the Fleet. Provide PlatformConfiguration Ids
+corresponding to all the Products that need to be managed. 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

oci_cli/help_text_producer/data_files/text/cmdref/fleet-apps-management/fleet/create-fleet-manual-resource-selection.txt

@@ -167,10 +167,11 @@ The OCID of the fleet that would be the parent for this fleet.
 
 --products [complex type]
 
-Products associated with the Fleet. 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.
+Products associated with the Fleet. Provide PlatformConfiguration Ids
+corresponding to all the Products that need to be managed. 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

oci_cli/help_text_producer/data_files/text/cmdref/fleet-apps-management/fleet/create-fleet-product-fleet-details.txt

@@ -167,10 +167,11 @@ The OCID of the fleet that would be the parent for this fleet.
 
 --products [complex type]
 
-Products associated with the Fleet. 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.
+Products associated with the Fleet. Provide PlatformConfiguration Ids
+corresponding to all the Products that need to be managed. 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