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.5.1).

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_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

Parameter Choices/Defaults Comments
cert
raw
Certificate path
data
dictionary / required
Defines the vm interface configuration
custom_fields
dictionary
added in 3.4.0 of netbox.netbox
Must exist in NetBox
description
string
The description of the interface
enabled
boolean
    Choices:
  • no
  • yes
Sets whether interface shows enabled or disabled
mac_address
string
The MAC address of the interface
mode
raw
The mode of the interface
mtu
integer
The MTU of the interface
name
string / required
Name of the interface to be created
parent_vm_interface
raw
added in 3.2.0 of netbox.netbox
The virtual machine interface's parent interface.
tagged_vlans
raw
A list of tagged VLANS to be assigned to interface. Mode must be set to either Tagged or Tagged All
tags
list / elements=raw
Any tags that the prefix may need to be associated with
untagged_vlan
raw
The untagged VLAN to be assigned to interface
virtual_machine
raw
Name of the virtual machine the interface will be associated with (case-sensitive)
netbox_token
string / required
The NetBox API token.
netbox_url
string / required
The URL of the NetBox instance.
Must be accessible by the Ansible control host.
query_params
list / elements=string
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.
state
string
    Choices:
  • present ←
  • absent
The state of the object.
validate_certs
raw
Default:
"yes"
If no, SSL certificates will not be validated.
This should only be used on personally controlled sites using a self-signed certificates.

Notes

Note

  • Tags should be defined as a YAML list

  • This should be ran with connection local and hosts localhost

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:

Key Returned Description
interface
dictionary
on creation
Serialized object as created or already existent within NetBox
msg
string
always
Message indicating failure or info about what has been achieved


Authors

  • Benjamin Vergnaud (@bvergnaud)