Class: Ansible::Ruby::Modules::Cnos_image

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

Overview

This module allows you to work with switch firmware images. It provides a way to download a firmware image to a network device from a remote server using FTP, SFTP, TFTP, or SCP. The first step is to create a directory from where the remote server can be reached. The next step is to provide the full file path of the image’s location. Authentication details required by the remote server must be provided as well. By default, this method makes the newly downloaded firmware image the active image, which will be used by the switch during the next restart. This module uses SSH to manage network device configuration. The results of the operation will be placed in a directory named ‘results’ that must be created by the user in their local directory to where the playbook is run. For more information about this module from Lenovo and customizing it usage for your use cases, please visit U(systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_image.html)

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#imgpath ⇒ Object

Returns This specifies the full file path of the image located on the remote server. In case the relative path is used as the variable value, the root folder for the user of the server needs to be specified.

Returns:

  • (Object) —

    This specifies the full file path of the image located on the remote server. In case the relative path is used as the variable value, the root folder for the user of the server needs to be specified.



20
 
# File 'lib/ansible/ruby/modules/generated/network/cnos/cnos_image.rb', line 20

attribute :imgpath

#imgtype ⇒ :all, ...

Returns This specifies the firmware image type to be downloaded.

Returns:

  • (:all, :boot, :os, :onie) —

    This specifies the firmware image type to be downloaded



24
 
# File 'lib/ansible/ruby/modules/generated/network/cnos/cnos_image.rb', line 24

attribute :imgtype

#protocol ⇒ :SFTP, ...

Returns This refers to the protocol used by the network device to interact with the remote server from where to download the firmware image. The choices are FTP, SFTP, TFTP, or SCP. Any other protocols will result in error. If this parameter is not specified there is no default value to be used.

Returns:

  • (:SFTP, :SCP, :FTP, :TFTP) —

    This refers to the protocol used by the network device to interact with the remote server from where to download the firmware image. The choices are FTP, SFTP, TFTP, or SCP. Any other protocols will result in error. If this parameter is not specified there is no default value to be used.



12
 
# File 'lib/ansible/ruby/modules/generated/network/cnos/cnos_image.rb', line 12

attribute :protocol

#serverip ⇒ Object

Returns This specifies the IP Address of the remote server from where the software image will be downloaded.

Returns:

  • (Object) —

    This specifies the IP Address of the remote server from where the software image will be downloaded.



16
 
# File 'lib/ansible/ruby/modules/generated/network/cnos/cnos_image.rb', line 16

attribute :serverip

#serverpassword ⇒ Object?

Returns Specify the password for the server relating to the protocol used.

Returns:

  • (Object, nil) —

    Specify the password for the server relating to the protocol used



32
 
# File 'lib/ansible/ruby/modules/generated/network/cnos/cnos_image.rb', line 32

attribute :serverpassword

#serverusername ⇒ Object

Returns Specify the username for the server relating to the protocol used.

Returns:

  • (Object) —

    Specify the username for the server relating to the protocol used



28
 
# File 'lib/ansible/ruby/modules/generated/network/cnos/cnos_image.rb', line 28

attribute :serverusername