codeaffen.phpipam.vrf – Manage virtual routers and forwarders

Note

This plugin is part of the codeaffen.phpipam collection (version 1.5.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.vrf.

New in version 0.4.0: of codeaffen.phpipam

Synopsis

  • create, update and delete L2 routing vrfs

Requirements

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

  • inflection

  • ipaddress

  • phpypam>=1.0.0

Parameters

Parameter Choices/Defaults Comments
app_id
string
Default:
"ansible"
API app name
description
string
A descriptive text for that entity
distinguisher
string
VRF route distinguisher
name
string / required
Name of the given vrf
password
string / required
Password of the user to access phpIPAM server
sections
list / elements=string
List of sections where the nameserver appears
server_url
string / required
URL of the phpIPAM server
state
string
    Choices:
  • present ←
  • absent
State of the entity
username
string / required
Username to access phpIPAM server
validate_certs
boolean
    Choices:
  • no
  • yes ←
Is the TLS certificate of the phpIPAM server verified or not.

Examples

- name: "Create vrf"
  codeaffen.phpipam.vrf:
    username: "admin"
    password: "s3cr3t"
    server_url: "https://ipam.example.com"
    name: "my vrf"
    sections:
      - Example Inc.
      - DEVOPS department
    state: present

- name: "Remove vrf"
  codeaffen.phpipam.vrf:
    username: "admin"
    password: "s3cr3t"
    server_url: "https://ipam.example.com"
    name: "my vrf"
    state: absent

Authors

  • Christian Meißner (@cmeissner)