infoblox.nios_modules.nios_vlan module – Configure Infoblox NIOS VLANs
Note
This module is part of the infoblox.nios_modules collection (version 1.8.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 infoblox.nios_modules.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: infoblox.nios_modules.nios_vlan.
New in infoblox.nios_modules 1.8.0
Synopsis
Adds and/or removes instances of vlan objects from Infoblox NIOS servers. This module manages NIOS
vlanobjects using the Infoblox WAPI interface over REST.Updates instances of vlan object from Infoblox NIOS servers.
Requirements
The below requirements are needed on the host that executes this module.
infoblox-client
Parameters
Parameter |
Comments |
|---|---|
Configures a text string comment to be associated with the instance of this object. The provided text string will be configured on the object instance. Default: |
|
Contact information for person/team managing or using VLAN. Default: |
|
Department where VLAN is used. Default: |
|
Description for the VLAN object, may be potentially used for longer VLAN names. Default: |
|
Allows for the configuration of Extensible Attributes on the instance of the object. This argument accepts a set of key / value pairs for configuration. |
|
Specifies the vlan id to add or remove from the system. |
|
Specifies the vlan name to add or remove from the system. |
|
Specifies the vlan parent to add or remove from the system. Can be either a Default: |
|
A dict object containing connection details. |
|
Specifies the client certificate file with digest of x509 config for extra layer secure connection the remote instance of NIOS. Value can also be specified using |
|
Specifies the DNS host name or address for connecting to the remote instance of NIOS WAPI over REST Value can also be specified using |
|
Insert decription here Default: |
|
Insert description here Default: |
|
The amount of time before to wait before receiving a response Value can also be specified using Default: |
|
Specifies private key file for encryption with the certificate in order to connect with remote instance of NIOS. Value can also be specified using |
|
Specifies the maximum number of objects to be returned, if set to a negative number the appliance will return an error when the number of returned objects would exceed the setting. Value can also be specified using Default: |
|
Configures the number of attempted retries before the connection is declared usable Value can also be specified using Default: |
|
Specifies the password to use to authenticate the connection to the remote instance of NIOS. Value can also be specified using |
|
Insert description here Choices:
|
|
Configures the username to use to authenticate the connection to the remote instance of NIOS. Value can also be specified using |
|
Boolean value to enable or disable verifying SSL certificates Value can also be specified using Choices:
|
|
Specifies the version of WAPI to use Value can also be specified using Until ansible 2.8 the default WAPI was 1.4 Default: |
|
When set VLAN can only be assigned to IPAM object manually. Choices:
|
|
Configures the intended state of the instance of the object on the NIOS server. When this value is set to Choices:
|
Notes
Note
This module supports
check_mode.This module must be run locally, which can be achieved by specifying
connection: local.Please read the :ref:`nios_guide` for more detailed information on how to use Infoblox with Ansible.
Examples
- name: Create a new vlan
infoblox.nios_modules.nios_vlan:
name: ansible
id: 10
parent: my_vlanview
state: present
provider:
host: "{{ inventory_hostname_short }}"
username: admin
password: admin
connection: local
- name: Update the comment for a vlan
infoblox.nios_modules.nios_vlan:
name: ansible
id: 10
parent: my_vlanview
comment: this is an example comment
state: present
provider:
host: "{{ inventory_hostname_short }}"
username: admin
password: admin
connection: local
- name: Remove the vlan
infoblox.nios_modules.nios_vlan:
name: ansible
id: 10
parent: my_vlanview
state: absent
provider:
host: "{{ inventory_hostname_short }}"
username: admin
password: admin
connection: local
- name: Update an existing vlan
infoblox.nios_modules.nios_vlan:
name: {new_name: ansible-new, old_name: ansible}
id: 10
parent: my_vlanview
state: present
provider:
host: "{{ inventory_hostname_short }}"
username: admin
password: admin
connection: local
- name: Create vlan with extensible attributes
infoblox.nios_modules.nios_vlan:
name: ansible
id: 11
parent: my_vlanview
comment: "this is an example comment"
contact: "itlab@email.com"
department: "IT"
description: "test"
reserved: True
extattrs:
Site: "HQ"
state: present
provider:
host: "{{ inventory_hostname_short }}"
username: admin
password: admin
connection: local
- name: Create a new vlan with next available id
infoblox.nios_modules.nios_vlan:
name: ansible-vlan
id: "{{
lookup('infoblox.nios_modules.nios_next_vlan_id',
parent='my_vlanrange',
exclude=[1,2],
provider=nios_provider)[0]
}}"
parent: my_vlanrange
state: present
provider:
host: "{{ inventory_hostname_short }}"
username: admin
password: admin
connection: local