diff --git a/lib/ansible/modules/network/files/net_get.py b/lib/ansible/modules/network/files/net_get.py index 0352e82535..7c4dc5dfdd 100644 --- a/lib/ansible/modules/network/files/net_get.py +++ b/lib/ansible/modules/network/files/net_get.py @@ -18,9 +18,9 @@ DOCUMENTATION = """ module: net_get version_added: "2.6" author: "Deepak Agrawal (@dagrawal)" -short_description: Copy files from a network device to Ansible Controller +short_description: Copy a file from a network device to Ansible Controller description: - - This module provides functionlity to copy file from network device to + - This module provides functionality to copy file from network device to ansible controller. options: src: @@ -40,7 +40,7 @@ options: either be the full path on the Ansible control host or a relative path from the playbook or role root directory. default: - - Same filename as specified in src. The path will be playbook root + - Same filename as specified in I(src). The path will be playbook root or role root directory if playbook is part of a role. requirements: @@ -48,15 +48,15 @@ requirements: notes: - Some devices need specific configurations to be enabled before scp can work - These configuration should be pre-configued before using this module - e.g ios - C(ip scp server enable) - - User privileage to do scp on network device should be pre-configured - e.g. ios - need user privileage 15 by default for allowing scp - - Default destination of source file + These configuration should be pre-configured before using this module + e.g ios - C(ip scp server enable). + - User privilege to do scp on network device should be pre-configured + e.g. ios - need user privilege 15 by default for allowing scp. + - Default destination of source file. """ EXAMPLES = """ -- name: copy file from the network device to ansible controller +- name: copy file from the network device to Ansible controller net_get: src: running_cfg_ios1.txt diff --git a/lib/ansible/modules/network/files/net_put.py b/lib/ansible/modules/network/files/net_put.py index 14dafe32e1..4112b90f04 100644 --- a/lib/ansible/modules/network/files/net_put.py +++ b/lib/ansible/modules/network/files/net_put.py @@ -18,9 +18,9 @@ DOCUMENTATION = """ module: net_put version_added: "2.6" author: "Deepak Agrawal (@dagrawal)" -short_description: Copy files from Ansibe controller to a network device +short_description: Copy a file from Ansible Controller to a network device description: - - This module provides functionlity to copy file from Ansible controller to + - This module provides functionality to copy file from Ansible controller to network devices. options: src: @@ -44,9 +44,9 @@ options: required: no mode: description: - - Set the file transfer mode. If mode is set to 'template' then src - file will go through jinja2 template engine to replace any vars if - present in src file. If mode is set to 'binary' then file will be + - 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. default: binary choices: ['binary', 'template'] @@ -57,10 +57,10 @@ requirements: notes: - Some devices need specific configurations to be enabled before scp can work - These configuration should be pre-configued before using this module + These configuration should be pre-configured before using this module e.g ios - C(ip scp server enable). - - User privileage to do scp on network device should be pre-configured - e.g. ios - need user privileage 15 by default for allowing scp. + - User privilege to do scp on network device should be pre-configured + e.g. ios - need user privilege 15 by default for allowing scp. - Default destination of source file. """