Class: Ansible::Ruby::Modules::Cnos_backup

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

Overview

This module allows you to work with switch configurations. It provides a way to back up the running or startup configurations of a switch to a remote server. This is achieved by periodically saving a copy of the startup or running configuration of the network device 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 the location where the configuration will be backed up. Authentication details required by the remote server must be provided as well. 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_backup.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 specifies what type of configuration will be backed up. 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 specifies what type of configuration will be backed up. 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_backup.rb', line 12

attribute :configType

#protocol ⇒ :SFTP, ...

Returns This refers to the protocol used by the network device to interact with the remote server to where to upload 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 to where to upload 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_backup.rb', line 16

attribute :protocol

#rcpath ⇒ Object

Returns This specifies the full file path where the configuration file will be copied 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 where the configuration file will be copied 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_backup.rb', line 24

attribute :rcpath

#rcserverip ⇒ Object

Returns -This specifies the IP Address of the remote server to where the configuration will be backed up.

Returns:

  • (Object) —

    -This specifies the IP Address of the remote server to where the configuration will be backed up.



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

attribute :rcserverip

#serverpassword ⇒ Object

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

Returns:

  • (Object) —

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



32
 
# File 'lib/ansible/ruby/modules/generated/network/cnos/cnos_backup.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_backup.rb', line 28

attribute :serverusername