oci-cli 3.62.1__py3-none-any.whl → 3.63.0__py3-none-any.whl

oci_cli/cli_util.py

@@ -434,6 +434,8 @@ def create_config_and_signer_based_on_click_context(ctx):
         # OCI_RESOURCE_PRINCIPAL_REGION
         # OCI_KUBERNETES_SERVICE_ACCOUNT_TOKEN_PATH or OCI_KUBERNETES_SERVICE_ACCOUNT_TOKEN_STRING in case token path other than default "/var/run/secrets/kubernetes.io/serviceaccount/token" or token string is used
 
+        if ctx.obj['region']:
+            client_config["region"] = ctx.obj['region']
         if ctx.obj['debug']:
             logger.debug("auth: oke_workload_identity")
 

oci_cli/help_text_producer/data_files/text/cmdref/autoscaling/configuration/list.txt

@@ -94,6 +94,13 @@ Default order for TIMECREATED is descending. Default order for
 DISPLAYNAME is ascending. The DISPLAYNAME sort order is case
 sensitive.
 
+**Note:** In general, some “List” operations (for example,
+*ListInstances*) let you optionally filter by availability domain if
+the scope of the resource type is within a single availability domain.
+If you call one of these “List” operations without specifying an
+availability domain, the resources are grouped by availability domain,
+then sorted.
+
 Accepted values are:
 
    DISPLAYNAME, TIMECREATED

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

@@ -5,14 +5,9 @@ autoscaling
 Description
 ===========
 
-CLI for dynamically scaling Compute resources to meet application
-requirements. For more information about autoscaling, see Autoscaling.
-For information about the Compute service, see Overview of the Compute
-Service.
-
-**Note:** Autoscaling is not available in US Government Cloud
-tenancies. For more information, see Oracle Cloud Infrastructure US
-Government Cloud.
+Use the Autoscaling CLI to dynamically scale compute resources to meet
+application requirements. For more information about autoscaling, see
+Autoscaling. For information about the Compute service, see Compute.
 
 
 Available Commands

oci_cli/help_text_producer/data_files/text/cmdref/ce/cluster/create-kubeconfig.txt

@@ -85,10 +85,6 @@ option or kubeconfig file at default location if –file is not used.
 
 --token-version [text]
 
-The version of the kubeconfig token. Supported value 2.0.0
-
---token-version [text]
-
 The version of the kubeconfig token. Supported value is 2.0.0
 
 Accepted values are:

oci_cli/help_text_producer/data_files/text/cmdref/{marketplace-publisher/offer/offer/get-offer-internal-detail.txt → database-management/cloud-asm/get-cloud-asm-configuration.txt}

@@ -1,5 +1,5 @@
-"get-offer-internal-detail"
-***************************
+"get-cloud-asm-configuration"
+*****************************
 
 * Description
 
@@ -17,21 +17,22 @@
 Description
 ===========
 
-Gets an Offer internal details by identifier
+Gets configuration details including disk groups for the cloud ASM
+specified by *cloudAsmId*.
 
 
 Usage
 =====
 
-   oci marketplace-publisher offer offer get-offer-internal-detail [OPTIONS]
+   oci database-management cloud-asm get-cloud-asm-configuration [OPTIONS]
 
 
 Required Parameters
 ===================
 
---offer-id [text]
+--cloud-asm-id [text]
 
-unique Offer identifier
+The OCID of the cloud ASM.
 
 
 Optional Parameters
@@ -59,6 +60,10 @@ 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
 
+--opc-named-credential-id [text]
+
+The OCID of the Named Credential.
+
 
 Global Parameters
 =================
@@ -86,9 +91,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 display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/offer/offer/create.html#cmdoption-display-name
-       export seller_compartment_id=<substitute-value-of-seller_compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/offer/offer/create.html#cmdoption-seller-compartment-id
-
-       offer_id=$(oci marketplace-publisher offer offer create --display-name $display_name --seller-compartment-id $seller_compartment_id --query data.id --raw-output)
+       export cloud_asm_id=<substitute-value-of-cloud_asm_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/cloud-asm/get-cloud-asm-configuration.html#cmdoption-cloud-asm-id
 
