community.missing_collection.checkly_dashboards_module.rst

community.missing_collection.checkly_dashboards

Management of the checkly Dashboards.

Version added: 0.3.0

• Synopsis
• Requirements
• Parameters
• Examples
• Return Values
• Status

Synopsis

• Management of the checkly Dashboards.
• https://www.checklyhq.com/docs/api#tag/Dashboards

Requirements

The below requirements are needed on the host that executes this module.

• requests

Parameters

Parameter	Choices/Defaults	Comments
api_key string / required		api key for checkly.
command string	Choices: create ← update delete	type of operation on dashboards.
custom_domain string		A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.
custom_url string		A subdomain name under "checklyhq.com". Needs to be unique across all users.
header string	Default: "Managed by Ansible Automation"	A piece of text displayed at the top of your dashboard.
hide_tags boolean	Choices: no ← yes	Show or hide the tags on the dashboard.
id string		id of dashboard. required only for delete and update.
logo string		A URL pointing to an image file. example https://upload.wikimedia.org/wikipedia/en/8/8a/Axway_Software_logo_June_2017.png
paginate boolean	Choices: no yes ←	Determines of pagination is on or off.
pagination_rate integer	Choices: 30 60 ← 300	How often to trigger pagination in seconds.
refresh_rate integer	Choices: 60 ← 300 600	How often to refresh the dashboard in seconds.
tags list	Default: []	A list of one or more tags that filter which checks to display on the dashboard.
url string	Default: "https://api.checklyhq.com/v1/dashboards/"	checkly api.
width string	Choices: FULL ← 960PX	Determines whether to use the full screen or focus in the center.

Examples

- name: create a dashboard
  community.missing_collection.checkly_dashboards:
    api_key: '4a7734debb54464e9fefe8b4f14b896e'
    command: 'create'
    custom_domain: '6605c28f.axway.com'
    custom_url: "6605c28f"
    header: 'Managed by Ansible Automation'
    tags:
      - 'api'
      - 'axway'
    logo: 'https://upload.wikimedia.org/wikipedia/en/8/8a/Axway_Software_logo_June_2017.png'
  register: __

- name: update a dashboard
  community.missing_collection.checkly_dashboards:
    api_key: '4a7734debb54464e9fefe8b4f14b896e'
    command: 'update'
    custom_domain: '6605c28f.axway.com'
    custom_url: "6605c28f"
    header: 'Managed by Ansible Automation'
    tags:
      - 'api'
      - 'axway'
    id: '{{ __.result.dashboardId }}'
    logo: 'https://upload.wikimedia.org/wikipedia/en/8/8a/Axway_Software_logo_June_2017.png'

- name: delete a dashboard
  community.missing_collection.checkly_dashboards:
    api_key: '4a7734debb54464e9fefe8b4f14b896e'
    command: 'delete'
    id: '{{ __.result.dashboardId }}'

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
result dictionary	when command is create/update and success.	result of checkly api. Sample: {'customUrl': 'string', 'customDomain': 'string', 'logo': 'string', 'header': 'string', 'width': 'FULL', 'refreshRate': 60, 'paginate': True, 'paginationRate': 30, 'tags': [], 'hideTags': False, 'dashboardId': 'string'}

Status

Authors

• Davinder Pal (@116davinder) <dpsangwal@gmail.com>