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

Inherits:
Base show all
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 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

#config_path ⇒ String?

Returns Custom path to the Docker CLI configuration file.

Returns:

  • (String, nil) —

    Custom path to the Docker CLI configuration file.



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

attribute :config_path

#email ⇒ Object?

Returns The email address for the registry account.

Returns:

  • (Object, nil) —

    The email address for the registry account.



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

attribute :email

#password ⇒ String

Returns The plaintext password for the registry account.

Returns:

  • (String) —

    The plaintext password for the registry account



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

attribute :password

#reauthorize ⇒ :yes, ...

Returns Refresh existing authentication found in the configuration file.

Returns:

  • (:yes, :no, nil) —

    Refresh existing authentication found in the configuration file.



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

attribute :reauthorize

#registry_url ⇒ String?

Returns The registry URL.

Returns:

  • (String, nil) —

    The registry URL.



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

attribute :registry_url

#state ⇒ :present, ...

Returns This controls the current state of the user. C(present) will login in a user, C(absent) will log them out.,To logout you only need the registry server, which defaults to DockerHub.,Before 2.1 you could ONLY log in.,docker does not support ‘logout’ with a custom config file.

Returns:

  • (:present, :absent, nil) —

    This controls the current state of the user. C(present) will login in a user, C(absent) will log them out.,To logout you only need the registry server, which defaults to DockerHub.,Before 2.1 you could ONLY log in.,docker does not support ‘logout’ with a custom config file.



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

attribute :state

#username ⇒ String

Returns The username for the registry account.

Returns:

  • (String) —

    The username for the registry account



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

attribute :username