REFERENCE.md

Reference

Table of Contents

Resource types

• http_conn_validator: Verify that a connection can be successfully established between a node and an HTTP server. Its primary use is as a precondition to prevent
• tcp_conn_validator: Verify that a TCP connection can be successfully established between a node and the expected host. Its primary use is as a precondition to p

Resource types

http_conn_validator

Verify that a connection can be successfully established between a node and an HTTP server. Its primary use is as a precondition to prevent configuration changes from being applied if the HTTP server cannot be reached, but it could potentially be used for other purposes such as monitoring.

Properties

The following properties are available in the http_conn_validator 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 http_conn_validator type.

• expected_code
• host
• name
• port
• provider
• test_url
• timeout
• try_sleep
• use_ssl
• verify_peer

expected_code

The HTTP status code that should be expected; defaults to 200.

Default value: 200

host

An array containing DNS names or IP addresses of the host where the expected service should be running.

name

namevar

An arbitrary name used as the identity of the resource.

port

The port that the server should be listening on.

provider

The specific backend to use for this http_conn_validator resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

test_url

URL to use for testing if the HTTP server is up

Default value: /

timeout

The max number of seconds that the validator should wait before giving up and deciding that the service is not running; defaults to 60 seconds.

Default value: 60

try_sleep

The time to sleep in seconds between 'tries'.

Default value: 1

use_ssl

Whether the connection will be attemped using https

Default value: false

verify_peer

Whether to verify the peer credentials, if possible. Verification will not take place if the CA certificate is missing

Default value: true

tcp_conn_validator

Verify that a TCP connection can be successfully established between a node and the expected host. Its primary use is as a precondition to prevent configuration changes from being applied if the host cannot be reached, but it could potentially be used for other purposes such as monitoring.

Properties

The following properties are available in the tcp_conn_validator 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 tcp_conn_validator type.

• host
• name
• port
• provider
• timeout
• try_sleep

host

An array containing DNS names or IP addresses of the host where the expected service should be running.

name

namevar

An arbitrary name used as the identity of the resource.

port

The port that the server should be listening on.

provider

The specific backend to use for this tcp_conn_validator resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

timeout

The max number of seconds that the validator should wait before giving up and deciding that the service is not running; defaults to 60 seconds.

Default value: 60

try_sleep

The time to sleep in seconds between 'tries'.

Default value: 1