netbox.netbox.netbox_vm_interface – Creates or removes interfaces from virtual machines in Netbox¶
Note
This plugin is part of the netbox.netbox collection (version 3.1.0).
To install it use: ansible-galaxy collection install netbox.netbox
.
To use it in a playbook, specify: netbox.netbox.netbox_vm_interface
.
New in version 0.1.0: of netbox.netbox
Synopsis¶
Creates or removes interfaces from virtual machines in 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 interface module"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create interface within Netbox with only required information
netbox_vm_interface:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
virtual_machine: test100
name: GigabitEthernet1
state: present
- name: Delete interface within netbox
netbox_vm_interface:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
virtual_machine: test100
name: GigabitEthernet1
state: absent
- name: Create interface as a trunk port
netbox_vm_interface:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
virtual_machine: test100
name: GigabitEthernet25
enabled: false
untagged_vlan:
name: Wireless
site: Test Site
tagged_vlans:
- name: Data
site: Test Site
- name: VoIP
site: Test Site
mtu: 1600
mode: Tagged
state: present
Return Values¶
Common return values are documented here, the following are the fields unique to this module: