oci_dhcp_options - Create,update and delete OCI Dhcp Options¶

New in version 2.5.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

Synopsis ¶

Creates OCI Dhcp Options
Update OCI Dhcp Options, if present, with a new display name
Update OCI Dhcp Options, if present, by appending new options to existing options
Update OCI Dhcp Options, if present, by purging existing options and replacing them with specified ones
Delete OCI Dhcp Options, if present.

Requirements ¶

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

python >= 2.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

Parameters ¶

Parameter		Choices/Defaults	Comments
api_user			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			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			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			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		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 under which this Dhcp Options would be created. Mandatory for create operation.Optional for delete and update. Mutually exclusive with dhcp_id.
config_file_location			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		Default: DEFAULT	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`.
defined_tags			Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
dhcp_id			Identifier of the Dhcp Options. Mandatory for delete and update. aliases: id
display_name			Name of the Dhcp Options. A user friendly name. Does not have to be unique, and could be changed. If not specified, a default name would be provided. aliases: name
force_create bool		Choices: no ← yes	Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags			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 https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
key_by			The list of comma-separated attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource except freeform_tags are used to uniquely identify a resource.
options			A set of DHCP options. Mandatory for create and update.
	type required	Choices: DomainNameServer SearchDomain	The specific DHCP option.
	search_domain_names required		Applicable only for the type='SearchDomain'.A single search domain name according to RFC 952 and RFC 1123. Do not include this option with an empty list of search domain names, or with an empty string as the value for any search domain name.
	custom_dns_servers		Applicable only for the type='DomainNameServer' and server_type='CustomDnsServer'. Maximum three DNS server ips are allowed as part of this option.
	server_type required	Choices: VcnLocalPlusInternet CustomDnsServer	Applicable only for the type='DomainNameServer'.Describes the type of the server.
purge_dhcp_options bool		Choices: no yes ←	Purge existing Dhcp Options which are not present in the provided Dhcp Options. If purge_dhcp_options=no, provided options would be appended to existing options.
region			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.
state		Choices: present ← absent	Create,update or delete Dhcp Options. For state=present, if it does not exist, it gets created. If it exists, it gets updated.
tenancy			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 should be attached. Mandatory for create operation. Optional for delete and update. Mutually exclusive with dhcp_id.
wait bool		Choices: no yes ←	Whether to wait for create or delete operation to complete.
wait_timeout		Default: 1200	Time, in seconds, to wait when wait=yes.
wait_until			The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

#Note: These examples do not set authentication details.
#Create/update Dhcp Options
- name: Create dhcp options
  oci_dhcp_options:
    compartment_id: 'ocid1.compartment..xdsc'
    name: 'ansible_dhcp_options'
    vcn_id: 'ocid1.vcn..aaaa'
    options:
          - type: 'DomainNameServer'
            server_type: 'VcnLocalPlusInternet'
            custom_dns_servers: []
          - type: 'SearchDomain'
            search_domain_names: ['ansibletestvcn.oraclevcn.com']
    freeform_tags:
        region: 'east'
    defined_tags:
        features:
            capacity: 'medium'
    state: 'present'

#Update Dhcp Options by appending new options
- name: Update the display name of a Dhcp Options
  oci_dhcp_options:
    id: 'ocid1.dhcpoptions.oc1.aaa'
    purge_dhcp_options: 'no'
    options:
          - type: 'DomainNameServer'
            server_type: 'CustomDnsServer'
            custom_dns_servers: ['10.0.0.8']
          - type: 'SearchDomain'
            search_domain_names: ['ansibletestvcn.oraclevcn.com']
    state: 'present'

#Update Dhcp Options by purging existing options
- name: Update the display name of a Dhcp Options
  oci_dhcp_options:
    dhcp_id: 'ocid1.dhcpoptions.oc1.aaa'
    options:
          - type: 'DomainNameServer'
            server_type: 'CustomDnsServer'
            custom_dns_servers: ['10.0.0.8', '10.0.0.10', '10.0.0.12']
          - type: 'SearchDomain'
            search_domain_names: ['ansibletestvcn.oraclevcn.com']
    state: 'present'

#Delete Dhcp Options
- name: Delete Dhcp Options
  oci_dhcp_options:
    dhcp_id: 'ocid1.dhcpoptions..xdsc'
    state: 'absent'

Return Values ¶

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

Key		Returned	Description
dhcp_options complex		success	Attributes of the created/updated Dhcp Options. For delete, deleted Dhcp Options description will be returned. 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'}]}
	vcn_id string	always	Identifier of the Virtual Cloud Network to which the Dhcp Options is attached. Sample: ocid1.vcn..ixcd
	display_name string	always	Name assigned to the Dhcp Options during creation Sample: ansible_dhcp_options
	compartment_id string	always	The identifier of the compartment containing the Dhcp Options Sample: ocid1.compartment.oc1.xzvf..oifds
	lifecycle_state string	always	The current state of the Dhcp Options Sample: AVAILABLE
	id string	always	Identifier of the Dhcp Options Sample: ocid1.dhcpoptions.oc1.axdf
	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
	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']}]

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author ¶

Debayan Gupta(@debayan_gupta)

Hint

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