codeaffen.phpipam.subnet – Manage subnets¶
Note
This plugin is part of the codeaffen.phpipam collection (version 1.5.0).
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 codeaffen.phpipam
.
To use it in a playbook, specify: codeaffen.phpipam.subnet
.
New in version 0.0.1: of codeaffen.phpipam
Synopsis¶
create, update and delete subnets
Requirements¶
The below requirements are needed on the host that executes this module.
inflection
ipaddress
phpypam>=1.0.0
Parameters¶
Examples¶
- name: "Create a subnet"
codeaffen.phpipam.subnet:
username: "admin"
password: "s3cr3t"
server_url: "https://ipam.example.com"
cidr: "192.0.2.128/26"
section: "EXAMPLE INC"
state: present
- name: "Create a subnet with parent"
codeaffen.phpipam.subnet:
username: "admin"
password: "s3cr3t"
server_url: "https://ipam.example.com"
cidr: "192.0.2.128/28"
parent: "192.0.2.128/25"
section: "DEVOPS department"
state: present
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
entity
dictionary
|
success |
Final state of the affected entities grouped by their type.
|
|
subnets
list
/ elements=dictionary
|
success |
List of subnets.
|