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 for details.
To use it in a playbook, specify: codeaffen.phpipam.folder
.
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
Parameter |
Comments |
---|---|
API app name Default: |
|
Name of the folder to manage |
|
Name of parent folder |
|
Password of the user to access phpIPAM server |
|
JSON object that represent the permissions for each user Default: |
|
Name of the section under which the folder is located |
|
URL of the phpIPAM server |
|
State of the entity Choices:
|
|
Username to access phpIPAM server |
|
Is the TLS certificate of the phpIPAM server verified or not. Choices:
|
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, the following are the fields unique to this module:
Key |
Description |
---|---|
Final state of the affected entities grouped by their type. Returned: success |
|
List of folders. Returned: success |