Cisco IOS Switch Cisco IOS Switch: VLANs

Summary

This module contains actions for viewing & managing VLANs on a Cisco IOS v15 switch.

See the Overview page for information on how actions in this plugin work.

Actions

cisco_ios_switch.vlans.

get_all

Get all VLANs from the switch.

Minimum Plugin Version: 1.0.0

Input
  • cisco_switch: a CiscoSwitch dictionary

  • progress_bar: set to true to display a progress bar when performing the operation (defaults to false)

  • prompt_timeout: the number of seconds to wait for commands to complete (defaults to 5)

  • connection_timeout: the number of seconds to wait for the connection to establish (defaults to 10)

Output

A list of VLAN Dictionaries.

Example
1
2
3
4
- cisco_ios_switch.vlans.get_all:
  load:
    cisco_switch: cisco_switch
  save: vlans

cisco_ios_switch.vlans.

input_table

Display a list of VLANs in a table, and allow the task operator to make a selection.

The table will have the following columns:

  • Name
  • Status
  • Interfaces

Minimum Plugin Version: 1.0.0

Input
  • text: the title of the table

  • vlan_list: a list of VLAN Dictionaries

  • exclude_vlans: a list of VLAN names to exclude from the table (defaults to null)

  • minimum: the minimum number of acceptable selections (defaults to null)

  • maximum: the maximum number of acceptable selections (defaults to null)

Output

A list of VLAN Dictionaries.

Example
  • Getting all interfaces from the switch and saving them as variable all_interfaces.

  • Displaying all interfaces other than the uplink, and saving the selection as chosen_interfaces.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
- cisco_ios_switch.vlans.get_all:
  load:
    cisco_switch: cisco_switch
  save: all_vlans

- cisco_ios_switch.vlans.input_table:
    text: Please Select an Interface
    exclude_vlans:
      - Development VLAN
    minimum: 1
    maximum: 1
  load:
    vlan_list: all_vlans
  save: selected_vlan

cisco_ios_switch.vlans.

output_table

Display a list of VLANs in a table.

The table will have the following columns:

  • Name
  • Status
  • Interfaces

Minimum Plugin Version: 1.0.0

Input
  • text: the title of the table

  • vlan_list: a list of VLAN Dictionaries

  • exclude_vlans: a list of VLAN names to exclude from the table (defaults to null)

  • expand_ports: set to true to list interface names in the table (defaults to false, showing the count instead)

Output

Nothing is outputted by this action.

Example
1
2
3
4
5
6
7
8
9
- cisco_ios_switch.vlans.get_all:
  load:
    cisco_switch: cisco_switch
  save: all_vlans

- cisco_ios_switch.vlans.output_table:
    text: All VLANs
  load:
    interface_list: all_vlans