oracle.oci.oci_functions_pbf_listing_version_facts – Fetches details about one or multiple PbfListingVersion 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_functions_pbf_listing_version_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Fetches a wrapped list of all Pre-built Function(PBF) Listing versions. Returns a PbfListingVersionCollection containing an array of PbfListingVersionSummary response models.

  • Note that the PbfListingIdentifier must be provided as a query parameter, otherwise an exception shall be thrown.

  • If pbf_listing_version_id is specified, the details of a single PbfListingVersion 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
  • security_token
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.
is_current_version
boolean
    Choices:
  • no
  • yes
Matches the current version (the most recently added version with an Active lifecycleState) associated with a PbfListing.
lifecycle_state
string
    Choices:
  • ACTIVE
  • INACTIVE
  • DELETED
A filter to return only resources their lifecycleState matches the given lifecycleState.
name
string
Matches a PbfListingVersion based on a provided semantic version name for a PbfListingVersion. Each PbfListingVersion name is unique with respect to its associated PbfListing.
pbf_listing_id
string
unique PbfListing identifier
Required to list multiple pbf_listing_versions.
pbf_listing_version_id
string
unique PbfListingVersion identifier
Required to get a specific pbf_listing_version.

aliases: id
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
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
    Choices:
  • timeCreated
  • name
The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending.
sort_order
string
    Choices:
  • ASC
  • DESC
Specifies sort order.
* **ASC:** Ascending sort order. * **DESC:** Descending sort order.
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 pbf_listing_version
  oci_functions_pbf_listing_version_facts:
    # required
    pbf_listing_version_id: "ocid1.pbflistingversion.oc1..xxxxxxEXAMPLExxxxxx"

- name: List pbf_listing_versions
  oci_functions_pbf_listing_version_facts:
    # required
    pbf_listing_id: "ocid1.pbflisting.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    pbf_listing_version_id: "ocid1.pbflistingversion.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example
    is_current_version: true
    lifecycle_state: ACTIVE
    sort_order: ASC
    sort_by: timeCreated

Return Values

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

Key Returned Description
pbf_listing_versions
complex
on success
List of PbfListingVersion resources

Sample:
[{'change_summary': 'change_summary_example', 'config': [{'description': 'description_example', 'is_optional': True, 'key': 'key_example'}], 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'ACTIVE', 'name': 'name_example', 'pbf_listing_id': 'ocid1.pbflisting.oc1..xxxxxxEXAMPLExxxxxx', 'requirements': {'min_memory_required_in_mbs': 56, 'policies': [{'description': 'description_example', 'policy': 'policy_example'}]}, 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'triggers': [{'name': 'name_example'}]}]
 
change_summary
string
on success
Details changes are included in this version.

Sample:
change_summary_example
 
config
complex
on success
Details about the required and optional Function configurations needed for proper performance of the PBF.
   
description
string
on success
Details about why this config is required and what it will be used for.

Sample:
description_example
   
is_optional
boolean
on success
Is this a required config or an optional one. Requests with required config params missing will be rejected.

Sample:
True
   
key
string
on success
The key name of the config param.

Sample:
key_example
 
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'}}
 
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
Unique identifier that is immutable on creation

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The current state of the PBF resource.

Sample:
ACTIVE
 
name
string
on success
Semantic version

Sample:
name_example
 
pbf_listing_id
string
on success
The OCID of the PbfListing this resource version belongs to.

Sample:
ocid1.pbflisting.oc1..xxxxxxEXAMPLExxxxxx
 
requirements
complex
on success

   
min_memory_required_in_mbs
integer
on success
Minimum memory required by this PBF. The user should use memory greater than or equal to this value while configuring the Function.

Sample:
56
   
policies
complex
on success
List of policies required for this PBF execution.
     
description
string
on success
Details about why this policy is required and what it will be used for.

Sample:
description_example
     
policy
string
on success
Policy required for PBF execution

Sample:
policy_example
 
system_tags
dictionary
on success
System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
 
time_created
string
on success
The time the PbfListingVersion was created. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The last time the PbfListingVersion was updated. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
triggers
complex
on success
An array of Trigger. A list of triggers that may activate the PBF.
   
name
string
on success
A brief descriptive name for the PBF trigger.

Sample:
name_example


Authors

  • Oracle (@oracle)