Resource Type: sensu_api_validator

Defined in:

lib/puppet/type/sensu_api_validator.rb

Providers:

puppet_https

Overview

NOTE This is a private type not intended to be used directly.

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

Examples:

Verify API connectivity to localhost:8080

sensu_api_validator { 'sensu':
  sensu_api_server => 'localhost',
  sensu_api_port    => 8080,
}

Properties

• ensure (defaults to: present)

  The basic property that the resource should be in.

  Supported values:

  • present
  • absent

Parameters

• name (namevar)

  An arbitrary name used as the identity of the resource.

• provider

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

• sensu_api_port (defaults to: 8080)

  The port that the sensu_api server should be listening on.

• sensu_api_server (defaults to: localhost)

  The DNS name or IP address of the server where sensu_api should be running.

• test_url (defaults to: /version)

  URL to use for testing if the Sensu backend is up

• timeout (defaults to: 30)

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

• use_ssl (defaults to: false)

  Whether the connection will be attemped using https