oracle.oci.oci_file_storage_outbound_connector_facts – Fetches details about one or multiple OutboundConnector 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_file_storage_outbound_connector_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Lists the outbound connector resources in the specified compartment.

  • If outbound_connector_id is specified, the details of a single OutboundConnector 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.
availability_domain
string
The name of the availability domain.
Example: `Uocm:PHX-AD-1`
Required to list multiple outbound_connectors.
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.
Required to list multiple outbound_connectors.
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 user-friendly name. It does not have to be unique, and it is changeable.
Example: `My resource`

aliases: name
lifecycle_state
string
    Choices:
  • CREATING
  • ACTIVE
  • DELETING
  • DELETED
  • FAILED
Filter results by the specified lifecycle state. Must be a valid state for the resource type.
outbound_connector_id
string
The OCID of the outbound connector.
Required to get a specific outbound_connector.

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
  • DISPLAYNAME
The field to sort by. You can choose either value, but not both. By default, when you sort by time created, results are shown in descending order. When you sort by display name, results are shown in ascending order.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'asc' or 'desc', where 'asc' is ascending and 'desc' is descending. The default order is 'desc' except for numeric values.
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 outbound_connector
  oci_file_storage_outbound_connector_facts:
    # required
    outbound_connector_id: "ocid1.outboundconnector.oc1..xxxxxxEXAMPLExxxxxx"

- name: List outbound_connectors
  oci_file_storage_outbound_connector_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    availability_domain: Uocm:PHX-AD-1

    # optional
    lifecycle_state: CREATING
    display_name: display_name_example
    sort_by: TIMECREATED
    sort_order: ASC

Return Values

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

Key Returned Description
outbound_connectors
complex
on success
List of OutboundConnector resources

Sample:
[{'availability_domain': 'Uocm:PHX-AD-1', 'bind_distinguished_name': 'bind_distinguished_name_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'connector_type': 'LDAPBIND', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'endpoints': [{'hostname': 'hostname_example', 'port': 56}], 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'password_secret_id': 'ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx', 'password_secret_version': 56, 'time_created': '2013-10-20T19:20:30+01:00'}]
 
availability_domain
string
on success
The availability domain the outbound connector is in. May be unset as a blank or NULL value.
Example: `Uocm:PHX-AD-1`

Sample:
Uocm:PHX-AD-1
 
bind_distinguished_name
string
on success
The LDAP Distinguished Name of the account.

Sample:
bind_distinguished_name_example
 
compartment_id
string
on success
The OCID of the compartment that contains the outbound connector.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
connector_type
string
on success
The account type of this outbound connector.

Sample:
LDAPBIND
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
Example: `My outbound connector`

Sample:
display_name_example
 
endpoints
complex
on success
Array of server endpoints to use when connecting with the LDAP bind account.
   
hostname
string
on success
Name of the DNS server.

Sample:
hostname_example
   
port
integer
on success
Port of the DNS server.

Sample:
56
 
freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the outbound connector.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The current state of this outbound connector.

Sample:
CREATING
 
password_secret_id
string
on success
The OCID of the password for the LDAP bind account in the Vault.
Returned for get operation

Sample:
ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx
 
password_secret_version
integer
on success
Version of the password secret in the Vault to use.
Returned for get operation

Sample:
56
 
time_created
string
on success
The date and time the outbound connector was created in RFC 3339 timestamp format.
Example: `2016-08-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)