"list-monitors"
***************

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Example using required parameter


Description
===========

Returns a list of monitors.


Usage
=====

   oci apm-synthetics monitor-collection list-monitors [OPTIONS]


Required Parameters
===================

--apm-domain-id [text]

The APM domain ID the request is intended for.


Optional Parameters
===================

--all

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

--display-name [text]

A filter to return only the resources that match the entire 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/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--is-maintenance-window-active [boolean]

A filter to return the monitors whose maintenance window is currently
active.

--is-maintenance-window-set [boolean]

A filter to return the monitors whose maintenance window is set.

--limit [integer]

The maximum number of items to return.

--monitor-type [text]

A filter to return only monitors that match the given monitor type.
Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST, REST
and NETWORK.

--page [text]

The maximum number of results per page, or items to return in a
paginated “List” call. For information on how pagination works, see
List Pagination.

Example:

   50

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

--script-id [text]

A filter to return only monitors using scriptId.

--sort-by [text]

The field to sort by. Only one sort order may be provided. Default
order of displayName is ascending. Default order of timeCreated and
timeUpdated is descending. The displayName sort by is case
insensitive.

Accepted values are:

   displayName, maintenanceWindowTimeStarted, monitorType, status, timeCreated, timeUpdated

--sort-order [text]

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

Accepted values are:

   ASC, DESC

--status [text]

A filter to return only monitors that match the status given.

Accepted values are:

   DISABLED, ENABLED, INVALID

--vantage-point [text]

The name of the public or dedicated vantage point.


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 apm_domain_id=<substitute-value-of-apm_domain_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/apm-synthetics/monitor-collection/list-monitors.html#cmdoption-apm-domain-id

       oci apm-synthetics monitor-collection list-monitors --apm-domain-id $apm_domain_id
