Class: Ansible::Ruby::Modules::Cnos_rollback

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

Overview

This module allows you to work with switch configurations. It provides a way to roll back configurations of a switch from a remote server. This is achieved by using startup or running configurations of the target device that were previously backed up to 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 he backup configuration’s location. Authentication details required by the remote server must be provided as well. By default, this method overwrites the switch’s configuration file with the newly downloaded file. 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_rollback.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

#configType:"running-config", :"startup-config"

Returns This refers to the type of configuration which will be used for the rolling back process. The choices are the running or startup configurations. There is no default value, so it will result in an error if the input is incorrect.

Returns:

  • (:"running-config", :"startup-config")

    This refers to the type of configuration which will be used for the rolling back process. The choices are the running or startup configurations. There is no default value, so it will result in an error if the input is incorrect.



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

attribute :configType

#protocol:SFTP, ...

Returns This refers to the protocol used by the network device to interact with the remote server from where to download the backup configuration. 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 backup configuration. 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.



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

attribute :protocol

#rcpathObject

Returns This specifies the full file path of the configuration file 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 configuration file 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.



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

attribute :rcpath

#rcserveripObject

Returns This specifies the IP Address of the remote server from where the backup configuration will be downloaded.

Returns:

  • (Object)

    This specifies the IP Address of the remote server from where the backup configuration will be downloaded.



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

attribute :rcserverip

#serverpasswordObject

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

Returns:

  • (Object)

    Specify password for the server relating to the protocol used.



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

attribute :serverpassword

#serverusernameObject

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

Returns:

  • (Object)

    Specify username for the server relating to the protocol used.



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

attribute :serverusername