Skip to content

Latest commit

 

History

History
337 lines (303 loc) · 12.6 KB

community.missing_collection.statuscake_pagespeed_module.rst

File metadata and controls

337 lines (303 loc) · 12.6 KB

community.missing_collection.statuscake_pagespeed

Management of the Status Cake (Pagespeed).

Version added: 0.3.0

Synopsis

Requirements

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

  • requests

Parameters

Parameter Choices/Defaults Comments
alert_bigger
integer
Default:
0
An alert will be sent if the size of the page is larger than this value (kb).
A value of 0 prevents alerts being sent.
alert_slower
integer
Default:
0
An alert will be sent if the load time of the page exceeds this value (ms).
A value of 0 prevents alerts being sent.
alert_smaller
integer
Default:
0
An alert will be sent if the size of the page is smaller than this value (kb).
A value of 0 prevents alerts being sent.
api_key
string / required
api key for statuscake.
check_rate
integer
Default:
5
Number of minutes between tests
command
string
    Choices:
  • create ←
  • update
  • delete
type of operation on pagespeed.
contact_groups_csv
string
Default:
""
Comma separated list of contact group IDs.
id
string
id of pagespeed test.
required only for `delete` and `update`.
location_iso
string
Testing location
Enum "AU" "CA" "DE" "IN" "NL" "SG" "UK" "US" "PRIVATE".
name
string
name of the pagespeed test.
required only for `create` and `update`.
paused
boolean
    Choices:
  • no ←
  • yes
Whether the test should be run.
url
string
Default:
statuscake pagespeed api.
website_url
string
URL or IP address of the website under test.
{'example': 'https://www.google.com'}
required only for `create` and `update`.

Examples

- name: create pagespeed test
  community.missing_collection.statuscake_pagespeed:
    api_key: 'Ohxxxxxxxxxxxxxxxxpi'
    command: 'create'
    website_url: 'https://www.google.com'
    location_iso: 'US'
    name: 'google_test'
  register: __id

- name: rename pagespeed test
  community.missing_collection.statuscake_pagespeed:
    api_key: 'Ohxxxxxxxxxxxxxxxxpi'
    command: 'update'
    id: '{{ __id.id }}'
    name: 'google_test_new'

- name: delete pagespeed test
  community.missing_collection.statuscake_pagespeed:
    api_key: 'Ohxxxxxxxxxxxxxxxxpi'
    command: 'delete'
    id: '{{ __id.id }}'

Return Values

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

Key Returned Description
id
string
when command is `create` and success.
id of pagespeed test.

Sample:
88175


Status

Authors