REFERENCE.md

Reference

Table of Contents

Classes

Public Classes

• pdsh: Manage pdsh

Private Classes

• pdsh::config: Manage pdsh config
• pdsh::install: Install pdsh

Defined types

• pdsh::group: Define pdsh groups

Classes

pdsh

Manage pdsh

Examples

include ::pdsh

Parameters

The following parameters are available in the pdsh class:

• with_rsh
• with_ssh
• with_genders
• with_slurm
• support_dsh
• manage_epel
• manage_genders
• package_ensure
• package_name
• rsh_package_name
• ssh_package_name
• dshgroup_package_name
• genders_package_name
• slurm_package_name
• extra_packages
• dsh_config_dir
• dsh_group_dir
• dsh_group_dir_purge
• groups
• use_setuid
• rcmd_type
• ssh_args_append

with_rsh

Data type: Boolean

Install rsh support

Default value: false

with_ssh

Data type: Boolean

Install ssh support

Default value: true

with_genders

Data type: Boolean

Install genders support

Default value: false

with_slurm

Data type: Boolean

Install SLURM support

Default value: false

support_dsh

Data type: Boolean

Boolean to set if dsh support is available

Default value: true

manage_epel

Data type: Boolean

Boolean that determines if EPEL repo should be managed

Default value: true

manage_genders

Data type: Boolean

Boolean that determines if genders class should be managed

Default value: true

package_ensure

Data type: String

Packages ensure property

Default value: 'present'

package_name

Data type: String

Main pdsh package name

Default value: 'pdsh'

rsh_package_name

Data type: Optional[String]

rsh support package name

Default value: undef

ssh_package_name

Data type: Optional[String]

ssh support package name

Default value: undef

dshgroup_package_name

Data type: Optional[String]

dshgroup support package name

Default value: undef

genders_package_name

Data type: Optional[String]

Genders support package name

Default value: undef

slurm_package_name

Data type: Optional[String]

SLURM support package name

Default value: undef

extra_packages

Data type: Array

Additional pdsh packages to install

Default value: []

dsh_config_dir

Data type: Stdlib::Absolutepath

Path to dsh config directory

Default value: '/etc/dsh'

dsh_group_dir

Data type: Stdlib::Absolutepath

Path to dsh group directory

Default value: '/etc/dsh/group'

dsh_group_dir_purge

Data type: Boolean

Sets if dsh group directory should be purged

Default value: true

groups

Data type: Variant[Array, Hash]

Groups that should be defined using pdsh::group

Default value: {}

use_setuid

Data type: Boolean

Should pdsh binaries have setuid

Default value: false

rcmd_type

Data type: Optional[String]

Sets default remote command via PDSH_RCMD_TYPE environment variable

Default value: undef

ssh_args_append

Data type: Optional[String]

Additional SSH arguments set via PDSH_SSH_ARGS_APPEND environment variable

Default value: undef

Defined types

pdsh::group

Define pdsh groups

Examples

pdsh::group { 'nodes':
  members => 'c[01-04]',
  aliases => 'compute',
}

Parameters

The following parameters are available in the pdsh::group defined type:

• aliases
• members

aliases

Data type: Variant[Array, String]

Group aliases

Default value: []

members

Data type: Variant[Array, String]

Group members

Default value: []