REFERENCE.md

Reference

Table of Contents

Defined types

• ssh_keygen

Defined types

ssh_keygen

The ssh_keygen class.

Examples

Generate a dsa key

ssh_keygen { 'john':
  type => 'dsa'
}

specify the bit length

ssh_keygen { 'john':
  bits => 4096
}

Generate new host key

ssh_keygen { 'root':
  filename => '/etc/ssh/ssh_host_rsa_key'
}

Parameters

The following parameters are available in the ssh_keygen defined type:

• user
• type
• bits
• home
• filename
• comment
• options

user

Data type: Optional[String]

Username to create key for

Default value: undef

type

Data type: Enum['rsa', 'dsa', 'ecdsa', 'ed25519', 'rsa1']

Type of key to create

Default value: 'rsa'

bits

Data type: Optional[Integer]

Number of bits in key

Default value: undef

home

Data type: Optional[Stdlib::Absolutepath]

Home directory for user

Default value: undef

filename

Data type: Optional[Stdlib::Absolutepath]

Key filename

Default value: undef

comment

Data type: Optional[String]

Key comment

Default value: undef

options

Data type: Optional[Array[String]]

Additional options to pass on to ssh-keygen

Default value: undef