"list"
******

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Example using required parameter


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

Lists the Deployment Upgrades in a compartment.


Usage
=====

   oci goldengate deployment-upgrade list [OPTIONS]


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

--compartment-id, -c [text]

The OCID of the compartment that contains the work request. Work
requests should be scoped to the same compartment as the resource the
work request affects. If the work request concerns multiple resources,
and those resources are not in the same compartment, it is up to the
service team to pick the primary resource whose compartment should be
used.


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

--all

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

--deployment-id [text]

The OCID of the deployment in which to list resources.

--display-name [text]

A filter to return only the resources that match the entire
‘displayName’ 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]

A filter to return only the resources that match the ‘lifecycleState’
given.

Accepted values are:

   ACTIVE, CANCELED, CANCELING, CREATING, DELETED, DELETING, FAILED, INACTIVE, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, UPDATING, WAITING

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

--sort-by [text]

The field to sort by. Only one sort order can be provided. Default
order for ‘timeCreated’ is descending.  Default order for
‘displayName’ is ascending. If no value is specified timeCreated is
the 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-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/goldengate/deployment-upgrade/list.html#cmdoption-compartment-id

       oci goldengate deployment-upgrade list --compartment-id $compartment_id
