netbox_vm_interface_module.rst

orphan

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.6.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_vm_interface.

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

ansible-option-table

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

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

    - 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 <common_return_values>, the following are the fields unique to this module:

ansible-option-table

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

Authors

• Benjamin Vergnaud (@bvergnaud)