community.general.infinity module – Manage Infinity IPAM using Rest API

Note

This module is part of the community.general collection (version 10.7.5).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.infinity.

Synopsis

  • Manage Infinity IPAM using REST API.

Parameters

Parameter

Comments

action

string / required

Action to perform.

Choices:

  • "add_network"

  • "delete_network"

  • "get_network"

  • "get_network_id"

  • "release_ip"

  • "release_network"

  • "reserve_network"

  • "reserve_next_available_ip"

ip_address

string

IP Address for a reservation or a release.

network_address

string

Network address with CIDR format (for example 192.168.310.0).

network_family

string

Network family defined by Infinity, for example IPv4, IPv6 and Dual stack.

Choices:

  • "4" ← (default)

  • "6"

  • "dual"

network_id

string

Network ID.

network_location

integer

The parent network ID for a given network.

Default: -1

network_name

string

The name of a network.

network_size

string

Network bitmask (for example 255.255.255.220 or CIDR format /26).

network_type

string

Network type defined by Infinity.

Choices:

  • "lan" ← (default)

  • "shared_lan"

  • "supernet"

password

string / required

Infinity password.

server_ip

string / required

Infinity server_ip with IP address.

username

string / required

Username to access Infinity.

The user must have REST API privileges.

Attributes

Attribute

Support

Description

check_mode

Support: none

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Examples

- hosts: localhost
  connection: local
  strategy: debug
  tasks:
    - name: Reserve network into Infinity IPAM
      community.general.infinity:
        server_ip: 80.75.107.12
        username: username
        password: password
        action: reserve_network
        network_name: reserve_new_ansible_network
        network_family: 4
        network_type: lan
        network_id: 1201
        network_size: /28
      register: infinity

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

ip_info

string

When reserve next available IP address from a network, the IP address info is returned.

Please note that the value is a string containing JSON data.

Returned: success

Sample: "{\n  \"address\": \"192.168.10.3\",\n  \"hostname\": \"\",\n  \"FQDN\": \"\",\n  \"domainname\": \"\",\n  \"id\": 3229\n}"

network_id

string

ID for a given network.

Returned: success

Sample: "1501"

network_info

string

When reserving a LAN network from a Infinity supernet by providing network_size, the information about the reserved network is returned.

Please note that the value is a string containing JSON data.

Returned: success

Sample: "{\n  \"network_address\": \"192.168.10.32/28\",\n  \"network_family\": \"4\",\n  \"network_id\": 3102,\n  \"network_size\": null,\n  \"description\": null,\n  \"network_location\": \"3085\",\n  \"ranges\": {\"id\": 0, \"name\": null, \"first_ip\": null, \"type\": null, \"last_ip\": null},\n  \"network_type\": \"lan\",\n  \"network_name\": \"'reserve_new_ansible_network'\"\n}"

Authors

  • Meirong Liu (@MeganLiu)