oci-cli 3.64.1__py3-none-any.whl → 3.65.0__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/dts/export/create.txt

@@ -1,226 +0,0 @@
-"create"
-********
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Creates a new Appliance Export Job that corresponds with customer’s
-logical dataset
-
-
-Usage
-=====
-
-   oci dts export create [OPTIONS]
-
-
-Required Parameters
-===================
-
---address1 [text]
-
-Address line 1.
-
---addressee [text]
-
-Company or person to send the appliance to
-
---bucket-name [text]
-
-Name of the object storage bucket for this export job
-
---care-of [text]
-
-Place/person to direct the package to.
-
---city-or-locality [text]
-
-City or Locality.
-
---compartment-id, -c [text]
-
-OCID of the compartment in which the export job is created
-
---country [text]
-
-Country.
-
---display-name [text]
-
-User friendly name of the export job
-
---email [text]
-
-Email address.
-
---phone-number [text]
-
-Phone number.
-
---state-province-region [text]
-
-State or Province or Region.
-
---zip-postal-code [text]
-
-Zip or Postal Code
-
-
-Optional Parameters
-===================
-
---address2 [text]
-
-Optional address line 2.
-
---address3 [text]
-
-Optional address line 3.
-
---address4 [text]
-
-Optional address line 4.
-
---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.
-
---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
-
---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.
-
---setup-notifications [boolean]
-
-Setup notifications for export
-
---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, CANCELLED, CREATING, DELETED, FAILED, INPROGRESS, SUCCEEDED
-
---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 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 address1=<substitute-value-of-address1> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/export/create.html#cmdoption-address1
-       export addressee=<substitute-value-of-addressee> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/export/create.html#cmdoption-addressee
-       export bucket_name=<substitute-value-of-bucket_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/export/create.html#cmdoption-bucket-name
-       export care_of=<substitute-value-of-care_of> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/export/create.html#cmdoption-care-of
-       export city_or_locality=<substitute-value-of-city_or_locality> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/export/create.html#cmdoption-city-or-locality
-       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/export/create.html#cmdoption-compartment-id
-       export country=<substitute-value-of-country> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/export/create.html#cmdoption-country
-       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/export/create.html#cmdoption-display-name
-       export email=<substitute-value-of-email> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/export/create.html#cmdoption-email
-       export phone_number=<substitute-value-of-phone_number> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/export/create.html#cmdoption-phone-number
-       export state_province_region=<substitute-value-of-state_province_region> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/export/create.html#cmdoption-state-province-region
-       export zip_postal_code=<substitute-value-of-zip_postal_code> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/export/create.html#cmdoption-zip-postal-code
-
-       oci dts export create --address1 $address1 --addressee $addressee --bucket-name $bucket_name --care-of $care_of --city-or-locality $city_or_locality --compartment-id $compartment_id --country $country --display-name $display_name --email $email --phone-number $phone_number --state-province-region $state_province_region --zip-postal-code $zip_postal_code

oci_cli/help_text_producer/data_files/text/cmdref/dts/export/delete.txt

@@ -1,132 +0,0 @@
-"delete"
-********
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-deletes a Appliance Export Job
-
-
-Usage
-=====
-
-   oci dts export delete [OPTIONS]
-
-
-Required Parameters
-===================
-
---job-id [text]
-
-OCID of the Export Job
-
-
-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]
-
-The entity tag to match. Optional, if set, the update will be
-successful only if the object’s tag matches the tag specified in the
-request.
-
---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, CANCELLED, CREATING, DELETED, FAILED, INPROGRESS, SUCCEEDED
-
---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 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 bucket=<substitute-value-of-bucket> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/job/create.html#cmdoption-bucket
-       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/job/create.html#cmdoption-compartment-id
-       export device_type=<substitute-value-of-device_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/job/create.html#cmdoption-device-type
-       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/job/create.html#cmdoption-display-name
-
-       job_id=$(oci dts job create --bucket $bucket --compartment-id $compartment_id --device-type $device_type --display-name $display_name --query data.id --raw-output)
-
-       oci dts export delete --job-id $job_id

oci_cli/help_text_producer/data_files/text/cmdref/dts/export/generate-manifest.txt

@@ -1,97 +0,0 @@
-"generate-manifest"
-*******************
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Generates a manifest file for the objects that need to be exported
-
-
-Usage
-=====
-
-   oci dts export generate-manifest [OPTIONS]
-
-
-Required Parameters
-===================
-
---bucket [text]
-
-Name of the bucket for which export is requested
-
---compartment-id, -c [text]
-
-Compartment OCID where the bucket resides
-
---job-id [text]
-
-OCID of the Export Job
-
-
-Optional Parameters
-===================
-
---end [text]
-
-The subset of objects that needs to be exported upto this object
-(inclusive)
-
---prefix [text]
-
-The subset of objects that needs to be exported whose names starts
-with this Prefix
-
---start [text]
-
-The subset of objects that needs to be exported starting with this
-object (inclusive)
-
-
-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 bucket=<substitute-value-of-bucket> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/job/create.html#cmdoption-bucket
-       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/job/create.html#cmdoption-compartment-id
-       export device_type=<substitute-value-of-device_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/job/create.html#cmdoption-device-type
-       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/job/create.html#cmdoption-display-name
-
-       job_id=$(oci dts job create --bucket $bucket --compartment-id $compartment_id --device-type $device_type --display-name $display_name --query data.id --raw-output)
-
-       oci dts export generate-manifest --bucket $bucket --compartment-id $compartment_id --job-id $job_id

oci_cli/help_text_producer/data_files/text/cmdref/dts/export/get-passphrase.txt

@@ -1,68 +0,0 @@
-"get-passphrase"
-****************
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Get the passphrase of the export job
-
-
-Usage
-=====
-
-   oci dts export get-passphrase [OPTIONS]
-
-
-Required Parameters
-===================
-
---job-id [text]
-
-OCID of the Export Job
-
-
-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 bucket=<substitute-value-of-bucket> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/job/create.html#cmdoption-bucket
-       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/job/create.html#cmdoption-compartment-id
-       export device_type=<substitute-value-of-device_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/job/create.html#cmdoption-device-type
-       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/job/create.html#cmdoption-display-name
-
-       job_id=$(oci dts job create --bucket $bucket --compartment-id $compartment_id --device-type $device_type --display-name $display_name --query data.id --raw-output)
-
-       oci dts export get-passphrase --job-id $job_id

oci_cli/help_text_producer/data_files/text/cmdref/dts/export/request-appliance.txt

@@ -1,68 +0,0 @@
-"request-appliance"
-*******************
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Request an appliance for export
-
-
-Usage
-=====
-
-   oci dts export request-appliance [OPTIONS]
-
-
-Required Parameters
-===================
-
---job-id [text]
-
-OCID of the Export Job
-
-
-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 bucket=<substitute-value-of-bucket> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/job/create.html#cmdoption-bucket
-       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/job/create.html#cmdoption-compartment-id
-       export device_type=<substitute-value-of-device_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/job/create.html#cmdoption-device-type
-       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dts/job/create.html#cmdoption-display-name
-
-       job_id=$(oci dts job create --bucket $bucket --compartment-id $compartment_id --device-type $device_type --display-name $display_name --query data.id --raw-output)
-
-       oci dts export request-appliance --job-id $job_id