codeaffen.phpipam.folder (1.7.0) — module

Install collection

Install with ansible-galaxy collection install codeaffen.phpipam:==1.7.0

Add to requirements.yml

  collections:
    - name: codeaffen.phpipam
      version: 1.7.0

Description

create, update and delete folders

Requirements

• inflection
• ipaddress
• phpypam>=1.0.0

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
name:
    description: Name of the folder to manage
    required: false
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description: State of the entity
    type: str

app_id:
    default: ansible
    description: API app name
    required: false
    type: str

parent:
    description: Name of parent folder
    required: false
    type: str

section:
    description: Name of the section under which the folder is located
    required: true
    type: int

password:
    description: Password of the user to access phpIPAM server
    required: true
    type: str

username:
    description: Username to access phpIPAM server
    required: true
    type: str

server_url:
    description: URL of the phpIPAM server
    required: true
    type: str

permissions:
    default: None
    description: JSON object that represent the permissions for each user
    required: false
    type: json

validate_certs:
    default: true
    description: Is the TLS certificate of the phpIPAM server verified or not.
    required: false
    type: bool

Outputs

entity:
  contains:
    folders:
      description: List of folders.
      elements: dict
      type: list
  description: Final state of the affected entities grouped by their type.
  returned: success
  type: dict