codeaffen.phpipam.address (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 addresses

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: "Reserve an IP address"
  codeaffen.phpipam.address:
    username: "admin"
    password: "s3cr3t"
    server_url: "https://ipam.example.com"
    address: "192.0.2.1"
    section: "Customers"
    description: "Default router of sunet"
    subnet: "192.0.2.0/24"
    is_gateway: yes
    state: present

Scanned by Steampunk Spotter

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

- name: "Remove address reservation"
  codeaffen.phpipam.address:
    username: "admin"
    password: "s3cr3t"
    server_url: "https://ipam.example.com"
    address: "192.0.2.1"
    subnet: "192.0.2.0/24"
    section: "Customers"
    state: absent

Inputs

    
ptr:
    description: DNS PTR record
    required: false
    type: str

tag:
    description: IP tag (online, offline, ...)
    required: false
    type: str

note:
    description: Note
    required: false
    type: str

port:
    description: Port
    required: false
    type: str

owner:
    description: Address owner
    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

device:
    description: Device address belongs to
    required: false
    type: str

subnet:
    description: subnet address belongs to
    required: true
    type: str

section:
    description: name of the section the given subnet belongs to
    required: true
    type: str
    version_added: 1.3.1
    version_added_collection: codeaffen.phpipam

hostname:
    description: Address hostname
    required: false
    type: str

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

ipaddress:
    aliases:
    - ip
    - address
    description: IP address to hanle
    required: true
    type: str

ignore_ptr:
    default: false
    description: Controls if PTR should not be created
    required: false
    type: bool

is_gateway:
    default: false
    description: Defines if address is presented as gateway
    required: false
    type: bool

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

description:
    description: Address description
    required: false
    type: str

mac_address:
    aliases:
    - mac
    description: Mac address
    required: false
    type: str

exclude_ping:
    description: Exclude this address from status update scans
    required: false
    type: bool

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