Class: Ansible::Ruby::Modules::Nxos_file_copy

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

Overview

This module supports two different workflows for copying a file to flash (or bootflash) on NXOS devices. Files can either be (1) pushed from the Ansible controller to the device or (2) pulled from a remote SCP file server to the device. File copies are initiated from the NXOS device to the remote SCP server. This module only supports the use of connection C(network_cli) or C(Cli) transport with connection C(local).

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

#connect_ssh_port ⇒ Integer?

Returns SSH port to connect to server during transfer of file.

Returns:

  • (Integer, nil) —

    SSH port to connect to server during transfer of file



24
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_file_copy.rb', line 24

attribute :connect_ssh_port

#file_pull ⇒ Symbol?

Returns When (False) file is copied from the Ansible controller to the NXOS device.,When (True) file is copied from a remote SCP server to the NXOS device. In this mode, the file copy is initiated from the NXOS device.,If the file is already present on the device it will be overwritten and therefore the operation is NOT idempotent.

Returns:

  • (Symbol, nil) —

    When (False) file is copied from the Ansible controller to the NXOS device.,When (True) file is copied from a remote SCP server to the NXOS device. In this mode, the file copy is initiated from the NXOS device.,If the file is already present on the device it will be overwritten and therefore the operation is NOT idempotent.



28
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_file_copy.rb', line 28

attribute :file_pull

#file_pull_timeout ⇒ Integer?

Returns Use this parameter to set timeout in seconds, when transferring large files or when the network is slow.

Returns:

  • (Integer, nil) —

    Use this parameter to set timeout in seconds, when transferring large files or when the network is slow.



35
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_file_copy.rb', line 35

attribute :file_pull_timeout

#file_system ⇒ String?

Returns The remote file system of the device. If omitted, devices that support a I(file_system) parameter will use their default values.

Returns:

  • (String, nil) —

    The remote file system of the device. If omitted, devices that support a I(file_system) parameter will use their default values.



20
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_file_copy.rb', line 20

attribute :file_system

#local_file ⇒ String?

Returns When (file_pull is False) this is the path to the local file on the Ansible controller. The local directory must exist.,When (file_pull is True) this is the file name used on the NXOS device.

Returns:

  • (String, nil) —

    When (file_pull is False) this is the path to the local file on the Ansible controller. The local directory must exist.,When (file_pull is True) this is the file name used on the NXOS device.



12
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_file_copy.rb', line 12

attribute :local_file

#local_file_directory ⇒ Object?

Returns When (file_pull is True) file is copied from a remote SCP server to the NXOS device, and written to this directory on the NXOS device. If the directory does not exist, it will be created under the file_system. This is an optional parameter.,When (file_pull is False), this not used.

Returns:

  • (Object, nil) —

    When (file_pull is True) file is copied from a remote SCP server to the NXOS device, and written to this directory on the NXOS device. If the directory does not exist, it will be created under the file_system. This is an optional parameter.,When (file_pull is False), this not used.



32
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_file_copy.rb', line 32

attribute :local_file_directory

#remote_file ⇒ String?

Returns When (file_pull is False) this is the remote file path on the NXOS device. If omitted, the name of the local file will be used. The remote directory must exist.,When (file_pull is True) this is the full path to the file on the remote SCP server to be copied to the NXOS device.

Returns:

  • (String, nil) —

    When (file_pull is False) this is the remote file path on the NXOS device. If omitted, the name of the local file will be used. The remote directory must exist.,When (file_pull is True) this is the full path to the file on the remote SCP server to be copied to the NXOS device.



16
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_file_copy.rb', line 16

attribute :remote_file

#remote_scp_server ⇒ String?

Returns The remote scp server address which is used to pull the file. This is required if file_pull is True.

Returns:

  • (String, nil) —

    The remote scp server address which is used to pull the file. This is required if file_pull is True.



39
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_file_copy.rb', line 39

attribute :remote_scp_server

#remote_scp_server_password ⇒ String?

Returns The remote scp server password which is used to pull the file. This is required if file_pull is True.

Returns:

  • (String, nil) —

    The remote scp server password which is used to pull the file. This is required if file_pull is True.



47
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_file_copy.rb', line 47

attribute :remote_scp_server_password

#remote_scp_server_user ⇒ String?

Returns The remote scp server username which is used to pull the file. This is required if file_pull is True.

Returns:

  • (String, nil) —

    The remote scp server username which is used to pull the file. This is required if file_pull is True.



43
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_file_copy.rb', line 43

attribute :remote_scp_server_user