oci-cli 3.62.2__py3-none-any.whl → 3.63.1__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/database-management/cloud-listener/list-cloud-listener-services.txt

@@ -0,0 +1,139 @@
+"list-cloud-listener-services"
+******************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Lists the database services registered with the specified cloud
+listener for the specified Managed Database.
+
+
+Usage
+=====
+
+   oci database-management cloud-listener list-cloud-listener-services [OPTIONS]
+
+
+Required Parameters
+===================
+
+--cloud-listener-id [text]
+
+The OCID of the cloud listener.
+
+--managed-database-id [text]
+
+The OCID of the Managed Database.
+
+
+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]
+
+The maximum number of records returned in the paginated response.
+
+--opc-named-credential-id [text]
+
+The OCID of the Named Credential.
+
+--page [text]
+
+The page token representing the page from where the next set of
+paginated results are retrieved. This 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 information by. Only one sortOrder can be used. The
+default sort order for *NAME* is ascending and it is case-sensitive.
+
+Accepted values are:
+
+   NAME
+
+--sort-order [text]
+
+The option to sort information in ascending (‘ASC’) or descending
+(‘DESC’) order. Ascending order is the default order.
+
+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 cloud_listener_id=<substitute-value-of-cloud_listener_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/cloud-listener/list-cloud-listener-services.html#cmdoption-cloud-listener-id
+       export managed_database_id=<substitute-value-of-managed_database_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/cloud-listener/list-cloud-listener-services.html#cmdoption-managed-database-id
+
+       oci database-management cloud-listener list-cloud-listener-services --cloud-listener-id $cloud_listener_id --managed-database-id $managed_database_id

oci_cli/help_text_producer/data_files/text/cmdref/database-management/cloud-listener/list.txt

@@ -0,0 +1,132 @@
+"list"
+******
+
+* Description
+
+* Usage
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Lists the listeners in the specified cloud DB system.
+
+
+Usage
+=====
+
+   oci database-management cloud-listener list [OPTIONS]
+
+
+Optional Parameters
+===================
+
+--all
+
+Fetches all pages of results. If you provide this option, then you
+cannot provide the "--limit" option.
+
+--cloud-db-system-id [text]
+
+The OCID of the cloud DB system.
+
+--compartment-id, -c [text]
+
+The OCID of the compartment.
+
+--display-name [text]
+
+A filter to only return the resources that match the entire 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
+
+--limit [integer]
+
+The maximum number of records returned in the paginated response.
+
+--page [text]
+
+The page token representing the page from where the next set of
+paginated results are retrieved. This 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 information by. Only one sortOrder can be used. The
+default sort order for *TIMECREATED* is descending and the default
+sort order for *DISPLAYNAME* is ascending. The *DISPLAYNAME* sort
+order is case-sensitive.
+
+Accepted values are:
+
+   DISPLAYNAME, TIMECREATED
+
+--sort-order [text]
+
+The option to sort information in ascending (‘ASC’) or descending
+(‘DESC’) order. Ascending order is the default order.
+
+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.
+
+       oci database-management cloud-listener list

oci_cli/help_text_producer/data_files/text/cmdref/database-management/cloud-listener/summarize-cloud-listener-metrics.txt

@@ -0,0 +1,121 @@
+"summarize-cloud-listener-metrics"
+**********************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Gets metrics for the cloud listener specified by *cloudListenerId*.
+
+
+Usage
+=====
+
+   oci database-management cloud-listener summarize-cloud-listener-metrics [OPTIONS]
+
+
+Required Parameters
+===================
+
+--cloud-listener-id [text]
+
+The OCID of the cloud listener.
+
+--end-time [text]
+
+The end of the time range set to retrieve metric data for the DB
+system and its members. Expressed in UTC in ISO-8601 format, which is
+*yyyy-MM-dd’T’hh:mm:ss.sss’Z’*.
+
+--start-time [text]
+
+The beginning of the time range set to retrieve metric data for the DB
+system and its members. Expressed in UTC in ISO-8601 format, which is
+*yyyy-MM-dd’T’hh:mm:ss.sss’Z’*.
+
+
+Optional Parameters
+===================
+
+--filter-by-metric-names [text]
+
+The filter used to retrieve a specific set of metrics by passing the
+desired metric names with a comma separator. Note that, by default,
+the service returns all supported metrics.
+
+--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]
+
+The maximum number of records returned in the paginated response.
+
+--page [text]
+
+The page token representing the page from where the next set of
+paginated results are retrieved. This is usually retrieved from a
+previous list call.
+
+
+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 cloud_listener_id=<substitute-value-of-cloud_listener_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/cloud-listener/summarize-cloud-listener-metrics.html#cmdoption-cloud-listener-id
+       export end_time=<substitute-value-of-end_time> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/cloud-listener/summarize-cloud-listener-metrics.html#cmdoption-end-time
+       export start_time=<substitute-value-of-start_time> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/cloud-listener/summarize-cloud-listener-metrics.html#cmdoption-start-time
+
+       oci database-management cloud-listener summarize-cloud-listener-metrics --cloud-listener-id $cloud_listener_id --end-time $end_time --start-time $start_time

oci_cli/help_text_producer/data_files/text/cmdref/database-management/cloud-listener/update.txt

