Defined Type: sensu::enterprise::dashboard::api

Defined in:
manifests/enterprise/dashboard/api.pp

Summary

Manages the Sensu Enterprise API configuration

Overview

Manages the Sensu Enterprise API configuration

Parameters:

  • host —

    The hostname or IP address of the Sensu API. This is used as the namevar for the underlying resource, so must be unique within the catalog.

  • ensure (Enum['present','absent']) (defaults to: present) —

    Whether the dashboard API should be configured or not

  • base_path (Optional[String]) (defaults to: undef) —

    The base path to the client config file.

  • datacenter (Optional[String]) (defaults to: undef) —

    The datacenter name.

  • port (Optional[Integer]) (defaults to: undef) —

    The port of the Sensu API.

  • ssl (Optional[Boolean]) (defaults to: undef) —

    Whether or not to use the HTTPS protocol.

  • insecure (Optional[Boolean]) (defaults to: undef) —

    Whether or not to accept an insecure SSL certificate.

  • path (Optional[String]) (defaults to: undef) —

    The path of the Sensu API. Leave empty unless your Sensu API is not mounted to /.

  • timeout (Optional[Integer]) (defaults to: undef) —

    The timeout for the Sensu API, in seconds.

  • user (Optional[String]) (defaults to: undef) —

    The username of the Sensu API. Leave empty for no authentication.

  • pass (Optional[String]) (defaults to: undef) —

    The password of the Sensu API. Leave empty for no authentication.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'manifests/enterprise/dashboard/api.pp', line 29

define sensu::enterprise::dashboard::api (
  Enum['present','absent'] $ensure = present,
  Optional[String]  $base_path     = undef,
  Optional[String]  $datacenter    = undef,
  Optional[Integer] $port          = undef,
  Optional[Boolean] $ssl           = undef,
  Optional[Boolean] $insecure      = undef,
  Optional[String]  $path          = undef,
  Optional[Integer] $timeout       = undef,
  Optional[String]  $user          = undef,
  Optional[String]  $pass          = undef,
) {

  include ::sensu::enterprise::dashboard

  sensu_enterprise_dashboard_api_config { $title:
    ensure     => $ensure,
    base_path  => $base_path,
    datacenter => $datacenter,
    port       => $port,
    ssl        => $ssl,
    insecure   => $insecure,
    path       => $path,
    timeout    => $timeout,
    user       => $user,
    pass       => $pass,
  }

}