oracle.oci.oci_devops_connection_facts – Fetches details about one or multiple Connection 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_connection_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple Connection resources in Oracle Cloud Infrastructure
Returns a list of connections.
If connection_id is specified, the details of a single Connection will be returned.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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 . |
|
connection_id
string
|
Unique connection identifier.
Required to get a specific connection.
aliases: id |
|
connection_type
string
|
|
A filter to return only resources that match the given connection type.
|
display_name
string
|
A filter to return only resources that match the entire display name given.
aliases: name |
|
lifecycle_state
string
|
|
A filter to return only connections that matches the given lifecycle state.
|
project_id
string
|
unique project identifier
|
|
realm_specific_endpoint_template_enabled
boolean
|
|
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
|
|
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
|
|
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 |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific connection
oci_devops_connection_facts:
# required
connection_id: "ocid1.connection.oc1..xxxxxxEXAMPLExxxxxx"
- name: List connections
oci_devops_connection_facts:
# optional
project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
lifecycle_state: ACTIVE
display_name: display_name_example
connection_type: GITHUB_ACCESS_TOKEN
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 | ||
---|---|---|---|---|
connections
complex
|
on success |
List of Connection resources
Sample:
[{'access_token': 'access_token_example', 'app_password': 'example-password', 'base_url': 'base_url_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'connection_type': 'GITHUB_ACCESS_TOKEN', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'last_connection_validation_result': {'message': 'message_example', 'result': 'PASS', 'time_validated': '2013-10-20T19:20:30+01:00'}, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'ACTIVE', 'project_id': 'ocid1.project.oc1..xxxxxxEXAMPLExxxxxx', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'tls_verify_config': {'ca_certificate_bundle_id': 'ocid1.cacertificatebundle.oc1..xxxxxxEXAMPLExxxxxx', 'tls_verify_mode': 'CA_CERTIFICATE_VERIFY'}, 'username': 'username_example'}]
|
||
access_token
string
|
on success |
The OCID of personal access token saved in secret store.
Returned for get operation
Sample:
access_token_example
|
||
app_password
string
|
on success |
OCID of personal Bitbucket Cloud AppPassword saved in secret store
Returned for get operation
Sample:
example-password
|
||
base_url
string
|
on success |
The Base URL of the hosted BitbucketServer.
Returned for get operation
Sample:
base_url_example
|
||
compartment_id
string
|
on success |
The OCID of the compartment containing the connection.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
connection_type
string
|
on success |
The type of connection.
Sample:
GITHUB_ACCESS_TOKEN
|
||
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 |
Optional description about the connection.
Sample:
description_example
|
||
display_name
string
|
on success |
Connection display name, which can be renamed and is not necessarily unique. 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
|
||
last_connection_validation_result
complex
|
on success |
|
||
message
string
|
on success |
A message describing the result of connection validation in more detail.
Sample:
message_example
|
||
result
string
|
on success |
The latest result of whether the credentials pass the validation.
Sample:
PASS
|
||
time_validated
string
|
on success |
The latest timestamp when the connection was validated. Format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
||
lifecycle_details
string
|
on success |
A detailed message describing the current state. 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 connection.
Sample:
ACTIVE
|
||
project_id
string
|
on success |
The OCID of the DevOps project.
Sample:
ocid1.project.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 connection was created. Format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_updated
string
|
on success |
The time the connection was updated. Format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
||
tls_verify_config
complex
|
on success |
Returned for get operation
|
||
ca_certificate_bundle_id
string
|
on success |
The OCID of OCI certificate service CA bundle.
Sample:
ocid1.cacertificatebundle.oc1..xxxxxxEXAMPLExxxxxx
|
||
tls_verify_mode
string
|
on success |
The type of TLS verification.
Sample:
CA_CERTIFICATE_VERIFY
|
||
username
string
|
on success |
Public Bitbucket Cloud Username in plain text
Returned for get operation
Sample:
username_example
|
Authors¶
Oracle (@oracle)