Skip to content

8 1. show commands

Jump to bottom
Yusuke Ogawa edited this page Jan 15, 2026 · 4 revisions

What you can do with this procedure

The following show commands can be executed from the CLI

Basic syntax

python [file path]/network_sketcher.py [command] --master [master file path]

Add --one_msg option to display output on a single line

python [file path]/network_sketcher.py [command] --master [master file path] --one_msg
  • The location of [command], --one_msg, and --master [master file path] can be changed as follows
    python [file path]/network_sketcher.py --one_msg -master [master file path] [command]

show area

Displays all area names.

python [file path]/network_sketcher.py show area　--master [master file path]
  • ex.
    ＃python .\network_sketcher.py show area　--master "C:\work\[MASTER]test.xlsx"
    DC-TOP1
    DC-TOP2
    DC-TOP3

show area_device

Displays all device names in each area.

python [file path]/network_sketcher.py show area_device　--master [master file path]
  • ex.
    ＃python .\network_sketcher.py show area_device　--master "C:\work\[MASTER]test.xlsx"
    ['Site1', ['L2sw-x', 'L3sw-1', 'L3sw-2', 'R-1', 'R-2']]

show area_location

Displays area placement information. Relative location information. '_AIR_' indicates a blank area.

python [file path]/network_sketcher.py show area_location　--master [master file path]
  • ex.
    ＃python .\network_sketcher.py show area_location　--master "C:\work\[MASTER]test.xlsx"
    ['DC-TOP1', 'DC-TOP2', 'DC-TOP3']
    ['Site1', 'Site2', '_AIR_']

show attribute

Displays attributes for all devices. It also displays the color of the cell specified by the attribute.
The item following the device name displays the color of the cell for the device name with the value of [R,G,B].

python [file path]/network_sketcher.py show attribute　--master [master file path]
  • ex.
    ＃python .\network_sketcher.py show attribute　--master "C:\work\[MASTER]test.xlsx"
    ['Device Name', 'Default', 'Model', 'Attribute-B', 'Attribute-C', 'Attribute-D', 'Attribute-E', 'Attribute-F', 'Attribute-G', 'Attribute-H']
    ['ACCESS-SW1', "['DEVICE',[235, 241, 222]]", "['Catalyst9200', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]"]
    ['WLC-9800', "['DEVICE',[235, 241, 222]]", "['Catalyst9800', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]"]

In this example, the device name ACCESS-SW1 has a Model's attribute value of Catalyst9200 and an RGP Color of [255, 255, 255].

show device

Displays all device names.

python [file path]/network_sketcher.py show device　--master [master file path]
  • ex.
    ＃python .\network_sketcher.py show device　--master "C:\work\[MASTER]test.xlsx"
    DEVICE1
    DEVICE10
    DEVICE11
    DEVICE12

show device_interface

Displays all interface names for all devices.

python [file path]/network_sketcher.py show device_interface　--master [master file path]
  • ex.
    ＃python .\network_sketcher.py show device_interface　--master "C:\work\[MASTER]test.xlsx"
    ['DEVICE6', ['GigabitEthernet 0/3']]
    ['DEVICE5', ['GigabitEthernet 0/4']]
    ['DEVICE10', ['GigabitEthernet 0/5']]

show device_location

Displays device placement information within each area. It is relative location information.' AIR' means blank.

python [file path]/network_sketcher.py show device_location　--master [master file path]

  • ex.
    ＃python .\network_sketcher.py show device_location　--master "C:\work\[MASTER]test.xlsx"
    ['tmp', [['AIR', 'AIR', 'AIR', 'AIR', 'AIR', 'DEVICE1', 'DEVICE2', 'AIR'], ['AIR', 'AIR', 'AIR', 'AIR', 'AIR', 'AIR', 'AIR', 'DEVICE3'], ['AIR', 'AIR', 'DEVICE4', 'AIR', 'AIR', 'DEVICE5', 'DEVICE6', 'DEVICE7'], ['DEVICE8', 'DEVICE9', 'DEVICE10', 'DEVICE11', 'DEVICE12', 'AIR', 'AIR', 'AIR']]]

  • explanation Area name:tmp
    Device location:
    ['AIR', 'AIR', 'AIR', 'AIR', 'AIR', 'DEVICE1', 'DEVICE2', 'AIR']
    ['AIR', 'AIR', 'AIR', 'AIR', 'AIR', 'AIR', 'AIR', 'DEVICE3']
    ['AIR', 'AIR', 'DEVICE4', 'AIR', 'AIR', 'DEVICE5', 'DEVICE6', 'DEVICE7']
    ['DEVICE8', 'DEVICE9', 'DEVICE10', 'DEVICE11', 'DEVICE12', 'AIR', 'AIR', 'AIR']

show l1_interface

Displays detailed information on all L1 interfaces for each device.

python [file path]/network_sketcher.py show l1_interface　--master [master file path]
  • ex.
    ＃python .\network_sketcher.py show l1_interface　--master "C:\work\[MASTER]test.xlsx"
    ['DEVICE1', 'GE 0/0', 'GigabitEthernet 0/0', 'Auto', 'Auto', '1000BASE-T']
    ['DEVICE1', 'GE 0/2', 'GigabitEthernet 0/2', 'Auto', 'Auto', '1000BASE-T']
    ['DEVICE1', 'GE 0/4', 'GigabitEthernet 0/4', 'Auto', 'Auto', '1000BASE-T']
    ['DEVICE10', 'GE 0/5', 'GigabitEthernet 0/5', 'Auto', 'Auto', '1000BASE-T']

show L1_link

