oracle.oci.oci_devops_trigger_facts – Fetches details about one or multiple Trigger resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Returns a list of triggers.

  • If trigger_id is specified, the details of a single Trigger 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.
compartment_id
string
The OCID of the compartment in which to list resources.
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
A filter to return only resources that match the entire display name given.

aliases: name
lifecycle_state
string
    Choices:
  • ACTIVE
  • DELETING
A filter to return only triggers that matches the given lifecycle state.
project_id
string
unique project identifier
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
  • displayName
The field to sort by. Only one sort order may be provided. Default order for time created is descending. Default order for display name is ascending. If no value is specified, then the default time created value is considered.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use. Use either ascending or descending.
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
trigger_id
string
Unique trigger identifier.
Required to get a specific trigger.

aliases: id

Examples

- name: Get a specific trigger
  oci_devops_trigger_facts:
    # required
    trigger_id: "ocid1.trigger.oc1..xxxxxxEXAMPLExxxxxx"

- name: List triggers
  oci_devops_trigger_facts:

    # optional
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"
    lifecycle_state: ACTIVE
    display_name: display_name_example
    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
triggers
complex
on success
List of Trigger resources

Sample:
[{'actions': [{'build_pipeline_id': 'ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx', 'filter': {'events': [], 'exclude': {'file_filter': {'file_paths': []}}, 'include': {'base_ref': 'base_ref_example', 'file_filter': {'file_paths': []}, 'head_ref': 'head_ref_example', 'repository_name': 'repository_name_example'}, 'trigger_source': 'BITBUCKET_CLOUD'}, 'type': 'TRIGGER_BUILD_PIPELINE'}], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'connection_id': 'ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'ACTIVE', 'project_id': 'ocid1.project.oc1..xxxxxxEXAMPLExxxxxx', 'repository_id': 'ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'trigger_source': 'GITHUB', 'trigger_url': 'trigger_url_example'}]
 
actions
complex
on success
The list of actions that are to be performed for this trigger.
Returned for get operation
   
build_pipeline_id
string
on success
The OCID of the build pipeline to be triggered.

Sample:
ocid1.buildpipeline.oc1..xxxxxxEXAMPLExxxxxx
   
filter
complex
on success

     
events
list / elements=string
on success
The events, for example, PUSH, PULL_REQUEST_MERGE.
     
exclude
complex
on success

       
file_filter
complex
on success

         
file_paths
list / elements=string
on success
The file paths/glob pattern for files.
     
include
complex
on success

       
base_ref
string
on success
The target branch for pull requests; not applicable for push requests.

Sample:
base_ref_example
       
file_filter
complex
on success

         
file_paths
list / elements=string
on success
The file paths/glob pattern for files.
       
head_ref
string
on success
Branch for push event; source branch for pull requests.

Sample:
head_ref_example
       
repository_name
string
on success
The repository name for trigger events.

Sample:
repository_name_example
     
trigger_source
string
on success
Source of the trigger. Allowed values are, GITHUB and GITLAB.

Sample:
BITBUCKET_CLOUD
   
type
string
on success
The type of action that will be taken. Allowed value is TRIGGER_BUILD_PIPELINE.

Sample:
TRIGGER_BUILD_PIPELINE
 
compartment_id
string
on success
The OCID of the compartment that contains the trigger.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
connection_id
string
on success
The OCID of the connection resource used to get details for triggered events.
Returned for get operation

Sample:
ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
description
string
on success
Description about the trigger.

Sample:
description_example
 
display_name
string
on success
Trigger display name. Avoid entering confidential information.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
Unique identifier that is immutable on creation.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the trigger.

Sample:
ACTIVE
 
project_id
string
on success
The OCID of the DevOps project to which the trigger belongs to.

Sample:
ocid1.project.oc1..xxxxxxEXAMPLExxxxxx
 
repository_id
string
on success
The OCID of the DevOps code repository.
Returned for get operation

Sample:
ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx
 
system_tags
dictionary
on success
Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
 
time_created
string
on success
The time the trigger was created. Format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the trigger was updated. Format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
trigger_source
string
on success
Source of the trigger.

Sample:
GITHUB
 
trigger_url
string
on success
The endpoint that listens to trigger events.
Returned for get operation

Sample:
trigger_url_example


Authors

  • Oracle (@oracle)