Class: Ansible::Ruby::Modules::Authorized_key

Inherits:

Base

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

Defined in:

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

Overview

Adds or removes SSH authorized keys for particular user accounts

Instance Method Summary

• #comment ⇒ Object^?

  Change the comment on the public key.

• #exclusive ⇒ :yes, ...

  Whether to remove all other non-specified keys from the authorized_keys file.

• #follow ⇒ :yes, ...

  Follow path symlink instead of replacing it.

• #key ⇒ String

  The SSH public key(s), as a string or (since 1.9) url (github.com/username.keys).

• #key_options ⇒ Array<String>, ...

  A string of ssh key options to be prepended to the key in the authorized_keys file.

• #manage_dir ⇒ :yes, ...

  Whether this module should manage the directory of the authorized key file.

• #path ⇒ String^?

  Alternate path to the authorized_keys file.

• #state ⇒ :present, ...

  Whether the given key (with the given key_options) should or should not be in the file.

• #user ⇒ String

  The username on the remote host whose authorized_keys file will be modified.

• #validate_certs ⇒ :yes, ...

  This only applies if using a https url as the source of the keys.

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#comment ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/system/authorized_key.rb', line 44

attribute :comment

#exclusive ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/system/authorized_key.rb', line 36

attribute :exclusive

#follow ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/system/authorized_key.rb', line 47

attribute :follow

#key ⇒ String

# File 'lib/ansible/ruby/modules/generated/system/authorized_key.rb', line 16

attribute :key

#key_options ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/system/authorized_key.rb', line 32

attribute :key_options

#manage_dir ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/system/authorized_key.rb', line 24

attribute :manage_dir

#path ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/system/authorized_key.rb', line 20

attribute :path

#state ⇒ :present, ...

# File 'lib/ansible/ruby/modules/generated/system/authorized_key.rb', line 28

attribute :state

#user ⇒ String

# File 'lib/ansible/ruby/modules/generated/system/authorized_key.rb', line 12

attribute :user

#validate_certs ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/system/authorized_key.rb', line 40

attribute :validate_certs