Skip to content

section_module.rst

Latest commit

 

History

History
835 lines (433 loc) · 17 KB

section_module.rst

File metadata and controls

835 lines (433 loc) · 17 KB
orphan:

codeaffen.phpipam.section module -- Manage sections

Note

This module is part of the codeaffen.phpipam collection (version 1.7.1).

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. You need further requirements to be able to use this module, see :ref:`Requirements <ansible_collections.codeaffen.phpipam.section_module_requirements>` for details.

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

.. rst-class:: ansible-version-added

New in codeaffen.phpipam 0.0.1

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

.. tabularcolumns:: \X{1}{3}\X{2}{3}
Parameter Comments 
.. rst-class:: ansible-option-title

app_id

.. ansible-option-type-line::

  :ansible-option-type:`string`

API app name

.. rst-class:: ansible-option-line

:ansible-option-default-bold:`Default:` :ansible-option-default:`"ansible"`

 
.. rst-class:: ansible-option-title

description

.. ansible-option-type-line::

  :ansible-option-type:`string`

Short descriptive text

.. rst-class:: ansible-option-line

:ansible-option-default-bold:`Default:` :ansible-option-default:`"None"`

 
.. rst-class:: ansible-option-title

dns_resolver

.. ansible-option-type-line::

  :ansible-option-type:`string`

The NS resolver to be used for this section

 
.. rst-class:: ansible-option-title

name

.. ansible-option-type-line::

  :ansible-option-type:`string` / :ansible-option-required:`required`

Name of the section

 
.. rst-class:: ansible-option-title

order_by

.. ansible-option-type-line::

  :ansible-option-type:`string`

Specifies the field to use for sorting the returned subnets

.. rst-class:: ansible-option-line

:ansible-option-choices:`Choices:`

 
.. rst-class:: ansible-option-title

order_direction

.. ansible-option-type-line::

  :ansible-option-type:`string`

Determines the sorting direction, either ascending or descending

'asc' sorts from A to Z or from smallest to largest number

'desc' sorts from Z to A or from largest to smallest number

.. rst-class:: ansible-option-line

:ansible-option-choices:`Choices:`

 
.. rst-class:: ansible-option-title

parent

.. ansible-option-type-line::

  :ansible-option-aliases:`aliases: master, master_section`

  :ansible-option-type:`string`

Name of the parent section

.. rst-class:: ansible-option-line

:ansible-option-default-bold:`Default:` :ansible-option-default:`"None"`

 
.. rst-class:: ansible-option-title

password

.. ansible-option-type-line::

  :ansible-option-type:`string` / :ansible-option-required:`required`

Password of the user to access phpIPAM server

 
.. rst-class:: ansible-option-title

permissions

.. ansible-option-type-line::

  :ansible-option-type:`json`

JSON object that represents the permissions for each user

.. rst-class:: ansible-option-line

:ansible-option-default-bold:`Default:` :ansible-option-default:`"None"`

 
.. rst-class:: ansible-option-title

server_url

.. ansible-option-type-line::

  :ansible-option-type:`string` / :ansible-option-required:`required`

URL of the phpIPAM server

 
.. rst-class:: ansible-option-title

show_supernets_only

.. ansible-option-type-line::

  :ansible-option-type:`boolean`


.. rst-class:: ansible-option-title

show_vlan

.. ansible-option-type-line::

  :ansible-option-type:`boolean`


.. rst-class:: ansible-option-title

show_vrf

.. ansible-option-type-line::

  :ansible-option-type:`boolean`


.. rst-class:: ansible-option-title

state

.. ansible-option-type-line::

  :ansible-option-type:`string`


.. rst-class:: ansible-option-title

strict_mode

.. ansible-option-type-line::

  :ansible-option-type:`boolean`


.. rst-class:: ansible-option-title

username

.. ansible-option-type-line::

  :ansible-option-type:`string` / :ansible-option-required:`required`

Username to access phpIPAM server

 
.. rst-class:: ansible-option-title

validate_certs

.. ansible-option-type-line::

  :ansible-option-type:`boolean`

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

.. ansible-links::

  - title: "Issue Tracker"
    url: "https://github.com/codeaffen/phpipam-ansible-modules/issues"
    external: true
  - title: "Homepage"
    url: "https://codeaffen.org/projects/phpipam-ansible-modules"
    external: true
  - title: "Repository (Sources)"
    url: "https://github.com/codeaffen/phpipam-ansible-modules"
    external: true