REFERENCE.md

Reference

Table of Contents

Classes

• apt_dater: Install and configure apt-dater

Defined types

• apt_dater::host: Configure a host in apt-dater
• apt_dater::hostgroup: Group host

Classes

apt_dater

Install and configure apt-dater

Examples

include apt_dater

Parameters

The following parameters are available in the apt_dater class:

• ensure
• manage_tmux_package
• export_host
• export_config
• config_host_path
• config_path
• collect_hosts
• collect_tag
• spawn_agent

ensure

Data type: Enum['present', 'absent']

Should apt-dater and apt-dater-host be installed?

Default value: 'present'

manage_tmux_package

Data type: Boolean

Sould this class install tmux

Default value: true

export_host

Data type: Boolean

Do i need to export this host to be collected?

Default value: true

export_config

Data type: Hash[String, Any]

The attribute to pass to the exported host

Default value: {}

config_host_path

Data type: Stdlib::Unixpath

The config file to save the host list

Default value: '/etc/apt-dater/hosts.xml'

config_path

Data type: Stdlib::Unixpath

The config file of apt-dater central node

Default value: '/etc/apt-dater/apt-dater.xml'

collect_hosts

Data type: Boolean

Should we collect all exported hosts?

Default value: false

collect_tag

Data type: String

The tag to use for the export and the collect

Default value: 'default'

spawn_agent

Data type: Boolean

Do apt-dater need to spawn his own agent?

Default value: false

Defined types

apt_dater::host

Configure a host in apt-dater

Examples

apt_dater::host { 'namevar':
  host => 'myserver.mycompany.lan',
  user => 'root',
}

Parameters

The following parameters are available in the apt_dater::host defined type:

• user
• host
• group
• ensure
• comment
• type
• port
• identity

user

Data type: String

Username used for the SSH connection

host

Data type: String

Hostname or IP used for the connection

group

Data type: String[1]

Group of this host

Default value: 'Default Group'

ensure

Data type: Enum['present', 'absent']

Should this host be present

Default value: 'present'

comment

Data type: Optional[String[1]]

Comment for this host dicplayed in apt-dater

Default value: undef

type

Data type: String[1]

Connection type

Default value: 'generic-ssh'

port

Data type: Integer[1, 65535]

SSH Port

Default value: 22

identity

Data type: Optional[Stdlib::Unixpath]

Identity file to use

Default value: undef

apt_dater::hostgroup

Group host

Examples

apt_dater::hostgroup { 'Internal Hosts': }

Parameters

The following parameters are available in the apt_dater::hostgroup defined type:

• user

user

Data type: Optional[String[1]]

the default user of this group

Default value: undef