list

Description

Return a list of log analytics entities.

Usage

oci log-analytics entity list [OPTIONS]

Required Parameters

--compartment-id, -c [text]

The ID of the compartment in which to list resources.

--namespace-name, --namespace, -ns [text]

The Logging Analytics namespace used for the request.

Optional Parameters

--all

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

--cloud-resource-id [text]

A filter to return only log analytics entities whose cloudResourceId matches the cloudResourceId given.

--creation-source-details [text]

A filter to return only log analytics entities whose auto-creation source details contains the specified string.

--creation-source-type [text]

A filter to return only those log analytics entities with the specified auto-creation source.

Accepted values are:

BULK_DISCOVERY, DISCOVERY, EM_BRIDGE, LOGGING_ANALYTICS, NONE, SERVICE_CONNECTOR_HUB

--entity-type-name [text]

A filter to return only log analytics entities whose entityTypeName matches the entire log analytics entity type name of one of the entityTypeNames given in the list. The match is case-insensitive.

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

--hostname [text]

A filter to return only log analytics entities whose hostname matches the entire hostname given.

--hostname-contains [text]

A filter to return only log analytics entities whose hostname contains the substring given. The match is case-insensitive.

--is-agent-id-null [text]

A filter to return only those log analytics entities whose managementAgentId is null or is not null

Accepted values are:

false, true

--lifecycle-details-contains [text]

A filter to return only log analytics entities whose lifecycleDetails contains the specified string.

--lifecycle-state [text]

A filter to return only those log analytics entities with the specified lifecycle state. The state value is case-insensitive.

Accepted values are:

ACTIVE, DELETED

--limit [integer]

The maximum number of items to return.

--metadata-equals [text]

A filter to return only log analytics entities whose metadata name, value and type matches the specified string. Each item in the array has the format “{name}:{value}:{type}”. All inputs are case-insensitive.

--name [text]

A filter to return only log analytics entities whose name matches the entire name given. The match is case-insensitive.

--name-contains [text]

A filter to return only log analytics entities whose name contains the name given. The match is case-insensitive.

--page [text]

The page token representing the page at which to start retrieving results. This is usually retrieved from a 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.

--sort-by [text]

The field to sort entities by. Only one sort order may be provided. Default order for timeCreated and timeUpdated is descending. Default order for entity name is ascending. If no value is specified timeCreated is default.

Accepted values are:

name, timeCreated, timeUpdated

--sort-order [text]

The sort order to use, either ascending (ASC) or descending (DESC).

Accepted values are:

ASC, DESC

--source-id [text]

A filter to return only log analytics entities whose sourceId matches the sourceId given.

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/log-analytics/entity/list.html#cmdoption-compartment-id
    export namespace_name=<substitute-value-of-namespace_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/log-analytics/entity/list.html#cmdoption-namespace-name

    oci log-analytics entity list --compartment-id $compartment_id --namespace-name $namespace_name