codeaffen.phpipam.section (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 sections

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 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

Scanned by Steampunk Spotter

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

- 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

Inputs

    
name:
    description: Name of the section
    required: true
    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:
    aliases:
    - master
    - master_section
    default: None
    description: Name of the parent section
    required: false
    type: str

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

show_vrf:
    default: false
    description: Show/hide VRFs in subnet list view
    required: false
    type: bool

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

show_vlan:
    default: false
    description: Show/hide VLANs in subnet list view
    required: false
    type: bool

list_order:
    description: Order in sections list view
    required: false
    type: int

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

description:
    default: None
    description: Short descriptive text
    required: false
    type: str

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

strict_mode:
    default: false
    description: If set to true, consistency of subnets and IP addresses will be checked
    required: false
    type: bool

dns_resolver:
    description: The NS resolver to be used for this section
    required: false
    type: str

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

subnet_ordering:
    default: subnet,asc
    description: How to order subnets within this section
    required: false
    type: str

show_supernets_only:
    default: false
    description: Show only supernets in subnet list view
    required: false
    type: bool