Cisco IOS Switch Cisco IOS Switch: Inputs & Outputs

Summary

Each plugin uses a set of dictionaries to store data.

These are used by plugin actions as both inputs and outputs.

This page will cover:

  • The dictionaries used in this plugin
  • The information each dictionary contains

Info

See Interfaces, VLANs, & Config for each action's inputs & outputs.

Dictionary Types

CiscoSwitch

  • Contains SSH connection details for an IOS switch

  • It is used as an input to many of the actions in this plugin

  • The example below shows the dictionary structure in YAML

Supplying Credentials

You should always use a PPA Vault integration to provide credentials to a plugin action.

Example

1
2
3
4
5
6
7
cisco_switch:
  address: 1.2.3.4
  port: 22
  username: [username]
  password: [password]
  base_prompt: >
    ^\w+\-.*([>#]|\(.*\)[>#])

Required Keys

address: The target IP or DNS address.

port: The target SSH port.

username: Username for authentication.

password: Password for authentication.

base_prompt: A regular expression representing the SSH command prompt.

Interface

  • Contains switch interface properties

All Interface Keys

port: the interface port

name: the interface name

status: the current interface status

vlan: the ID of the VLAN the interface is currently assigned to

duplex: the interface duplicity

speed: the interface speed

type: the type of the interface

Interface YAML Structure

1
2
3
4
5
6
7
  port: Gi0/3
  name: VCenter
  status: connect
  vlan: 200
  duplex: a-full
  speed: a-1000
  type: 10/100/1000BaseTX

VLAN

  • Contains switch VLAN properties

All VLAN Keys

name: the VLAN name

status: the current VLAN status

interfaces: a list of interface ports currently assigned to the VLAN

VLAN YAML Structure

1
2
3
4
5
6
  name: VoIP
  status: active
  interfaces:
    - Gi02
    - Gi03
    - Gi04