networktocode.nautobot.virtual_machine module – Create, update or delete virtual_machines within Nautobot

Note

This module is part of the networktocode.nautobot collection (version 3.4.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 networktocode.nautobot.

To use it in a playbook, specify: networktocode.nautobot.virtual_machine.

New in version 1.0.0: of networktocode.nautobot

Synopsis

  • Creates, updates or removes virtual_machines from Nautobot

Requirements

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

  • pynautobot

Parameters

Parameter

Comments

cluster

raw

added in 3.0.0 of networktocode.nautobot

The name of the cluster attach to the virtual machine

comments

string

added in 3.0.0 of networktocode.nautobot

Comments of the virtual machine

custom_fields

dictionary

Must exist in Nautobot

disk

integer

added in 3.0.0 of networktocode.nautobot

Disk of the virtual machine (GB)

local_context_data

dictionary

added in 3.0.0 of networktocode.nautobot

configuration context of the virtual machine

memory

integer

added in 3.0.0 of networktocode.nautobot

Memory of the virtual machine (MB)

name

string / required

added in 3.0.0 of networktocode.nautobot

The name of the virtual machine

platform

raw

added in 3.0.0 of networktocode.nautobot

The platform of the virtual machine

primary_ip4

raw

added in 3.0.0 of networktocode.nautobot

Primary IPv4 address assigned to the virtual machine

primary_ip6

raw

added in 3.0.0 of networktocode.nautobot

Primary IPv6 address assigned to the virtual machine

query_params

list / elements=string

added in 3.0.0 of networktocode.nautobot

This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined

in plugins/module_utils/utils.py and provides control to users on what may make

an object unique in their environment.

site

raw

added in 3.0.0 of networktocode.nautobot

The name of the site attach to the virtual machine

state

string

Use present or absent for adding or removing.

Choices:

  • absent

  • present ← (default)

status

raw

added in 3.0.0 of networktocode.nautobot

The status of the virtual machine

Required if state=present and does not exist yet

tags

list / elements=raw

added in 3.0.0 of networktocode.nautobot

Any tags that the virtual machine may need to be associated with

tenant

raw

added in 3.0.0 of networktocode.nautobot

The tenant that the virtual machine will be assigned to

token

string / required

The token created within Nautobot to authorize API access

url

string / required

URL of the Nautobot instance resolvable by Ansible control host

validate_certs

raw

If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Default: “yes”

vcpus

integer

added in 3.0.0 of networktocode.nautobot

Number of vcpus of the virtual machine

virtual_machine_role

raw

added in 3.0.0 of networktocode.nautobot

The role of the virtual machine

Notes

Note

  • Tags should be defined as a YAML list

  • This should be ran with connection local and hosts localhost

Examples

- name: "Test Nautobot modules"
  connection: local
  hosts: localhost
  gather_facts: False
  tasks:
    - name: Create virtual machine within Nautobot with only required information
      networktocode.nautobot.virtual_machine:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Virtual Machine
        cluster: test cluster
        status: active
        state: present

    - name: Delete virtual machine within nautobot
      networktocode.nautobot.virtual_machine:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Virtual Machine
        state: absent

    - name: Create virtual machine with tags
      networktocode.nautobot.virtual_machine:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Another Test Virtual Machine
        cluster: test cluster
        site: Test Site
        status: active
        tags:
          - Schnozzberry
        state: present

    - name: Update vcpus, memory and disk of an existing virtual machine
      networktocode.nautobot.virtual_machine:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test Virtual Machine
        cluster: test cluster
        vcpus: 8
        memory: 8
        disk: 8
        state: present

Return Values

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

Key

Description

msg

string

Message indicating failure or info about what has been achieved

Returned: always

virtual machine

dictionary

Serialized object as created or already existent within Nautobot

Returned: success (when state=present)

Authors

  • Gaelle MANGIN (@gmangin)