netbox.netbox.netbox_virtual_machine – Create, update or delete virtual_machines within NetBox¶
Note
This plugin is part of the netbox.netbox collection (version 3.5.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 netbox.netbox
.
To use it in a playbook, specify: netbox.netbox.netbox_virtual_machine
.
New in version 0.1.0: of netbox.netbox
Synopsis¶
Creates, updates or removes virtual_machines from NetBox
Requirements¶
The below requirements are needed on the host that executes this module.
pynetbox
Parameters¶
Notes¶
Note
Tags should be defined as a YAML list
This should be ran with connection
local
and hostslocalhost
Examples¶
- name: "Test NetBox modules"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create virtual machine within NetBox with only required information
netbox_virtual_machine:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Virtual Machine
cluster: test cluster
state: present
- name: Delete virtual machine within netbox
netbox_virtual_machine:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Virtual Machine
state: absent
- name: Create virtual machine with tags
netbox_virtual_machine:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Another Test Virtual Machine
cluster: test cluster
site: Test Site
tags:
- Schnozzberry
state: present
- name: Update vcpus, memory and disk of an existing virtual machine
netbox_virtual_machine:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Virtual Machine
cluster: test cluster
vcpus: 8
memory: 8
disk: 8
state: present
Return Values¶
Common return values are documented here, the following are the fields unique to this module: