oci_dhcp_options_facts – Fetches details of a specific Dhcp Options or a list of Dhcp Optionss in the specified VCN and compartment

New in version 2.5.

Synopsis

  • Fetches details of a specific Dhcp Options or a list of Dhcp Optionss in the specified VCN and compartment.

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_OCID 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_type
string
    Choices:
  • api_key ←
  • instance_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.
compartment_id
-
Identifier of the compartment details about whose Dhcp Options must be retrived
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.
dhcp_id
-
Identifier of the Dhcp Options. Required if the detailsof a specific Dhcp Options details needs to be fetched. Mutually exclusive with compartment_id and vcn_id.

aliases: id
display_name
string
Use display_name along with the other options to return only resources that match the given display name exactly.
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
vcn_id
-
Identifier of the Virtual Cloud Network to which the Dhcp Options is attached.

Examples

# Fetch details of all Dhcp Optionss in the specified compartment and VCN
- name: List Dhcp Options
  oci_dhcp_options:
      compartment_id: 'ocid1.compartment..xcds'
      vcn_id: 'ocid1.vcn..dfxs'

#Fetch specific Dhcp Options
- name: List a specific Dhcp Options
  oci_dhcp_options::
      dhcp_id: 'ocid1.dhcpoptions..xcds'

Return Values

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

Key Returned Description
dhcp_options_list
complex
success
Attributes of the fetched Dhcp Options(s).

Sample:
[{'lifecycle_state': 'AVAILABLE', 'display_name': 'ansible_dhcp_options', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'vcn_id': 'ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx', 'defined_tags': {'features': {'capacity': 'medium'}}, 'freeform_tags': {'region': 'east'}, 'time_created': '2017-11-26T16:41:06.996000+00:00', 'id': 'ocid1.dhcpoptions.oc1.phx.xxxxxEXAMPLExxxxx', 'options': [{'type': 'DomainNameServer', 'custom_dns_servers': [], 'server_type': 'VcnLocalPlusInternet'}, {'type': 'SearchDomain', 'search_domain_names': ['ansibletestvcn.oraclevcn.com']}, {'type': 'DomainNameServer', 'custom_dns_servers': ['10.0.0.8'], 'server_type': 'CustomDnsServer'}]}, {'lifecycle_state': 'AVAILABLE', 'display_name': 'ansible_dhcp_options_two', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'vcn_id': 'ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx', 'defined_tags': {'features': {'capacity': 'large'}}, 'freeform_tags': {'region': 'west'}, 'time_created': '2017-10-26T16:41:06.996000+00:00', 'id': 'ocid1.dhcpoptions.oc1.phx.xxxxxEXAMPLExxxxx', 'options': [{'type': 'DomainNameServer', 'custom_dns_servers': [], 'server_type': 'VcnLocalPlusInternet'}, {'type': 'SearchDomain', 'search_domain_names': ['vcn.oraclevcn.com']}, {'type': 'DomainNameServer', 'custom_dns_servers': ['10.0.0.8', '10.0.0.12', '10.0.0.14'], 'server_type': 'CustomDnsServer'}]}]
  compartment_id
string
always
The identifier of the compartment containing the Dhcp Options

Sample:
ocid1.compartment.oc1.xzvf..oifds
  display_name
string
always
Name assigned to the Dhcp Options during creation

Sample:
ansible_dhcp_options
  id
string
always
Identifier of the Dhcp Options

Sample:
ocid1.dhcpoptions.oc1.axdf
  lifecycle_state
string
always
The current state of the Dhcp Options

Sample:
AVAILABLE
  options
list
always
A list of dhcp options.

Sample:
[{'type': 'DomainNameServer', 'custom_dns_servers': [], 'server_type': 'CustomDnsServer'}, {'type': 'SearchDomain', 'search_domain_names': ['myansiblevcn.oraclevcn.com']}]
  time_created
datetime
always
Date and time when the Dhcp Options was created, in the format defined by RFC3339

Sample:
2016-08-25 21:10:29.600000
  vcn_id
string
always
Identifier of the Virtual Cloud Network to which the Dhcp Options is attached.

Sample:
ocid1.vcn..ixcd


Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]
  • This module is maintained by the Ansible Community. [community]

Authors

  • Debayan Gupta(@debayan_gupta)

Hint

If you notice any issues in this documentation you can edit this document to improve it.