kenmoini.phpipam.reserve_address (1.0.2) — module

Install collection

Install with ansible-galaxy collection install kenmoini.phpipam:==1.0.2

Add to requirements.yml

  collections:
    - name: kenmoini.phpipam
      version: 1.0.2

Description

Update an IP address in phpIPAM

Usage examples

Scanned by Steampunk Spotter

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

# Reserve an IP Address
- name: Reserve an IP Address
  kenmoini.phpipam.reserve_address:
    phpipam_url: https://phpipam.example.com
    phpipam_app_id: 1234567890
    phpipam_app_code: 1234567890
    subnet_id: 123
    ip: 1.2.3.4
    hostname: "test-hostname.example.com"
    description: "Test Description"
    tag: "reserved"
  register: r_address

Inputs

    
ip:
    aliases:
    - address
    - ip_address
    description:
    - This is the IP Address you want to reserve
    required: true
    type: str

tag:
    choices:
    - offline
    - used
    - reserved
    - dhcp
    default: reserved
    description:
    - This is the tag you want to assign to the IP Address
    required: false
    type: str

note:
    description:
    - A note about the IP Address
    required: false
    type: str

owner:
    description:
    - The owner of the IP Address
    required: false
    type: str

hostname:
    description:
    - This is the hostname you want to assign to the IP Address
    required: false
    type: str

subnet_id:
    aliases:
    - subnet
    description:
    - This is the ID of the subnet you want to get the first free IP Address from
    required: true
    type: int

is_gateway:
    description:
    - Whether or not the IP Address is a gateway
    required: false
    type: bool

description:
    description:
    - This is the description you want to assign to the IP Address
    required: false
    type: str

phpipam_url:
    description:
    - This is the URL of your phpIPAM instance
    required: true
    type: str

ptr_exclude:
    description:
    - Whether or not to exclude the IP Address from PTR records
    required: false
    type: bool

ping_exclude:
    description:
    - Whether or not to exclude the IP Address from pings
    required: false
    type: bool

phpipam_app_id:
    description:
    - This is the app ID for your phpIPAM instance
    required: true
    type: str

phpipam_app_code:
    description:
    - This is the app code for your phpIPAM instance
    required: true
    type: str

phpipam_skip_tls_verify:
    aliases:
    - skip_tls_verify
    default: false
    description:
    - Whether or not to skip TLS verification
    required: false
    type: bool

Outputs

ip_address:
  description: Details of the IP Address reservation request
  returned: always
  type: object