Class: Ansible::Ruby::Modules::Docker_login

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/cloud/docker/docker_login.rb

Overview

Provides functionality similar to the “docker login” command. Authenticate with a docker registry and add the credentials to your local Docker config file. Adding the credentials to the config files allows future connections to the registry using tools such as Ansible’s Docker modules, the Docker CLI and docker-py without needing to provide credentials. Running in check mode will perform the authentication without updating the config file.

Instance Method Summary

• #config_path ⇒ String^?

  Custom path to the Docker CLI configuration file.

• #email ⇒ Object^?

  The email address for the registry account.

• #password ⇒ String

  The plaintext password for the registry account.

• #reauthorize ⇒ :yes, ...

  Refresh existing authentication found in the configuration file.

• #registry_url ⇒ String^?

  The registry URL.

• #state ⇒ :present, ...

  This controls the current state of the user.

• #username ⇒ String

  The username for the registry account.

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

#config_path ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_login.rb', line 33

attribute :config_path

#email ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_login.rb', line 26

attribute :email

#password ⇒ String

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_login.rb', line 22

attribute :password

#reauthorize ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_login.rb', line 29

attribute :reauthorize

#registry_url ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_login.rb', line 14

attribute :registry_url

#state ⇒ :present, ...

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_login.rb', line 37

attribute :state

#username ⇒ String

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_login.rb', line 18

attribute :username