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/os-management/scheduled-job/change-compartment.txt

@@ -1,110 +0,0 @@
-"change-compartment"
-********************
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Moves a resource into a different compartment. When provided, If-Match
-is checked against ETag values of the resource.
-
-
-Usage
-=====
-
-   oci os-management scheduled-job change-compartment [OPTIONS]
-
-
-Required Parameters
-===================
-
---scheduled-job-id [text]
-
-The ID of the scheduled job.
-
-
-Optional Parameters
-===================
-
---compartment-id, -c [text]
-
-The OCID of the compartment into which the resource should be moved.
-
---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 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/os-management/scheduled-job/create.html#cmdoption-compartment-id
-       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/os-management/scheduled-job/create.html#cmdoption-display-name
-       export operation_type=<substitute-value-of-operation_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/os-management/scheduled-job/create.html#cmdoption-operation-type
-       export schedule_type=<substitute-value-of-schedule_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/os-management/scheduled-job/create.html#cmdoption-schedule-type
-       export time_next_execution=<substitute-value-of-time_next_execution> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/os-management/scheduled-job/create.html#cmdoption-time-next-execution
-
-       scheduled_job_id=$(oci os-management scheduled-job create --compartment-id $compartment_id --display-name $display_name --operation-type $operation_type --schedule-type $schedule_type --time-next-execution $time_next_execution --query data.id --raw-output)
-
-       oci os-management scheduled-job change-compartment --scheduled-job-id $scheduled_job_id

oci_cli/help_text_producer/data_files/text/cmdref/os-management/scheduled-job/create.txt

