Skip to content
This repository has been archived by the owner on Aug 27, 2024. It is now read-only.

Latest commit

 

History

History
462 lines (264 loc) · 13.5 KB

REFERENCE.md

File metadata and controls

462 lines (264 loc) · 13.5 KB

Reference

Table of Contents

Classes

Classes

dynatraceoneagent

This module deploys the OneAgent on Linux, Windows and AIX Operating Systems with different available configurations and ensures the OneAgent service maintains a running state. It provides types/providers to interact with the various OneAgent configuration points.

Examples

class { 'dynatraceoneagent':
    tenant_url  => 'https://{your-environment-id}.live.dynatrace.com',
    paas_token  => '{your-paas-token}',
}

Parameters

The following parameters are available in the dynatraceoneagent class:

global_mode

Data type: String

Sets the permissions for any files that don't have this assignment either set manually or by the OneAgent installer

Default value: $dynatraceoneagent::params::global_mode

tenant_url

Data type: String

URL of your dynatrace Tenant Managed https://{your-domain}/e/{your-environment-id} - SaaS https://{your-environment-id}.live.dynatrace.com

Default value: $dynatraceoneagent::params::tenant_url

paas_token

Data type: String

Paas token for downloading the OneAgent installer

Default value: $dynatraceoneagent::params::paas_token

api_path

Data type: String

Path of the Dynatrace OneAgent deployment API

Default value: $dynatraceoneagent::params::api_path

version

Data type: String

The required version of the OneAgent in 1.155.275.20181112-084458 format

Default value: $dynatraceoneagent::params::version

arch

Data type: String

The architecture of your OS - default is all

Default value: $dynatraceoneagent::params::arch

installer_type

Data type: String

The type of the installer - default is default

Default value: $dynatraceoneagent::params::installer_type

verify_signature

Data type: Optional[Boolean]

Verify OneAgent installer signature (Linux only).

Default value: $dynatraceoneagent::params::verify_signature

proxy_server

Data type: Optional[String]

Proxy server to be used by the archive module for downloading the OneAgent installer if needed

Default value: $dynatraceoneagent::params::proxy_server

download_cert_link

Data type: Optional[String]

Link for downloading dynatrace root cert pem file

Default value: $dynatraceoneagent::params::download_cert_link

cert_file_name

Data type: Optional[String]

Name of the downloaded cert file

Default value: $dynatraceoneagent::params::cert_file_name

ca_cert_src_path

Data type: Optional[String]

Location of dynatrace root cert file in module

Default value: $dynatraceoneagent::params::ca_cert_src_path

allow_insecure

Data type: Optional[Boolean]

Ignore HTTPS certificate errors when using the archive module.

Default value: $dynatraceoneagent::params::allow_insecure

download_options

Data type: Optional

In some cases you may need custom flags for curl/wget/s3 which can be supplied via download_options. Refer to Download Customizations

Default value: $dynatraceoneagent::params::download_options

download_dir

Data type: String

OneAgent installer file download directory.

Default value: $dynatraceoneagent::params::download_dir

default_install_dir

Data type: String

OneAgent default install directory

Default value: $dynatraceoneagent::params::default_install_dir

oneagent_params_hash

Data type: Hash

Hash map of additional parameters to pass to the installer Refer to the Customize OneAgent installation documentation on Technology Support

Default value: $dynatraceoneagent::params::oneagent_params_hash

reboot_system

Data type: Boolean

If set to true, puppet will reboot the server after installing the OneAgent - default is false

Default value: $dynatraceoneagent::params::reboot_system

service_state

Data type: String

What state the dynatrace oneagent service should be in - default is running Allowed values: running, stopped

Default value: $dynatraceoneagent::params::service_state

manage_service

Data type: Boolean

Whether puppet should manage the state of the OneAgent service - default is true

Default value: $dynatraceoneagent::params::manage_service

service_name

Data type: String

The name of the dynatrace OneAgent based on the OS

Default value: $dynatraceoneagent::params::service_name

package_state

Data type: String

What state the dynatrace oneagent package should be in - default is present Allowed values: present, absent

