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

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Nxos_file_copy

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

• #connect_ssh_port ⇒ Integer^?

  SSH port to connect to server during transfer of file.

• #file_pull ⇒ Symbol^?

  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.

• #file_pull_timeout ⇒ Integer^?

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

• #file_system ⇒ String^?

  The remote file system of the device.

• #local_file ⇒ String^?

  When (file_pull is False) this is the path to the local file on the Ansible controller.

• #local_file_directory ⇒ Object^?

  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.

• #remote_file ⇒ String^?

  When (file_pull is False) this is the remote file path on the NXOS device.

• #remote_scp_server ⇒ String^?

  The remote scp server address which is used to pull the file.

• #remote_scp_server_password ⇒ String^?

  The remote scp server password which is used to pull the file.

• #remote_scp_server_user ⇒ String^?

  The remote scp server username which is used to pull the file.

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

#connect_ssh_port ⇒ Integer^?

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

attribute :connect_ssh_port

#file_pull ⇒ Symbol^?

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

attribute :file_pull

#file_pull_timeout ⇒ Integer^?

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

attribute :file_pull_timeout

#file_system ⇒ String^?

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

attribute :file_system

#local_file ⇒ String^?

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

attribute :local_file

#local_file_directory ⇒ Object^?

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

attribute :local_file_directory

#remote_file ⇒ String^?

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

attribute :remote_file

#remote_scp_server ⇒ String^?

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

attribute :remote_scp_server

#remote_scp_server_password ⇒ String^?

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

attribute :remote_scp_server_password

#remote_scp_server_user ⇒ String^?

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

attribute :remote_scp_server_user