| orphan: |
|---|
Note
This module is part of the netbox.netbox collection (version 3.17.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 :ref:`Requirements <ansible_collections.netbox.netbox.netbox_vlan_group_module_requirements>` for details.
To use it in a playbook, specify: netbox.netbox.netbox_vlan_group.
.. rst-class:: ansible-version-added
New in netbox.netbox 0.1.0
- Creates, updates or removes vlans groups from NetBox
The below requirements are needed on the host that executes this module.
- pynetbox
.. tabularcolumns:: \X{1}{3}\X{2}{3}
| Parameter | Comments |
|---|---|
Certificate path |
|
Defines the vlan group configuration |
|
must exist in NetBox |
|
Description for VLAN group |
|
Highest permissible ID of a child VLAN |
|
Lowest permissible ID of a child VLAN |
|
The name of the vlan group |
|
Object related to scope type (NetBox 2.11+) |
|
Type of scope to be applied (NetBox 2.11+) .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:`
|
|
The site the vlan will be assigned to (NetBox < 2.11) Will be removed in version 5.0.0 |
|
The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided |
|
The tags to add/update |
|
The NetBox API token. |
|
The URL of the NetBox instance. Must be accessible by the Ansible control host. |
|
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. |
|
The state of the object. .. rst-class:: ansible-option-line |
|
If This should only be used on personally controlled sites using a self-signed certificates. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`true` |
Note
- Tags should be defined as a YAML list
- This should be ran with connection
localand hostslocalhost
- name: "Test NetBox modules"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create vlan group within NetBox with only required information - Pre 2.11
netbox_vlan_group:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test vlan group
site: Test Site
state: present
- name: Create vlan group within NetBox with only required information - Post 2.11
netbox_vlan_group:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test vlan group
scope_type: "dcim.site"
scope: Test Site
state: present
- name: Delete vlan group within netbox
netbox_vlan_group:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test vlan group
state: absent
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
.. tabularcolumns:: \X{1}{3}\X{2}{3}
| Key | Description |
|---|---|
Message indicating failure or info about what has been achieved .. rst-class:: ansible-option-line |
|
Serialized object as created or already existent within NetBox .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success (when state=present) |
- Mikhail Yohman (@FragmentedPacket)
.. ansible-links::
- title: "Issue Tracker"
url: "https://github.com/netbox-community/ansible_modules/issues"
external: true
- title: "Repository (Sources)"
url: "https://github.com/netbox-community/ansible_modules"
external: true