kalenpeterson.orion_ipam.orion_ipam_record (1.1.3) — module

Install collection

Install with ansible-galaxy collection install kalenpeterson.orion_ipam:==1.1.3

Add to requirements.yml

  collections:
    - name: kalenpeterson.orion_ipam
      version: 1.1.3

Description

This module currently only supported requesting new IP Addresses in a given subnet

Requirements

• orionsdk>=0.3.0
• requests>=2.28,<3.0
• ping3>=4.0,<5.0

Usage examples

Scanned by Steampunk Spotter

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

# Get the next available IP Address in 10.0.0.0/24
- name: Get Next IP
  orion_ipam_record:
    subnet: '10.0.0.0 /24'
    orion_server: 'orion.server.com'
    orion_username: 'orionapiuser'
    orion_password: 'orionapipass'

Scanned by Steampunk Spotter

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

# Get the next available IP Address in 10.0.0.0/24, with optional args
- name: Get Next IP
  orion_ipam_record:
    subnet: '10.0.0.0 /24'
    orion_server: 'orion.server.com'
    orion_username: 'orionapiuser'
    orion_password: 'orionapipass'
    new_ip_status: 'Transient'
    new_ip_comment: 'Changed by Script'
    ping_test: false
    retry_limit: 1

Inputs

    
subnet:
    description:
    - This is the subnet to request an address from
    required: true

ping_test:
    default: true
    description:
    - Option to perform a ping test before returning the IP
    required: false

retry_limit:
    default: 5
    description:
    - Number of times to validate an IP from Orion before failing
    required: false

orion_server:
    description:
    - The Orion Server's hostname
    required: true

new_ip_status:
    default: Used
    description:
    - The IPAM Record Status to set for the provisioned IP
    - '"Used", "Available", "Reserved", "Transient", "Blocked"'
    required: false

new_ip_comment:
    default: Updated by Ansible
    description:
    - The IPAM Record Comment to set for the provisioned IP
    required: false

orion_password:
    description:
    - The Orion Server's password
    required: true

orion_username:
    description:
    - The Orion Server's username
    required: true

Outputs

ip_address:
  description: The returned IP Address
  returned: always
  type: str