community.general.influxdb_retention_policy (1.3.14) — module

Install collection

Install with ansible-galaxy collection install community.general:==1.3.14

Add to requirements.yml

  collections:
    - name: community.general
      version: 1.3.14

Description

Manage InfluxDB retention policies.

Requirements

• python >= 2.6
• influxdb >= 0.9
• requests

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Example influxdb_retention_policy command from Ansible Playbooks
- name: Create 1 hour retention policy
  community.general.influxdb_retention_policy:
      hostname: "{{influxdb_ip_address}}"
      database_name: "{{influxdb_database_name}}"
      policy_name: test
      duration: 1h
      replication: 1
      ssl: yes
      validate_certs: yes

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create 1 day retention policy
  community.general.influxdb_retention_policy:
      hostname: "{{influxdb_ip_address}}"
      database_name: "{{influxdb_database_name}}"
      policy_name: test
      duration: 1d
      replication: 1

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create 1 week retention policy
  community.general.influxdb_retention_policy:
      hostname: "{{influxdb_ip_address}}"
      database_name: "{{influxdb_database_name}}"
      policy_name: test
      duration: 1w
      replication: 1

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create infinite retention policy
  community.general.influxdb_retention_policy:
      hostname: "{{influxdb_ip_address}}"
      database_name: "{{influxdb_database_name}}"
      policy_name: test
      duration: INF
      replication: 1
      ssl: no
      validate_certs: no

Inputs

    
ssl:
    default: false
    description:
    - Use https instead of http to connect to InfluxDB server.
    type: bool

path:
    description:
    - The path on which InfluxDB server is accessible
    - Only available when using python-influxdb >= 5.1.0
    type: str
    version_added: 0.2.0
    version_added_collection: community.general

port:
    default: 8086
    description:
    - The port on which InfluxDB server is listening
    type: int

default:
    default: false
    description:
    - Sets the retention policy as default retention policy.
    type: bool

proxies:
    description:
    - HTTP(S) proxy to use for Requests to connect to InfluxDB server.
    type: dict

retries:
    default: 3
    description:
    - Number of retries client will try before aborting.
    - C(0) indicates try until success.
    - Only available when using python-influxdb >= 4.1.0
    type: int

timeout:
    description:
    - Number of seconds Requests will wait for client to establish a connection.
    type: int

use_udp:
    default: false
    description:
    - Use UDP to connect to InfluxDB server.
    type: bool

duration:
    description:
    - Determines how long InfluxDB should keep the data.
    required: true
    type: str

hostname:
    default: localhost
    description:
    - The hostname or IP address on which InfluxDB server is listening.
    - Since Ansible 2.5, defaulted to localhost.
    type: str

password:
    aliases:
    - login_password
    default: root
    description:
    - Password that will be used to authenticate against InfluxDB server.
    - Alias C(login_password) added in Ansible 2.5.
    type: str

udp_port:
    default: 4444
    description:
    - UDP port to connect to InfluxDB server.
    type: int

username:
    aliases:
    - login_username
    default: root
    description:
    - Username that will be used to authenticate against InfluxDB server.
    - Alias C(login_username) added in Ansible 2.5.
    type: str

policy_name:
    description:
    - Name of the retention policy.
    required: true
    type: str

replication:
    description:
    - Determines how many independent copies of each point are stored in the cluster.
    required: true
    type: int

database_name:
    description:
    - Name of the database.
    required: true
    type: str

validate_certs:
    default: true
    description:
    - If set to C(no), the SSL certificates will not be validated.
    - This should only set to C(no) used on personally controlled sites using self-signed
      certificates.
    type: bool