list

Description

Gets a list of all cluster placement groups in the specified compartment.

Usage

oci cpg cluster-placement-group list [OPTIONS]

Optional Parameters

--ad [text]

A filter to return only the resources that match the specified availability domain.

--all

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

--compartment-id, -c [text]

A filter to return only the resources that match the specified compartment OCID.

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

When set to true, cluster placement groups in all compartments under the specified compartment are returned. The default is set to false.

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

--id [text]

A filter to return only the resources that match the specified unique cluster placement group identifier.

--lifecycle-state [text]

A filter to return only the resources that match the specified lifecycle state.

Accepted values are:

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

--limit [integer]

The maximum number of items to return.

--name [text]

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

--page [text]

A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.

--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. You can specify only one sort order. The default order for timeCreated is descending. The default order for name is ascending.

Accepted values are:

id, name, 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.

    oci cpg cluster-placement-group list