oracle.oci.oci_onesubscription_commitment_facts – Fetches details about one or multiple Commitment 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_onesubscription_commitment_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • This list API returns all commitments for a particular Subscribed Service

  • If commitment_id is specified, the details of a single Commitment will be returned.

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.
commitment_id
string
The Commitment Id
Required to get a specific commitment.

aliases: id
compartment_id
string
The OCID of the root compartment.
Required to list multiple commitments.
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.
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:
  • ORDERNUMBER
  • TIMEINVOICING
The field to sort by. You can provide one sort order ('sortOrder').
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either ascending ('ASC') or descending ('DESC').
subscribed_service_id
string
This param is used to get the commitments for a particular subscribed service
Required to list multiple commitments.
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: Get a specific commitment
  oci_onesubscription_commitment_facts:
    # required
    commitment_id: "ocid1.commitment.oc1..xxxxxxEXAMPLExxxxxx"

- name: List commitments
  oci_onesubscription_commitment_facts:
    # required
    subscribed_service_id: "ocid1.subscribedservice.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    sort_order: ASC
    sort_by: ORDERNUMBER

Return Values

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

Key Returned Description
commitments
complex
on success
List of Commitment resources

Sample:
[{'available_amount': 'available_amount_example', 'funded_allocation_value': 'funded_allocation_value_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'quantity': 'quantity_example', 'subscribed_service_id': 'ocid1.subscribedservice.oc1..xxxxxxEXAMPLExxxxxx', 'time_end': '2013-10-20T19:20:30+01:00', 'time_start': '2013-10-20T19:20:30+01:00', 'used_amount': 'used_amount_example'}]
 
available_amount
string
on success
Commitment available amount

Sample:
available_amount_example
 
funded_allocation_value
string
on success
Funded Allocation line value example: 12000.00

Sample:
funded_allocation_value_example
 
id
string
on success
SPM internal Commitment ID

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
quantity
string
on success
Commitment quantity

Sample:
quantity_example
 
subscribed_service_id
string
on success
SPM internal Subscribed Service ID

Sample:
ocid1.subscribedservice.oc1..xxxxxxEXAMPLExxxxxx
 
time_end
string
on success
Commitment end date

Sample:
2013-10-20T19:20:30+01:00
 
time_start
string
on success
Commitment start date

Sample:
2013-10-20T19:20:30+01:00
 
used_amount
string
on success
Commitment used amount

Sample:
used_amount_example


Authors

  • Oracle (@oracle)