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

oci_cli/help_text_producer/data_files/text/cmdref/network/subnet/modify-ipv4-subnet-cidr.txt

@@ -0,0 +1,148 @@
+"modify-ipv4-subnet-cidr"
+*************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Updates the specified Ipv4 CIDR block of a Subnet. The new Ipv4 CIDR
+IP range must meet the following criteria:
+
+* Must be valid. - Must not overlap with another Ipv4 CIDR block in
+  the Subnet or the on-premises network CIDR block. - Must not exceed
+  the limit of Ipv4 CIDR blocks allowed per Subnet. - Must include IP
+  addresses from the original CIDR block that are used in the VCN’s
+  existing route rules. - No IP address in an existing subnet should
+  be outside of the new CIDR block range.
+
+
+Usage
+=====
+
+   oci network subnet modify-ipv4-subnet-cidr [OPTIONS]
+
+
+Required Parameters
+===================
+
+--ipv4-cidr-block [text]
+
+The Ipv4 CIDR IP address to update.
+
+--subnet-id [text]
+
+Specify the OCID of the subnet.
+
+--updated-ipv4-cidr-block [text]
+
+The new Ipv4 CIDR IP address.
+
+
+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
+
+--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 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/network/vcn/create.html#cmdoption-compartment-id
+       export ipv4_cidr_block=<substitute-value-of-ipv4_cidr_block> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/network/subnet/modify-ipv4-subnet-cidr.html#cmdoption-ipv4-cidr-block
+       export updated_ipv4_cidr_block=<substitute-value-of-updated_ipv4_cidr_block> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/network/subnet/modify-ipv4-subnet-cidr.html#cmdoption-updated-ipv4-cidr-block
+
+       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)
+
+       oci network subnet modify-ipv4-subnet-cidr --ipv4-cidr-block $ipv4_cidr_block --subnet-id $subnet_id --updated-ipv4-cidr-block $updated_ipv4_cidr_block

oci_cli/help_text_producer/data_files/text/cmdref/network/subnet/remove-ipv4-subnet-cidr.txt

@@ -0,0 +1,145 @@
+"remove-ipv4-subnet-cidr"
+*************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Remove an IPv4 prefix from a subnet
+
+
+Usage
+=====
+
+   oci network subnet remove-ipv4-subnet-cidr [OPTIONS]
+
+
+Required Parameters
+===================
+
+--ipv4-cidr-block [text]
+
+This field should only be specified when removing an IPv4 prefix from
+a subnet’s IPv4 address space. The CIDR must maintain the following
+rules -
+
+1. The CIDR block is valid and correctly formatted. b. The CIDR range
+   is within one of the parent VCN ranges. c. The CIDR range to be
+   removed is already present in the list of ipv4CidrBlocks
+
+Example:
+
+   10.0.1.0/24
+
+--subnet-id [text]
+
+Specify the OCID of the subnet.
+
+
+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
+
+--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 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/network/vcn/create.html#cmdoption-compartment-id
+       export ipv4_cidr_block=<substitute-value-of-ipv4_cidr_block> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/network/subnet/remove-ipv4-subnet-cidr.html#cmdoption-ipv4-cidr-block
+
+       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)
+
+       oci network subnet remove-ipv4-subnet-cidr --ipv4-cidr-block $ipv4_cidr_block --subnet-id $subnet_id

oci_cli/help_text_producer/data_files/text/cmdref/network/subnet/remove-ipv6-subnet-cidr.txt

@@ -138,6 +138,6 @@ security policies before trying the examples.
 
        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 --cidr-block $cidr_block --compartment-id $compartment_id --vcn-id $vcn_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)
 
        oci network subnet remove-ipv6-subnet-cidr --ipv6-cidr-block $ipv6_cidr_block --subnet-id $subnet_id

oci_cli/help_text_producer/data_files/text/cmdref/network/subnet/update.txt

@@ -243,6 +243,6 @@ security policies before trying the examples.
 
        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 --cidr-block $cidr_block --compartment-id $compartment_id --vcn-id $vcn_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)
 
        oci network subnet update --subnet-id $subnet_id

oci_cli/help_text_producer/data_files/text/cmdref/network/subnet-topology/get.txt

@@ -131,6 +131,6 @@ security policies before trying the examples.
 
        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 --cidr-block $cidr_block --compartment-id $compartment_id --vcn-id $vcn_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)
 
        oci network subnet-topology get --compartment-id $compartment_id --subnet-id $subnet_id

