community.general.infinity module – Manage Infinity IPAM using Rest API
Note
This module is part of the community.general collection (version 9.5.1).
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 to perform Choices:
|
|
IP Address for a reservation or a release. |
|
Network address with CIDR format (e.g., 192.168.310.0). |
|
Network family defined by Infinity, e.g. IPv4, IPv6 and Dual stack Choices:
|
|
Network ID. |
|
The parent network id for a given network. Default: |
|
The name of a network. |
|
Network bitmask (e.g. 255.255.255.220) or CIDR format (e.g., /26). |
|
Network type defined by Infinity Choices:
|
|
Infinity password. |
|
Infinity server_ip with IP address. |
|
Username to access Infinity. The user must have REST API privileges. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
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 |
---|---|
when reserve next available ip address from a network, the ip address info ) is returned. Returned: success Sample: |
|
id for a given network Returned: success Sample: |
|
when reserving a LAN network from a Infinity supernet by providing network_size, the information about the reserved network is returned. Returned: success Sample: |