Class: Ansible::Ruby::Modules::Packet_device

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/cloud/packet/packet_device.rb

Overview

Manage a bare metal server in the Packet Host (a “device” in the API terms). When the machine is created it can optionally wait for public IP address, or for active state. This module has a dependency on packet >= 1.0. API is documented at U(www.packet.net/developers/api/devices).

Instance Method Summary

• #always_pxe ⇒ Boolean^?

  Persist PXE as the first boot option.,Normally, the PXE process happens only on the first boot.

• #auth_token ⇒ Object^?

  Packet api token.

• #count ⇒ Integer^?

  The number of devices to create.

• #count_offset ⇒ Integer^?

  From which number to start the count.

• #device_ids ⇒ Object^?

  List of device IDs on which to operate.

• #facility ⇒ Object^?

  Facility slug for device creation.

• #features ⇒ Object^?

  Dict with “features” for device creation.

• #hostnames ⇒ Object^?

  A hostname of a device, or a list of hostnames.,If given string or one-item list, you can use the C(“%d”) Python string format to expand numbers from I(count).,If only one hostname, it might be expanded to list if I(count)>1.

• #ipxe_script_url ⇒ Object^?

  URL of custom iPXE script for provisioning.,More about custome iPXE for Packet devices at U(help.packet.net/technical/infrastructure/custom-ipxe).

• #locked ⇒ Boolean^?

  Whether to lock a created device.

• #operating_system ⇒ Object^?

  OS slug for device creation.

• #plan ⇒ Object^?

  Plan slug for device creation.

• #project_id ⇒ Object

  ID of project of the device.

• #state ⇒ :present, ...

  Desired state of the device.,If set to C(present) (the default), the module call will return immediately after the device-creating HTTP request successfully returns.,If set to C(active), the module call will block until all the specified devices are in state active due to the Packet API, or until I(wait_timeout).

• #user_data ⇒ Object^?

  Userdata blob made available to the machine.

• #wait_for_public_IPv ⇒ 4, ...

  Whether to wait for the instance to be assigned a public IPv4/IPv6 address.,If set to 4, it will wait until IPv4 is assigned to the instance.,If set to 6, wait until public IPv6 is assigned to the instance.

• #wait_timeout ⇒ Integer^?

  How long (seconds) to wait either for automatic IP address assignment, or for the device to reach the C(active) I(state).,If I(wait_for_public_IPv) is set and I(state) is C(active), the module will wait for both events consequently, applying the timeout twice.

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

#always_pxe ⇒ Boolean^?

# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_device.rb', line 70

attribute :always_pxe

#auth_token ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_device.rb', line 15

attribute :auth_token

#count ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_device.rb', line 18

attribute :count

#count_offset ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_device.rb', line 22

attribute :count_offset

#device_ids ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_device.rb', line 26

attribute :device_ids

#facility ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_device.rb', line 29

attribute :facility

#features ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_device.rb', line 32

attribute :features

#hostnames ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_device.rb', line 35

attribute :hostnames

#ipxe_script_url ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_device.rb', line 67

attribute :ipxe_script_url

#locked ⇒ Boolean^?

# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_device.rb', line 38

attribute :locked

#operating_system ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_device.rb', line 42

attribute :operating_system

#plan ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_device.rb', line 45

attribute :plan

#project_id ⇒ Object

# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_device.rb', line 48

attribute :project_id

#state ⇒ :present, ...

# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_device.rb', line 52

attribute :state

#user_data ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_device.rb', line 56

attribute :user_data

#wait_for_public_IPv ⇒ 4, ...

# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_device.rb', line 59

attribute :wait_for_public_IPv

#wait_timeout ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/packet/packet_device.rb', line 63

attribute :wait_timeout