oci_cli/help_text_producer/data_files/text/cmdref/network/subnet.txt

@@ -19,6 +19,8 @@ Getting Started with Policies.
 Available Commands
 ==================
 
+* add-ipv4-subnet-cidr
+
 * add-ipv6-subnet-cidr
 
 * change-compartment
@@ -31,6 +33,10 @@ Available Commands
 
 * list
 
+* modify-ipv4-subnet-cidr
+
+* remove-ipv4-subnet-cidr
+
 * remove-ipv6-subnet-cidr
 
 * update

oci_cli/help_text_producer/data_files/text/cmdref/network/vnic/assign-private-ip.txt

@@ -32,6 +32,20 @@ Usage
 Optional Parameters
 ===================
 
+--cidr-prefix-length [integer]
+
+An optional field that when combined with the ipAddress field, will be
+used to allocate secondary IPv4 CIDRs. The CIDR range created by this
+combination must be within the subnet’s CIDR and the CIDR range should
+not collide with any existing IPv4 address allocation. The VNIC ID
+specified in the request object should not already been assigned more
+than the max IPv4 addresses. If you don’t specify a value, this option
+will be ignored.
+
+Example:
+
+   18
+
 --defined-tags [complex type]
 
 Defined tags for this resource. Each key is predefined and scoped to a
@@ -120,6 +134,10 @@ Example:
 
    10.0.3.3
 
+--ipv4-subnet-cidr-at-creation [text]
+
+Any one of the IPv4 CIDRs allocated to the subnet.
+
 --lifetime [text]
 
 Lifetime of the IP address. There are two types of IPs:  - Ephemeral

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

@@ -509,6 +509,8 @@ Available Commands
 
 * subnet
 
+  * add-ipv4-subnet-cidr
+
   * add-ipv6-subnet-cidr
 
   * change-compartment
@@ -521,6 +523,10 @@ Available Commands
 
   * list
 
+  * modify-ipv4-subnet-cidr
+
+  * remove-ipv4-subnet-cidr
+
   * remove-ipv6-subnet-cidr
 
   * update

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

@@ -1,5 +1,5 @@
-"list"
-******
+"list-errors"
+*************
 
 * Description
 
@@ -23,7 +23,7 @@ Return a (paginated) list of errors for a given work request.
 Usage
 =====
 
-   oci organizations work-request-error list [OPTIONS]
+   oci organizations work-request-error list-errors [OPTIONS]
 
 
 Required Parameters
@@ -113,6 +113,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-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/organizations/work-request-error/list-errors.html#cmdoption-work-request-id
 
-       oci organizations work-request-error list --work-request-id $work_request_id
+       oci organizations work-request-error list-errors --work-request-id $work_request_id

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

@@ -141,7 +141,7 @@ Available Commands
 
 * work-request-error
 
-  * list
+  * list-errors
 
 * work-request-log
 

oci_cli/help_text_producer/data_files/text/cmdref/psa/private-service-access/change-compartment.txt

@@ -0,0 +1,136 @@
+"change-compartment"
+********************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Moves a PrivateServiceAccess into a different compartment within the
+same tenancy. For information about moving resources between
+compartments, see Moving Resources to a Different Compartment.
+
+
+Usage
+=====
+
+   oci psa private-service-access change-compartment [OPTIONS]
+
+
+Required Parameters
+===================
+
+--compartment-id, -c [text]
+
+The OCID of the compartment into which the private service access
+should be moved.
+
+--private-service-access-id [text]
+
+The OCID of the PrivateServiceAccess.
+
+
+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
+
+--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, CANCELLED, CANCELLING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
+
+--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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/psa/private-service-access/create.html#cmdoption-compartment-id
+       export service_id=<substitute-value-of-service_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/psa/private-service-access/create.html#cmdoption-service-id
+       export subnet_id=<substitute-value-of-subnet_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/psa/private-service-access/create.html#cmdoption-subnet-id
+
+       private_service_access_id=$(oci psa private-service-access create --compartment-id $compartment_id --service-id $service_id --subnet-id $subnet_id --query data.id --raw-output)
+
+       oci psa private-service-access change-compartment --compartment-id $compartment_id --private-service-access-id $private_service_access_id