oracle.oci.oci_devops_repository_ref_facts – Fetches details about one or multiple RepositoryRef resources 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_devops_repository_ref_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Returns a list of references.

  • If ref_name is specified, the details of a single RepositoryRef 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.
commit_id
string
Commit ID in a repository.
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.
ref_name
string
A filter to return only resources that match the given reference name.
Required to get a specific repository_ref.
ref_type
string
    Choices:
  • BRANCH
  • TAG
Reference type to distinguish between branch and tag. If it is not specified, all references are returned.
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.
repository_id
string / required
Unique repository identifier.
sort_by
string
    Choices:
  • refType
  • refName
The field to sort by. Only one sort order may be provided. Default order for reference name is ascending. Default order for reference type is ascending. If no value is specified reference name is default.
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

Examples

- name: Get a specific repository_ref
  oci_devops_repository_ref_facts:
    # required
    repository_id: "ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx"
    ref_name: ref_name_example

- name: List repository_reves
  oci_devops_repository_ref_facts:
    # required
    repository_id: "ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    ref_type: BRANCH
    commit_id: "ocid1.commit.oc1..xxxxxxEXAMPLExxxxxx"
    ref_name: ref_name_example
    sort_order: ASC
    sort_by: refType

Return Values

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

Key Returned Description
repository_reves
complex
on success
List of RepositoryRef resources

Sample:
[{'commit_id': 'ocid1.commit.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'freeform_tags': {'Department': 'Finance'}, 'full_ref_name': 'full_ref_name_example', 'object_id': 'ocid1.object.oc1..xxxxxxEXAMPLExxxxxx', 'ref_name': 'ref_name_example', 'ref_type': 'BRANCH', 'repository_id': 'ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx'}]
 
commit_id
string
on success
Commit ID pointed to by the new branch.
Returned for get operation

Sample:
ocid1.commit.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'}}
 
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'}
 
full_ref_name
string
on success
Unique full reference name inside a repository.

Sample:
full_ref_name_example
 
object_id
string
on success
SHA-1 hash value of the object pointed to by the tag.
Returned for get operation

Sample:
ocid1.object.oc1..xxxxxxEXAMPLExxxxxx
 
ref_name
string
on success
Unique reference name inside a repository.

Sample:
ref_name_example
 
ref_type
string
on success
The type of reference (BRANCH or TAG).

Sample:
BRANCH
 
repository_id
string
on success
The OCID of the repository containing the reference.

Sample:
ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx


Authors

  • Oracle (@oracle)