packet_device – Manage a bare metal server in the Packet Host¶
Synopsis¶
- 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 https://www.packet.net/developers/api/devices.
Requirements¶
The below requirements are needed on the host that executes this module.
- packet-python >= 1.35
Parameters¶
| Parameter | Choices/Defaults | Comments |
|---|---|---|
|
always_pxe
boolean
added in 2.4 |
|
Persist PXE as the first boot option.
Normally, the PXE process happens only on the first boot. Set this arg to have your device continuously boot to iPXE.
|
|
auth_token
-
|
Packet api token. You can also supply it in env var
PACKET_API_TOKEN. |
|
|
count
-
|
Default: 1
|
The number of devices to create. Count number can be included in hostname via the %d string formatter.
|
|
count_offset
-
|
Default: 1
|
From which number to start the count.
|
|
device_ids
-
|
List of device IDs on which to operate.
|
|
|
facility
-
|
Facility slug for device creation. See Packet API for current list - https://www.packet.net/developers/api/facilities/.
|
|
|
features
-
|
Dict with "features" for device creation. See Packet API docs for details.
|
|
|
hostnames
-
|
A hostname of a device, or a list of hostnames.
If given string or one-item list, you can use the
"%d" Python string format to expand numbers from count.If only one hostname, it might be expanded to list if count>1.
aliases: name |
|
|
ipxe_script_url
-
added in 2.4 |
URL of custom iPXE script for provisioning.
More about custom iPXE for Packet devices at https://help.packet.net/technical/infrastructure/custom-ipxe.
|
|
|
locked
boolean
added in 2.4 |
|
Whether to lock a created device.
aliases: lock |
|
operating_system
-
|
OS slug for device creation. See Packet API for current list - https://www.packet.net/developers/api/operatingsystems/.
|
|
|
plan
-
|
Plan slug for device creation. See Packet API for current list - https://www.packet.net/developers/api/plans/.
|
|
|
project_id
-
/ required
|
ID of project of the device.
|
|
|
state
-
|
|
Desired state of the device.
If set to
present (the default), the module call will return immediately after the device-creating HTTP request successfully returns.If set to
active, the module call will block until all the specified devices are in state active due to the Packet API, or until wait_timeout. |
|
user_data
-
|
Userdata blob made available to the machine
|
|
|
wait_for_public_IPv
-
added in 2.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
-
|
Default: 900
|
How long (seconds) to wait either for automatic IP address assignment, or for the device to reach the
active state.If wait_for_public_IPv is set and state is
active, the module will wait for both events consequently, applying the timeout twice. |
Examples¶
# All the examples assume that you have your Packet api token in env var PACKET_API_TOKEN.
# You can also pass it to the auth_token parameter of the module instead.
# Creating devices
- name: create 1 device
hosts: localhost
tasks:
- packet_device:
project_id: 89b497ee-5afc-420a-8fb5-56984898f4df
hostnames: myserver
operating_system: ubuntu_16_04
plan: baremetal_0
facility: sjc1
# Create the same device and wait until it is in state "active", (when it's
# ready for other API operations). Fail if the devices in not "active" in
# 10 minutes.
- name: create device and wait up to 10 minutes for active state
hosts: localhost
tasks:
- packet_device:
project_id: 89b497ee-5afc-420a-8fb5-56984898f4df
hostnames: myserver
operating_system: ubuntu_16_04
plan: baremetal_0
facility: sjc1
state: active
wait_timeout: 600
- name: create 3 ubuntu devices called server-01, server-02 and server-03
hosts: localhost
tasks:
- packet_device:
project_id: 89b497ee-5afc-420a-8fb5-56984898f4df
hostnames: server-%02d
count: 3
operating_system: ubuntu_16_04
plan: baremetal_0
facility: sjc1
- name: Create 3 coreos devices with userdata, wait until they get IPs and then wait for SSH
hosts: localhost
tasks:
- name: create 3 devices and register their facts
packet_device:
hostnames: [coreos-one, coreos-two, coreos-three]
operating_system: coreos_stable
plan: baremetal_0
facility: ewr1
locked: true
project_id: 89b497ee-5afc-420a-8fb5-56984898f4df
wait_for_public_IPv: 4
user_data: |
#cloud-config
ssh_authorized_keys:
- {{ lookup('file', 'my_packet_sshkey') }}
coreos:
etcd:
discovery: https://discovery.etcd.io/6a28e078895c5ec737174db2419bb2f3
addr: $private_ipv4:4001
peer-addr: $private_ipv4:7001
fleet:
public-ip: $private_ipv4
units:
- name: etcd.service
command: start
- name: fleet.service
command: start
register: newhosts
- name: wait for ssh
wait_for:
delay: 1
host: "{{ item.public_ipv4 }}"
port: 22
state: started
timeout: 500
with_items: "{{ newhosts.devices }}"
# Other states of devices
- name: remove 3 devices by uuid
hosts: localhost
tasks:
- packet_device:
project_id: 89b497ee-5afc-420a-8fb5-56984898f4df
state: absent
device_ids:
- 1fb4faf8-a638-4ac7-8f47-86fe514c30d8
- 2eb4faf8-a638-4ac7-8f47-86fe514c3043
- 6bb4faf8-a638-4ac7-8f47-86fe514c301f
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Tomas Karasek (@t0mk) <tom.to.the.k@gmail.com>
- Matt Baldwin (@baldwinSPC) <baldwin@stackpointcloud.com>
- Thibaud Morel l’Horset (@teebes) <teebes@gmail.com>
Hint
If you notice any issues in this documentation, you can edit this document to improve it.