unixadm.influxdb

 

modules

influxdb_auth - manipulate influxdb authorisations

Synopsis

This module adds or removes an influxdb read/write bucket authorisation

Parameters
Parameter Choices/Defaults Description
api_token
(string)
required
influxdb manager token
api_url
(string)
http://localhost:8086 influxdb api url
bucket
(string)
required
name of the bucket to grant/revoke rw access to/from
organisation
(string)
required
the organisation of the bucket
state
(string)
present
absent
add (present) or remove (absent) authorisation token
user
(string)
required
username
Examples
- name: "create influxdb bucket auth"
  influxdb_bucket:
    api_url: https://server.example:8086
    api_token: yourtokenhere
    user: myeviluser
    bucket: mybucket
    organisation: myorg

- name: "remove influxdb bucket auth"
  influxdb_bucket:
    api_token: yourtokenhere
    user: myeviluser
    bucket: mybucket
    organisation: myorg
    state: absent
Return values
Key Returned Description
_raw Success auth dict

influxdb_bucket - manipulate influxdb bucket

Synopsis

This module adds, updates or deletes an influxdb buckets

Parameters
Parameter Choices/Defaults Description
api_token
(string)
required
influxdb manager token
api_url
(string)
http://localhost:8086 influxdb api url
name
(string)
required
name of the bucket
organisation
(string)
required
the organisation of the bucket
retention
(string)
0 Duration in seconds bucket will retain data, or 0 for infinite
shardgroupduration
(string)
Shard group duration used internally by the storage engine
state
(string)
present
absent
add/update (present) or remove (absent) organisation
Examples
- name: "create influxdb bucket"
  influxdb_bucket:
    api_url: https://server.example:8086
    api_token: yourtokenhere
    name: mybucket
    organisation: myorg

- name: "remove influxdb bucket"
  influxdb_bucket:
    api_token: yourtokenhere
    name: mybucket
    organisation: myorg
    state: absent
Return values
Key Returned Description
_raw Success bucket dict

influxdb_org - manipulate influxdb organisation

Synopsis

This module adds, updates or deletes an influxdb organisation

Parameters
Parameter Choices/Defaults Description
api_token
(string)
required
influxdb manager token
api_url
(string)
http://localhost:8086 influxdb api url
description
(string)
description of the given organisation
name
(string)
required
name of the organisation
state
(string)
present
absent
add/update (present) or remove (absent) organisation
Examples
- name: "create influxdb organisation"
  influxdb_org:
    api_url: https://server.example:8086
    api_token: yourtokenhere
    name: myorganisation
    description: some text here

- name: "remove influxdb organisation"
  influxdb_org:
    api_token: yourtokenhere
    name: myorganisation
    state: absent
Return values
Key Returned Description
_raw Success organisation dict

influxdb_user - manipulate influxdb user

Synopsis

This module adds or deletes an influxdb user

Parameters
Parameter Choices/Defaults Description
api_token
(string)
required
influxdb manager token
api_url
(string)
http://localhost:8086 influxdb api url
name
(string)
required
name of the user
state
(string)
present
absent
add (present) or remove (absent) user
Examples
- name: "create influxdb user"
  influxdb_user:
    api_url: https://server.example:8086
    api_token: yourtokenhere
    organisations:
      - myorg
      - anotherorg
    name: myuser

- name: "remove influxdb use"
  influxdb_user:
    api_token: yourtokenhere
    name: myuser
    state: absent
Return values
Key Returned Description
_raw Success user dict