community.missing_collection.checkly_mw_module.rst

community.missing_collection.checkly_mw

Management of the checkly maintenance windows.

Version added: 0.3.0

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

Synopsis

• Management of the checkly maintenance windows.
• https://www.checklyhq.com/docs/api#tag/Environment-variables

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 maintenance windows.
ends_at string		The end date of the maintenance window. example 2021-09-07T14:30:00.000Z or 2021-09-07
id string		id of maintenance window.
name string		The maintenance window name.
repeat_ends_at string		The end date where the maintenance window should stop repeating. example 2021-09-07T14:30:00.000Z or 2021-09-07
repeat_interval string		The repeat interval of the maintenance window from the first occurance. any number >=1.
repeat_unit string	Choices: DAY WEEK MONTH	The repeat strategy for the maintenance window.
start_at string		The start date of the maintenance window. example 2021-09-07T14:30:00.000Z or 2021-09-07
tags list	Default: []	The names of the checks and groups maintenance window should apply to.
url string	Default: "https://api.checklyhq.com/v1/maintenance-windows/"	checkly api.

Examples

- name: create maintenance window
  community.missing_collection.checkly_mw:
    api_key: 'f7b0813b3428419d8b9c5ebb86fcca52'
    command: 'create'
    name: 'testMW'
    ends_at: "2021-09-07"
    start_at: "2021-09-06"
    repeat_unit: "DAY"
    repeat_ends_at: "2021-09-24"
    repeat_interval: "1"
    tags:
      - 'api'
  register: __

- name: update maintenance window
  community.missing_collection.checkly_mw:
    api_key: 'f7b0813b3428419d8b9c5ebb86fcca52'
    command: 'update'
    id: "{{ __.result.id }}"
    name: 'testNewMW'
    ends_at: "2021-09-07"
    start_at: "2021-09-06"
    repeat_unit: "DAY"
    repeat_ends_at: "2021-09-28"
    repeat_interval: "2"
    tags:
      - 'api'
      - 'axway'

- name: delete maintenance window
  community.missing_collection.checkly_mw:
    api_key: 'f7b0813b3428419d8b9c5ebb86fcca52'
    command: 'delete'
    id: "{{ __.result.id }}"

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: {'name': 'string', 'tags': ['string'], 'startsAt': '2019-08-24', 'endsAt': '2019-08-24', 'repeatInterval': 1, 'repeatUnit': 'string', 'repeatEndsAt': '2019-08-24'}

Status

Authors

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