Lists all availability catalogs.


oci capacity-management occ-availability-catalog-collection list [OPTIONS]

Required Parameters

--compartment-id, -c [text]

The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.

Optional Parameters


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

--catalog-state [text]

Filter the list of availability catalogs based on the catalog state.

Accepted values are:

--display-name [text]

A filter to return only the resources that match the entire display name. The match is not case sensitive.

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

--id [text]

The OCID of the availability catalog to filter the list of availability catalogs.

--limit [integer]

The maximum number of items to return.

--namespace [text]

The namespace by which we would filter the list.

Accepted values are:

--page [text]

A token representing the position at which to start retrieving results. This must come from 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. Only one sort order may be provided. The default order for displayName is ascending. The default order for timeCreated is descending.

Accepted values are:

displayName, timeCreated
--sort-order [text]

The sort order to use, either ‘ASC’ or ‘DESC’.

Accepted values are:


Example using required parameter

Copy the following CLI commands into a file named Run the command by typing “bash” 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> #

    oci capacity-management occ-availability-catalog-collection list --compartment-id $compartment_id