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/core/cloud/docker/docker_login.rb

Instance Method Summary

• #config_path ⇒ String^?

  Custom path to the Docker CLI configuration file.

• #email ⇒ String^?

  The email address for the registry account.

• #password ⇒ String

  The plaintext password for the registry account.

• #reauthorize ⇒ Boolean^?

  Refresh exiting authentication found in the configuration file.

• #registry_url ⇒ String^?

  The registry URL.

• #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, #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.

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

attribute :config_path

#email ⇒ String^?

Returns The email address for the registry account. NOTE: private registries may not require this, but Docker Hub requires it.

Returns:

• (String, nil) —

  The email address for the registry account. NOTE: private registries may not require this, but Docker Hub requires it.

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

attribute :email

#password ⇒ String

Returns The plaintext password for the registry account.

Returns:

• (String) —

  The plaintext password for the registry account

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

attribute :password

#reauthorize ⇒ Boolean^?

Returns Refresh exiting authentication found in the configuration file.

Returns:

• (Boolean, nil) —

  Refresh exiting authentication found in the configuration file.

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

attribute :reauthorize

#registry_url ⇒ String^?

Returns The registry URL.

Returns:

• (String, nil) —

  The registry URL.

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

attribute :registry_url

#username ⇒ String

Returns The username for the registry account.

Returns:

• (String) —

  The username for the registry account

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

attribute :username