oracle.oci.oci_license_manager_license_record_facts – Fetches details about one or multiple LicenseRecord 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_license_record_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple LicenseRecord resources in Oracle Cloud Infrastructure
Retrieves all license records for a given product license ID.
If license_record_id is specified, the details of a single LicenseRecord 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.
|
|
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.
|
|
license_record_id
string
|
Unique license record identifier.
Required to get a specific license_record.
aliases: id |
|
product_license_id
string
|
Unique product license identifier.
Required to list multiple license_records.
|
|
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: `expirationDate`
* **expirationDate:** Sorts by expiration date of the license record.
|
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 license_record
oci_license_manager_license_record_facts:
# required
license_record_id: "ocid1.licenserecord.oc1..xxxxxxEXAMPLExxxxxx"
- name: List license_records
oci_license_manager_license_record_facts:
# required
product_license_id: "ocid1.productlicense.oc1..xxxxxxEXAMPLExxxxxx"
# optional
sort_order: ASC
sort_by: expirationDate
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
license_records
complex
|
on success |
List of LicenseRecord resources
Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'expiration_date': '2013-10-20T19:20:30+01:00', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_perpetual': True, 'is_unlimited': True, 'license_count': 56, 'license_unit': 'OCPU', 'lifecycle_state': 'ACTIVE', 'product_id': 'ocid1.product.oc1..xxxxxxEXAMPLExxxxxx', 'product_license': 'product_license_example', 'product_license_id': 'ocid1.productlicense.oc1..xxxxxxEXAMPLExxxxxx', 'support_end_date': '2013-10-20T19:20:30+01:00', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
|
|
compartment_id
string
|
on success |
The compartment OCID where the license record 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 |
The license record display name. Avoid entering confidential information.
Sample:
display_name_example
|
|
expiration_date
string
|
on success |
The license record end date in RFC 3339 date format. Example: `2018-09-12`
Sample:
2013-10-20T19:20:30+01:00
|
|
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 license record OCID.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|
is_perpetual
boolean
|
on success |
Specifies if the license record term is perpertual.
Sample:
True
|
|
is_unlimited
boolean
|
on success |
Specifies if the license count is unlimited.
Sample:
True
|
|
license_count
integer
|
on success |
The number of license units added by the user for the given license record. Default 1
Sample:
56
|
|
license_unit
string
|
on success |
The product license unit.
Sample:
OCPU
|
|
lifecycle_state
string
|
on success |
The current license record state.
Sample:
ACTIVE
|
|
product_id
string
|
on success |
The license record product ID.
Sample:
ocid1.product.oc1..xxxxxxEXAMPLExxxxxx
|
|
product_license
string
|
on success |
The product license name with which the license record is associated.
Sample:
product_license_example
|
|
product_license_id
string
|
on success |
The product license OCID with which the license record is associated.
Sample:
ocid1.productlicense.oc1..xxxxxxEXAMPLExxxxxx
|
|
support_end_date
string
|
on success |
The license record support end date in RFC 3339 date format. Example: `2018-09-12`
Sample:
2013-10-20T19:20:30+01:00
|
|
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 license record was created. An RFC 3339-formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
|
time_updated
string
|
on success |
The time the license record was updated. An RFC 3339-formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)