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/generative-ai/generative-ai-private-endpoint-collection/list-generative-ai-private-endpoints.txt

@@ -0,0 +1,147 @@
+"list-generative-ai-private-endpoints"
+**************************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Lists all Generative AI private endpoints in the specified
+compartment.
+
+
+Usage
+=====
+
+   oci generative-ai generative-ai-private-endpoint-collection list-generative-ai-private-endpoints [OPTIONS]
+
+
+Required Parameters
+===================
+
+--compartment-id, -c [text]
+
+The OCID of the compartment in which to list resources.
+
+
+Optional Parameters
+===================
+
+--all
+
+Fetches all pages of results. If you provide this option, then you
+cannot provide the "--limit" option.
+
+--display-name [text]
+
+A filter to return only resources that match the given display name
+exactly.
+
+--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
+
+--id [text]
+
+The OCID of the private endpoint.
+
+--lifecycle-state [text]
+
+The lifecycle state of Generative AI private endpoints.
+
+Accepted values are:
+
+   ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING
+
+--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 used to sort the results. Multiple fields aren’t supported.
+
+Accepted values are:
+
+   timeCreated
+
+--sort-order [text]
+
+The sort order to use, either ‘ASC’ or ‘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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/generative-ai/generative-ai-private-endpoint-collection/list-generative-ai-private-endpoints.html#cmdoption-compartment-id
+
+       oci generative-ai generative-ai-private-endpoint-collection list-generative-ai-private-endpoints --compartment-id $compartment_id

oci_cli/help_text_producer/data_files/text/cmdref/generative-ai/generative-ai-private-endpoint-collection.txt

@@ -0,0 +1,14 @@
+generative-ai-private-endpoint-collection
+*****************************************
+
+
+Description
+===========
+
+Collection of GenerativeAiPrivateEndpointSummary
+
+
+Available Commands
+==================
+
+* list-generative-ai-private-endpoints

oci_cli/help_text_producer/data_files/text/cmdref/generative-ai/generative-ai-private-endpoint.txt

@@ -0,0 +1,22 @@
+generative-ai-private-endpoint
+******************************
+
+
+Description
+===========
+
+Generative AI private endpoint.
+
+
+Available Commands
+==================
+
+* change-compartment
+
+* create
+
+* delete
+
+* get
+
+* update

oci_cli/help_text_producer/data_files/text/cmdref/generative-ai.txt

@@ -59,6 +59,22 @@ Available Commands
 
   * list-endpoints
 
+* generative-ai-private-endpoint
+
+  * change-compartment
+
+  * create
+
+  * delete
+
+  * get
+
+  * update
+
+* generative-ai-private-endpoint-collection
+
+  * list-generative-ai-private-endpoints
+
 * model
 
   * change-compartment

oci_cli/help_text_producer/data_files/text/cmdref/governance-rules-control-plane/work-request/work-request-error/{list.txt → list-errors.txt}

@@ -1,5 +1,5 @@
-"list"
-******
+"list-errors"
+*************
 
 * Description
 
@@ -24,7 +24,7 @@ given ID.
 Usage
 =====
 
-   oci governance-rules-control-plane work-request work-request-error list [OPTIONS]
+   oci governance-rules-control-plane work-request work-request-error list-errors [OPTIONS]
 
 
 Required Parameters
@@ -124,6 +124,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/governance-rules-control-plane/work-request/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/governance-rules-control-plane/work-request/work-request-error/list-errors.html#cmdoption-work-request-id
 
-       oci governance-rules-control-plane work-request work-request-error list --work-request-id $work_request_id
+       oci governance-rules-control-plane work-request work-request-error list-errors --work-request-id $work_request_id

oci_cli/help_text_producer/data_files/text/cmdref/governance-rules-control-plane/work-request/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/governance-rules-control-plane/work-request/{work-request-log-entry/list-work-request-logs.txt → work-request-log/list.txt}

