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

oci_cli/bin/psa.psm1

@@ -0,0 +1,51 @@
+function GetOciTopLevelCommand_psa() {
+    return 'psa'
+}
+
+function GetOciSubcommands_psa() {
+    $ociSubcommands = @{
+        'psa' = 'private-service-access psa-services work-request work-request-error work-request-log'
+        'psa private-service-access' = 'change-compartment create delete get list update'
+        'psa psa-services' = 'list'
+        'psa work-request' = 'cancel get list'
+        'psa work-request-error' = 'list'
+        'psa work-request-log' = 'list'
+    }
+    return $ociSubcommands
+}
+
+function GetOciCommandsToLongParams_psa() {
+    $ociCommandsToLongParams = @{
+        'psa private-service-access change-compartment' = 'compartment-id from-json help if-match max-wait-seconds private-service-access-id wait-for-state wait-interval-seconds'
+        'psa private-service-access create' = 'compartment-id defined-tags description display-name freeform-tags from-json help ipv4-ip max-wait-seconds nsg-ids security-attributes service-id subnet-id wait-for-state wait-interval-seconds'
+        'psa private-service-access delete' = 'force from-json help if-match max-wait-seconds private-service-access-id wait-for-state wait-interval-seconds'
+        'psa private-service-access get' = 'from-json help private-service-access-id'
+        'psa private-service-access list' = 'all compartment-id display-name from-json help id lifecycle-state limit page page-size service-id sort-by sort-order vcn-id'
+        'psa private-service-access update' = 'defined-tags description display-name force freeform-tags from-json help if-match max-wait-seconds nsg-ids private-service-access-id security-attributes wait-for-state wait-interval-seconds'
+        'psa psa-services list' = 'all display-name from-json help limit page page-size service-id sort-by sort-order'
+        'psa work-request cancel' = 'force from-json help if-match work-request-id'
+        'psa work-request get' = 'from-json help work-request-id'
+        'psa work-request list' = 'all compartment-id from-json help limit page page-size resource-id sort-by sort-order status work-request-id'
+        'psa work-request-error list' = 'all from-json help limit page page-size sort-by sort-order work-request-id'
+        'psa work-request-log list' = 'all from-json help limit page page-size sort-by sort-order work-request-id'
+    }
+    return $ociCommandsToLongParams
+}
+
+function GetOciCommandsToShortParams_psa() {
+    $ociCommandsToShortParams = @{
+        'psa private-service-access change-compartment' = '? c h'
+        'psa private-service-access create' = '? c h'
+        'psa private-service-access delete' = '? h'
+        'psa private-service-access get' = '? h'
+        'psa private-service-access list' = '? c h'
+        'psa private-service-access update' = '? h'
+        'psa psa-services list' = '? h'
+        'psa work-request cancel' = '? h'
+        'psa work-request get' = '? h'
+        'psa work-request list' = '? c h'
+        'psa work-request-error list' = '? h'
+        'psa work-request-log list' = '? h'
+    }
+    return $ociCommandsToShortParams
+}

oci_cli/help_text_producer/data_files/text/cmdref/compute-management/instance-pool/create.txt

@@ -145,6 +145,17 @@ hostnames follow the format. The formatter does not retroactively
 change instance’s hostnames, only instance hostnames in the future
 follow the format
 
+--lifecycle-management [complex type]
+
+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.
+
 --load-balancers [complex type]
 
 The load balancers to attach to the instance pool.

oci_cli/help_text_producer/data_files/text/cmdref/compute-management/instance-pool/update.txt

@@ -134,6 +134,17 @@ hostnames follow the format. The formatter does not retroactively
 change instance’s hostnames, only instance hostnames in the future
 follow the format
 
+--lifecycle-management [complex type]
+
+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.
+
 --max-wait-seconds [integer]
 
 The maximum time to wait for the resource to reach the lifecycle state

oci_cli/help_text_producer/data_files/text/cmdref/compute-management/instance-pool-instance/attach.txt

@@ -83,7 +83,7 @@ is returned.
 
 Accepted values are:
 
-   ACTIVE, ATTACHING, DETACHING
+   ACTIVE, ATTACHING, DETACHING, TERMINATION_AWAIT, TERMINATION_PROCEED
 
 --wait-interval-seconds [integer]
 

oci_cli/help_text_producer/data_files/text/cmdref/compute-management/instance-pool-instance/termination-proceed.txt