Default value: $dynatraceoneagent::params::package_state

host_tags

Data type: Optional[Array]

Values to automatically add tags to a host, should contain an array of strings or key/value pairs. For example: ['Environment=Prod', 'Organization=D1P', 'Owner=[email protected]', 'Support=https://www.dynatrace.com/support/linux']

Default value: $dynatraceoneagent::params::host_tags

host_metadata

Data type: Optional[Array]

Values to automatically add metadata to a host, Should contain an array of strings or key/value pairs. For example: ['LinuxHost', 'Gdansk', 'role=fallback', 'app=easyTravel']

Default value: $dynatraceoneagent::params::host_metadata

hostname

Data type: Optional[String]

Overrides an automatically detected host name. Example: My App Server

Default value: $dynatraceoneagent::params::hostname

oneagent_communication_hash

Data type: Optional[Hash]

Hash map of parameters used to change OneAgent communication settings Refer to Change OneAgent communication settings on Communication Settings

Default value: $dynatraceoneagent::params::oneagent_communication_hash

log_monitoring

Data type: Optional[Boolean]

Enable or disable Log Monitoring

Default value: $dynatraceoneagent::params::log_monitoring

log_access

Data type: Optional[Boolean]

Enable or disable access to system logs

Default value: $dynatraceoneagent::params::log_access

host_group

Data type: Optional[String]

Change host group assignment

Default value: $dynatraceoneagent::params::host_group

infra_only

Data type: Optional[Boolean]

Enable or disable Infrastructure Monitoring mode

Default value: $dynatraceoneagent::params::infra_only

network_zone

Data type: Optional[String]

Set the network zone for the host

Default value: $dynatraceoneagent::params::network_zone

oneagent_puppet_conf_dir

Data type: String

Directory puppet will use to store oneagent configurations

Default value: $dynatraceoneagent::params::oneagent_puppet_conf_dir

oneagent_ctl

Data type: String

Name of oneagentctl executable file

Default value: $dynatraceoneagent::params::oneagent_ctl

provider

Data type: String

The specific backend to use for this exec resource.

Default value: $dynatraceoneagent::params::provider

oneagent_comms_config_file

Data type: String

Configuration file location for OneAgent communication

Default value: $dynatraceoneagent::params::oneagent_comms_config_file

oneagent_logmonitoring_config_file

Data type: String

Configuration file location for OneAgent log monitoring

Default value: $dynatraceoneagent::params::oneagent_logmonitoring_config_file

oneagent_logaccess_config_file

Data type: String

Configuration file location for OneAgent log access

Default value: $dynatraceoneagent::params::oneagent_logaccess_config_file

hostgroup_config_file

Data type: String

Configuration file location for OneAgent host group value

Default value: $dynatraceoneagent::params::hostgroup_config_file

hostmetadata_config_file

Data type: String

Configuration file location for OneAgent host metadata value(s)

Default value: $dynatraceoneagent::params::hostmetadata_config_file

hostautotag_config_file

Data type: String

Configuration file location for OneAgent host tag value(s)

Default value: $dynatraceoneagent::params::hostautotag_config_file

hostname_config_file

Data type: String

Configuration file location for OneAgent host name value

Default value: $dynatraceoneagent::params::hostname_config_file

oneagent_infraonly_config_file

Data type: String

Configuration file location for OneAgent infra only mode

Default value: $dynatraceoneagent::params::oneagent_infraonly_config_file

oneagent_networkzone_config_file

Data type: String

Configuration file location for OneAgent network zone value

Default value: $dynatraceoneagent::params::oneagent_networkzone_config_file

dynatraceoneagent::config

This class manages the configuration of the OneAgent

dynatraceoneagent::download

This class downloads the OneAgent installer binary

dynatraceoneagent::install

This class manages the installation of the OneAgent on the host

dynatraceoneagent::params

This class manages the OneAgent parameters

dynatraceoneagent::service

Manages the OneAgent service

dynatraceoneagent::uninstall

Uninstalls the Dynatrace OneAgent