webcheck
Version information
This version is compatible with:
- Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >= 4.0.0 < 8.0.0
- , , , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'ningyou-webcheck', '0.1.1'
Learn more about managing modules with a PuppetfileDocumentation
Reference
Table of Contents
Classes
webcheck
: Contains the wait_for_connection and wait_for_response resources
Resource types
wait_for_connection
: Waits until a socket is available.wait_for_response
: Waits until a certain response is received.
Classes
webcheck
Contains the wait_for_connection and wait_for_response resources
Resource types
wait_for_connection
Waits until a socket is available.
Properties
The following properties are available in the wait_for_connection
type.
ensure
Valid values: present
, absent
The basic property that the resource should be in.
Default value: present
Parameters
The following parameters are available in the wait_for_connection
type.
host
The DNS name or IP address of the server.
port
The port that the server should be listening on.
provider
The specific backend to use for this wait_for_connection
resource. You will seldom need to specify this --- Puppet
will usually discover the appropriate provider for your platform.
refreshonly
Valid values: true
, false
Only run on refreshs
Default value: false
retry_sleep
The number of seconds to wait betweet each connection attempt.
Default value: 2
timeout
The max. number of seconds to wait for a valid connection.
Default value: 10
wait_for_response
Waits until a certain response is received.
Properties
The following properties are available in the wait_for_response
type.
ensure
Valid values: present
, absent
The basic property that the resource should be in.
Default value: present
Parameters
The following parameters are available in the wait_for_response
type.
expected_json
A hash of key/values the reponse should be checked for.
expected_keywords
A list of keywords the response should be checked for.
Default value: []
expected_status_codes
A list of status codes which a valid response should have.
Default value: [200]
provider
The specific backend to use for this wait_for_response
resource. You will seldom need to specify this --- Puppet will
usually discover the appropriate provider for your platform.
refreshonly
Valid values: true
, false
Only run on refreshs
Default value: false
retry_sleep
The number of seconds to wait betweet each connection attempt.
Default value: 2
timeout
The max. number of seconds to wait for a valid connection.
Default value: 10
uri
The uri to perform a http-get request on.