Class: Ansible::Ruby::Modules::Ec2_vpc_dhcp_option

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Ec2_vpc_dhcp_option

Defined in:

lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_dhcp_option.rb,
lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_dhcp_options.rb

Overview

This module removes, or creates DHCP option sets, and can associate them to a VPC. Optionally, a new DHCP Options set can be created that converges a VPC’s existing DHCP option set with values provided. When dhcp_options_id is provided, the module will 1. remove (with state=‘absent’) 2. ensure tags are applied (if state=‘present’ and tags are provided 3. attach it to a VPC (if state=‘present’ and a vpc_id is provided. If any of the optional values are missing, they will either be treated as a no-op (i.e., inherit what already exists for the VPC) To remove existing options while inheriting, supply an empty value (e.g. set ntp_servers to [] if you want to remove them from the VPC’s options) Most of the options should be self-explanatory.

Instance Method Summary

• #delete_old ⇒ :yes, ...

  Whether to delete the old VPC DHCP option set when associating a new one.

• #dhcp_options_id ⇒ String^?

  The resource_id of an existing DHCP options set.

• #dns_servers ⇒ Array<String>, ...

  A list of hosts to set the DNS servers for the VPC to.

• #domain_name ⇒ String^?

  The domain name to set in the DHCP option sets.

• #inherit_existing ⇒ :yes, ...

  For any DHCP options not specified in these parameters, whether to inherit them from the options set already applied to vpc_id, or to reset them to be empty.

• #netbios_name_servers ⇒ Array<String>, ...

  List of hosts to advertise as NetBIOS servers.

• #netbios_node_type ⇒ Integer^?

  NetBIOS node type to advertise in the DHCP options.

• #ntp_servers ⇒ Array<String>, ...

  List of hosts to advertise as NTP servers for the VPC.

• #state ⇒ :absent, ...

  Create/assign or remove the DHCP options.

• #tags ⇒ Hash^?

  Tags to be applied to a VPC options set if a new one is created, or if the resource_id is provided.

• #vpc_id ⇒ String^?

  VPC ID to associate with the requested DHCP option set.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#delete_old ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_dhcp_option.rb', line 36

attribute :delete_old

#dhcp_options_id ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_dhcp_option.rb', line 48

attribute :dhcp_options_id

#dns_servers ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_dhcp_option.rb', line 16

attribute :dns_servers

#domain_name ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_dhcp_option.rb', line 12

attribute :domain_name

#inherit_existing ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_dhcp_option.rb', line 40

attribute :inherit_existing

#netbios_name_servers ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_dhcp_option.rb', line 24

attribute :netbios_name_servers

#netbios_node_type ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_dhcp_option.rb', line 28

attribute :netbios_node_type

#ntp_servers ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_dhcp_option.rb', line 20

attribute :ntp_servers

#state ⇒ :absent, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_dhcp_option.rb', line 52

attribute :state

#tags ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_dhcp_option.rb', line 44

attribute :tags

#vpc_id ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_dhcp_option.rb', line 32

attribute :vpc_id