kenmoini.phpipam.first_free_address (1.0.2) — module

Get the first free IP Address in a subnet from phpIPAM

| "added in version" 2.11 of kenmoini.phpipam"

Authors: Ken Moini (@kenmoini)

preview | supported by community

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

Get the first free IP Address in a subnet from phpIPAM

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Get the first free IP Address from a subnet
- name: Find a free IP Address in the target subnet
  kenmoini.phpipam.first_free_address:
    subnet_id: 123
    phpipam_url: https://phpipam.example.com
    phpipam_app_id: 1234567890
    phpipam_app_code: 1234567890
  register: r_first_free_ip

Inputs

    
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

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

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: The first free IP Address in the subnet
  returned: always
  type: object