Class: Ansible::Ruby::Modules::Net_put

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

Overview

This module provides functionality to copy file from Ansible controller to network devices.

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

#dest ⇒ String?

Returns Specifies the destination file. The path to destination file can either be the full path or relative path as supported by network_os.

Returns:

  • (String, nil) —

    Specifies the destination file. The path to destination file can either be the full path or relative path as supported by network_os.



20
 
# File 'lib/ansible/ruby/modules/generated/network/files/net_put.rb', line 20

attribute :dest

#mode ⇒ :binary, ...

Returns Set the file transfer mode. If mode is set to I(template) then I(src) file will go through Jinja2 template engine to replace any vars if present in the src file. If mode is set to I(binary) then file will be copied as it is to destination device.

Returns:

  • (:binary, :text, nil) —

    Set the file transfer mode. If mode is set to I(template) then I(src) file will go through Jinja2 template engine to replace any vars if present in the src file. If mode is set to I(binary) then file will be copied as it is to destination device.



24
 
# File 'lib/ansible/ruby/modules/generated/network/files/net_put.rb', line 24

attribute :mode

#protocol ⇒ :scp, ...

Returns Protocol used to transfer file.

Returns:

  • (:scp, :sftp, nil) —

    Protocol used to transfer file.



16
 
# File 'lib/ansible/ruby/modules/generated/network/files/net_put.rb', line 16

attribute :protocol

#src ⇒ String

Returns Specifies the source file. The path to the source file can either be the full path on the Ansible control host or a relative path from the playbook or role root directory.

Returns:

  • (String) —

    Specifies the source file. The path to the source file can either be the full path on the Ansible control host or a relative path from the playbook or role root directory.



12
 
# File 'lib/ansible/ruby/modules/generated/network/files/net_put.rb', line 12

attribute :src