list-top-utilized-product-licenses

Description

Retrieves the top utilized product licenses for a given compartment.

Usage

oci license-manager product-license list-top-utilized-product-licenses [OPTIONS]

Required Parameters

--compartment-id, -c [text]

The compartment OCID used for the license record, product license, and configuration.

Optional Parameters

--all

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

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

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

Indicates if the given compartment is the root compartment.

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

Specifies the attribute with which to sort the rules.

Default: totalLicenseUnitsConsumed

  • totalLicenseUnitsConsumed: Sorts by totalLicenseUnitsConsumed of ProductLicense.

Accepted values are:

totalLicenseUnitsConsumed
--sort-order [text]

The sort order to use, whether ASC or DESC.

Accepted values are:

ASC, DESC

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/license-manager/product-license/list-top-utilized-product-licenses.html#cmdoption-compartment-id

    oci license-manager product-license list-top-utilized-product-licenses --compartment-id $compartment_id