-       oci marketplace-publisher offer offer get-offer-internal-detail --offer-id $offer_id
+       oci database-management cloud-asm get-cloud-asm-configuration --cloud-asm-id $cloud_asm_id

oci_cli/help_text_producer/data_files/text/cmdref/{marketplace-publisher/offer/offer → database-management/cloud-asm}/get.txt

@@ -17,21 +17,21 @@
 Description
 ===========
 
-Gets an Offer by identifier
+Gets the details for the cloud ASM specified by *cloudAsmId*.
 
 
 Usage
 =====
 
-   oci marketplace-publisher offer offer get [OPTIONS]
+   oci database-management cloud-asm get [OPTIONS]
 
 
 Required Parameters
 ===================
 
---offer-id [text]
+--cloud-asm-id [text]
 
-unique Offer identifier
+The OCID of the cloud ASM.
 
 
 Optional Parameters
@@ -86,9 +86,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 display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/offer/offer/create.html#cmdoption-display-name
-       export seller_compartment_id=<substitute-value-of-seller_compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/offer/offer/create.html#cmdoption-seller-compartment-id
+       export cloud_asm_id=<substitute-value-of-cloud_asm_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/cloud-asm/get.html#cmdoption-cloud-asm-id
 
-       offer_id=$(oci marketplace-publisher offer offer create --display-name $display_name --seller-compartment-id $seller_compartment_id --query data.id --raw-output)
-
-       oci marketplace-publisher offer offer get --offer-id $offer_id
+       oci database-management cloud-asm get --cloud-asm-id $cloud_asm_id

oci_cli/help_text_producer/data_files/text/cmdref/database-management/cloud-asm/list-cloud-asm-disk-groups.txt

@@ -0,0 +1,133 @@
+"list-cloud-asm-disk-groups"
+****************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Lists ASM disk groups for the cloud ASM specified by *cloudAsmId*.
+
+
+Usage
+=====
+
+   oci database-management cloud-asm list-cloud-asm-disk-groups [OPTIONS]
+
+
+Required Parameters
+===================
+
+--cloud-asm-id [text]
+
+The OCID of the cloud ASM.
+
+
+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_asm_id=<substitute-value-of-cloud_asm_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/cloud-asm/list-cloud-asm-disk-groups.html#cmdoption-cloud-asm-id
+
+       oci database-management cloud-asm list-cloud-asm-disk-groups --cloud-asm-id $cloud_asm_id

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

@@ -0,0 +1,133 @@
+"list-cloud-asm-users"
+**********************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Lists ASM users for the cloud ASM specified by *cloudAsmId*.
+
+
+Usage
+=====
+
+   oci database-management cloud-asm list-cloud-asm-users [OPTIONS]
+
+
+Required Parameters
+===================
+
+--cloud-asm-id [text]
+
+The OCID of the cloud ASM.
+
+
+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_asm_id=<substitute-value-of-cloud_asm_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/cloud-asm/list-cloud-asm-users.html#cmdoption-cloud-asm-id
+
+       oci database-management cloud-asm list-cloud-asm-users --cloud-asm-id $cloud_asm_id

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

@@ -0,0 +1,132 @@
+"list"
+******
+
+* Description
+
+* Usage
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Lists the ASMs in the specified cloud DB system.
+
+
+Usage
+=====
+
+   oci database-management cloud-asm 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-asm list

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

@@ -0,0 +1,121 @@
+"summarize-cloud-asm-metrics"
+*****************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Gets metrics for the cloud ASM specified by *cloudAsmId*.
+
+
+Usage
+=====
+
+   oci database-management cloud-asm summarize-cloud-asm-metrics [OPTIONS]
+
+
+Required Parameters
+===================
+
+--cloud-asm-id [text]
+
+The OCID of the cloud ASM.
+
+--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_asm_id=<substitute-value-of-cloud_asm_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/cloud-asm/summarize-cloud-asm-metrics.html#cmdoption-cloud-asm-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-asm/summarize-cloud-asm-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-asm/summarize-cloud-asm-metrics.html#cmdoption-start-time
+
+       oci database-management cloud-asm summarize-cloud-asm-metrics --cloud-asm-id $cloud_asm_id --end-time $end_time --start-time $start_time