codeaffen.phpipam.location module – Manage locations
Note
This module is part of the codeaffen.phpipam collection (version 1.7.0).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: codeaffen.phpipam.location
.
New in codeaffen.phpipam 1.4.0
Synopsis
create, update and delete locations
Requirements
The below requirements are needed on the host that executes this module.
geopy
inflection
ipaddress
phpypam>=1.0.0
Parameters
Parameter |
Comments |
---|---|
Address of the given location if resolv_location is set to True, this address will be used to resolve the latitude and longitude Mutually exclusive with latitude and longitude |
|
API app name Default: |
|
Description of the given location |
|
Latitude of the given location if resolv_location is set to True, this latitude will be used to resolve the address This parameter is mutually exclusive with address This parameter is required if longitude is given |
|
Longitude of the given location if resolv_location is set to True, this longitude will be used to resolve the address This parameter is mutually exclusive with address This parameter is required if latitude is given |
|
Name of the given location |
|
Password of the user to access phpIPAM server |
|
Resolve the given location Requires network connectivity to https://nominatim.org/ to resolve the given address If address can not be resolved, latitude and longitude will not be set Choices:
|
|
URL of the phpIPAM server |
|
State of the entity Choices:
|
|
Username to access phpIPAM server |
|
Is the TLS certificate of the phpIPAM server verified or not. Choices:
|
Examples
- name: "Create with address"
codeaffen.phpipam.location:
username: "admin"
password: "s3cr3t"
server_url: "https://ipam.example.com"
name: "my location"
description: "my location description"
address: "my location address"
state: present
- name: "Create location with geo coordinates"
codeaffen.phpipam.location:
username: "admin"
password: "s3cr3t"
server_url: "https://ipam.example.com"
name: "my location"
description: "my location description"
latitude: 123.456
longitude: 123.456
state: present
- name: "Remove location"
codeaffen.phpipam.location:
username: "admin"
password: "s3cr3t"
server_url: "https://ipam.example.com"
name: "my location"
state: absent