list

Description

Lists scheduled jobs that match the specified compartment or scheduled job OCID.

Usage

oci os-management-hub scheduled-job list [OPTIONS]

Optional Parameters

--all

Fetches all pages of results. If you provide this option, then you cannot provide the --limit option.

--compartment-id, -c [text]

The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment.

--compartment-id-in-subtree [boolean]

Indicates whether to include subcompartments in the returned results. Default is false.

--display-name [text]

A filter to return resources that match the given user-friendly name.

--display-name-contains [text]

A filter to return resources that may partially match the given display name.

--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/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--group-id [text]

The OCID of the managed instance group for which to list resources.

--is-managed-by-alx [boolean]

Indicates whether to list only resources managed by the Autonomous Linux service.

--is-restricted [boolean]

A filter to return only restricted scheduled jobs.

--lifecycle-state [text]

A filter to return only scheduled jobs currently in the given state.

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. For important details about how pagination works, see List Pagination.

Example:

50

--location [text]

A filter to return only resources whose location matches the given value.

Accepted values are:

AZURE, EC2, GCP, OCI_COMPUTE, ON_PREMISE

--location-ne [text]

A filter to return only resources whose location does not match the given value.

Accepted values are:

AZURE, EC2, GCP, OCI_COMPUTE, ON_PREMISE

--managed-compartment-id [text]

The OCID of the managed compartment. This filter returns resources associated with this compartment.

--managed-instance-id [text]

The OCID of the managed instance. This filter returns resources associated with this managed instance.

--operation-type [text]

A filter to return only scheduled jobs with the given operation type.

Accepted values are:

ATTACH_SOFTWARE_SOURCES, DETACH_SOFTWARE_SOURCES, INSTALL_ALL_WINDOWS_UPDATES, INSTALL_BUGFIX_WINDOWS_UPDATES, INSTALL_ENHANCEMENT_WINDOWS_UPDATES, INSTALL_OTHER_WINDOWS_UPDATES, INSTALL_PACKAGES, INSTALL_SECURITY_WINDOWS_UPDATES, INSTALL_WINDOWS_UPDATES, MANAGE_MODULE_STREAMS, PROMOTE_LIFECYCLE, REMOVE_PACKAGES, SWITCH_MODULE_STREAM, SYNC_MANAGEMENT_STATION_MIRROR, UPDATE_ALL, UPDATE_BUGFIX, UPDATE_ENHANCEMENT, UPDATE_KSPLICE_KERNEL, UPDATE_KSPLICE_USERSPACE, UPDATE_OTHER, UPDATE_PACKAGES, UPDATE_SECURITY

--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.

Example:

3

--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.

--schedule-type [text]

A filter to return only scheduled jobs of the given scheduling type (one-time or recurring).

Accepted values are:

ONETIME, RECURRING

--scheduled-job-id [text]

The OCID of the scheduled job.

--sort-by [text]

The field to sort by. Only one sort order may be provided. 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 ‘ASC’ or ‘DESC’.

Accepted values are:

ASC, DESC

--stage-id [text]

The OCID of the lifecycle stage for which to list resources.

--time-end [datetime]

A filter to return only resources with a date on or before the given value, in ISO 8601 format.

Example: 2017-07-14T02:40:00.000Z

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

--time-start [datetime]

A filter to return only resources with a date on or after the given value, in ISO 8601 format.

Example: 2017-07-14T02:40:00.000Z

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

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 os-management-hub scheduled-job list