@@ -1,5 +1,5 @@
-"list-work-request-logs"
-************************
+"list"
+******
 
 * Description
 
@@ -24,7 +24,7 @@ ID.
 Usage
 =====
 
-   oci governance-rules-control-plane work-request work-request-log-entry list-work-request-logs [OPTIONS]
+   oci governance-rules-control-plane work-request work-request-log list [OPTIONS]
 
 
 Required Parameters
@@ -124,6 +124,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/governance-rules-control-plane/work-request/work-request-log-entry/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/governance-rules-control-plane/work-request/work-request-log/list.html#cmdoption-work-request-id
 
-       oci governance-rules-control-plane work-request work-request-log-entry list-work-request-logs --work-request-id $work_request_id
+       oci governance-rules-control-plane work-request work-request-log list --work-request-id $work_request_id

oci_cli/help_text_producer/data_files/text/cmdref/governance-rules-control-plane/work-request/work-request-log.txt

@@ -0,0 +1,14 @@
+work-request-log
+****************
+
+
+Description
+===========
+
+A log message from the execution of a work request.
+
+
+Available Commands
+==================
+
+* list

oci_cli/help_text_producer/data_files/text/cmdref/governance-rules-control-plane/work-request.txt

@@ -21,8 +21,8 @@ Available Commands
 
 * work-request-error
 
-  * list
+  * list-errors
 
-* work-request-log-entry
+* work-request-log
 
-  * list-work-request-logs
+  * list

oci_cli/help_text_producer/data_files/text/cmdref/governance-rules-control-plane.txt

@@ -77,8 +77,8 @@ Available Commands
 
   * work-request-error
 
-    * list
+    * list-errors
 
-  * work-request-log-entry
+  * work-request-log
 
-    * list-work-request-logs
+    * list

oci_cli/help_text_producer/data_files/text/cmdref/jms/agent-installer-summary/generate-agent-installer-configuration.txt

@@ -48,6 +48,14 @@ configuration file.
 Optional Parameters
 ===================
 
+--agent-type [text]
+
+The JMS plugin type.
+
+Accepted values are:
+
+   OCA, OCMA, OMA
+
 --from-json [text]
 
 Provide input to this command as a JSON document from a file using the

oci_cli/help_text_producer/data_files/text/cmdref/jms/blocklist/create.txt

@@ -39,7 +39,7 @@ The operation type
 
 Accepted values are:
 
-   COLLECT_JFR, CREATE_DRS_FILE, CREATE_FLEET, CREATE_JAVA_INSTALLATION, DELETE_DRS_FILE, DELETE_FLEET, DELETE_JAVA_INSTALLATION, DELETE_JMS_REPORT, DISABLE_DRS, ENABLE_DRS, EXPORT_DATA_CSV, MOVE_FLEET, REQUEST_CRYPTO_EVENT_ANALYSIS, REQUEST_JAVA_MIGRATION_ANALYSIS, REQUEST_PERFORMANCE_TUNING_ANALYSIS, SCAN_JAVA_SERVER_USAGE, SCAN_LIBRARY_USAGE, UPDATE_DRS_FILE, UPDATE_FLEET, UPDATE_FLEET_AGENT_CONFIGURATION
+   COLLECT_JFR, CREATE_DRS_FILE, CREATE_FLEET, CREATE_JAVA_INSTALLATION, DELETE_DRS_FILE, DELETE_FLEET, DELETE_JAVA_INSTALLATION, DELETE_JMS_REPORT, DISABLE_DRS, ENABLE_DRS, EXPORT_DATA_CSV, MOVE_FLEET, REQUEST_CRYPTO_EVENT_ANALYSIS, REQUEST_JAVA_MIGRATION_ANALYSIS, REQUEST_PERFORMANCE_TUNING_ANALYSIS, SCAN_JAVA_SERVER_USAGE, SCAN_LIBRARY_DYNAMIC_USAGE, SCAN_LIBRARY_USAGE, UPDATE_DRS_FILE, UPDATE_FLEET, UPDATE_FLEET_AGENT_CONFIGURATION
 
 --target [complex type]
 

