vultr.cloud.bare_metal module – Manages bare metal machines on Vultr.
Note
This module is part of the vultr.cloud collection (version 1.11.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install vultr.cloud.
To use it in a playbook, specify: vultr.cloud.bare_metal.
New in vultr.cloud 1.9.0
Synopsis
Manage bare metal machines on Vultr.
Parameters
Parameter |
Comments |
|---|---|
Whether to send an activation email when the bare metal machine is ready or not. Only considered on creation. Choices:
|
|
URL to API endpint (without trailing slash). Fallback environment variable Default: |
|
API key of the Vultr API. Fallback environment variable |
|
Amount of retries in case of the Vultr API retuns an HTTP 503 code. Fallback environment variable Default: |
|
Retry backoff delay in seconds is exponential up to this max. value, in seconds. Fallback environment variable Default: |
|
HTTP timeout to Vultr API. Fallback environment variable Default: |
|
The app deploy name of Vultr OneClick apps. Mutually exclusive with image and os. |
|
Whether to enable IPv6 or not. Choices:
|
|
The hostname to assign to this bare metal machine. |
|
The image deploy name of Vultr Marketplace apps. Mutually exclusive with os and app. |
|
Name of the bare metal machine. |
|
The operating system name. Mutually exclusive with image and app. |
|
Whether to enable persistent PXE or not. Choices:
|
|
The plan name to use for the bare metal machine. Required if the bare metal machine does not yet exist. |
|
Region the bare metal machine is deployed into. |
|
IP address of the floating IP to use as the main IP of this bare metal machine. Only considered on creation. |
|
Description or ID of the snapshot. Only considered while creating the bare metal machine. |
|
List of SSH key names passed to the bare metal machine on creation. |
|
Name or ID of the startup script to execute on boot. Only considered while creating the bare metal machine. |
|
State of the bare metal machine. Choices:
|
|
Tags for the bare metal machine. |
|
User data to be passed to the bare metal machine. |
|
Validate SSL certs of the Vultr API. Choices:
|
|
A list of VPCs (VPC 2.0) identified by their description to be assigned to the bare metal machine. |
Notes
Note
Also see the API documentation on https://www.vultr.com/api/.
Examples
---
- name: Create an bare metal machine using OS
vultr.cloud.bare_metal:
label: my web server
hostname: my-hostname
user_data: |
#cloud-config
packages:
- nginx
plan: vbm-4c-32gb
enable_ipv6: true
ssh_keys:
- my ssh key
vpc2s:
- my vpc description
tags:
- web
- project-genesis
region: ams
os: Debian 12 x64 (bookworm)
- name: Deploy an bare metal machine of a marketplace app
vultr.cloud.bare_metal:
label: git-server
hostname: git
plan: vbm-4c-32gb
enable_ipv6: true
region: ams
image: Gitea on Ubuntu 20.04
- name: Delete an bare metal machine
vultr.cloud.bare_metal:
label: my web server
region: ams
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Response from Vultr API with a few additions/modification. Returned: success |
|
Endpoint used for the API requests. Returned: success Sample: |
|
Amount of max retries for the API requests. Returned: success Sample: |
|
Exponential backoff delay in seconds between retries up to this max delay value. Returned: success Sample: |
|
Timeout used for the API requests. Returned: success Sample: |
|
Response from Vultr API. Returned: success |
|
App ID of the bare metal machine. Returned: success Sample: |
|
CPU count of the bare metal machine. Returned: success Sample: |
|
Date when the bare metal machine was created. Returned: success Sample: |
|
The default password assigned at deployment. Only available for ten minutes after deployment. Returned: success Sample: |
|
Disk info of the bare metal machine. Returned: success Sample: |
|
Whether IPv6 is enabled or not. Returned: success Sample: |
|
Features of the bare metal machine. Returned: success Sample: |
|
Gateway IPv4. Returned: success Sample: |
|
ID of the bare metal machine. Returned: success Sample: |
|
Image ID of the bare metal machine. Returned: success Sample: |
|
Label of the bare metal machine. Returned: success Sample: |
|
MAC address of the bare metal machine. Returned: success Sample: |
|
IPv4 of the bare metal machine. Returned: success Sample: |
|
Netmask IPv4 of the bare metal machine. Returned: success Sample: |
|
OS of the bare metal machine. Returned: success Sample: |
|
OS ID of the bare metal machine. Returned: success Sample: |
|
Plan of the bare metal machine. Returned: success Sample: |
|
Power status of the bare metal machine. Returned: success Sample: |
|
RAM info of the bare metal machine. Returned: success Sample: |
|
Region the bare metal machine was deployed into. Returned: success Sample: |
|
Status about the deployment of the bare metal machine. Returned: success Sample: |
|
Tags of the bare metal machine. Returned: success Sample: |
|
Base64 encoded user data (cloud init) of the bare metal machine. Returned: success Sample: |
|
IPv6 of the bare metal machine. Returned: success Sample: |
|
IPv6 network of the bare metal machine. Returned: success Sample: |
|
IPv6 network size of the bare metal machine. Returned: success Sample: |
|
List of VPCs (VPC 2.0) attached. Returned: success |
|
Date when the VPC was created. Returned: success Sample: |
|
Description of the VPC. Returned: success Sample: |
|
ID of the VPC. Returned: success Sample: |
|
IP block assigned to the VPC. Returned: success Sample: |
|
The number of bits for the netmask in CIDR notation. Returned: success Sample: |
|
Region the VPC is assigned to. Returned: success Sample: |