"list"
******

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Examples


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

Retrieves details of all the sources that are available in the
specified compartment and match the specified query criteria. If you
don’t specify any query criteria, then details of all the sources are
displayed. To filter the retrieved results, you can pass one or more
of the following query parameters, by appending them to the URI as
shown in the following example.


Usage
=====

   oci application-migration source list [OPTIONS]


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

--compartment-id, -c [text]

The OCID of a compartment. Retrieves details of objects in the
specified compartment.


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

--all

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

--display-name [text]

Display name on which to query.

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

--id [text]

The OCID on which to query for a source.

--lifecycle-state [text]

Filter results on lifecycleState.

Accepted values are:

   ACTIVE, CREATING, DELETED, DELETING, INACTIVE, UPDATING

--limit [integer]

The number of items returned in a paginated *List* call. For
information about pagination, see List Pagination.

--page [text]

The value of the *opc-next-page* response header from the preceding
*List* call. For information about pagination, 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 field on which to sort. By default, *TIMECREATED* is
ordered descending. By default, *DISPLAYNAME* is ordered ascending.
Note that you can sort only on one field.

Accepted values are:

   DISPLAYNAME, TIMECREATED

--sort-order [text]

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

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", "--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", "-i", "-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/application-migration/source/list.html#cmdoption-compartment-id

       oci application-migration source list --compartment-id $compartment_id
