community.network.pn_show – Run show commands on nvOS device.
Note
This plugin is part of the community.network collection (version 1.3.0).
To install it use: ansible-galaxy collection install community.network.
To use it in a playbook, specify: community.network.pn_show.
DEPRECATED
- Removed in
-
version 2.0.0
- Why
-
Doesn’t support latest Pluribus Networks netvisor
- Alternative
-
Latest modules will be pushed in Ansible future versions.
Synopsis
- Execute show command in the nodes and returns the results read from the device.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| pn_clipassword
string
|
Provide login password if user is not root.
|
|
| pn_cliswitch
string
|
Target switch(es) to run the cli on.
|
|
| pn_cliusername
string
|
Provide login username if user is not root.
|
|
| pn_command
string / required
|
The pn_command takes a CLI show command as value.
|
|
| pn_options
string
|
Specify formatting options.
|
|
| pn_parameters
string
|
Default:
"all"
|
Display output using a specific parameter. Use 'all' to display possible output. List of comma separated parameters.
|
Examples
- name: Run the vlan-show command
community.network.pn_show:
pn_command: 'vlan-show'
pn_parameters: id,scope,ports
pn_options: 'layout vertical'
- name: Run the vlag-show command
community.network.pn_show:
pn_command: 'vlag-show'
pn_parameters: 'id,name,cluster,mode'
pn_options: 'no-show-headers'
- name: Run the cluster-show command
community.network.pn_show:
pn_command: 'cluster-show'
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| changed
boolean
|
always(False) |
Indicates whether the CLI caused any change on the target.
|
| command
string
|
always |
The CLI command run on the target node(s).
|
| stderr
list / elements=string
|
on error |
The set of error responses from the show command.
|
| stdout
list / elements=string
|
always |
The set of responses from the show command.
|
Status
- This module will be removed in version 2.0.0. [deprecated]
- For more information see DEPRECATED.
Authors
- Pluribus Networks (@amitsi)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/pn_show_module.html