Puppet Class: te_agent

Inherited by:
te_agent::config
te_agent::install
te_agent::service
Defined in:
manifests/init.pp

Summary

The te_agent class installs, configures, and manages the services of the Tripwire Enterprise Agent.

Overview

Main class. Contains all private classes.

Examples:

Minimum required parameters

class { 'te_agent':
  package_source         => '/mnt/share/tripwire/te_agent.bin',
  te_server_host         => 'teconsole.example.com',
  te_services_passphrase => 'correct horse battery staple',
}

Custom tag sets

class { 'te_agent':
  ...
  tags => {
    'tagset_1' => 'tag1',
    'tagset_2' => ['tag2a', 'tag2b'],
  },
}

Parameters:

  • package_manage (Boolean) —

    Whether to manage the TE Agent package. Default: true

  • package_ensure (String) —

    Whether to install the TE Agent package. Default: installed

  • package_install_path (String) —

    Path to install the TE Agent package. Default: /usr/local/tripwire/te/agent or C:\Program Files\Tripwire\TE\Agent, depending on OS

  • package_source (String) —

    The path to te_agent.bin or te_agent.msi. Must be a path on the local filesystem for te_agent.bin. Required.

  • package_name (String) —

    The name of the TE Agent package. Default: varies by operating system

  • package_provider (Optional[String]) —

    Which package provider to use to manage the TE Agent package. Default: varies by operating system

  • te_server_host (String) —

    The hostname or IP address of the TE Console. Required.

  • te_services_port (Integer[0, 65535]) —

    The TE Console services port. Default: 9898

  • te_services_passphrase (String) —

    The TE Console services passphrase. Required.

  • te_server_http_port (Integer[0, 65535]) —

    The TE Console HTTP port. Default: 8080

  • local_port (Integer[0, 65535]) —

    The port the Agent will listen on for communications from the TE Console. Default: 9898

  • install_rtm (Boolean) —

    Whether to install the Event Generator service. Default: true

  • proxy_host (Optional[String]) —

    The hostname or IP address of a TE proxy. Optional.

  • proxy_port (Integer[0, 65535]) —

    The port to communicate with the TE proxy. Default: 1080

  • rtm_port (Integer[0, 65535]) —

    The port for the Event Generator service to communicate with the Agent. Default: 1169

  • enable_fips (Boolean) —

    Enables FIPS mode for the Agent. Default: false

  • agent_properties (Optional[Hash]) —

    Additional properties to set in the Agent configuration. See documentation or contact support for details on which properties are available. Note that this will only ever set properties. They will not be removed from the configuration if they are removed from this parameter. Default: undef

  • tags (Optional[Hash]) —

    Tags to automatically apply to the node when registered. Format is a Hash of tag set names to tag values, or an array of tag values. Optional.

  • service_enable (Optional[Boolean]) —

    Whether to enable the TE Agent service to start at boot. Default: true

  • service_ensure (Enum['running', 'stopped']) —

    Whether the TE Agent service should be running. Default: running

  • service_manage (Boolean) —

    Whether to manage the TE Agent service. Default: true

  • service_name (String) —

    The TE Agent service name to manage. Default value: varies by operating system

  • service_provider (Optional[String]) —

    Which service provider to use for the TE Agent service. Default: undef.

  • service_rtm_enable (Boolean) —

    Whether to enable the Event Generator service to start at boot. Default: true

  • service_rtm_ensure (Enum['running', 'stopped']) —

    Whether the Event Generator service should be running. Default: running

  • service_rtm_manage (Boolean) —

    Whether to manage the Event Generator service. Should only be used if install_rtm is true. Default: true

  • service_rtm_name (String) —

    The Event Generator service name to manage. Default: varies by operating system

  • service_rtm_provider (Optional[String]) —

    Which service provider to use for the Event Generator service. Default: undef.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'manifests/init.pp', line 57

class te_agent (
  Boolean $package_manage,
  String $package_ensure,
  String $package_install_path,
  String $package_source,
  String $package_name,
  Optional[String] $package_provider,
  String $te_server_host,
  Integer[0, 65535] $te_services_port,
  String $te_services_passphrase,
  Integer[0, 65535] $te_server_http_port,
  Integer[0, 65535] $local_port,
  Boolean $install_rtm,
  Integer[0, 65535] $rtm_port,
  Optional[String] $proxy_host,
  Integer[0, 65535] $proxy_port,
  Boolean $enable_fips,
  Optional[Hash] $agent_properties,
  Optional[Hash] $tags,
  Optional[Boolean] $service_enable,
  Enum['running', 'stopped'] $service_ensure,
  Boolean $service_manage,
  String $service_name,
  Optional[String] $service_provider,
  Boolean $service_rtm_enable,
  Enum['running', 'stopped'] $service_rtm_ensure,
  Boolean $service_rtm_manage,
  String $service_rtm_name,
  Optional[String] $service_rtm_provider,
) {

  contain te_agent::install
  contain te_agent::config
  contain te_agent::service

  Class['::te_agent::install']
  -> Class['::te_agent::config']
  ~> Class['::te_agent::service']
}