Displays Layer 1 (L1) physical wiring information per link.

  • Each output line represents one physical link.
  • Each line contains two endpoints: [[Device-A, Interface-A], [Device-B, Interface-B]].
  • The left/right order in the output is not meaningful (either endpoint may appear on the left).
  • Therefore, when identifying or deleting a link, you can treat either endpoint (device + interface) as the “from” side.
python [file path]/network_sketcher.py show l1_link　--master [master file path]
  • ex.
    ＃python .\network_sketcher.py show l1_link　--master "C:\work\[MASTER]test.xlsx"
    [['DEVICE1', 'GigabitEthernet 0/0'], ['DEVICE4', 'GigabitEthernet 0/0']]
    [['DEVICE1', 'GigabitEthernet 0/4'], ['DEVICE5', 'GigabitEthernet 0/4']]
    [['DEVICE10', 'GigabitEthernet 0/5'], ['DEVICE4', 'GigabitEthernet 0/5']]
  • Notes
    • show l1_link shows only existing links. Interfaces that are not connected by an L1 link will not appear.
    • To delete an L1 link, specify one endpoint (device + interface). The peer endpoint will be determined automatically by the tool (see delete l1_link).

show l2_broadcast_domain

Displays the name of the Layer 2 segment included in each broadcast domain.

python [file path]/network_sketcher.py show l2_boradcast_domain　--master [master file path]
  • ex.
    ＃python .\network_sketcher.py show l2_broadcast_domain　--master "C:\work\[MASTER]test.xlsx"
    [[[1], ['Sever-131', 'vlan300']]]
    [[2, 3, 4, 5], [['Sever-141', 'vlan800'], ['WAN-Dum3', 'L2SEGMENT']]]

*The first element, [1], represents the identifier of the broadcast domain; the second element, ['Sever-13~1~', 'vlan300'], represents the name of the Layer 2 segment connected to that broadcast domain. On the left is the device name and on the right is the Layer 2 segment name.
The second line is similar. The broadcast domain with identifiers [2, 3, 4, 5] has Layer 2 segments ['Sever-14~1~', 'vlan800'], ['WAN-Dum3', 'L2SEGMENT'] connected to it.

show l2_interface

Displays detailed information about the L2 interface, exported from the input-ready information in the DEVICE file.

python [file path]/network_sketcher.py show l2_interface　--master [master file path]
  • ex.
    ＃python .\network_sketcher.py show l2_interface　--master "C:\work\[MASTER]test.xlsx"
    ['FW-12', 'GigabitEthernet 0/32', '', '', '']
    ['FW-12', 'GigabitEthernet 0/33', '', '', '']
    ['FW-12', 'GigabitEthernet 0/36', '', '', '']
    ['FW-12', 'GigabitEthernet 0/37', '', '', '']

show l3_broadcast_domain

Displays the Layer 3 interface names included in each broadcast domain.

python [file path]/network_sketcher.py show l3_boradcast_domain　--master [master file path]
  • ex.
    ＃python .\network_sketcher.py show l3_broadcast_domain　--master "C:\work\[MASTER]test.xlsx"
    [[45], [['Sever-141', 'Loopback 0']]]
    [[48, 55], [['FW-122', 'GigabitEthernet 0/24'], ['Sever-132', 'GigabitEthernet 0/24']]]

*The first element, [45], represents the identifier of the broadcast domain; the second element, ['Sever-14~1~', 'Loopback 0'], represents the Layer 3 interface connected to that broadcast domain. On the left is the device name and on the right is the Layer 3 interface name.
The second line is similar. The broadcast domain with the identifier [48, 55] has two Layer 3 interfaces connected to it, ['FW-12~2~', 'GigabitEthernet 0/24'] and ['Sever-13~2~', 'GigabitEthernet 0/24'].

show l3_interface

Displays detailed information about the L3 interface, exported from the input-ready information in the DEVICE file.

python [file path]/network_sketcher.py show l3_interface　--master [master file path]
  • ex.
    ＃python .\network_sketcher.py show l3_interface　--master "C:\work\[MASTER]test.xlsx"
    ['FW-12', 'GigabitEthernet 0/32', '', '10.0.2.1/29']
    ['FW-12', 'GigabitEthernet 0/33', '', '10.0.2.9/29']
    ['FW-12', 'GigabitEthernet 0/36', '', '10.0.2.17/29']
    ['FW-12', 'GigabitEthernet 0/37', '', '10.0.2.25/29']
    ['FW-12', 'GigabitEthernet 0/38', '', '10.0.5.57/29']

show waypoint

Displays all waypoint names.

python [file path]/network_sketcher.py show waypoint　--master [master file path]
  • ex.
    ＃python .\network_sketcher.py show waypoint　--master "C:\work\[MASTER]test.xlsx"
    WAN-1
    WAN-Dum3

show waypoint_interface

Displays all interface names for each waypoint.

python [file path]/network_sketcher.py show waypoint_interface　--master [master file path]
  • ex.
    ＃python .\network_sketcher.py show waypoint_interface　--master "C:\work\[MASTER]test.xlsx"
    ['WAN-1', ['GigabitEthernet 0/0', 'GigabitEthernet 0/19', 'GigabitEthernet 0/31', 'GigabitEthernet 0/45', 'GigabitEthernet 0/46', 'GigabitEthernet 0/53', 'GigabitEthernet 0/54']]
    ['WAN-Dum3', ['GigabitEthernet 0/6', 'GigabitEthernet 0/10', 'GigabitEthernet 0/13', 'GigabitEthernet 0/14', 'GigabitEthernet 0/26']]

Author

  • Yusuke Ogawa - Security Architect, Cisco | CCIE#17583

License

SPDX-License-Identifier: Apache-2.0

Copyright 2023 Cisco Systems, Inc. and its affiliates

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

User_Guide[EN]

User_Guide[JP]

Clone this wiki locally