codeaffen.phpipam.vlan module – Manage vlans
Note
This module is part of the codeaffen.phpipam collection (version 1.7.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 codeaffen.phpipam
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: codeaffen.phpipam.vlan
.
New in codeaffen.phpipam 0.3.0
Synopsis
create, update and delete vlans
Requirements
The below requirements are needed on the host that executes this module.
inflection
ipaddress
phpypam>=1.0.0
Parameters
Parameter |
Comments |
---|---|
API app name Default: |
|
A descriptive text for that entity |
|
Name of the given vlan |
|
Password of the user to access phpIPAM server |
|
Name of the L2 routing domain of that VLAN |
|
URL of the phpIPAM server |
|
State of the entity Choices:
|
|
Username to access phpIPAM server |
|
Is the TLS certificate of the phpIPAM server verified or not. Choices:
|
|
The VLAN-ID. Must be a number. Due to implementation of api the value has to be string here but is int in phpIPAM |
Examples
- name: "Create vlan"
codeaffen.phpipam.vlan:
username: "admin"
password: "s3cr3t"
server_url: "https://ipam.example.com"
name: "my vlan"
vlan_id: 1337
state: present
- name: "Remove vlan"
codeaffen.phpipam.vlan:
username: "admin"
password: "s3cr3t"
server_url: "https://ipam.example.com"
name: "my vlan"
state: absent