Documentation

boundary_meter - Manage boundary meters

New in version 1.3.

Synopsis

  • This module manages boundary meters

Requirements (on host that executes module)

  • Boundary API access
  • bprobe is required to send data, but not to register a meter

Options

parameter required default choices comments
apiid
yes
Organizations boundary API ID
apikey
yes
Organizations boundary API KEY
name
yes
meter name
state
no True
  • present
  • absent
Whether to create or remove the client from boundary
validate_certs
(added in 1.5.1)
no yes
  • yes
  • no
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Examples

- name: Create meter
  boundary_meter:
    apiid: AAAAAA
    apikey: BBBBBB
    state: present
    name: '{{ inventory_hostname }}'

- name: Delete meter
  boundary_meter:
    apiid: AAAAAA
    apikey: BBBBBB
    state: absent
    name: '{{ inventory_hostname }}'

Notes

Note

  • This module does not yet support boundary tags.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.