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/lfs/object-storage-link-collection/list-object-storage-links.txt

@@ -0,0 +1,154 @@
+"list-object-storage-links"
+***************************
+
+* Description
+
+* Usage
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Gets a list of Object Storage links.
+
+
+Usage
+=====
+
+   oci lfs object-storage-link-collection list-object-storage-links [OPTIONS]
+
+
+Optional Parameters
+===================
+
+--all
+
+Fetches all pages of results. If you provide this option, then you
+cannot provide the "--limit" option.
+
+--availability-domain [text]
+
+The name of the availability domain.
+
+Example:
+
+   Uocm:PHX-AD-1
+
+--compartment-id, -c [text]
+
+The OCID of the compartment in which to list resources.
+
+--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 Object Storage link.
+
+--lifecycle-state [text]
+
+A filter to return only resources that match the given lifecycle
+state. The state value is case-insensitive.
+
+Accepted values are:
+
+   ACTIVE, CREATING, DELETED, DELETING, FAILED
+
+--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.
+
+--lustre-file-system-id [text]
+
+The OCID of the Lustre file system.
+
+--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 to sort by. You can provide only one sort order. Default
+order for *timeCreated* is descending. Default order for *displayName*
+is ascending.
+
+Accepted values are:
+
+   displayName, timeCreated
+
+--sort-order [text]
+
+The sort order to use, either ascending (*ASC*) or descending
+(*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.
+
+       oci lfs object-storage-link-collection list-object-storage-links

oci_cli/help_text_producer/data_files/text/cmdref/lfs/object-storage-link-collection.txt

@@ -0,0 +1,16 @@
+object-storage-link-collection
+******************************
+
+
+Description
+===========
+
+Results of a Object Storage link search. Contains both
+ObjectStorageLinkSummary items and other information, such as
+metadata.
+
+
+Available Commands
+==================
+
+* list-object-storage-links

oci_cli/help_text_producer/data_files/text/cmdref/lfs/object-storage-link.txt

@@ -0,0 +1,42 @@
+object-storage-link
+*******************
+
+
+Description
+===========
+
+Object Storage links create the relationship between a directory in an
+File Storage with Lustre file system and a path within an Object
+Storage bucket. For more information, see [Syncing Lustre file systems
+with Object Storage].
+
+To use any of the API operations, you must be authorized in an IAM
+policy. If you’re not authorized, talk to an administrator. If you’re
+an administrator who needs to write policies to give users access, see
+Getting Started with Policies.
+
+
+Available Commands
+==================
+
+* change-compartment
+
+* create
+
+* delete
+
+* get
+
+* get-sync-job
+
+* list-sync-jobs
+
+* start-export-to-object
+
+* start-import-from-object
+
+* stop-export-to-object
+
+* stop-import-from-object
+
+* update

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

@@ -29,6 +29,34 @@ Available Commands
 
   * list-lustre-file-systems
 
+* object-storage-link
+
+  * change-compartment
+
+  * create
+
+  * delete
+
+  * get
+
+  * get-sync-job
+
+  * list-sync-jobs
+
+  * start-export-to-object
+
+  * start-import-from-object
+
+  * stop-export-to-object
+
+  * stop-import-from-object
+
+  * update
+
+* object-storage-link-collection
+
+  * list-object-storage-links
+
 * work-request
 
   * cancel

oci_cli/help_text_producer/data_files/text/cmdref/network/ipam/get-subnet-cidr-utilization.txt

@@ -92,6 +92,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 ipam get-subnet-cidr-utilization --subnet-id $subnet_id

oci_cli/help_text_producer/data_files/text/cmdref/network/ipam/get-subnet-ip-inventory.txt

@@ -91,6 +91,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 ipam get-subnet-ip-inventory --subnet-id $subnet_id

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

@@ -28,6 +28,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
@@ -116,6 +130,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/subnet/add-ipv4-subnet-cidr.txt

@@ -0,0 +1,143 @@
+"add-ipv4-subnet-cidr"
+**********************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Add an IPv4 prefix to a subnet.
+
+
+Usage
+=====
+
+   oci network subnet add-ipv4-subnet-cidr [OPTIONS]
+
+
+Required Parameters
+===================
+
+--ipv4-cidr-block [text]
+
+The CIDR IP address range of the subnet. The CIDR must maintain the
+following rules -
+
+1. The CIDR block is valid and correctly formatted. b. The new range
+   is within one of the parent VCN ranges.
+
+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/add-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 add-ipv4-subnet-cidr --ipv4-cidr-block $ipv4_cidr_block --subnet-id $subnet_id

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

@@ -136,6 +136,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 add-ipv6-subnet-cidr --ipv6-cidr-block $ipv6_cidr_block --subnet-id $subnet_id

oci_cli/help_text_producer/data_files/text/cmdref/network/subnet/change-compartment.txt

@@ -123,6 +123,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 change-compartment --compartment-id $compartment_id --subnet-id $subnet_id

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

@@ -63,18 +63,6 @@ Usage
 Required Parameters
 ===================
 
---cidr-block [text]
-
-The CIDR IP address range of the subnet. The CIDR must maintain the
-following rules -
-
-1. The CIDR block is valid and correctly formatted. b. The new range
-   is within one of the parent VCN ranges.
-
-Example:
-
-   10.0.1.0/24
-
 --compartment-id, -c [text]
 
 The OCID of the compartment to contain the subnet.
@@ -108,6 +96,18 @@ Example:
 
    Uocm:PHX-AD-1
 
+--cidr-block [text]
+
+The CIDR IP address range of the subnet. The CIDR must maintain the
+following rules -
+
+1. The CIDR block is valid and correctly formatted. b. The new range
+   is within one of the parent VCN ranges.
+
+Example:
+
+   10.0.1.0/24
+
 --defined-tags [complex type]
 
 Defined tags for this resource. Each key is predefined and scoped to a
@@ -197,6 +197,21 @@ 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
 
+--ipv4-cidr-blocks [complex type]
+
+The list of all IPv4 CIDR blocks for the subnet that meets the
+following criteria: - Ipv4 CIDR blocks must be valid. - Multiple Ipv4
+CIDR blocks must not overlap each other or the on-premises network
+CIDR block. - The number of prefixes must not exceed the limit of IPv4
+prefixes allowed to a subnet. 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.
+
 --ipv6-cidr-block [text]
 
 Use this to enable IPv6 addressing for this subnet. The VCN must be
@@ -339,4 +354,4 @@ 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)
 
-       oci network subnet create --cidr-block $cidr_block --compartment-id $compartment_id --vcn-id $vcn_id
+       oci network subnet create --compartment-id $compartment_id --vcn-id $vcn_id

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

@@ -133,6 +133,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 delete --subnet-id $subnet_id

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

@@ -91,6 +91,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 get --subnet-id $subnet_id