codeaffen.phpipam.section – Manage sections

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.section.

New in version 0.0.1: of codeaffen.phpipam

Synopsis

  • create, update and delete sections

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
Default:
"None"
Short descriptive text
dns_resolver
string
The NS resolver to be used for this section
list_order
integer
Order in sections list view
name
string / required
Name of the section
parent
string
Default:
"None"
Name of the parent section

aliases: master, master_section
password
string / required
Password of the user to access phpIPAM server
permissions
json
Default:
"None"
JSON object that represents the permissions for each user
server_url
string / required
URL of the phpIPAM server
show_supernets_only
boolean
    Choices:
  • no ←
  • yes
Show only supernets in subnet list view
show_vlan
boolean
    Choices:
  • no ←
  • yes
Show/hide VLANs in subnet list view
show_vrf
boolean
    Choices:
  • no ←
  • yes
Show/hide VRFs in subnet list view
state
string
    Choices:
  • present ←
  • absent
State of the entity
strict_mode
boolean
    Choices:
  • no ←
  • yes
If set to true, consistency of subnets and IP addresses will be checked
subnet_ordering
string
Default:
"subnet,asc"
How to order subnets within this section
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 a section"
  codeaffen.phpipam.section:
    username: "admin"
    password: "s3cr3t"
    server_url: "https://ipam.example.com"
    name: "EXAMPLE INC"
    description: "Section for company EXAMPLE INC"
    state: present

- name: "Create a section with parent"
  codeaffen.phpipam.section:
    username: "admin"
    password: "s3cr3t"
    server_url: "https://ipam.example.com"
    name: "DEVOPS department"
    parent: "EXAMPLE INC"
    description: "Section for devops department in EXAMPLE INC"
    state: present

Authors

  • Christian Meißner (@cmeissner)