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

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

@@ -0,0 +1,118 @@
+"stop-import-from-object"
+*************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Stops the import of data from Object Storage to the Lustre file
+system. The Lustre file system path and Object Storage object prefix
+are defined in the Object Storage link resource.
+
+
+Usage
+=====
+
+   oci lfs object-storage-link stop-import-from-object [OPTIONS]
+
+
+Required Parameters
+===================
+
+--object-storage-link-id [text]
+
+The OCID of the Object Storage link.
+
+
+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.
+
+
+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 lfs lustre-file-system create --generate-param-json-input root-squash-configuration > root-squash-configuration.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 availability_domain=<substitute-value-of-availability_domain> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lfs/lustre-file-system/create.html#cmdoption-availability-domain
+       export capacity_in_gbs=<substitute-value-of-capacity_in_gbs> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lfs/lustre-file-system/create.html#cmdoption-capacity-in-gbs
+       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lfs/lustre-file-system/create.html#cmdoption-compartment-id
+       export file_system_name=<substitute-value-of-file_system_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lfs/lustre-file-system/create.html#cmdoption-file-system-name
+       export performance_tier=<substitute-value-of-performance_tier> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lfs/lustre-file-system/create.html#cmdoption-performance-tier
+       export subnet_id=<substitute-value-of-subnet_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lfs/lustre-file-system/create.html#cmdoption-subnet-id
+       export file_system_path=<substitute-value-of-file_system_path> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lfs/object-storage-link/create.html#cmdoption-file-system-path
+       export is_overwrite=<substitute-value-of-is_overwrite> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lfs/object-storage-link/create.html#cmdoption-is-overwrite
+       export object_storage_prefix=<substitute-value-of-object_storage_prefix> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lfs/object-storage-link/create.html#cmdoption-object-storage-prefix
+
+       lustre_file_system_id=$(oci lfs lustre-file-system create --availability-domain $availability_domain --capacity-in-gbs $capacity_in_gbs --compartment-id $compartment_id --file-system-name $file_system_name --performance-tier $performance_tier --root-squash-configuration file://root-squash-configuration.json --subnet-id $subnet_id --query data.id --raw-output)
+
+       object_storage_link_id=$(oci lfs object-storage-link create --availability-domain $availability_domain --compartment-id $compartment_id --file-system-path $file_system_path --is-overwrite $is_overwrite --lustre-file-system-id $lustre_file_system_id --object-storage-prefix $object_storage_prefix --query data.id --raw-output)
+
+       oci lfs object-storage-link stop-import-from-object --object-storage-link-id $object_storage_link_id

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

@@ -0,0 +1,200 @@
+"update"
+********
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Updates an Object Storage link.
+
+
+Usage
+=====
+
+   oci lfs object-storage-link update [OPTIONS]
+
+
+Required Parameters
+===================
+
+--object-storage-link-id [text]
+
+The OCID of the Object Storage link.
+
+
+Optional Parameters
+===================
+
+--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.
+
+--display-name [text]
+
+A user-friendly name. It does not have to be unique, and it is
+changeable. Avoid entering confidential information.
+
+Example:
+
+   My Object Storage Link
+
+--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.
+
+--is-overwrite [boolean]
+
+The flag is an identifier to tell whether the job run has overwrite
+enabled. If *isOverwrite* is false, the file to be imported or
+exported will be skipped if it already exists. If *isOverwrite* is
+true, the file to be imported or exported will be overwritten if it
+already exists.
+
+--max-wait-seconds [integer]
+
+The maximum time to wait for the resource to reach the lifecycle state
+defined by "--wait-for-state". Defaults to 1200 seconds.
+
+--wait-for-state [text]
+
+This operation creates, modifies or deletes a resource that has a
+defined lifecycle state. Specify this option to perform the action and
+then wait until the resource reaches a given lifecycle 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:
+
+   ACTIVE, CREATING, DELETED, DELETING, FAILED
+
+--wait-interval-seconds [integer]
+
+Check every "--wait-interval-seconds" to see whether the resource has
+reached the lifecycle 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 and paste the following example into a JSON file, replacing the
+example parameters with your own.
+
+       oci lfs lustre-file-system create --generate-param-json-input root-squash-configuration > root-squash-configuration.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 availability_domain=<substitute-value-of-availability_domain> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lfs/lustre-file-system/create.html#cmdoption-availability-domain
+       export capacity_in_gbs=<substitute-value-of-capacity_in_gbs> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lfs/lustre-file-system/create.html#cmdoption-capacity-in-gbs
+       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lfs/lustre-file-system/create.html#cmdoption-compartment-id
+       export file_system_name=<substitute-value-of-file_system_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lfs/lustre-file-system/create.html#cmdoption-file-system-name
+       export performance_tier=<substitute-value-of-performance_tier> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lfs/lustre-file-system/create.html#cmdoption-performance-tier
+       export subnet_id=<substitute-value-of-subnet_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lfs/lustre-file-system/create.html#cmdoption-subnet-id
+       export file_system_path=<substitute-value-of-file_system_path> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lfs/object-storage-link/create.html#cmdoption-file-system-path
+       export is_overwrite=<substitute-value-of-is_overwrite> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lfs/object-storage-link/create.html#cmdoption-is-overwrite
+       export object_storage_prefix=<substitute-value-of-object_storage_prefix> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/lfs/object-storage-link/create.html#cmdoption-object-storage-prefix
+
+       lustre_file_system_id=$(oci lfs lustre-file-system create --availability-domain $availability_domain --capacity-in-gbs $capacity_in_gbs --compartment-id $compartment_id --file-system-name $file_system_name --performance-tier $performance_tier --root-squash-configuration file://root-squash-configuration.json --subnet-id $subnet_id --query data.id --raw-output)
+
+       object_storage_link_id=$(oci lfs object-storage-link create --availability-domain $availability_domain --compartment-id $compartment_id --file-system-path $file_system_path --is-overwrite $is_overwrite --lustre-file-system-id $lustre_file_system_id --object-storage-prefix $object_storage_prefix --query data.id --raw-output)
+
+       oci lfs object-storage-link update --object-storage-link-id $object_storage_link_id

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