oracle.oci.oci_osp_gateway_address_facts – Fetches details about a Address resource 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_osp_gateway_address_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about a Address resource in Oracle Cloud Infrastructure

  • Get the address by id for the compartment

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
address_id
string / required
The identifier of the address.

aliases: id
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 / required
The OCID of the compartment.
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.
osp_home_region
string / required
The home region's public name of the logged in user.
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.
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 address
  oci_osp_gateway_address_facts:
    # required
    osp_home_region: us-phoenix-1
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    address_id: "ocid1.address.oc1..xxxxxxEXAMPLExxxxxx"

Return Values

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

Key Returned Description
address
complex
on success
Address resource

Sample:
{'address_key': 'address_key_example', 'city': 'city_example', 'company_name': 'company_name_example', 'contributor_class': 'contributor_class_example', 'country': 'country_example', 'county': 'county_example', 'department_name': 'department_name_example', 'email_address': 'email_address_example', 'first_name': 'first_name_example', 'internal_number': 'internal_number_example', 'job_title': 'job_title_example', 'last_name': 'last_name_example', 'line1': 'line1_example', 'line2': 'line2_example', 'line3': 'line3_example', 'line4': 'line4_example', 'middle_name': 'middle_name_example', 'municipal_inscription': 'municipal_inscription_example', 'phone_country_code': 'phone_country_code_example', 'phone_number': 'phone_number_example', 'postal_code': 'postal_code_example', 'province': 'province_example', 'state': 'state_example', 'state_inscription': 'state_inscription_example', 'street_name': 'street_name_example', 'street_number': 'street_number_example'}
 
address_key
string
on success
Address identifier.

Sample:
address_key_example
 
city
string
on success
Name of the city.

Sample:
city_example
 
company_name
string
on success
Name of the customer company.

Sample:
company_name_example
 
contributor_class
string
on success
Contributor class of the customer company.

Sample:
contributor_class_example
 
country
string
on success
Country of the address.

Sample:
country_example
 
county
string
on success
County of the address.

Sample:
county_example
 
department_name
string
on success
Department name of the customer company.

Sample:
department_name_example
 
email_address
string
on success
Contact person email address.

Sample:
email_address_example
 
first_name
string
on success
First name of the contact person.

Sample:
first_name_example
 
internal_number
string
on success
Internal number of the customer company.

Sample:
internal_number_example
 
job_title
string
on success
Job title of the contact person.

Sample:
job_title_example
 
last_name
string
on success
Last name of the contact person.

Sample:
last_name_example
 
line1
string
on success
Address line 1.

Sample:
line1_example
 
line2
string
on success
Address line 2.

Sample:
line2_example
 
line3
string
on success
Address line 3.

Sample:
line3_example
 
line4
string
on success
Address line 4.

Sample:
line4_example
 
middle_name
string
on success
Middle name of the contact person.

Sample:
middle_name_example
 
municipal_inscription
string
on success
Municipal Inscription.

Sample:
municipal_inscription_example
 
phone_country_code
string
on success
Phone country code of the contact person.

Sample:
phone_country_code_example
 
phone_number
string
on success
Phone number of the contact person.

Sample:
phone_number_example
 
postal_code
string
on success
Post code of the address.

Sample:
postal_code_example
 
province
string
on success
Province of the address.

Sample:
province_example
 
state
string
on success
State of the address.

Sample:
state_example
 
state_inscription
string
on success
State Inscription.

Sample:
state_inscription_example
 
street_name
string
on success
Street name of the address.

Sample:
street_name_example
 
street_number
string
on success
Street number of the address.

Sample:
street_number_example


Authors

  • Oracle (@oracle)