InfluxDB - A distributed time series database
Module to provide InfluxDB compatibility to Salt (compatible with InfluxDB version 0.9+)
depends: |
|
---|---|
configuration: | This module accepts connection configuration details either as parameters or as configuration settings in /etc/salt/minion on the relevant minions: influxdb.host: 'localhost'
influxdb.port: 8086
influxdb.user: 'root'
influxdb.password: 'root'
This data can also be passed into pillar. Options passed into opts will overwrite options passed into pillar. Most functions in this module allow you to override or provide some or all of these settings via keyword arguments: salt '*' influxdb.foo_function user='influxadmin' password='s3cr1t'
would override |
salt.modules.influx.
alter_retention_policy
(database, name, duration, replication, default=False, **client_args)¶Modify an existing retention policy.
New duration of given retention policy.
Durations such as 1h, 90m, 12h, 7d, and 4w, are all supported and mean 1 hour, 90 minutes, 12 hours, 7 day, and 4 weeks, respectively. For infinite retention – meaning the data will never be deleted – use 'INF' for duration. The minimum retention period is 1 hour.
New replication of given retention policy.
This determines how many independent copies of each data point are stored in a cluster.
CLI Example:
salt '*' influxdb.alter_retention_policy metrics default 1d 1
salt.modules.influx.
continuous_query_exists
(database, name, **client_args)¶Check if continuous query with given name exists on the database.
CLI Example:
salt '*' influxdb.continuous_query_exists metrics default
salt.modules.influx.
create_continuous_query
(database, name, query, resample_time=None, coverage_period=None, **client_args)¶Create a continuous query.
CLI Example:
salt '*' influxdb.create_continuous_query mydb cq_month 'SELECT mean(*) INTO mydb.a_month.:MEASUREMENT FROM mydb.a_week./.*/ GROUP BY time(5m), *'
salt.modules.influx.
create_db
(name, **client_args)¶Create a database.
CLI Example:
salt '*' influxdb.create_db <name>
salt.modules.influx.
create_retention_policy
(database, name, duration, replication, default=False, **client_args)¶Create a retention policy.
Duration of the new retention policy.
Durations such as 1h, 90m, 12h, 7d, and 4w, are all supported and mean 1 hour, 90 minutes, 12 hours, 7 day, and 4 weeks, respectively. For infinite retention – meaning the data will never be deleted – use 'INF' for duration. The minimum retention period is 1 hour.
Replication factor of the retention policy.
This determines how many independent copies of each data point are stored in a cluster.
CLI Example:
salt '*' influxdb.create_retention_policy metrics default 1d 1
salt.modules.influx.
create_user
(name, password, admin=False, **client_args)¶Create a user.
CLI Example:
salt '*' influxdb.create_user <name> <password>
salt '*' influxdb.create_user <name> <password> admin=True
salt.modules.influx.
db_exists
(name, **client_args)¶Checks if a database exists in InfluxDB.
CLI Example:
salt '*' influxdb.db_exists <name>
salt.modules.influx.
drop_continuous_query
(database, name, **client_args)¶Drop a continuous query.
CLI Example:
salt '*' influxdb.drop_continuous_query mydb my_cq
salt.modules.influx.
drop_db
(name, **client_args)¶Drop a database.
CLI Example:
salt '*' influxdb.drop_db <name>
salt.modules.influx.
drop_retention_policy
(database, name, **client_args)¶Drop a retention policy.
CLI Example:
salt '*' influxdb.drop_retention_policy mydb mypr
salt.modules.influx.
get_continuous_query
(database, name, **client_args)¶Get an existing continuous query.
CLI Example:
salt '*' influxdb.get_continuous_query mydb cq_month
salt.modules.influx.
get_retention_policy
(database, name, **client_args)¶Get an existing retention policy.
CLI Example:
salt '*' influxdb.get_retention_policy metrics default
salt.modules.influx.
grant_admin_privileges
(name, **client_args)¶Grant cluster administration privileges to a user.
CLI Example:
salt '*' influxdb.grant_admin_privileges <name>
salt.modules.influx.
grant_privilege
(database, privilege, username, **client_args)¶Grant a privilege on a database to a user.
salt.modules.influx.
list_dbs
(**client_args)¶List all InfluxDB databases.
CLI Example:
salt '*' influxdb.list_dbs
salt.modules.influx.
list_privileges
(name, **client_args)¶List privileges from a user.
CLI Example:
salt '*' influxdb.list_privileges <name>
salt.modules.influx.
list_users
(**client_args)¶List all users.
CLI Example:
salt '*' influxdb.list_users
salt.modules.influx.
query
(database, query, **client_args)¶Execute a query.
salt.modules.influx.
remove_user
(name, **client_args)¶Remove a user.
CLI Example:
salt '*' influxdb.remove_user <name>
salt.modules.influx.
retention_policy_exists
(database, name, **client_args)¶Check if retention policy with given name exists.
CLI Example:
salt '*' influxdb.retention_policy_exists metrics default
salt.modules.influx.
revoke_admin_privileges
(name, **client_args)¶Revoke cluster administration privileges from a user.
CLI Example:
salt '*' influxdb.revoke_admin_privileges <name>
salt.modules.influx.
revoke_privilege
(database, privilege, username, **client_args)¶Revoke a privilege on a database from a user.
salt.modules.influx.
set_user_password
(name, password, **client_args)¶Change password of a user.
CLI Example:
salt '*' influxdb.set_user_password <name> <password>
salt.modules.influx.
user_exists
(name, **client_args)¶Check if a user exists.
CLI Example:
salt '*' influxdb.user_exists <name>
salt.modules.influx.
user_info
(name, **client_args)¶Get information about given user.
CLI Example:
salt '*' influxdb.user_info <name>