list

Description

Gets a list of all steering policies in the specified compartment.

Usage

oci dns steering-policy list [OPTIONS]

Required Parameters

--compartment-id, -c [text]

The OCID of the compartment the resource belongs to.

Optional Parameters

--all

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

--display-name [text]

The displayName of a resource.

--display-name-contains [text]

The partial displayName of a resource. Will match any resource whose name (case-insensitive) contains the provided value.

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

--health-check-monitor-id [text]

Search by health check monitor OCID. Will match any resource whose health check monitor ID matches the provided value.

--id [text]

The OCID of a resource.

--lifecycle-state [text]

The state of a resource.

Accepted values are:

ACTIVE, CREATING, DELETED, DELETING
--limit [integer]

The maximum number of items to return in a page of the collection.

--page [text]

The value of the opc-next-page response header from the previous "List" call.

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

--scope [text]

Specifies to operate only on resources that have a matching DNS scope.

Accepted values are:

GLOBAL, PRIVATE
--sort-by [text]

The field by which to sort steering policies. If unspecified, defaults to timeCreated.

Accepted values are:

displayName, template, timeCreated
--sort-order [text]

The order to sort the resources.

Accepted values are:

ASC, DESC
--template [text]

Search by steering template type. Will match any resource whose template type matches the provided value.

--time-created-greater-than-or-equal-to [datetime]

An RFC 3339 timestamp that states all returned resources were created on or after the indicated time.

The following datetime formats are supported:

Format: YYYY-MM-DDTHH:mm:ss.sssTZD
Example: 2017-09-15T20:30:00.123Z
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T20:30:00Z
Format: YYYY-MM-DDTHH:mmTZD
Example: 2017-09-15T20:30Z
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800
Format: YYYY-MM-DDTHH:mmTZD
Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800

The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes)

Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
Example: '2017-09-15 17:25'

This date will be taken as midnight UTC of that day

Format: YYYY-MM-DD
Example: 2017-09-15
Example: 1412195400
--time-created-less-than [datetime]

An RFC 3339 timestamp that states all returned resources were created before the indicated time.

The following datetime formats are supported:

Format: YYYY-MM-DDTHH:mm:ss.sssTZD
Example: 2017-09-15T20:30:00.123Z
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T20:30:00Z
Format: YYYY-MM-DDTHH:mmTZD
Example: 2017-09-15T20:30Z
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800
Format: YYYY-MM-DDTHH:mmTZD
Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800

The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes)

Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
Example: '2017-09-15 17:25'

This date will be taken as midnight UTC of that day

Format: YYYY-MM-DD
Example: 2017-09-15
Example: 1412195400

Examples

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/dns/steering-policy/list.html#cmdoption-compartment-id

    oci dns steering-policy list --compartment-id $compartment_id