community.general.pn_show (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

Execute show command in the nodes and returns the results read from the device.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: run the vlan-show command
  pn_show:
    pn_command: 'vlan-show'
    pn_parameters: id,scope,ports
    pn_options: 'layout vertical'

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: run the vlag-show command
  pn_show:
    pn_command: 'vlag-show'
    pn_parameters: 'id,name,cluster,mode'
    pn_options: 'no-show-headers'

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: run the cluster-show command
  pn_show:
    pn_command: 'cluster-show'

Inputs

    
pn_command:
    description:
    - The C(pn_command) takes a CLI show command as value.
    required: true

pn_options:
    description:
    - Specify formatting options.

pn_cliswitch:
    description:
    - Target switch(es) to run the cli on.
    required: false

pn_parameters:
    default: all
    description:
    - Display output using a specific parameter. Use 'all' to display possible output.
      List of comma separated parameters.

pn_clipassword:
    description:
    - Provide login password if user is not root.
    required: false

pn_cliusername:
    description:
    - Provide login username if user is not root.
    required: false

Outputs

changed:
  description: Indicates whether the CLI caused any change on the target.
  returned: always(False)
  type: bool
command:
  description: The CLI command run on the target node(s).
  returned: always
  type: str
stderr:
  description: The set of error responses from the show command.
  returned: on error
  type: list
stdout:
  description: The set of responses from the show command.
  returned: always
  type: list