@@ -1,357 +0,0 @@
-"create"
-********
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Creates a new Scheduled Job to perform a specific package operation on
-a set of managed instances or managed instance groups.  Can be created
-as a one-time execution in the future, or as a recurring execution
-that repeats on a defined interval.
-
-
-Usage
-=====
-
-   oci os-management scheduled-job create [OPTIONS]
-
-
-Required Parameters
-===================
-
---compartment-id, -c [text]
-
-OCID for the Compartment
-
---display-name [text]
-
-Scheduled Job name
-
---operation-type [text]
-
-the type of operation this Scheduled Job performs
-
-Accepted values are:
-
-   COMPOUND, DISABLEMODULESTREAM, ENABLEMODULESTREAM, INSTALL, INSTALLMODULESTREAMPROFILE, REMOVE, REMOVEMODULESTREAMPROFILE, SWITCHMODULESTREAM, UPDATE, UPDATEALL
-
---schedule-type [text]
-
-the type of scheduling this Scheduled Job follows
-
-Accepted values are:
-
-   ONETIME, RECURRING
-
---time-next-execution [datetime]
-
-the desired time for the next execution of this Scheduled Job
-
-   The following datetime formats are supported:
-
-
-UTC with microseconds
----------------------
-
-   Format: YYYY-MM-DDTHH:mm:ss.ssssssTZD
-   Example: 2017-09-15T20:30:00.123456Z
-
-   UTC with milliseconds
-   ***********************
-   .. code::
-
-       Format: YYYY-MM-DDTHH:mm:ss.sssTZD
-       Example: 2017-09-15T20:30:00.123Z
-
-   UTC without milliseconds
-   **************************
-   .. code::
-
-       Format: YYYY-MM-DDTHH:mm:ssTZD
-       Example: 2017-09-15T20:30:00Z
-
-   UTC with minute precision
-   **************************
-   .. code::
-
-       Format: YYYY-MM-DDTHH:mmTZD
-       Example: 2017-09-15T20:30Z
-
-
-Timezone with microseconds
---------------------------
-
-   Format: YYYY-MM-DDTHH:mm:ssTZD
-   Example: 2017-09-15T12:30:00.456789-08:00, 2017-09-15T12:30:00.456789-0800
-
-   Timezone with milliseconds
-   ***************************
-   .. code::
-
-       Format: YYYY-MM-DDTHH:mm:ssTZD
-       Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800
-
-   Timezone without milliseconds
-   *******************************
-   .. code::
-
-       Format: YYYY-MM-DDTHH:mm:ssTZD
-       Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800
-
-   Timezone with minute precision
-   *******************************
-   .. code::
-
-       Format: YYYY-MM-DDTHH:mmTZD
-       Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800
-
-   Short date and time
-   ********************
-   The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes)
-
-   .. code::
-
-       Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
-       Example: '2017-09-15 17:25'
-
-   Date Only
-   **********
-   This date will be taken as midnight UTC of that day
-
-   .. code::
-
-       Format: YYYY-MM-DD
-       Example: 2017-09-15
-
-   Epoch seconds
-   **************
-   .. code::
-
-       Example: 1412195400
-
-
-Optional Parameters
-===================
-
---defined-tags [complex type]
-
-Defined tags for this resource. Each key is predefined and scoped to a
-namespace. Example: *{“foo-namespace”: {“bar-key”: “value”}}* 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]
-
-Details describing the Scheduled Job.
-
---freeform-tags [complex type]
-
-Simple key-value pair that is applied without any predefined name,
-type or scope. Exists for cross-compatibility only. Example: *{“bar-
-key”: “value”}* 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
-
---interval-type [text]
-
-the interval period for a recurring Scheduled Job (only if schedule
-type is RECURRING)
-
-Accepted values are:
-
-   DAY, HOUR, MONTH, WEEK
-
---interval-value [text]
-
-the value for the interval period for a recurring Scheduled Job (only
-if schedule type is RECURRING)
-
---managed-instance-groups [complex type]
-
-The list of managed instance groups this scheduled job operates on
-(mutually exclusive with managedInstances). Either this or
-managedInstances must be supplied.
-
-This option is a JSON list with items of type Id.  For documentation
-on Id please see our API reference: https://docs.cloud.oracle.com/api
-/#/en/osmanagement/20190801/datatypes/Id. 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.
-
---managed-instances [complex type]
-
-The list of managed instances this scheduled job operates on (mutually
-exclusive with managedInstanceGroups). Either this or the
-managedInstanceGroups must be supplied.
-
-This option is a JSON list with items of type Id.  For documentation
-on Id please see our API reference: https://docs.cloud.oracle.com/api
-/#/en/osmanagement/20190801/datatypes/Id. 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.
-
---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.
-
---os-family [text]
-
-The Operating System type of the managed instance(s) on which this
-scheduled job will operate. If not specified, this defaults to Linux.
-
-Accepted values are:
-
-   ALL, LINUX, WINDOWS
-
---package-names [complex type]
-
-the id of the package (only if operation type is
-INSTALL/UPDATE/REMOVE)
-
-This option is a JSON list with items of type PackageName.  For
-documentation on PackageName please see our API reference: https://do
-cs.cloud.oracle.com/api/#/en/osmanagement/20190801/datatypes/PackageN
-ame. 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.
-
---update-names [complex type]
-
-The unique names of the Windows Updates (only if operation type is
-INSTALL). This is only applicable when the osFamily is for Windows
-managed instances. 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.
-
---update-type [text]
-
-Type of the update (only if operation type is UPDATEALL)
-
-Accepted values are:
-
-   ALL, BUGFIX, ENHANCEMENT, KSPLICE, OTHER, SECURITY
-
---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, UPDATING
-
---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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/os-management/scheduled-job/create.html#cmdoption-compartment-id
-       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/os-management/scheduled-job/create.html#cmdoption-display-name
-       export operation_type=<substitute-value-of-operation_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/os-management/scheduled-job/create.html#cmdoption-operation-type
-       export schedule_type=<substitute-value-of-schedule_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/os-management/scheduled-job/create.html#cmdoption-schedule-type
-       export time_next_execution=<substitute-value-of-time_next_execution> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/os-management/scheduled-job/create.html#cmdoption-time-next-execution
-
-       oci os-management scheduled-job create --compartment-id $compartment_id --display-name $display_name --operation-type $operation_type --schedule-type $schedule_type --time-next-execution $time_next_execution

oci_cli/help_text_producer/data_files/text/cmdref/os-management/scheduled-job/delete.txt

@@ -1,135 +0,0 @@
-"delete"
-********
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Cancels an existing Scheduled Job on the management system
-
-
-Usage
-=====
-
-   oci os-management scheduled-job delete [OPTIONS]
-
-
-Required Parameters
-===================
-
---scheduled-job-id [text]
-
-The ID of the scheduled 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]
-
-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 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, UPDATING
-
---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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/os-management/scheduled-job/create.html#cmdoption-compartment-id
-       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/os-management/scheduled-job/create.html#cmdoption-display-name
-       export operation_type=<substitute-value-of-operation_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/os-management/scheduled-job/create.html#cmdoption-operation-type
-       export schedule_type=<substitute-value-of-schedule_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/os-management/scheduled-job/create.html#cmdoption-schedule-type
-       export time_next_execution=<substitute-value-of-time_next_execution> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/os-management/scheduled-job/create.html#cmdoption-time-next-execution
-
-       scheduled_job_id=$(oci os-management scheduled-job create --compartment-id $compartment_id --display-name $display_name --operation-type $operation_type --schedule-type $schedule_type --time-next-execution $time_next_execution --query data.id --raw-output)
-
-       oci os-management scheduled-job delete --scheduled-job-id $scheduled_job_id