codeaffen.phpipam.vlan module – Manage vlans

Note

This module is part of the codeaffen.phpipam collection (version 1.6.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 codeaffen.phpipam.

To use it in a playbook, specify: codeaffen.phpipam.vlan.

New in version 0.3.0: of codeaffen.phpipam

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

app_id

string

API app name

Default: “ansible”

description

string

A descriptive text for that entity

name

string / required

Name of the given vlan

password

string / required

Password of the user to access phpIPAM server

routing_domain

string

Name of the L2 routing domain of that VLAN

server_url

string / required

URL of the phpIPAM server

state

string

State of the entity

Choices:

  • present ← (default)

  • absent

username

string / required

Username to access phpIPAM server

validate_certs

boolean

Is the TLS certificate of the phpIPAM server verified or not.

Choices:

  • no

  • yes ← (default)

vlan_id

string / required

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

Authors

  • Christian Meißner (@cmeissner)