oci_cli/help_text_producer/data_files/text/cmdref/jms/blocklist/list.txt

@@ -78,7 +78,7 @@ The operation type.
 
 Accepted values are:
 
-   COLLECT_JFR, CREATE_DRS_FILE, CREATE_FLEET, CREATE_JAVA_INSTALLATION, DELETE_DRS_FILE, DELETE_FLEET, DELETE_JAVA_INSTALLATION, DELETE_JMS_REPORT, DISABLE_DRS, ENABLE_DRS, EXPORT_DATA_CSV, MOVE_FLEET, REQUEST_CRYPTO_EVENT_ANALYSIS, REQUEST_JAVA_MIGRATION_ANALYSIS, REQUEST_PERFORMANCE_TUNING_ANALYSIS, SCAN_JAVA_SERVER_USAGE, SCAN_LIBRARY_USAGE, UPDATE_DRS_FILE, UPDATE_FLEET, UPDATE_FLEET_AGENT_CONFIGURATION
+   COLLECT_JFR, CREATE_DRS_FILE, CREATE_FLEET, CREATE_JAVA_INSTALLATION, DELETE_DRS_FILE, DELETE_FLEET, DELETE_JAVA_INSTALLATION, DELETE_JMS_REPORT, DISABLE_DRS, ENABLE_DRS, EXPORT_DATA_CSV, MOVE_FLEET, REQUEST_CRYPTO_EVENT_ANALYSIS, REQUEST_JAVA_MIGRATION_ANALYSIS, REQUEST_PERFORMANCE_TUNING_ANALYSIS, SCAN_JAVA_SERVER_USAGE, SCAN_LIBRARY_DYNAMIC_USAGE, SCAN_LIBRARY_USAGE, UPDATE_DRS_FILE, UPDATE_FLEET, UPDATE_FLEET_AGENT_CONFIGURATION
 
 --page [text]
 

oci_cli/help_text_producer/data_files/text/cmdref/jms/container-summary/list-containers.txt

