list

Description

Lists all unified agent configurations in the specified compartment.

Usage

oci logging agent-configuration list [OPTIONS]

Required Parameters

--compartment-id, -c [text]

Compartment OCID to list resources in. See compartmentIdInSubtree for nested compartments traversal.

Optional Parameters

--all

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

--compartmentidinsubtree [boolean]

Specifies whether or not nested compartments should be traversed. Defaults to false.

--display-name [text]

Resource 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 a group or a dynamic group.

--lifecycle-state [text]

Lifecycle state of the log object

Accepted values are:

ACTIVE, CREATING, DELETING, FAILED, INACTIVE, UPDATING

--limit [integer]

The maximum number of items to return in a paginated “List” call.

--log-id [text]

Custom log OCID to list resources with the log as destination.

--page [text]

For list pagination. The value of the opc-next-page or opc-previous-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]

The field to sort by (one column only). Default sort order is ascending exception of timeCreated and timeLastModified columns (descending).

Accepted values are:

displayName, timeCreated

--sort-order [text]

The sort order to use, whether ‘asc’ or ‘desc’.

Accepted values are:

ASC, DESC

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/logging/agent-configuration/list.html#cmdoption-compartment-id

    oci logging agent-configuration list --compartment-id $compartment_id