Resource Type: sshkey

Included in Puppet Enterprise 2015.3. A newer version is available; see the version menu above for details.

NOTE: This page was generated from the Puppet source code on 2016-01-27 14:15:19 +0000

sshkey

Description

Installs and manages ssh host keys. At this point, this type only knows how to install keys into /etc/ssh/ssh_known_hosts. See the ssh_authorized_key type to manage authorized keys.

Attributes

sshkey { 'resource title':
  name         => # (namevar) The host name that the key is associated...
  ensure       => # The basic property that the resource should be...
  host_aliases => # Any aliases the host might have.  Multiple...
  key          => # The key itself; generally a long string of...
  provider     => # The specific backend to use for this `sshkey...
  target       => # The file in which to store the ssh key.  Only...
  type         => # The encryption type used.  Probably ssh-dss or...
  # ...plus any applicable metaparameters.
}

name

(Namevar: If omitted, this attribute’s value defaults to the resource’s title.)

The host name that the key is associated with.

(↑ Back to sshkey attributes)

ensure

(Property: This attribute represents concrete state on the target system.)

The basic property that the resource should be in.

Valid values are present, absent.

(↑ Back to sshkey attributes)

host_aliases

(Property: This attribute represents concrete state on the target system.)

Any aliases the host might have. Multiple values must be specified as an array.

(↑ Back to sshkey attributes)

key

(Property: This attribute represents concrete state on the target system.)

The key itself; generally a long string of uuencoded characters.

(↑ Back to sshkey attributes)

provider

The specific backend to use for this sshkey resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.

Available providers are:

(↑ Back to sshkey attributes)

target

(Property: This attribute represents concrete state on the target system.)

The file in which to store the ssh key. Only used by the parsed provider.

(↑ Back to sshkey attributes)

type

(Property: This attribute represents concrete state on the target system.)

The encryption type used. Probably ssh-dss or ssh-rsa.

Valid values are ssh-dss (also called dsa), ssh-ed25519 (also called ed25519), ssh-rsa (also called rsa), ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, ecdsa-sha2-nistp521.

(↑ Back to sshkey attributes)

Providers

parsed

Parse and generate host-wide known hosts files for SSH.

NOTE: This page was generated from the Puppet source code on 2016-01-27 14:15:19 +0000

↑ Back to top