unixadm.influxdb

Jenkins related plugins

Repository

https://git.unixadm.org/phil/ansible-collection-influxdb

Plugins

module

influxdb_auth - manipulate influxdb authorisations

Synopsis

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

Parameters
Parameter Choices/Defaults Description
api_token
(str)
required		 influxdb manager token
api_url
(str)		 http://localhost:8086 influxdb api url
bucket
(str)
required		 name of the bucket to grant/revoke rw access to/from
organisation
(str)
required		 the organisation of the bucket
state
(str)		 present
absent		 add (present) or remove (absent) authorisation token
user
(str)
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
(str)		 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
(str)
required		 influxdb manager token
api_url
(str)		 http://localhost:8086 influxdb api url
name
(str)
required		 name of the bucket
organisation
(str)
required		 the organisation of the bucket
retention
(str)		 0 Duration in seconds bucket will retain data, or 0 for infinite
shardgroupduration
(str)		 604800 Shard group duration used internally by the storage engine
state
(str)		 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
(str)		 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
(str)
required		 influxdb manager token
api_url
(str)		 http://localhost:8086 influxdb api url
description
(str)		 description of the given organisation
name
(str)
required		 name of the organisation
state
(str)		 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
(str)		 Success organisation dict

influxdb_user - manipulate influxdb user

Synopsis

This module adds or deletes an influxdb user

Parameters
Parameter Choices/Defaults Description
api_token
(str)
required		 influxdb manager token
api_url
(str)		 http://localhost:8086 influxdb api url
name
(str)
required		 name of the user
state
(str)		 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
(str)		 Success user dict

filter

lookup

inventory

test

Authors

  • Philippe Kueck <projects at unixadm dot org>

Licenses

GPL-2.0-only