folder_module.rst

orphan

codeaffen.phpipam.folder module -- Manage folders

Note

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

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 Requirements <ansible_collections.codeaffen.phpipam.folder_module_requirements> for details.

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

ansible-version-added

New in codeaffen.phpipam 1.7.0

Synopsis

• create, update and delete folders

Requirements

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

• inflection
• ipaddress
• phpypam>=1.0.0

Parameters

X{1}{3}X{2}{3}

Parameter	Comments
ansible-option-title app_id string	API app name ansible-option-line Default: "ansible"
ansible-option-title name string	Name of the folder to manage
ansible-option-title parent string	Name of parent folder
ansible-option-title password string / required	Password of the user to access phpIPAM server
ansible-option-title permissions json	JSON object that represent the permissions for each user ansible-option-line Default: "None"
ansible-option-title section integer / required	Name of the section under which the folder is located
ansible-option-title server_url string / required	URL of the phpIPAM server
ansible-option-title state string	State of the entity ansible-option-line Choices: "present" ← (default) "absent"
ansible-option-title username string / required	Username to access phpIPAM server
ansible-option-title validate_certs boolean	Is the TLS certificate of the phpIPAM server verified or not. ansible-option-line Choices: false true ← (default)

Notes

Note

- This module needs a phpIPAM backend with version 1.4.1 or highter.

Examples

- name: "Create a folder"
  codeaffen.phpipam.folder:
    username: "admin"
    password: "s3cr3t"
    server_url: "https://ipam.example.com"
    name: "Example folder"
    section: "EXAMPLE INC"
    state: present

- name: "Create a folder with parent"
  codeaffen.phpipam.folder:
    username: "admin"
    password: "s3cr3t"
    server_url: "https://ipam.example.com"
    folder: "Example sub folder"
    parent: "Example folder"
    section: "DEVOPS department"
    state: present

Return Values

Common return values are documented here <common_return_values>, the following are the fields unique to this module:

X{1}{3}X{2}{3}

Key	Description
ansible-option-title entity dictionary	Final state of the affected entities grouped by their type. ansible-option-line Returned: success
ansible-option-title folders list / elements=dictionary	List of folders. ansible-option-line Returned: success

Authors

• Christian Meißner (@cmeissner)

Collection 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