Class: Ansible::Ruby::Modules::Aos_login

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/aos/aos_login.rb

Overview

Obtain the AOS server session token by providing the required username and password credentials. Upon successful authentication, this module will return the session-token that is required by all subsequent AOS module usage. On success the module will automatically populate ansible facts with the variable I(aos_session) This module is not idempotent and do not support check mode.

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

#passwd ⇒ String?

Returns Password to use when connecting to the AOS server.

Returns:

  • (String, nil) —

    Password to use when connecting to the AOS server.



24
 
# File 'lib/ansible/ruby/modules/generated/network/aos/aos_login.rb', line 24

attribute :passwd

#port ⇒ Integer?

Returns Port number to use when connecting to the AOS server.

Returns:

  • (Integer, nil) —

    Port number to use when connecting to the AOS server.



16
 
# File 'lib/ansible/ruby/modules/generated/network/aos/aos_login.rb', line 16

attribute :port

#server ⇒ String

Returns Address of the AOS Server on which you want to open a connection.

Returns:

  • (String) —

    Address of the AOS Server on which you want to open a connection.



12
 
# File 'lib/ansible/ruby/modules/generated/network/aos/aos_login.rb', line 12

attribute :server

#user ⇒ String?

Returns Login username to use when connecting to the AOS server.

Returns:

  • (String, nil) —

    Login username to use when connecting to the AOS server.



20
 
# File 'lib/ansible/ruby/modules/generated/network/aos/aos_login.rb', line 20

attribute :user