oracle.oci.oci_license_manager_license_record – Manage a LicenseRecord resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.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.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a LicenseRecord resource in Oracle Cloud Infrastructure

  • For state=present, creates a new license record for the given 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.
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.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
display_name
string
License record name.
Required for create using state=present, update using state=present with license_record_id present.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.

aliases: name
expiration_date
string
The license record end date in RFC 3339 date format. Example: `2018-09-12`
This parameter is updatable.
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
This parameter is updatable.
is_perpetual
boolean
    Choices:
  • no
  • yes
Specifies if the license record term is perpertual.
Required for create using state=present, update using state=present with license_record_id present.
is_unlimited
boolean
    Choices:
  • no
  • yes
Specifies if the license count is unlimited.
Required for create using state=present, update using state=present with license_record_id present.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
license_count
integer
The number of license units added by a user in a license record. Default 1
This parameter is updatable.
license_record_id
string
Unique license record identifier.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
product_id
string
The license record product ID.
This parameter is updatable.
product_license_id
string
Unique product license identifier.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
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.
state
string
    Choices:
  • present ←
  • absent
The state of the LicenseRecord.
Use state=present to create or update a LicenseRecord.
Use state=absent to delete a LicenseRecord.
support_end_date
string
The license record support end date in RFC 3339 date format. Example: `2018-09-12`
This parameter is updatable.
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
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create license_record
  oci_license_manager_license_record:
    # required
    product_license_id: "ocid1.productlicense.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    is_perpetual: true
    is_unlimited: true

    # optional
    expiration_date: expiration_date_example
    support_end_date: support_end_date_example
    license_count: 56
    product_id: "ocid1.product.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update license_record
  oci_license_manager_license_record:
    # required
    display_name: display_name_example
    is_perpetual: true
    is_unlimited: true
    license_record_id: "ocid1.licenserecord.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    expiration_date: expiration_date_example
    support_end_date: support_end_date_example
    license_count: 56
    product_id: "ocid1.product.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update license_record using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_license_manager_license_record:
    # required
    product_license_id: "ocid1.productlicense.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    is_perpetual: true
    expiration_date: expiration_date_example
    support_end_date: support_end_date_example
    is_unlimited: true
    license_count: 56
    product_id: "ocid1.product.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete license_record
  oci_license_manager_license_record:
    # required
    license_record_id: "ocid1.licenserecord.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete license_record using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_license_manager_license_record:
    # required
    product_license_id: "ocid1.productlicense.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    state: absent

Return Values

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

Key Returned Description
license_record
complex
on success
Details of the LicenseRecord resource acted upon by the current operation

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)