codeaffen.phpipam.section module – Manage sections

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

Comments

app_id

string

API app name

Default: “ansible”

description

string

Short descriptive text

Default: “None”

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

aliases: master, master_section

string

Name of the parent section

Default: “None”

password

string / required

Password of the user to access phpIPAM server

permissions

json

JSON object that represents the permissions for each user

Default: “None”

server_url

string / required

URL of the phpIPAM server

show_supernets_only

boolean

Show only supernets in subnet list view

Choices:

  • no ← (default)

  • yes

show_vlan

boolean

Show/hide VLANs in subnet list view

Choices:

  • no ← (default)

  • yes

show_vrf

boolean

Show/hide VRFs in subnet list view

Choices:

  • no ← (default)

  • yes

state

string

State of the entity

Choices:

  • present ← (default)

  • absent

strict_mode

boolean

If set to true, consistency of subnets and IP addresses will be checked

Choices:

  • no ← (default)

  • yes

subnet_ordering

string

How to order subnets within this section

Default: “subnet,asc”

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)

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)