-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* #45 Added Modules for Checkly API * typo fixed * added modules for checkly alert channels * * added more module for checkly * typo fix * * added checkly snippets API modules * added new info module for maintenance window * remove extra variables * added maintenance window module * * added new infor module for dashboards * update info module to return `result` as output keyword * * added dashboard module * update return keyword to `result` * added check group info module * added info module about checks * ansible lint * lin fix * added checks api module * lint fix * * added check groups module * minor fixes to tags * remove extra task
- Loading branch information
1 parent
bb7872a
commit f2ab261
Showing
70 changed files
with
9,403 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
132 changes: 132 additions & 0 deletions
132
docs/community.missing_collection.checkly_account_info_module.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| .. _community.missing_collection.checkly_account_info_module: | ||
|
|
||
|
|
||
| ************************************************* | ||
| community.missing_collection.checkly_account_info | ||
| ************************************************* | ||
|
|
||
| **Get information from checkly about Account.** | ||
|
|
||
|
|
||
| Version added: 0.3.0 | ||
|
|
||
| .. contents:: | ||
| :local: | ||
| :depth: 1 | ||
|
|
||
|
|
||
| Synopsis | ||
| -------- | ||
| - Get information from checkly about Account. | ||
| - https://www.checklyhq.com/docs/api#tag/Account | ||
|
|
||
|
|
||
|
|
||
| Requirements | ||
| ------------ | ||
| The below requirements are needed on the host that executes this module. | ||
|
|
||
| - requests | ||
|
|
||
|
|
||
| Parameters | ||
| ---------- | ||
|
|
||
| .. raw:: html | ||
|
|
||
| <table border=0 cellpadding=0 class="documentation-table"> | ||
| <tr> | ||
| <th colspan="1">Parameter</th> | ||
| <th>Choices/<font color="blue">Defaults</font></th> | ||
| <th width="100%">Comments</th> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1"> | ||
| <div class="ansibleOptionAnchor" id="parameter-"></div> | ||
| <b>api_key</b> | ||
| <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> | ||
| <div style="font-size: small"> | ||
| <span style="color: purple">string</span> | ||
| / <span style="color: red">required</span> | ||
| </div> | ||
| </td> | ||
| <td> | ||
| </td> | ||
| <td> | ||
| <div>api key for checkly.</div> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1"> | ||
| <div class="ansibleOptionAnchor" id="parameter-"></div> | ||
| <b>url</b> | ||
| <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> | ||
| <div style="font-size: small"> | ||
| <span style="color: purple">string</span> | ||
| </div> | ||
| </td> | ||
| <td> | ||
| <b>Default:</b><br/><div style="color: blue">"https://api.checklyhq.com/v1/account"</div> | ||
| </td> | ||
| <td> | ||
| <div>checkly api.</div> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
| <br/> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| Examples | ||
| -------- | ||
|
|
||
| .. code-block:: yaml | ||
| - name: get details about account | ||
| community.missing_collection.checkly_account_info: | ||
| api_key: 'sGxxxxxxxxxxxx6y' | ||
| Return Values | ||
| ------------- | ||
| Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module: | ||
|
|
||
| .. raw:: html | ||
|
|
||
| <table border=0 cellpadding=0 class="documentation-table"> | ||
| <tr> | ||
| <th colspan="1">Key</th> | ||
| <th>Returned</th> | ||
| <th width="100%">Description</th> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1"> | ||
| <div class="ansibleOptionAnchor" id="return-"></div> | ||
| <b>result</b> | ||
| <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> | ||
| <div style="font-size: small"> | ||
| <span style="color: purple">dictionary</span> | ||
| </div> | ||
| </td> | ||
| <td>when success.</td> | ||
| <td> | ||
| <div>result of the api.</div> | ||
| <br/> | ||
| <div style="font-size: smaller"><b>Sample:</b></div> | ||
| <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">{'accountId': 'string', 'name': 'string'}</div> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
| <br/><br/> | ||
|
|
||
|
|
||
| Status | ||
| ------ | ||
|
|
||
|
|
||
| Authors | ||
| ~~~~~~~ | ||
|
|
||
| - Davinder Pal (@116davinder) <dpsangwal@gmail.com> |
184 changes: 184 additions & 0 deletions
184
docs/community.missing_collection.checkly_alert_channels_info_module.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,184 @@ | ||
| .. _community.missing_collection.checkly_alert_channels_info_module: | ||
|
|
||
|
|
||
| ******************************************************** | ||
| community.missing_collection.checkly_alert_channels_info | ||
| ******************************************************** | ||
|
|
||
| **Get information about checkly Alert Channels.** | ||
|
|
||
|
|
||
| Version added: 0.3.0 | ||
|
|
||
| .. contents:: | ||
| :local: | ||
| :depth: 1 | ||
|
|
||
|
|
||
| Synopsis | ||
| -------- | ||
| - Get information about checkly Alert Channels. | ||
| - https://www.checklyhq.com/docs/api#tag/Alert-channels | ||
|
|
||
|
|
||
|
|
||
| Requirements | ||
| ------------ | ||
| The below requirements are needed on the host that executes this module. | ||
|
|
||
| - requests | ||
|
|
||
|
|
||
| Parameters | ||
| ---------- | ||
|
|
||
| .. raw:: html | ||
|
|
||
| <table border=0 cellpadding=0 class="documentation-table"> | ||
| <tr> | ||
| <th colspan="1">Parameter</th> | ||
| <th>Choices/<font color="blue">Defaults</font></th> | ||
| <th width="100%">Comments</th> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1"> | ||
| <div class="ansibleOptionAnchor" id="parameter-"></div> | ||
| <b>api_key</b> | ||
| <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> | ||
| <div style="font-size: small"> | ||
| <span style="color: purple">string</span> | ||
| / <span style="color: red">required</span> | ||
| </div> | ||
| </td> | ||
| <td> | ||
| </td> | ||
| <td> | ||
| <div>api key for checkly.</div> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1"> | ||
| <div class="ansibleOptionAnchor" id="parameter-"></div> | ||
| <b>id</b> | ||
| <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> | ||
| <div style="font-size: small"> | ||
| <span style="color: purple">string</span> | ||
| </div> | ||
| </td> | ||
| <td> | ||
| </td> | ||
| <td> | ||
| <div>id of alert channel.</div> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1"> | ||
| <div class="ansibleOptionAnchor" id="parameter-"></div> | ||
| <b>limit</b> | ||
| <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> | ||
| <div style="font-size: small"> | ||
| <span style="color: purple">integer</span> | ||
| </div> | ||
| </td> | ||
| <td> | ||
| <b>Default:</b><br/><div style="color: blue">100</div> | ||
| </td> | ||
| <td> | ||
| <div>number of alert channels retrieved in one call.</div> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1"> | ||
| <div class="ansibleOptionAnchor" id="parameter-"></div> | ||
| <b>page</b> | ||
| <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> | ||
| <div style="font-size: small"> | ||
| <span style="color: purple">integer</span> | ||
| </div> | ||
| </td> | ||
| <td> | ||
| <b>Default:</b><br/><div style="color: blue">1</div> | ||
| </td> | ||
| <td> | ||
| <div>page number of alert channels retrieve call.</div> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1"> | ||
| <div class="ansibleOptionAnchor" id="parameter-"></div> | ||
| <b>url</b> | ||
| <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> | ||
| <div style="font-size: small"> | ||
| <span style="color: purple">string</span> | ||
| </div> | ||
| </td> | ||
| <td> | ||
| <b>Default:</b><br/><div style="color: blue">"https://api.checklyhq.com/v1/alert-channels/"</div> | ||
| </td> | ||
| <td> | ||
| <div>checkly alert channels api.</div> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
| <br/> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| Examples | ||
| -------- | ||
|
|
||
| .. code-block:: yaml | ||
| - name: get all alert channels from checkly | ||
| community.missing_collection.checkly_alert_channels_info: | ||
| api_key: 'a8f08873c494445ba156e572e1324300' | ||
| - name: get one alert channel from checkly | ||
| community.missing_collection.checkly_alert_channels_info: | ||
| api_key: 'a8f08873c494445ba156e572e1324300' | ||
| id: 39308 | ||
| Return Values | ||
| ------------- | ||
| Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module: | ||
|
|
||
| .. raw:: html | ||
|
|
||
| <table border=0 cellpadding=0 class="documentation-table"> | ||
| <tr> | ||
| <th colspan="1">Key</th> | ||
| <th>Returned</th> | ||
| <th width="100%">Description</th> | ||
| </tr> | ||
| <tr> | ||
| <td colspan="1"> | ||
| <div class="ansibleOptionAnchor" id="return-"></div> | ||
| <b>result</b> | ||
| <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> | ||
| <div style="font-size: small"> | ||
| <span style="color: purple">list/dict</span> | ||
| </div> | ||
| </td> | ||
| <td>when success.</td> | ||
| <td> | ||
| <div>result of checkly api.</div> | ||
| <br/> | ||
| <div style="font-size: smaller"><b>Sample:</b></div> | ||
| <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">[{'id': 0, 'type': 'string', 'config': {}, 'subscriptions': [], 'sendRecovery': True, 'sendFailure': True, 'sendDegraded': True, 'sslExpiry': False, 'sslExpiryThreshold': 30, 'created_at': '2019-08-24T14:15:22Z', 'updated_at': '2019-08-24T14:15:22Z'}]</div> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
| <br/><br/> | ||
|
|
||
|
|
||
| Status | ||
| ------ | ||
|
|
||
|
|
||
| Authors | ||
| ~~~~~~~ | ||
|
|
||
| - Davinder Pal (@116davinder) <dpsangwal@gmail.com> |
Oops, something went wrong.