@@ -0,0 +1,338 @@
+"list-containers"
+*****************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+List containers in a fleet filtered by query parameters.
+
+
+Usage
+=====
+
+   oci jms container-summary list-containers [OPTIONS]
+
+
+Required Parameters
+===================
+
+--fleet-id [text]
+
+The OCID of the Fleet.
+
+
+Optional Parameters
+===================
+
+--all
+
+Fetches all pages of results. If you provide this option, then you
+cannot provide the "--limit" option.
+
+--application-name [text]
+
+The name of the application.
+
+--display-name [text]
+
+The display name.
+
+--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
+
+--jre-security-status [text]
+
+The security status of the Java Runtime.
+
+Accepted values are:
+
+   EARLY_ACCESS, UNKNOWN, UPDATE_REQUIRED, UPGRADE_REQUIRED, UP_TO_DATE
+
+--jre-version [text]
+
+The version of the related Java Runtime.
+
+--limit [integer]
+
+The maximum number of items to return.
+
+--managed-instance-id [text]
+
+The Fleet-unique identifier of the managed instance.
+
+--page [text]
+
+The page token representing the page at which to start retrieving
+results. The token is usually retrieved from a previous list call.
+
+--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 the containers. Only one sort order can be provided.
+Default order for _displayName_, _namespace_, _podName_,
+_applicationName_, or _jreVersion_ is **ascending**. Default order for
+_timeStarted_ is **descending**. If no value is specified
+_timeStarted_ is default.
+
+Accepted values are:
+
+   applicationName, displayName, jreSecurityStatus, jreVersion, namespace, podName, timeStarted
+
+--sort-order [text]
+
+The sort order, either ‘asc’ or ‘desc’.
+
+Accepted values are:
+
+   ASC, DESC
+
+--time-started-greater-than-or-equal-to [datetime]
+
+If specified, only containers with a start time later than or equal to
+this parameter will be included in the response (formatted according
+to RFC3339).
+
+   The following datetime formats are supported:
+
+
+UTC with microseconds
+---------------------
+
+   Format: YYYY-MM-DDTHH:mm:ss.ssssssTZD
+   Example: 2017-09-15T20:30:00.123456Z
+
+   UTC with milliseconds
+   ***********************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mm:ss.sssTZD
+       Example: 2017-09-15T20:30:00.123Z
+
+   UTC without milliseconds
+   **************************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mm:ssTZD
+       Example: 2017-09-15T20:30:00Z
+
+   UTC with minute precision
+   **************************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mmTZD
+       Example: 2017-09-15T20:30Z
+
+
+Timezone with microseconds
+--------------------------
+
+   Format: YYYY-MM-DDTHH:mm:ssTZD
+   Example: 2017-09-15T12:30:00.456789-08:00, 2017-09-15T12:30:00.456789-0800
+
+   Timezone with milliseconds
+   ***************************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mm:ssTZD
+       Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800
+
+   Timezone without milliseconds
+   *******************************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mm:ssTZD
+       Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800
+
+   Timezone with minute precision
+   *******************************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mmTZD
+       Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800
+
+   Short date and time
+   ********************
+   The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes)
+
+   .. code::
+
+       Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
+       Example: '2017-09-15 17:25'
+
+   Date Only
+   **********
+   This date will be taken as midnight UTC of that day
+
+   .. code::
+
+       Format: YYYY-MM-DD
+       Example: 2017-09-15
+
+   Epoch seconds
+   **************
+   .. code::
+
+       Example: 1412195400
+
+--time-started-less-than-or-equal-to [datetime]
+
+If specified, only containers with a start time earlier than or equal
+to this parameter will be included in the response (formatted
+according to RFC3339).
+
+   The following datetime formats are supported:
+
+
+UTC with microseconds
+---------------------
+
+   Format: YYYY-MM-DDTHH:mm:ss.ssssssTZD
+   Example: 2017-09-15T20:30:00.123456Z
+
+   UTC with milliseconds
+   ***********************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mm:ss.sssTZD
+       Example: 2017-09-15T20:30:00.123Z
+
+   UTC without milliseconds
+   **************************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mm:ssTZD
+       Example: 2017-09-15T20:30:00Z
+
+   UTC with minute precision
+   **************************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mmTZD
+       Example: 2017-09-15T20:30Z
+
+
+Timezone with microseconds
+--------------------------
+
+   Format: YYYY-MM-DDTHH:mm:ssTZD
+   Example: 2017-09-15T12:30:00.456789-08:00, 2017-09-15T12:30:00.456789-0800
+
+   Timezone with milliseconds
+   ***************************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mm:ssTZD
+       Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800
+
+   Timezone without milliseconds
+   *******************************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mm:ssTZD
+       Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800
+
+   Timezone with minute precision
+   *******************************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mmTZD
+       Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800
+
+   Short date and time
+   ********************
+   The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes)
+
+   .. code::
+
+       Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
+       Example: '2017-09-15 17:25'
+
+   Date Only
+   **********
+   This date will be taken as midnight UTC of that day
+
+   .. code::
+
+       Format: YYYY-MM-DD
+       Example: 2017-09-15
+
+   Epoch seconds
+   **************
+   .. code::
+
+       Example: 1412195400
+
+
+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 jms fleet create --generate-param-json-input inventory-log > inventory-log.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/jms/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/jms/fleet/create.html#cmdoption-display-name
+
+       fleet_id=$(oci jms fleet create --compartment-id $compartment_id --display-name $display_name --inventory-log file://inventory-log.json --query data.id --raw-output)
+
+       oci jms container-summary list-containers --fleet-id $fleet_id