netbox.netbox.netbox_vm_interface module – Creates or removes interfaces from virtual machines in NetBox
Note
This module is part of the netbox.netbox collection (version 3.20.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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: netbox.netbox.netbox_vm_interface
.
New in netbox.netbox 0.1.0
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
Parameter |
Comments |
---|---|
Certificate path |
|
Defines the vm interface configuration |
|
Must exist in NetBox |
|
The description of the interface |
|
Sets whether interface shows enabled or disabled Choices:
|
|
The MAC address of the interface |
|
The mode of the interface |
|
The MTU of the interface |
|
Name of the interface to be created |
|
The virtual machine interface’s parent interface. |
|
A list of tagged VLANS to be assigned to interface. Mode must be set to either |
|
Any tags that the prefix may need to be associated with |
|
The untagged VLAN to be assigned to interface |
|
Name of the virtual machine the interface will be associated with (case-sensitive) |
|
The bridge the interface is connected to |
|
VRF the interface is associated with |
|
The NetBox API token. |
|
The URL of the NetBox instance. Must be accessible by the Ansible control host. |
|
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that are defined in plugins/module_utils/netbox_utils.py and provides control to users on what may make an object unique in their environment. |
|
The state of the object. Choices:
|
|
If This should only be used on personally controlled sites using a self-signed certificates. Default: |
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
- name: Create bridge interface within NetBox
netbox_vm_interface:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
virtual_machine: test100
name: br1000
state: present
- name: Connect bridge interface within NetBox
netbox_vm_interface:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
virtual_machine: test100
name: br1001
vm_bridge: br1000
state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Serialized object as created or already existent within NetBox Returned: on creation |
|
Message indicating failure or info about what has been achieved Returned: always |