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

Inherits:

Base

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

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

• #force ⇒ :yes, ...

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

• #key ⇒ String

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

• #name ⇒ String

  The name for the deploy key.

• #otp ⇒ Integer^?

  The 6 digit One Time Password for 2-Factor Authentication.

• #owner ⇒ String

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

• #password ⇒ String^?

  The password to authenticate with.

• #read_only ⇒ :yes, ...

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

• #repo ⇒ String

  The name of the GitHub repository.

• #state ⇒ :present, ...

  The state of the deploy key.

• #token ⇒ String^?

  The OAuth2 token or personal access token to authenticate with.

• #username ⇒ String^?

  The username to authenticate with.

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

#force ⇒ :yes, ...

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

attribute :force

#key ⇒ String

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

attribute :key

#name ⇒ String

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

attribute :name

#otp ⇒ Integer^?

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

attribute :otp

#owner ⇒ String

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

attribute :owner

#password ⇒ String^?

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

attribute :password

#read_only ⇒ :yes, ...

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

attribute :read_only

#repo ⇒ String

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

attribute :repo

#state ⇒ :present, ...

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

attribute :state

#token ⇒ String^?

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

attribute :token

#username ⇒ String^?

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

attribute :username