Class: Ansible::Ruby::Modules::Github_deploy_key

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

Overview

Adds or removes deploy keys for GitHub repositories. Supports authentication using username and password, username and password and 2-factor authentication code (OTP), OAuth2 token, or personal access token.

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 If C(true), forcefully adds the deploy key by deleting any existing deploy key with the same public key or title.

Returns:

  • (:yes, :no, nil) —

    If C(true), forcefully adds the deploy key by deleting any existing deploy key with the same public key or title.



36
 
# File 'lib/ansible/ruby/modules/generated/source_control/github_deploy_key.rb', line 36

attribute :force

#key ⇒ String

Returns The SSH public key to add to the repository as a deploy key.

Returns:

  • (String) —

    The SSH public key to add to the repository as a deploy key.



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

attribute :key

#name ⇒ String

Returns The name for the deploy key.

Returns:

  • (String) —

    The name for the deploy key.



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

attribute :name

#otp ⇒ Integer?

Returns The 6 digit One Time Password for 2-Factor Authentication. Required together with I(username) and I(password).

Returns:

  • (Integer, nil) —

    The 6 digit One Time Password for 2-Factor Authentication. Required together with I(username) and I(password).



52
 
# File 'lib/ansible/ruby/modules/generated/source_control/github_deploy_key.rb', line 52

attribute :otp

#owner ⇒ String

Returns The name of the individual account or organization that owns the GitHub repository.

Returns:

  • (String) —

    The name of the individual account or organization that owns the GitHub repository.



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

attribute :owner

#password ⇒ String?

Returns The password to authenticate with. A personal access token can be used here in place of a password.

Returns:

  • (String, nil) —

    The password to authenticate with. A personal access token can be used here in place of a password.



44
 
# File 'lib/ansible/ruby/modules/generated/source_control/github_deploy_key.rb', line 44

attribute :password

#read_only ⇒ :yes, ...

Returns If C(true), the deploy key will only be able to read repository contents. Otherwise, the deploy key will be able to read and write.

Returns:

  • (:yes, :no, nil) —

    If C(true), the deploy key will only be able to read repository contents. Otherwise, the deploy key will be able to read and write.



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

attribute :read_only

#repo ⇒ String

Returns The name of the GitHub repository.

Returns:

  • (String) —

    The name of the GitHub repository.



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

attribute :repo

#state ⇒ :present, ...

Returns The state of the deploy key.

Returns:

  • (:present, :absent, nil) —

    The state of the deploy key.



32
 
# File 'lib/ansible/ruby/modules/generated/source_control/github_deploy_key.rb', line 32

attribute :state

#token ⇒ String?

Returns The OAuth2 token or personal access token to authenticate with. Mutually exclusive with I(password).

Returns:

  • (String, nil) —

    The OAuth2 token or personal access token to authenticate with. Mutually exclusive with I(password).



48
 
# File 'lib/ansible/ruby/modules/generated/source_control/github_deploy_key.rb', line 48

attribute :token

#username ⇒ String?

Returns The username to authenticate with.

Returns:

  • (String, nil) —

    The username to authenticate with.



40
 
# File 'lib/ansible/ruby/modules/generated/source_control/github_deploy_key.rb', line 40

attribute :username