Parameter |
Choices/Defaults |
Comments |
always_pxe
(added in 2.4) |
Default:
"no"
|
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
|
|
|
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.
|
locked
(added in 2.4) |
Default:
"no"
|
Whether to lock a created device.
aliases: lock
|
operating_system
|
|
|
plan
|
|
|
project_id
required |
|
ID of project of the device.
|
state
|
Choices:
present ←
- absent
- active
- inactive
- rebooted
|
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.
|