Resource Type: ssh_config

Defined in:
lib/puppet/type/ssh_config.rb
Providers:
augeas

Overview

Manages settings in an OpenSSH ssh_config file.

The resource name is used for the setting name, but if the ‘host` is given, then the name can be something else and the `key` given as the name of the setting.

Properties

  • comment

    Text to be stored in a comment immediately above the entry. It will be automatically prepended with the name of the variable in order for the provider to know whether it controls the comment or not.

  • ensure (defaults to: present)

    The basic property that the resource should be in.

    Supported values:
    • present
    • absent
  • value

    Value to change the setting to. The follow parameters take an array of values:

    • MACs;

    • Ciphers;

    • SendEnv.

    All other parameters take a string. When passing an array to other parameters, only the first value in the array will be considered.

Parameters

  • host

    Host condition for the entry.

  • key

    Overrides setting name to prevent resource conflicts if ‘host` is given.

  • name (namevar)

    The name of the setting, or a unique string if ‘host` given.

  • provider

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

  • target

    The file in which to store the settings, defaults to ‘/etc/ssh/ssh_config`.