Class: Ansible::Ruby::Modules::Github_key

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/source_control/github_key.rb

Overview

Creates, removes, or updates GitHub access keys.

Instance Method Summary collapse

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

#force ⇒ :yes, ...

Returns The default is C(yes), which will replace the existing remote key if it’s different than C(pubkey). If C(no), the key will only be set if no key with the given C(name) exists.

Returns:

  • (:yes, :no, nil) —

    The default is C(yes), which will replace the existing remote key if it’s different than C(pubkey). If C(no), the key will only be set if no key with the given C(name) exists.



28
 
# File 'lib/ansible/ruby/modules/generated/source_control/github_key.rb', line 28

attribute :force

#name ⇒ String

Returns SSH key name.

Returns:

  • (String) —

    SSH key name



16
 
# File 'lib/ansible/ruby/modules/generated/source_control/github_key.rb', line 16

attribute :name

#pubkey ⇒ String?

Returns SSH public key value. Required when C(state=present).

Returns:

  • (String, nil) —

    SSH public key value. Required when C(state=present).



20
 
# File 'lib/ansible/ruby/modules/generated/source_control/github_key.rb', line 20

attribute :pubkey

#state ⇒ :present, ...

Returns Whether to remove a key, ensure that it exists, or update its value.

Returns:

  • (:present, :absent, nil) —

    Whether to remove a key, ensure that it exists, or update its value.



24
 
# File 'lib/ansible/ruby/modules/generated/source_control/github_key.rb', line 24

attribute :state

#token ⇒ String

Returns GitHub Access Token with permission to list and create public keys.

Returns:

  • (String) —

    GitHub Access Token with permission to list and create public keys.



12
 
# File 'lib/ansible/ruby/modules/generated/source_control/github_key.rb', line 12

attribute :token