"list"
******

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Examples


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

Returns a list of all ResponderRecipes in a compartment The
ListResponderRecipe operation returns only the targets in
*compartmentId* passed. The list does not include any subcompartments
of the compartmentId passed.

The parameter *accessLevel* specifies whether to return only those
compartments for which the requestor has INSPECT permissions on at
least one resource directly or indirectly (ACCESSIBLE) (the resource
can be in a subcompartment) or to return Not Authorized if Principal
doesn’t have access to even one of the child compartments. This is
valid only when *compartmentIdInSubtree* is set to *true*.

The parameter *compartmentIdInSubtree* applies when you perform
ListResponderRecipe on the *compartmentId* passed and when it is set
to true, the entire hierarchy of compartments can be returned. To get
a full list of all compartments and subcompartments in the tenancy
(root compartment), set the parameter *compartmentIdInSubtree* to true
and *accessLevel* to ACCESSIBLE.


Usage
=====

   oci cloud-guard responder-recipe list [OPTIONS]


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

--compartment-id, -c [text]

The ID of the compartment in which to list resources.


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

--access-level [text]

Valid values are *RESTRICTED* and *ACCESSIBLE*. Default is
*RESTRICTED*. Setting this to *ACCESSIBLE* returns only those
compartments for which the user has INSPECT permissions directly or
indirectly (permissions can be on a resource in a subcompartment).
When set to *RESTRICTED* permissions are checked and no partial
results are displayed.

Accepted values are:

   ACCESSIBLE, RESTRICTED

--all

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

--compartment-id-in-subtree [boolean]

Default is false. When set to true, the hierarchy of compartments is
traversed and all compartments and subcompartments in the tenancy are
returned depending on the the setting of *accessLevel*.

--display-name [text]

A filter to return only resources that match the entire display name
given.

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

--lifecycle-state [text]

The field life cycle state. Only one state can be provided. Default
value for state is active. If no value is specified state is active.

Accepted values are:

   ACTIVE, CREATING, DELETED, DELETING, FAILED, INACTIVE, UPDATING

--limit [integer]

The maximum number of items to return.

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

--resource-metadata-only [boolean]

Default is false. When set to true, the list of all Oracle Managed
Resources Metadata supported by Cloud Guard are returned.

--sort-by [text]

The field to sort by. Only one sort order may be provided. Default
order for timeCreated is descending. Default order for displayName is
ascending. If no value is specified timeCreated is default.

Accepted values are:

   displayName, timeCreated

--sort-order [text]

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

Accepted values are:

   ASC, DESC


Global Parameters
=================

Use "oci --help" for help on global parameters.

"--auth-purpose", "--auth", "--cert-bundle", "--cli-rc-file", "--
config-file", "--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", "--query", "--raw-
output", "--region", "--release-info", "--request-id", "--version",
"-?", "-d", "-h", "-v"


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/cloud-guard/responder-recipe/list.html#cmdoption-compartment-id

       oci cloud-guard responder-recipe list --compartment-id $compartment_id
