oracle.oci.oci_osp_gateway_address_rule_facts – Fetches details about a AddressRule 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_rule_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about a AddressRule resource in Oracle Cloud Infrastructure

  • Get the address rule for the compartment based on the country code

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 / 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.
country_code
string / required
Country code for the address rule in ISO-3166-1 2-letter format.
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_rule
  oci_osp_gateway_address_rule_facts:
    # required
    osp_home_region: us-phoenix-1
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    country_code: country_code_example

Return Values

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

Key Returned Description
address_rule
complex
on success
AddressRule resource

Sample:
{'address': {'fields': [{'format': {'example': 'example_example', 'value': 'value_example'}, 'is_required': True, 'label': {'example': 'example_example', 'value': 'value_example'}, 'language': 'language_example', 'name': 'name_example'}], 'third_party_validation': 'OPTIONAL'}, 'contact': {'fields': [{'format': {'example': 'example_example', 'value': 'value_example'}, 'is_required': True, 'label': {'example': 'example_example', 'value': 'value_example'}, 'language': 'language_example', 'name': 'name_example'}]}, 'country_code': 'country_code_example', 'tax': {'fields': [{'format': {'example': 'example_example', 'value': 'value_example'}, 'is_required': True, 'label': {'example': 'example_example', 'value': 'value_example'}, 'language': 'language_example', 'name': 'name_example'}]}}
 
address
complex
on success

   
fields
complex
on success
Address type rule fields
     
format
complex
on success

       
example
string
on success
Example of the desired format that matches the regex

Sample:
example_example
       
value
string
on success
Regex format specification

Sample:
value_example
     
is_required
boolean
on success
The given field is requeired or not

Sample:
True
     
label
complex
on success

       
example
string
on success
English translation of the label (for reference only - translation is not provided)

Sample:
example_example
       
value
string
on success
Language token of the required label

Sample:
value_example
     
language
string
on success
Locale code (rfc4646 format) of a forced language (e.g.: jp addresses require jp always)

Sample:
language_example
     
name
string
on success
The field name

Sample:
name_example
   
third_party_validation
string
on success
Third party validation.

Sample:
OPTIONAL
 
contact
complex
on success

   
fields
complex
on success
Contact type rule fields
     
format
complex
on success

       
example
string
on success
Example of the desired format that matches the regex

Sample:
example_example
       
value
string
on success
Regex format specification

Sample:
value_example
     
is_required
boolean
on success
The given field is requeired or not

Sample:
True
     
label
complex
on success

       
example
string
on success
English translation of the label (for reference only - translation is not provided)

Sample:
example_example
       
value
string
on success
Language token of the required label

Sample:
value_example
     
language
string
on success
Locale code (rfc4646 format) of a forced language (e.g.: jp addresses require jp always)

Sample:
language_example
     
name
string
on success
The field name

Sample:
name_example
 
country_code
string
on success
Country code for the address rule in ISO-3166-1 2-letter format

Sample:
country_code_example
 
tax
complex
on success

   
fields
complex
on success
Tax type rule fields
     
format
complex
on success

       
example
string
on success
Example of the desired format that matches the regex

Sample:
example_example
       
value
string
on success
Regex format specification

Sample:
value_example
     
is_required
boolean
on success
The given field is requeired or not

Sample:
True
     
label
complex
on success

       
example
string
on success
English translation of the label (for reference only - translation is not provided)

Sample:
example_example
       
value
string
on success
Language token of the required label

Sample:
value_example
     
language
string
on success
Locale code (rfc4646 format) of a forced language (e.g.: jp addresses require jp always)

Sample:
language_example
     
name
string
on success
The field name

Sample:
name_example


Authors

  • Oracle (@oracle)