location_module.rst

orphan:

codeaffen.phpipam.location module -- Manage locations

Note

This module is part of the codeaffen.phpipam collection (version 1.6.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.location.

.. versionadded:: 1.4.0 of codeaffen.phpipam

• Synopsis
• Requirements
• Parameters
• Examples

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

.. rst-class:: ansible-option-table

Parameter	Comments
.. rst-class:: ansible-option-title address .. rst-class:: ansible-option-type-line string	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
.. rst-class:: ansible-option-title app_id .. rst-class:: ansible-option-type-line string	API app name .. rst-class:: ansible-option-line Default: "ansible"
.. rst-class:: ansible-option-title description .. rst-class:: ansible-option-type-line string	Description of the given location
.. rst-class:: ansible-option-title latitude .. rst-class:: ansible-option-type-line float	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
.. rst-class:: ansible-option-title longitude .. rst-class:: ansible-option-type-line float	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
.. rst-class:: ansible-option-title name .. rst-class:: ansible-option-type-line string / required	Name of the given location
.. rst-class:: ansible-option-title password .. rst-class:: ansible-option-type-line string / required	Password of the user to access phpIPAM server
.. rst-class:: ansible-option-title resolv_location .. rst-class:: ansible-option-type-line boolean	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 .. rst-class:: ansible-option-line Choices: no ← (default) yes
.. rst-class:: ansible-option-title server_url .. rst-class:: ansible-option-type-line string / required	URL of the phpIPAM server
.. rst-class:: ansible-option-title state .. rst-class:: ansible-option-type-line string	State of the entity .. rst-class:: ansible-option-line Choices: present ← (default) absent
.. rst-class:: ansible-option-title username .. rst-class:: ansible-option-type-line string / required	Username to access phpIPAM server
.. rst-class:: ansible-option-title validate_certs .. rst-class:: ansible-option-type-line boolean	Is the TLS certificate of the phpIPAM server verified or not. .. rst-class:: ansible-option-line Choices: no yes ← (default)

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

Authors

• Christian Meißner (@cmeissner)

Collection links

Issue Tracker Homepage Repository (Sources)