ansible.netcommon.cli_command module – Run a cli command on cli-based network devices
Note
This module is part of the ansible.netcommon collection (version 5.3.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install ansible.netcommon
.
To use it in a playbook, specify: ansible.netcommon.cli_command
.
New in ansible.netcommon 1.0.0
Synopsis
Sends a command to a network device and returns the result read from the device.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
The answer to reply with if prompt is matched. The value can be a single answer or a list of answer for multiple prompts. In case the command execution results in multiple prompts the sequence of the prompt and excepted answer should be in same order. |
|
By default if any one of the prompts mentioned in Choices:
|
|
The command to send to the remote network device. The resulting output from the command is returned, unless sendonly is set. |
|
The boolean value, that when set to false will send answer to the device without a trailing newline. Choices:
|
|
A single regex pattern or a sequence of patterns to evaluate the expected prompt from command. |
|
The boolean value, that when set to true will send command to the device but not wait for a result. Choices:
|
Notes
Note
This module is supported on
ansible_network_os
network platforms. See the :ref:`Network Platform Options <platform_options>` for details.
Examples
- name: run show version on remote devices
ansible.netcommon.cli_command:
command: show version
- name: run command with json formatted output
ansible.netcommon.cli_command:
command: show version | json
- name: run command expecting user confirmation
ansible.netcommon.cli_command:
command: commit replace
prompt: This commit will replace or remove the entire running configuration
answer: yes
- name: run command expecting user confirmation
ansible.netcommon.cli_command:
command: show interface summary
prompt: Press any key to continue
answer: y
newline: false
- name: run config mode command and handle prompt/answer
ansible.netcommon.cli_command:
command: '{{ item }}'
prompt:
- Exit with uncommitted changes
answer: y
loop:
- configure
- set system syslog file test any any
- exit
- name: multiple prompt, multiple answer (mandatory check for all prompts)
ansible.netcommon.cli_command:
command: copy sftp sftp://user@host//user/test.img
check_all: true
prompt:
- Confirm download operation
- Password
- Do you want to change that to the standby image
answer:
- y
- <password>
- y
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary representing a JSON-formatted response Returned: when the device response is valid JSON Sample: |
|
The response from the command Returned: when sendonly is false Sample: |