@@ -0,0 +1,161 @@
+"update"
+********
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Updates the cloud listener specified by *cloudListenerId*.
+
+
+Usage
+=====
+
+   oci database-management cloud-listener update [OPTIONS]
+
+
+Required Parameters
+===================
+
+--cloud-listener-id [text]
+
+The OCID of the cloud listener.
+
+
+Optional Parameters
+===================
+
+--cloud-connector-id [text]
+
+The OCID of the cloud connector.
+
+--defined-tags [complex type]
+
+Defined tags for this resource. Each key is predefined and scoped to a
+namespace. For more information, see Resource Tags. Example:
+*{“Operations”: {“CostCenter”: “42”}}* 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.
+
+--force
+
+Perform update without prompting for confirmation.
+
+--freeform-tags [complex type]
+
+Free-form tags for this resource. Each tag is a simple key-value pair
+with no predefined name, type, or namespace. For more information, see
+Resource Tags. Example: *{“Department”: “Finance”}* 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.
+
+--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 work request to reach the state
+defined by "--wait-for-state". Defaults to 1200 seconds.
+
+--wait-for-state [text]
+
+This operation asynchronously creates, modifies or deletes a resource
+and uses a work request to track the progress of the operation.
+Specify this option to perform the action and then wait until the work
+request reaches a certain 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:
+
+   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, SUCCEEDED
+
+--wait-interval-seconds [integer]
+
+Check every "--wait-interval-seconds" to see whether the work request
+has reached the 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", "--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 cloud_listener_id=<substitute-value-of-cloud_listener_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/cloud-listener/update.html#cmdoption-cloud-listener-id
+
+       oci database-management cloud-listener update --cloud-listener-id $cloud_listener_id

oci_cli/help_text_producer/data_files/text/cmdref/database-management/cloud-listener.txt

@@ -0,0 +1,22 @@
+cloud-listener
+**************
+
+
+Description
+===========
+
+The details of a cloud listener.
+
+
+Available Commands
+==================
+
+* get
+
+* list
+
+* list-cloud-listener-services
+
+* summarize-cloud-listener-metrics
+
+* update

oci_cli/help_text_producer/data_files/text/cmdref/database-management/job/get.txt

@@ -17,7 +17,7 @@
 Description
 ===========
 
-Gets the details for the job specified by jobId.
+Gets the details of the job specified by jobId.
 
 
 Usage

oci_cli/help_text_producer/data_files/text/cmdref/database-management/job/update-result-location.txt

@@ -17,8 +17,8 @@
 Description
 ===========
 
-Updates the details for the recurring scheduled job specified by
-jobId. Note that non-recurring (one time) jobs cannot be updated.
+Updates the details of the recurring scheduled job specified by jobId.
+Note that non-recurring (one time) jobs cannot be updated.
 
 
 Usage

oci_cli/help_text_producer/data_files/text/cmdref/database-management/job/update-sql-job-details.txt

@@ -17,8 +17,8 @@
 Description
 ===========
 
-Updates the details for the recurring scheduled job specified by
-jobId. Note that non-recurring (one time) jobs cannot be updated.
+Updates the details of the recurring scheduled job specified by jobId.
+Note that non-recurring (one time) jobs cannot be updated.
 
 
 Usage

oci_cli/help_text_producer/data_files/text/cmdref/database-management/job/update.txt

@@ -17,8 +17,8 @@
 Description
 ===========
 
-Updates the details for the recurring scheduled job specified by
-jobId. Note that non-recurring (one time) jobs cannot be updated.
+Updates the details of the recurring scheduled job specified by jobId.
+Note that non-recurring (one time) jobs cannot be updated.
 
 
 Usage

oci_cli/help_text_producer/data_files/text/cmdref/database-management/job-execution/get.txt

@@ -17,7 +17,7 @@
 Description
 ===========
 
-Gets the details for the job execution specified by jobExecutionId.
+Gets the details of the job execution specified by jobExecutionId.
 
 
 Usage

oci_cli/help_text_producer/data_files/text/cmdref/database-management/job-run/get.txt

@@ -17,7 +17,7 @@
 Description
 ===========
 
-Gets the details for the job run specified by jobRunId.
+Gets the details of the job run specified by jobRunId.
 
 
 Usage

oci_cli/help_text_producer/data_files/text/cmdref/database-management/managed-database/enable-database-management-feature-database-diagnostics-and-management-feature-details.txt

@@ -58,7 +58,8 @@ via the file:// syntax.
 
 --feature-details-management-type [text]
 
-The management type for the database.
+The management type for the database. Use “BASIC” for basic
+management. Use “ADVANCED” for full management.
 
 Accepted values are:
 

oci_cli/help_text_producer/data_files/text/cmdref/database-management/managed-database/enable-database-management-feature-database-sql-watch-feature-details.txt

@@ -60,6 +60,16 @@ via the file:// syntax.
 Optional Parameters
 ===================
 
+--feature-details-can-enable-all-current-pdbs [boolean]
+
+Indicates whether SQL Watch should be enabled for all the current
+pluggable databases in the container database.
+
+--feature-details-is-auto-enable-pluggable-database [boolean]
+
+Indicates whether SQL Watch should be enabled automatically for all
+the pluggable databases in the container database.
+
 --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/database-management/managed-database/enable-pluggable-database-management-feature-database-diagnostics-and-management-feature-details.txt

@@ -54,7 +54,8 @@ via the file:// syntax.
 
 --feature-details-management-type [text]
 
-The management type for the database.
+The management type for the database. Use “BASIC” for basic
+management. Use “ADVANCED” for full management.
 
 Accepted values are: