list

Description

Lists availabilities for a particular availability catalog.

Usage

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

Required Parameters

--occ-availability-catalog-id [text]

The OCID of the availability catalog.

Optional Parameters

--all

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

--date-expected-capacity-handover [text]

The capacity handover date of the capacity constraint to filter the list of capacity constraints.

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

--limit [integer]

The maximum number of items to return.

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

--resource-name [text]

The name of the resource to filter the list of capacity constraints.

--resource-type [text]

Resource type using which the capacity constraints of an availability catalog can be filtered.

Accepted values are:

CAPACITY_CONSTRAINT, SERVER_HW

--sort-by [text]

The field to sort by. Only one sort order may be provided. The default order for resource name is ascending. The default order for date of capacity handover is descending.

Accepted values are:

dateExpectedCapacityHandover, resourceName

--sort-order [text]

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

Accepted values are:

ASC, DESC

--workload-type [text]

Workload type using the resources in an availability catalog can be filtered.

Accepted values are:

GENERIC, ROW, US_PROD

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 base64_encoded_catalog_details=<substitute-value-of-base64_encoded_catalog_details> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/capacity-management/occ-availability-catalog/create.html#cmdoption-base64-encoded-catalog-details
    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/capacity-management/occ-availability-catalog/create.html#cmdoption-compartment-id
    export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/capacity-management/occ-availability-catalog/create.html#cmdoption-display-name
    export namespace=<substitute-value-of-namespace> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/capacity-management/occ-availability-catalog/create.html#cmdoption-namespace
    export occ_customer_group_id=<substitute-value-of-occ_customer_group_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/capacity-management/occ-availability-catalog/create.html#cmdoption-occ-customer-group-id

    occ_availability_catalog_id=$(oci capacity-management occ-availability-catalog create --base64-encoded-catalog-details $base64_encoded_catalog_details --compartment-id $compartment_id --display-name $display_name --namespace $namespace --occ-customer-group-id $occ_customer_group_id --query data.id --raw-output)

    oci capacity-management occ-availability-collection list --occ-availability-catalog-id $occ_availability_catalog_id