list

Description

Lists DKIMs for a email domain.

Usage

oci email dkim list [OPTIONS]

Required Parameters

--email-domain-id [text]

The OCID of the email domain to which this DKIM belongs.

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/Content/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, NEEDS_ATTENTION, 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 DKIMs.

Default: TIMECREATED

  • TIMECREATED: Sorts by timeCreated. * NAME: Sorts by name. * ID: Sorts by id.

Accepted values are:

ID, NAME, TIMECREATED
--sort-order [text]

The sort order to use, either ascending or descending order.

Accepted values are:

ASC, DESC

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 email_domain_id=<substitute-value-of-email_domain_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/email/dkim/list.html#cmdoption-email-domain-id

    oci email dkim list --email-domain-id $email_domain_id