netbox.netbox.netbox_virtual_machine module – Create, update or delete virtual_machines within NetBox

Note

This module is part of the netbox.netbox collection (version 3.20.0).

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_virtual_machine.

New in netbox.netbox 0.1.0

Synopsis

• Creates, updates or removes virtual_machines from NetBox

Requirements

The below requirements are needed on the host that executes this module.

• pynetbox

Parameters

Parameter	Comments
cert	Certificate path
data	Defines the virtual machine configuration
cluster	The name of the cluster attach to the virtual machine
comments	Comments of the virtual machine
config_template :ansible-option-versionadded:`added in netbox.netbox 3.17.0`	Configuration template
custom_fields	Must exist in NetBox
description :ansible-option-versionadded:`added in netbox.netbox 3.10.0`	The description of the virtual machine
device :ansible-option-versionadded:`added in netbox.netbox 3.9.0`	The device the virtual machine is pinned to in the cluster
disk	Disk of the virtual machine (GB)
local_context_data	configuration context of the virtual machine
memory	Memory of the virtual machine (MB)
name	The name of the virtual machine
platform	The platform of the virtual machine
primary_ip4	Primary IPv4 address assigned to the virtual machine
primary_ip6	Primary IPv6 address assigned to the virtual machine
serial :ansible-option-versionadded:`added in netbox.netbox 3.20.0`	Serial number of the virtual machine
site	The name of the site attach to the virtual machine
status	The status of the virtual machine
tags	Any tags that the virtual machine may need to be associated with
tenant	The tenant that the virtual machine will be assigned to
vcpus	Number of vcpus of the virtual machine
virtual_machine_role	The role of the virtual machine
netbox_token	The NetBox API token.
netbox_url	The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params	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	The state of the object. :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`"absent"`
validate_certs	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. :ansible-option-default-bold:`Default:` :ansible-option-default:`true`

Notes

Note

• Tags should be defined as a YAML list

• This should be ran with connection local and hosts localhost

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

    - name: Update virtual machine within NetBox with serial number
      netbox_virtual_machine:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test Virtual Machine
          cluster: test cluster
          serial: 1234abc
        state: present

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
msg	Message indicating failure or info about what has been achieved :ansible-option-returned-bold:`Returned:` always
virtual machine	Serialized object as created or already existent within NetBox :ansible-option-returned-bold:`Returned:` success (when state=present)

Authors

• Gaelle MANGIN (@gmangin)

Collection links