oracle.oci.oci_license_manager_product_license_facts – Fetches details about one or multiple ProductLicense resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.0.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_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple ProductLicense resources in Oracle Cloud Infrastructure
Retrieves all the product licenses from a given compartment.
If product_license_id is specified, the details of a single ProductLicense will be returned.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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
|
The compartment OCID used for the license record, product license, and configuration.
Required to list multiple product_licenses.
|
|
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 . |
|
display_name
string
|
Use display_name along with the other options to return only resources that match the given display name exactly.
|
|
is_compartment_id_in_subtree
boolean
|
|
Indicates if the given compartment is the root compartment.
|
product_license_id
string
|
Unique product license identifier.
Required to get a specific product_license.
aliases: id |
|
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
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
|
|
Specifies the attribute with which to sort the rules.
Default: `totalLicenseUnitsConsumed`
* **totalLicenseUnitsConsumed:** Sorts by totalLicenseUnitsConsumed of ProductLicense.
|
sort_order
string
|
|
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 |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific product_license
oci_license_manager_product_license_facts:
# required
product_license_id: "ocid1.productlicense.oc1..xxxxxxEXAMPLExxxxxx"
- name: List product_licenses
oci_license_manager_product_license_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
is_compartment_id_in_subtree: true
sort_order: ASC
sort_by: totalLicenseUnitsConsumed
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
product_licenses
complex
|
on success |
List of ProductLicense resources
Sample:
[{'active_license_record_count': 56, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'images': [{'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'listing_id': 'ocid1.listing.oc1..xxxxxxEXAMPLExxxxxx', 'listing_name': 'listing_name_example', 'package_version': 'package_version_example', 'publisher': 'publisher_example'}], 'is_over_subscribed': True, 'is_unlimited': True, 'is_vendor_oracle': True, 'license_unit': 'OCPU', 'lifecycle_state': 'ACTIVE', 'status': 'INCOMPLETE', 'status_description': 'status_description_example', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'total_active_license_unit_count': 56, 'total_license_record_count': 56, 'total_license_units_consumed': 1.2, 'vendor_name': 'vendor_name_example'}]
|
||
active_license_record_count
integer
|
on success |
The number of active license records associated with the product license.
Sample:
56
|
||
compartment_id
string
|
on success |
The compartment OCID where the product license is created.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||
display_name
string
|
on success |
License record name
Sample:
display_name_example
|
||
freeform_tags
dictionary
|
on success |
Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
Sample:
{'Department': 'Finance'}
|
||
id
string
|
on success |
The product license OCID.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
images
complex
|
on success |
The images associated with the product license.
|
||
id
string
|
on success |
The image ID associated with the product license.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
listing_id
string
|
on success |
The image listing ID.
Sample:
ocid1.listing.oc1..xxxxxxEXAMPLExxxxxx
|
||
listing_name
string
|
on success |
The listing name associated with the product license.
Sample:
listing_name_example
|
||
package_version
string
|
on success |
The image package version.
Sample:
package_version_example
|
||
publisher
string
|
on success |
The image publisher.
Sample:
publisher_example
|
||
is_over_subscribed
boolean
|
on success |
Specifies whether or not the product license is oversubscribed.
Sample:
True
|
||
is_unlimited
boolean
|
on success |
Specifies if the license unit count is unlimited.
Sample:
True
|
||
is_vendor_oracle
boolean
|
on success |
Specifies whether the vendor is Oracle or a third party.
Sample:
True
|
||
license_unit
string
|
on success |
The product license unit.
Sample:
OCPU
|
||
lifecycle_state
string
|
on success |
The current product license state.
Sample:
ACTIVE
|
||
status
string
|
on success |
The current product license status.
Sample:
INCOMPLETE
|
||
status_description
string
|
on success |
Status description for the current product license status.
Sample:
status_description_example
|
||
system_tags
dictionary
|
on success |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
|
||
time_created
string
|
on success |
The time the product license was created. An RFC 3339-formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_updated
string
|
on success |
The time the product license was updated. An RFC 3339-formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
||
total_active_license_unit_count
integer
|
on success |
The total number of licenses available for the product license, calculated by adding up all the license counts for active license records associated with the product license.
Sample:
56
|
||
total_license_record_count
integer
|
on success |
The number of license records associated with the product license.
Sample:
56
|
||
total_license_units_consumed
float
|
on success |
The number of license units consumed. Updated after each allocation run.
Sample:
1.2
|
||
vendor_name
string
|
on success |
The vendor of the ProductLicense
Sample:
vendor_name_example
|
Authors¶
Oracle (@oracle)