wbrawner/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

net_command: formatting (#20121)

Browse source 
* net_command: formatting

* Update net_command.py
This commit is contained in:
John R Barker 2017-01-11 08:22:19 +00:00 committed by GitHub
parent de21038feb
commit 8fe09d4ea9
1 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
lib/ansible/modules/network/basics/net_command.py
View file

@ -30,25 +30,27 @@ author: "Peter Sprygada (@privateip)"
short_description: Executes a common on a remote network device short_description: Executes a common on a remote network device
description: description:
- This module will take the command and execute it on the remote - This module will take the command and execute it on the remote
device in a CLI shell. The command will outout will be returned device in a CLI shell. The command will output will be returned
via the stdout return key. If an error is detected, the command via the stdout return key. If an error is detected, the command
will return the error via the stderr key. will return the error via the stderr key.
options: options:
free_form: free_form:
description: description:
- A free form command to run on the remote host. There is no - A free form command to run on the remote host. There is no
parameter actually named 'free_form'. See the examples . parameter actually named 'free_form'. See the examples.
required: true required: true
notes: notes:
- This module requires setting the Ansible connection type to network_cli - This module requires setting the Ansible C(connection) type to C(network_cli).
- This module will always set the changed return key to C(True) - This module will always set the changed return key to C(True)
""" """
EXAMPLES = """ EXAMPLES = """
# Note: These examples assume 'connection' has been set to 'network_cli'.
- name: execute show version - name: execute show version
net_command: show version net_command: show version
- name: run a series of commmands - name: run a series of commands
net_command: "{{ item }}" net_command: "{{ item }}"
with_items: with_items:
- show interfaces - show interfaces