@@ -0,0 +1,116 @@
+"termination-proceed"
+*********************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Marks an instance in an instance pool to be ready for termination.
+
+
+Usage
+=====
+
+   oci compute-management instance-pool-instance termination-proceed [OPTIONS]
+
+
+Required Parameters
+===================
+
+--instance-id [text]
+
+The OCID of the instance.
+
+--instance-pool-id [text]
+
+The OCID of the instance pool.
+
+
+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 compute-management instance-configuration create --generate-param-json-input instance-details > instance-details.json
+
+       oci compute-management instance-pool create --generate-param-json-input placement-configurations > placement-configurations.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 cidr_block=<substitute-value-of-cidr_block> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/network/vcn/create.html#cmdoption-cidr-block
+       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/compute-management/instance-configuration/create.html#cmdoption-compartment-id
+       export availability_domain=<substitute-value-of-availability_domain> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/compute/instance/launch.html#cmdoption-availability-domain
+       export image_id=<substitute-value-of-image_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/compute/instance/launch.html#cmdoption-image-id
+       export size=<substitute-value-of-size> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/compute-management/instance-pool/create.html#cmdoption-size
+
+       vcn_id=$(oci network vcn create --cidr-block $cidr_block --compartment-id $compartment_id --query data.id --raw-output)
+
+       subnet_id=$(oci network subnet create --compartment-id $compartment_id --vcn-id $vcn_id --query data.id --raw-output)
+
+       instance_id=$(oci compute instance launch --availability-domain $availability_domain --compartment-id $compartment_id --image-id $image_id --subnet-id $subnet_id --query data.id --raw-output)
+
+       instance_configuration_id=$(oci compute-management instance-configuration create --compartment-id $compartment_id --instance-details file://instance-details.json --query data.id --raw-output)
+
+       instance_pool_id=$(oci compute-management instance-pool create --compartment-id $compartment_id --instance-configuration-id $instance_configuration_id --placement-configurations file://placement-configurations.json --size $size --query data.id --raw-output)
+
+       oci compute-management instance-pool-instance termination-proceed --instance-id $instance_id --instance-pool-id $instance_pool_id

oci_cli/help_text_producer/data_files/text/cmdref/compute-management/instance-pool-instance.txt

@@ -16,3 +16,5 @@ Available Commands
 * detach
 
 * get
+
+* termination-proceed

oci_cli/help_text_producer/data_files/text/cmdref/compute-management.txt

@@ -90,3 +90,5 @@ Available Commands
   * detach
 
   * get
+
+  * termination-proceed

oci_cli/help_text_producer/data_files/text/cmdref/db/dbnode-snapshot/delete.txt

@@ -0,0 +1,129 @@
+"delete"
+********
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Deletes the specified Exadata Database Node Snapshot.
+
+
+Usage
+=====
+
+   oci db dbnode-snapshot delete [OPTIONS]
+
+
+Required Parameters
+===================
+
+--dbnode-snapshot-id [text]
+
+The Exadata Database Node Snapshot OCID.
+
+
+Optional Parameters
+===================
+
+--force
+
+Perform deletion without prompting for confirmation.
+
+--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, 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 dbnode_snapshot_id=<substitute-value-of-dbnode_snapshot_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/dbnode-snapshot/delete.html#cmdoption-dbnode-snapshot-id
+
+       oci db dbnode-snapshot delete --dbnode-snapshot-id $dbnode_snapshot_id

oci_cli/help_text_producer/data_files/text/cmdref/db/dbnode-snapshot/get.txt

@@ -0,0 +1,92 @@
+"get"
+*****
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Gets information about the specified Exadata Database Node Snapshot in
+the specified compartment.
+
+
+Usage
+=====
+
+   oci db dbnode-snapshot get [OPTIONS]
+
+
+Required Parameters
+===================
+
+--dbnode-snapshot-id [text]
+
+The Exadata Database Node Snapshot OCID.
+
+
+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 dbnode_snapshot_id=<substitute-value-of-dbnode_snapshot_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/dbnode-snapshot/get.html#cmdoption-dbnode-snapshot-id
+
+       oci db dbnode-snapshot get --dbnode-snapshot-id $dbnode_snapshot_id

oci_cli/help_text_producer/data_files/text/cmdref/db/dbnode-snapshot/list.txt

@@ -0,0 +1,153 @@
+"list"
+******
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Gets a list of the Exadata Database Node Snapshots in the specified
+compartment.
+
+
+Usage
+=====
+
+   oci db dbnode-snapshot list [OPTIONS]
+
+
+Required Parameters
+===================
+
+--compartment-id, -c [text]
+
+The compartment OCID.
+
+
+Optional Parameters
+===================
+
+--all
+
+Fetches all pages of results. If you provide this option, then you
+cannot provide the "--limit" option.
+
+--cluster-id [text]
+
+A filter to return only Exadata Database Node Snapshots that match the
+given VM cluster.
+
+--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
+
+--lifecycle-state [text]
+
+A filter to return only Exadata Database Snapshots that match the
+given lifecycle state exactly.
+
+Accepted values are:
+
+   AVAILABLE, CREATING, FAILED, MOUNTED, MOUNTING, TERMINATED, TERMINATING, UNMOUNTING
+
+--limit [integer]
+
+The maximum number of items to return per page.
+
+--name [text]
+
+A filter to return only resources that match the entire name given.
+The match is not case sensitive.
+
+--page [text]
+
+The pagination token to continue listing from.
+
+--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.  You can provide one sort order (*sortOrder*).
+Default order for TIMECREATED is descending.  Default order for NAME
+is ascending. The NAME sort order is case sensitive.
+
+Accepted values are:
+
+   NAME, TIMECREATED
+
+--sort-order [text]
+
+The sort order to use, either ascending (*ASC*) or descending
+(*DESC*).
+
+Accepted values are:
+
+   ASC, DESC
+
+--source-dbnode-id [text]
+
+A filter to return only Exadata Database Snapshots that match the
+given database node.
+
+
+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/db/dbnode-snapshot/list.html#cmdoption-compartment-id
+
+       oci db dbnode-snapshot list --compartment-id $compartment_id