netbox.netbox.netbox_virtual_chassis module – Create, update or delete virtual chassis within 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_virtual_chassis.

New in netbox.netbox 0.3.0

Synopsis 

Creates, updates or removes virtual chassis from NetBox

Requirements 

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

pynetbox

Parameters 

Parameter	Comments
cert any	Certificate path
data dictionary / required	Defines the virtual chassis configuration
comments string added in netbox.netbox 3.10.0	Comments that may include additional information in regards to the virtual chassis
custom_fields dictionary	must exist in NetBox
description string added in netbox.netbox 3.10.0	Description of the virtual chassis
domain string	domain of the virtual chassis
master any	The master device the virtual chassis is attached to
name string	Name
tags list / elements=any	Any tags that the virtual chassis may need to be associated with
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	The state of the object. Choices: `"present"` ← (default) `"absent"`
validate_certs any	If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. 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 chassis within NetBox with only required information
      netbox_virtual_chassis:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: "Virtual Chassis 1"
          master: Test Device
        state: present

    - name: Update virtual chassis with other fields
      netbox_virtual_chassis:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: "Virtual Chassis 1"
          domain: Domain Text
        state: present

    - name: Delete virtual chassis within netbox
      netbox_virtual_chassis:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: "Virtual Chassis 1"
        state: absent

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_chassis dictionary	Serialized object as created or already existent within NetBox Returned: success (when state=present)

Authors

Tobias Groß (@toerb)

netbox.netbox.netbox_virtual_chassis module – Create, update or delete virtual chassis within NetBox

Synopsis

Requirements

Parameters

Notes

Examples

Return Values