section_module.rst

orphan:

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.

.. versionadded:: 0.0.1 of codeaffen.phpipam

• Synopsis
• Requirements
• Parameters
• Examples

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

.. rst-class:: ansible-option-table

Parameter	Comments
.. rst-class:: ansible-option-title app_id .. rst-class:: ansible-option-type-line string	API app name .. rst-class:: ansible-option-line Default: "ansible"
.. rst-class:: ansible-option-title description .. rst-class:: ansible-option-type-line string	Short descriptive text .. rst-class:: ansible-option-line Default: "None"
.. rst-class:: ansible-option-title dns_resolver .. rst-class:: ansible-option-type-line string	The NS resolver to be used for this section
.. rst-class:: ansible-option-title list_order .. rst-class:: ansible-option-type-line integer	Order in sections list view
.. rst-class:: ansible-option-title name .. rst-class:: ansible-option-type-line string / required	Name of the section
.. rst-class:: ansible-option-title parent .. rst-class:: ansible-option-type-line aliases: master, master_section .. rst-class:: ansible-option-type-line string	Name of the parent section .. rst-class:: ansible-option-line Default: "None"
.. rst-class:: ansible-option-title password .. rst-class:: ansible-option-type-line string / required	Password of the user to access phpIPAM server
.. rst-class:: ansible-option-title permissions .. rst-class:: ansible-option-type-line json	JSON object that represents the permissions for each user .. rst-class:: ansible-option-line Default: "None"
.. rst-class:: ansible-option-title server_url .. rst-class:: ansible-option-type-line string / required	URL of the phpIPAM server
.. rst-class:: ansible-option-title show_supernets_only .. rst-class:: ansible-option-type-line boolean	Show only supernets in subnet list view .. rst-class:: ansible-option-line Choices: no ← (default) yes
.. rst-class:: ansible-option-title show_vlan .. rst-class:: ansible-option-type-line boolean	Show/hide VLANs in subnet list view .. rst-class:: ansible-option-line Choices: no ← (default) yes
.. rst-class:: ansible-option-title show_vrf .. rst-class:: ansible-option-type-line boolean	Show/hide VRFs in subnet list view .. rst-class:: ansible-option-line Choices: no ← (default) yes
.. rst-class:: ansible-option-title state .. rst-class:: ansible-option-type-line string	State of the entity .. rst-class:: ansible-option-line Choices: present ← (default) absent
.. rst-class:: ansible-option-title strict_mode .. rst-class:: ansible-option-type-line boolean	If set to true, consistency of subnets and IP addresses will be checked .. rst-class:: ansible-option-line Choices: no ← (default) yes
.. rst-class:: ansible-option-title subnet_ordering .. rst-class:: ansible-option-type-line string	How to order subnets within this section .. rst-class:: ansible-option-line Default: "subnet,asc"
.. rst-class:: ansible-option-title username .. rst-class:: ansible-option-type-line string / required	Username to access phpIPAM server
.. rst-class:: ansible-option-title validate_certs .. rst-class:: ansible-option-type-line boolean	Is the TLS certificate of the phpIPAM server verified or not. .. rst-class:: ansible-option-line 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)

Collection links

Issue Tracker Homepage Repository (Sources)