oracle.oci.oci_license_manager_bulk_upload_license_records_actions – Perform actions on a BulkUploadLicenseRecords 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_bulk_upload_license_records_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a BulkUploadLicenseRecords resource in Oracle Cloud Infrastructure

  • For action=bulk_upload_license_records, bulk upload the product licenses and license records for a given compartment.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • bulk_upload_license_records
The action to perform on the BulkUploadLicenseRecords.
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 where license records are created.
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.
file_content
string / required
The file to be uploaded.
file_name
string / required
Name of the file that is being uploaded.
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.
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: Perform action bulk_upload_license_records on bulk_upload_license_records
  oci_license_manager_bulk_upload_license_records_actions:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    file_name: file_name_example
    file_content: file_content_example
    action: bulk_upload_license_records

Return Values

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

Key Returned Description
bulk_upload_response
complex
on success
Details of the BulkUploadLicenseRecords resource acted upon by the current operation

Sample:
{'failed_license_record_info': [{'error': 'error_example', 'product_name': 'product_name_example', 'row_number': 56}], 'message': 'message_example', 'total_supported_duplicate_records': 56, 'total_supported_failed_license_records': 56, 'total_supported_invalid_records': 56, 'total_supported_records': 56, 'total_supported_records_saved': 56, 'validation_error_info': [{'product_name': 'product_name_example', 'row_error': [{'column_index': 'column_index_example', 'error_info': 'error_info_example'}], 'row_number': 56}]}
 
failed_license_record_info
complex
on success
Error information corresponding to the supported records which are valid but could not be created.

   
error
string
on success
Failed license record error information.

Sample:
error_example
   
product_name
string
on success
Product name of the failed row.

Sample:
product_name_example
   
row_number
integer
on success
Refers to the license record number as provided in the bulk upload file.

Sample:
56
 
message
string
on success
Response message for bulk upload.

Sample:
message_example
 
total_supported_duplicate_records
integer
on success
The number of supported license records that were valid but not uploaded since they were duplicates.

Sample:
56
 
total_supported_failed_license_records
integer
on success
The number of supported license records that were valid but failed with errors during upload.

Sample:
56
 
total_supported_invalid_records
integer
on success
The number of supported license records that could not be uploaded since they were invalid.

Sample:
56
 
total_supported_records
integer
on success
The number of license records which were supported.

Sample:
56
 
total_supported_records_saved
integer
on success
The number of supported license records that were uploaded successfully.

Sample:
56
 
validation_error_info
complex
on success
Detailed error information corresponding to each supported but invalid row for the uploaded file.

   
product_name
string
on success
Product name of invalid row.

Sample:
product_name_example
   
row_error
complex
on success
Error information corresponding to each column.

     
column_index
string
on success
Column index as in the given bulk upload file.

Sample:
column_index_example
     
error_info
string
on success
Error information corresponding to a particular column.

Sample:
error_info_example
   
row_number
integer
on success
Refers to the license record number as provided in the bulk upload file.

Sample:
56


Authors

  • Oracle (@oracle)