Class: Ansible::Ruby::Modules::Known_hosts

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Known_hosts

Defined in:

lib/ansible/ruby/modules/generated/system/known_hosts.rb

Overview

The C(known_hosts) module lets you add or remove a host keys from the C(known_hosts) file. Starting at Ansible 2.2, multiple entries per host are allowed, but only one for each key type supported by ssh. This is useful if you’re going to want to use the M(git) module over ssh, for example. If you have a very large number of host keys to manage, you will find the M(template) module more useful.

Instance Method Summary

• #hash_host ⇒ :yes, ...

  Hash the hostname in the known_hosts file.

• #key ⇒ String^?

  The SSH public host key, as a string (required if state=present, optional when state=absent, in which case all keys for the host are removed).

• #name ⇒ String

  The host to add or remove (must match a host specified in key).

• #path ⇒ String^?

  The known_hosts file to edit.

• #state ⇒ :present, ...

  I(present) to add the host key, I(absent) to remove it.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#hash_host ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/system/known_hosts.rb', line 26

attribute :hash_host

#key ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/system/known_hosts.rb', line 18

attribute :key

#name ⇒ String

# File 'lib/ansible/ruby/modules/generated/system/known_hosts.rb', line 14

attribute :name

#path ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/system/known_hosts.rb', line 22

attribute :path

#state ⇒ :present, ...

# File 'lib/ansible/ruby/modules/generated/system/known_hosts.rb', line 30

attribute :state