oracle.oci.oci_license_manager_product_license_consumer_facts – Fetches details about one or multiple ProductLicenseConsumer resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_license_manager_product_license_consumer_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple ProductLicenseConsumer resources in Oracle Cloud Infrastructure

  • Retrieves the product license consumers for a particular product license ID.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string / required
The compartment OCID used for the license record, product license, and configuration.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
is_compartment_id_in_subtree
boolean
    Choices:
  • no
  • yes
Indicates if the given compartment is the root compartment.
product_license_id
string / required
Unique product license identifier.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
sort_by
string
    Choices:
  • licenseUnitsRequired
Specifies the attribute with which to sort the rules.
Default: `licenseUnitsRequired`
* **licenseUnitsRequired:** Sorts by licenseUnitsRequired of the Resource.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, whether `ASC` or `DESC`.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm

Examples

- name: List product_license_consumers
  oci_license_manager_product_license_consumer_facts:
    # required
    product_license_id: "ocid1.productlicense.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    is_compartment_id_in_subtree: true
    sort_order: ASC
    sort_by: licenseUnitsRequired

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
product_license_consumers
complex
on success
List of ProductLicenseConsumer resources

Sample:
[{'are_all_options_available': True, 'is_base_license_available': True, 'license_unit_type': 'OCPU', 'license_units_consumed': 1.2, 'missing_products': [{'category': 'BASE', 'count': 1.2, 'name': 'name_example'}], 'product_name': 'product_name_example', 'resource_compartment_id': 'ocid1.resourcecompartment.oc1..xxxxxxEXAMPLExxxxxx', 'resource_compartment_name': 'resource_compartment_name_example', 'resource_id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'resource_name': 'resource_name_example', 'resource_unit_count': 1.2, 'resource_unit_type': 'OCPU'}]
 
are_all_options_available
boolean
on success
Specifies if all options are available.

Sample:
True
 
is_base_license_available
boolean
on success
Specifies if the base license is available.

Sample:
True
 
license_unit_type
string
on success
The product license unit.

Sample:
OCPU
 
license_units_consumed
float
on success
Number of license units consumed by the resource.

Sample:
1.2
 
missing_products
complex
on success
Collection of missing product licenses.

   
category
string
on success
Product category base or option.

Sample:
BASE
   
count
float
on success
Units required for the missing product.

Sample:
1.2
   
name
string
on success
Name of the product.

Sample:
name_example
 
product_name
string
on success
The resource product name.

Sample:
product_name_example
 
resource_compartment_id
string
on success
The OCID of the compartment that contains the resource.

Sample:
ocid1.resourcecompartment.oc1..xxxxxxEXAMPLExxxxxx
 
resource_compartment_name
string
on success
The display name of the compartment that contains the resource.

Sample:
resource_compartment_name_example
 
resource_id
string
on success
The OCID of the resource.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
resource_name
string
on success
The display name of the resource.

Sample:
resource_name_example
 
resource_unit_count
float
on success
Number of units of the resource

Sample:
1.2
 
resource_unit_type
string
on success
The unit type for the resource.

Sample:
OCPU


Authors

  • Oracle (@oracle)