oci-cli 3.70.1__py3-none-any.whl → 3.71.1__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/email/email-ip-pool/update.txt

@@ -0,0 +1,184 @@
+"update"
+********
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Updates the EmailIpPool
+
+
+Usage
+=====
+
+   oci email email-ip-pool update [OPTIONS]
+
+
+Required Parameters
+===================
+
+--email-ip-pool-id [text]
+
+The OCID of the IpPool.
+
+
+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.
+
+--description [text]
+
+The description of the IpPool. Avoid entering confidential
+information.
+
+--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]
+
+Used for optimistic concurrency control. In the update or delete call
+for a resource, set the *if-match* parameter to the value of the etag
+from a previous get, create, or update 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-lock-override [boolean]
+
+Whether to override locks (if any exist).
+
+--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, CANCELED, CANCELING, 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", "--enable-dual-stack", "--enable-propagation", "--
+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 email email-ip-pool create --generate-param-json-input outbound-ips > outbound-ips.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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/email/email-ip-pool/create.html#cmdoption-compartment-id
+       export name=<substitute-value-of-name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/email/email-ip-pool/create.html#cmdoption-name
+
+       email_ip_pool_id=$(oci email email-ip-pool create --compartment-id $compartment_id --name $name --outbound-ips file://outbound-ips.json --query data.id --raw-output)
+
+       oci email email-ip-pool update --email-ip-pool-id $email_ip_pool_id

oci_cli/help_text_producer/data_files/text/cmdref/email/email-ip-pool-collection/list-email-ip-pools.txt

@@ -0,0 +1,152 @@
+"list-email-ip-pools"
+*********************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Returns a list of EmailIpPools.
+
+
+Usage
+=====
+
+   oci email email-ip-pool-collection list-email-ip-pools [OPTIONS]
+
+
+Required Parameters
+===================
+
+--compartment-id, -c [text]
+
+The OCID for the compartment.
+
+
+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
+
+--id [text]
+
+A filter to only return resources that match the given id exactly.
+
+--lifecycle-state [text]
+
+Filter returned list by specified lifecycle state. This parameter is
+case-insensitive.
+
+Accepted values are:
+
+   ACTIVE, CREATING, DELETED, DELETING, FAILED, INACTIVE, UPDATING
+
+--limit [integer]
+
+For list pagination. The maximum number of results per page, or items
+to return in a paginated “List” call. *1* is the minimum, *1000* is
+the maximum. For important details about how pagination works, see
+List Pagination.
+
+--name [text]
+
+A filter to only return resources that match the given name exactly.
+
+--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]
+
+Specifies the attribute with which to sort the Email IpPools.
+
+Default: *TIMECREATED*
+
+* **TIMECREATED:** Sorts by timeCreated.
+
+Accepted values are:
+
+   NAME, TIMECREATED
+
+--sort-order [text]
+
+The sort order to use, either ascending or descending 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", "--enable-dual-stack", "--enable-propagation", "--
+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/email/email-ip-pool-collection/list-email-ip-pools.html#cmdoption-compartment-id
+
+       oci email email-ip-pool-collection list-email-ip-pools --compartment-id $compartment_id

oci_cli/help_text_producer/data_files/text/cmdref/email/email-ip-pool-collection.txt

@@ -0,0 +1,14 @@
+email-ip-pool-collection
+************************
+
+
+Description
+===========
+
+Results of an IpPool search. Contains EmailIpPoolSummary items.
+
+
+Available Commands
+==================
+
+* list-email-ip-pools

oci_cli/help_text_producer/data_files/text/cmdref/email/email-ip-pool.txt

@@ -0,0 +1,27 @@
+email-ip-pool
+*************
+
+
+Description
+===========
+
+A collection of IP addresses used by the Email Delivery service to
+submit an email.
+
+
+Available Commands
+==================
+
+* add
+
+* change-compartment
+
+* create
+
+* delete
+
+* get
+
+* remove
+
+* update

oci_cli/help_text_producer/data_files/text/cmdref/email/email-outbound-ip-collection/list-email-outbound-ips.txt

@@ -0,0 +1,155 @@
+"list-email-outbound-ips"
+*************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Returns a list of all Outbound Public IPs assigned for a given tenant.
+
+
+Usage
+=====
+
+   oci email email-outbound-ip-collection list-email-outbound-ips [OPTIONS]
+
+
+Required Parameters
+===================
+
+--compartment-id, -c [text]
+
+The OCID for the compartment.
+
+
+Optional Parameters
+===================
+
+--all
+
+Fetches all pages of results. If you provide this option, then you
+cannot provide the "--limit" option.
+
+--assignment-state [text]
+
+Filter returned list by specified assignment state.
+
+Accepted values are:
+
+   ASSIGNED, AVAILABLE
+
+--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]
+
+Filter returned list by specified lifecycle state. This parameter is
+case-insensitive.
+
+Accepted values are:
+
+   ACTIVE, DRAINING, FAILED, UPDATING
+
+--limit [integer]
+
+For list pagination. The maximum number of results per page, or items
+to return in a paginated “List” call. *1* is the minimum, *1000* is
+the maximum. For important details about how pagination works, see
+List Pagination.
+
+--outbound-ip [text]
+
+The outbound IP address assigned to the tenancy.
+
+--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. The *OUTBOUNDIP* value returns the list in
+ascending order or Outbound Ip address by default. Use the
+*SortOrderQueryParam* to change the direction of the returned list of
+items.
+
+Accepted values are:
+
+   OUTBOUNDIP
+
+--sort-order [text]
+
+The sort order to use, either ascending or descending 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", "--enable-dual-stack", "--enable-propagation", "--
+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/email/email-outbound-ip-collection/list-email-outbound-ips.html#cmdoption-compartment-id
+
+       oci email email-outbound-ip-collection list-email-outbound-ips --compartment-id $compartment_id

oci_cli/help_text_producer/data_files/text/cmdref/email/email-outbound-ip-collection.txt

@@ -0,0 +1,15 @@
+email-outbound-ip-collection
+****************************
+
+
+Description
+===========
+
+Results of an outbound public IP search. Contains
+EmailOutboundIpSummary items.
+
+
+Available Commands
+==================
+
+* list-email-outbound-ips

oci_cli/help_text_producer/data_files/text/cmdref/email/email-return-path/add.txt

@@ -123,12 +123,13 @@ 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"
+defaults-file", "--enable-dual-stack", "--enable-propagation", "--
+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

oci_cli/help_text_producer/data_files/text/cmdref/email/email-return-path/create.txt

@@ -151,12 +151,13 @@ 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"
+defaults-file", "--enable-dual-stack", "--enable-propagation", "--
+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

oci_cli/help_text_producer/data_files/text/cmdref/email/email-return-path/delete.txt

@@ -109,12 +109,13 @@ 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"
+defaults-file", "--enable-dual-stack", "--enable-propagation", "--
+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

oci_cli/help_text_producer/data_files/text/cmdref/email/email-return-path/get.txt

@@ -67,12 +67,13 @@ 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"
+defaults-file", "--enable-dual-stack", "--enable-propagation", "--
+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

oci_cli/help_text_producer/data_files/text/cmdref/email/email-return-path/list.txt

@@ -126,12 +126,13 @@ 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"
+defaults-file", "--enable-dual-stack", "--enable-propagation", "--
+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