Resource Type: influxdb_auth

Defined in:
lib/puppet/type/influxdb_auth.rb

Summary

Manages authentication tokens in InfluxDB

Overview

Examples:

influxdb_auth {"telegraf read token":
  ensure        => present,
  org           => 'my_org'
  permissions   => [
    {
      "action"   => "read",
      "resource" => {
        "type"   => "telegrafs"
      }
    },
  ],
}

Properties

  • ensure (defaults to: present)

    Whether the token should be present or absent on the target system.

  • force

    Recreate resource if immutable property changes

  • host

    The host running InfluxDB

  • name

    Name of the token. Note that InfluxDB does not currently have a human readable identifer for token, so for convinience we use the description property as the namevar of this resource

  • org

    The organization that owns the token

  • permissions

    List of permissions granted by the token

  • port (defaults to: 8086)

    Port used by the InfluxDB service

  • status (defaults to: active)

    Status of the token

  • token

    Administrative token used for authenticating API calls

  • token_file

    File on disk containing an administrative token

  • use_ssl (defaults to: true)

    Whether to enable SSL for the InfluxDB service

  • use_system_store

    Whether to use the system store for SSL connections

  • user

    User to scope authorization to