Class: Ansible::Ruby::Modules::Open_iscsi

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/system/open_iscsi.rb

Overview

Discover targets on given portal, (dis)connect targets, mark targets to manually or auto start, return device nodes of connected targets.

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

#auto_node_startup ⇒ Boolean?

Returns whether the target node should be automatically connected at startup.

Returns:

  • (Boolean, nil) —

    whether the target node should be automatically connected at startup



37
 
# File 'lib/ansible/ruby/modules/generated/extras/system/open_iscsi.rb', line 37

attribute :auto_node_startup

#discover ⇒ Boolean?

Returns whether the list of target nodes on the portal should be (re)discovered and added to the persistent iscsi database. Keep in mind that iscsiadm discovery resets configurtion, like node.startup to manual, hence combined with auto_node_startup=yes will allways return a changed state.

Returns:

  • (Boolean, nil) —

    whether the list of target nodes on the portal should be (re)discovered and added to the persistent iscsi database. Keep in mind that iscsiadm discovery resets configurtion, like node.startup to manual, hence combined with auto_node_startup=yes will allways return a changed state.



41
 
# File 'lib/ansible/ruby/modules/generated/extras/system/open_iscsi.rb', line 41

attribute :discover

#login ⇒ Boolean?

Returns whether the target node should be connected.

Returns:

  • (Boolean, nil) —

    whether the target node should be connected



23
 
# File 'lib/ansible/ruby/modules/generated/extras/system/open_iscsi.rb', line 23

attribute :login

#node_auth ⇒ String?

Returns discovery.sendtargets.auth.authmethod.

Returns:

  • (String, nil) —

    discovery.sendtargets.auth.authmethod



27
 
# File 'lib/ansible/ruby/modules/generated/extras/system/open_iscsi.rb', line 27

attribute :node_auth

#node_pass ⇒ Object?

Returns discovery.sendtargets.auth.password.

Returns:

  • (Object, nil) —

    discovery.sendtargets.auth.password



34
 
# File 'lib/ansible/ruby/modules/generated/extras/system/open_iscsi.rb', line 34

attribute :node_pass

#node_user ⇒ Object?

Returns discovery.sendtargets.auth.username.

Returns:

  • (Object, nil) —

    discovery.sendtargets.auth.username



31
 
# File 'lib/ansible/ruby/modules/generated/extras/system/open_iscsi.rb', line 31

attribute :node_user

#port ⇒ Integer?

Returns the port on which the iscsi target process listens.

Returns:

  • (Integer, nil) —

    the port on which the iscsi target process listens



15
 
# File 'lib/ansible/ruby/modules/generated/extras/system/open_iscsi.rb', line 15

attribute :port

#portal ⇒ String?

Returns the ip address of the iscsi target.

Returns:

  • (String, nil) —

    the ip address of the iscsi target



11
 
# File 'lib/ansible/ruby/modules/generated/extras/system/open_iscsi.rb', line 11

attribute :portal

#show_nodes ⇒ Boolean?

Returns whether the list of nodes in the persistent iscsi database should be returned by the module.

Returns:

  • (Boolean, nil) —

    whether the list of nodes in the persistent iscsi database should be returned by the module



45
 
# File 'lib/ansible/ruby/modules/generated/extras/system/open_iscsi.rb', line 45

attribute :show_nodes

#target ⇒ String?

Returns the iscsi target name.

Returns:

  • (String, nil) —

    the iscsi target name



19
 
# File 'lib/ansible/ruby/modules/generated/extras/system/open_iscsi.rb', line 19

attribute :target