community / community.grafana / 1.8.0 / module / grafana_folder Manage Grafana Folders | "added in version" 1.0.0 of community.grafana" Authors: Rémi REY (@rrey)community.grafana.grafana_folder (1.8.0) — module
Install with ansible-galaxy collection install community.grafana:==1.8.0
collections: - name: community.grafana version: 1.8.0
Create/update/delete Grafana Folders through the Folders API.
--- - name: Create a folder community.grafana.grafana_folder: url: "https://grafana.example.com" grafana_api_key: "{{ some_api_token_value }}" title: "grafana_working_group" state: present
- name: Delete a folder community.grafana.grafana_folder: url: "https://grafana.example.com" grafana_api_key: "{{ some_api_token_value }}" title: "grafana_working_group" state: absent
url: aliases: - grafana_url description: - The Grafana URL. required: true type: str name: aliases: - title description: - The title of the Grafana Folder. required: true type: str state: choices: - present - absent default: present description: - Delete the members not found in the C(members) parameters from the - list of members found on the Folder. type: str org_id: default: 1 description: - Grafana organization ID in which the datasource should be created. - Not used when C(grafana_api_key) is set, because the C(grafana_api_key) only belongs to one organization. - Mutually exclusive with C(org_name). type: int org_name: description: - Grafana organization name in which the datasource should be created. - Not used when C(grafana_api_key) is set, because the C(grafana_api_key) only belongs to one organization. - Mutually exclusive with C(org_id). type: str use_proxy: default: true description: - If C(false), it will not use a proxy, even if one is defined in an environment variable on the target hosts. type: bool client_key: description: - PEM formatted file that contains your private key to be used for SSL client authentication. - If I(client_cert) contains both the certificate and key, this option is not required. type: path client_cert: description: - PEM formatted certificate chain file to be used for SSL client authentication. - This file can also include the key as well, and if the key is included, I(client_key) is not required type: path url_password: aliases: - grafana_password default: admin description: - The Grafana password for API authentication. type: str url_username: aliases: - grafana_user default: admin description: - The Grafana user for API authentication. type: str validate_certs: default: true description: - If C(false), SSL certificates will not be validated. - This should only set to C(false) used on personally controlled sites using self-signed certificates. type: bool grafana_api_key: description: - The Grafana API key. - If set, C(url_username) and C(url_password) will be ignored. type: str skip_version_check: default: false description: - Skip Grafana version check and try to reach api endpoint anyway. - This parameter can be useful if you enabled C(hide_version) in grafana.ini required: false type: bool version_added: 1.2.0 version_added_collection: community.grafana
folder: contains: canAdmin: description: Boolean specifying if current user can admin in folder returned: always sample: - false type: bool canEdit: description: Boolean specifying if current user can edit in folder returned: always sample: - false type: bool canSave: description: Boolean specifying if current user can save in folder returned: always sample: - false type: bool created: description: The folder creation date returned: always sample: - '2018-01-31T17:43:12+01:00' type: str createdBy: description: The name of the user who created the folder returned: always sample: - admin type: str hasAcl: description: Boolean specifying if folder has acl returned: always sample: - false type: bool id: description: The Folder identifier returned: always sample: - 42 type: int title: description: The Folder title returned: always sample: - Department ABC type: str uid: description: The Folder uid returned: always sample: - nErXDvCkzz type: str updated: description: The date the folder was last updated returned: always sample: - '2018-01-31T17:43:12+01:00' type: str updatedBy: description: The name of the user who last updated the folder returned: always sample: - admin type: str url: description: The Folder url returned: always sample: - /dashboards/f/nErXDvCkzz/department-abc type: str version: description: The folder version returned: always sample: - 1 type: int description: Information about the Folder returned: On success type: complex