8‐4. Rename Commands_jp

Masterファイルを直接編集するため、実行前に必ずMasterファイルをバックアップしてください。

本手順でできること

CLIから以下のrenameコマンドを実行できます

rename area
rename attribute_bulk *Added in Ver 2.6.2
rename device
rename l3_instance
rename port
rename port_info_bulk *Added in Ver 2.6.2f

基本構文

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

以下のように[command] 、--master [master file path]　の場所は変更可能
python [file path]/network_sketcher.py -master [master file path] [command]

rename area

エリア名を変更します。

python [file path]/network_sketcher.py rename area [Original area name] [Updated area name] --master [master file path]

ex.

+BEFORE+
#python .\network_sketcher.py show area --master "C:\work\[MASTER]test.xlsx"
Area1
Area2
Area3

+Device renamed+
＃python .\network_sketcher.py rename area 'Area3' 'Area99' --master "C:\work\[MASTER]test.xlsx"
--- Area renamed --- Area3 -> Area99

+AFTER+
#python .\network_sketcher.py show area --master "C:\work\[MASTER]test.xlsx"
Area1
Area2
Area99

rename attribute_bulk

デバイスの属性（ヘッダー行を含む）を一括で変更します。このコマンドを使用すると、複数のデバイスとその属性値を1回の操作で更新できます。

構文
python [file path]/network_sketcher.py rename attribute_bulk [attribute_array] --master [master file path]

配列形式
属性配列は次の形式を使用します。

デバイス属性行（RGB カラー値付き）の場合: [device_name, "['attribute_value',[R,G,B]]", "['attribute_value',[R,G,B]]", ...]

ヘッダー行（RGB値のない列名）の場合： ['Device Name', 'Column1', 'Column2', 'Column3', ...]

複数のエントリの結合形式: [[device1_entry],[device2_entry],['Device Name', header_columns...]]

パラメータ

パラメータ	説明
device_name	更新するデバイスの名前
attribute_value	属性のテキスト値
R,G,B	属性セルの背景のRGBカラー値（0～255）
'Device Name'	ヘッダー行の特別な識別子

注記

RGB値は0～255の整数である必要があります
空の属性には"['', [255, 255, 255]]"（白背景）を使用してください
ヘッダー行のエントリは「デバイス名」で始まる必要があります
デバイスエントリとヘッダー行は、同じコマンド内で混在可能です
各デバイス/ヘッダーエントリには、最大9つの属性列が必要です（デバイス名列を除く）

例

例 1: 単一デバイス属性の更新
python .\network_sketcher.py rename attribute_bulk "[['L3SW1', "['DEVICE',[235, 241, 222]]", "['Cisco', [255,183,219]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]"]]" --master "C:\work[MASTER]test.xlsx"

例 2: 複数のデバイスを更新する
python .\network_sketcher.py rename attribute_bulk "[['ACCESS-SW1', "['DEVICE',[235, 241, 222]]", "['Catalyst9200', [255,183,219]]", "['', [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,183,219]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]"]]" --master "C:\work[MASTER]test.xlsx"

例 3: デバイスとヘッダー行を一緒に更新する
python .\network_sketcher.py rename attribute_bulk "[['ACCESS-SW1', "['DEVICE',[235, 241, 222]]", "['Catalyst9200', [255,183,219]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['TEST-Value', [235, 241, 22]]"],['WLC-9800', "['DEVICE',[235, 241, 222]]", "['Catalyst9800', [255,183,219]]", "['LAST VALUE', [100, 100, 100]]", "['', [255, 255, 255]]", "['TEST333', [200, 200, 200]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]"],['Device Name', 'Model name', 'Model', 'Attribute-B', 'Attribute-C', 'Attribute-D', 'Attribute-E', 'Attribute-F', 'LAST CHECK', 'TEST-B-NAME']]" --master "C:\work[MASTER]test.xlsx"

動作例 Before/After

+BEFORE+
#python .\network_sketcher.py show attribute --master "C:\work[MASTER]test.xlsx" ['Device Name', 'Default', 'Model', 'OS', 'Attribute-C', 'Attribute-D', 'Attribute-E', 'Attribute-F', 'Attribute-G', 'Others'] ['ACCESS-SW1', "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]"] ['WLC-9800', "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]"]

+Attribute bulk renamed+
#python .\network_sketcher.py rename attribute_bulk "[['ACCESS-SW1', "['DEVICE',[235, 241, 222]]", "['Catalyst9200', [255,183,219]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['TEST-Value', [235, 241, 22]]"],['WLC-9800', "['DEVICE',[235, 241, 222]]", "['Catalyst9800', [255,183,219]]", "['LAST VALUE', [100, 100, 100]]", "['', [255, 255, 255]]", "['TEST333', [200, 200, 200]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]"],['Device Name', 'Model name', 'Model', 'Attribute-B', 'Attribute-C', 'Attribute-D', 'Attribute-E', 'Attribute-F', 'LAST CHECK', 'TEST-B-NAME']]" --master "C:\work[MASTER]test.xlsx" --- Attribute bulk rename completed --- Successfully updated: 3 entry(ies) Updated: ACCESS-SW1, WLC-9800, Device Name (Header)

+AFTER+
#python .\network_sketcher.py show attribute --master "C:\work[MASTER]test.xlsx" ['Device Name', 'Model name', 'Model', 'Attribute-B', 'Attribute-C', 'Attribute-D', 'Attribute-E', 'Attribute-F', 'LAST CHECK', 'TEST-B-NAME'] ['ACCESS-SW1', "['DEVICE', [235, 241, 222]]", "['Catalyst9200', [255, 183, 219]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['TEST-Value', [235, 241, 22]]"] ['WLC-9800', "['DEVICE', [235, 241, 222]]", "['Catalyst9800', [255, 183, 219]]", "['LAST VALUE', [100, 100, 100]]", "['', [255, 255, 255]]", "['TEST333', [200, 200, 200]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]", "['', [255, 255, 255]]"]

一般的なRGBカラーの例

Color	RGB Value	Usage Example
White (empty)	[255, 255, 255]	"['', [255, 255, 255]]"
Light Green	[235, 241, 222]	"['DEVICE', [235, 241, 222]]"
Light Pink	[255, 183, 219]	"['Catalyst9200', [255, 183, 219]]"
Light Gray	[200, 200, 200]	"['TEST', [200, 200, 200]]"
Light Yellow	[235, 241, 22]	"['WARNING', [235, 241, 22]]"

rename device

デバイス名を変更します。

python [file path]/network_sketcher.py rename device [Original device name] [Updated device name] --master [master file path]

ex.

+BEFORE+
#python .\network_sketcher.py show device --master "C:\work\[MASTER]test.xlsx"
L3SW1
L3SW2

+Device renamed+
＃python .\network_sketcher.py rename device 'L3SW1' 'L3SW100' --master "C:\work\[MASTER]test.xlsx"
--- Device Name renamed --- L3SW1 -> L3SW100

+AFTER+
#python .\network_sketcher.py show device --master "C:\work\[MASTER]test.xlsx"
L3SW100
L3SW2

rename l3_instance

レイヤ3インタフェースが所属するVRFのようなl3_instanceを変更します。デフォルトでは全てのレイヤ３インタフェースはDefaultを意味する空欄''が設定されています。仮に１つのレイヤ３インターフェースのl3_instance名を変更すると、空欄''が設定されているその他全てのl3_instanceはDefaultのl3_instanceが設定された状態と同じ意味となります。

python [file path]/network_sketcher.py rename l3_instance [device name] [layer3 port name] [Renamed l3_instance name] --master [master file path]

ex.

+BEFORE+
#python .\network_sketcher.py show l3_interface --master "C:\work\[MASTER]test.xlsx"
['devcie1', 'GigabitEthernet 0/0', '', '']

+l3_interface renamed+
＃python .\network_sketcher.py rename l3_instance 'devcie1' 'GigabitEthernet 0/0' 'VRF-1' --master "C:\work\[MASTER]test.xlsx"
--- l3 instance renamed --- devcie1,GigabitEthernet 0/0,VRF-10

+AFTER+
#python .\network_sketcher.py show l3_interface --master "C:\work\[MASTER]test.xlsx"
['devcie1', 'GigabitEthernet 0/0', 'VRF-1', '']

rename port

ポート名及びポート番号を変更します。

python [file path]/network_sketcher.py rename port [device name] [Original port name] [Updated port name] --master [master file path]

ex.

+BEFORE+
#python .\network_sketcher.py show l1_interface --master "C:\work\[MASTER]test.xlsx"
['L3SW1', 'GE 0/0', 'GigabitEthernet 0/0', 'Auto', 'Auto', '1000BASE-T']
['L3SW2', 'GE 0/0', 'GigabitEthernet 0/0', 'Auto', 'Auto', '1000BASE-T']

#python .\network_sketcher.py show l2_interface --master "C:\work\[MASTER]test.xlsx"
['L3SW1', '', 'Vlan 201', 'Vlan100', '']
['L3SW1', '', 'Vlan 200', 'Vlan200', '']
['L3SW1', '', 'Vlan 300', 'Vlan300', '']
['L3SW1', 'GigabitEthernet 0/0', '', 'Vlan100,Vlan200,Vlan300', '']
['L3SW2', '', 'Vlan 201', 'Vlan100', '']
['L3SW2', '', 'Vlan 200', 'Vlan200', '']
['L3SW2', '', 'Vlan 202', 'Vlan300', '']
['L3SW2', 'GigabitEthernet 0/0', '', 'Vlan100,Vlan200,Vlan300', '']

#python .\network_sketcher.py show l3_interface --master "C:\work\[MASTER]test.xlsx"
['L3SW1', 'Vlan 201', '', '']
['L3SW1', 'Vlan 200', '', '']
['L3SW1', 'Vlan 300', '', '']
['L3SW2', 'Vlan 201', '', '']
['L3SW2', 'Vlan 200', '', '']
['L3SW2', 'Vlan 202', '', '']

+Port renamed+
＃python .\network_sketcher.py rename port 'L3SW1' 'GigabitEthernet 0/0' 'FastEthernet 1/1' --master "C:\work\[MASTER]test.xlsx"
--- Physical Port Name renamed --- L3SW1 GigabitEthernet 0/0 -> FastEthernet 1/1

＃python .\network_sketcher.py rename port 'L3SW2' 'Vlan 200' 'Vlan 999' --master "C:\work\[MASTER]test.xlsx"
--- Virtual Port Name renamed --- L3SW2 Vlan 200 -> Vlan 999

+AFTER+
#python .\network_sketcher.py show l1_interface --master "C:\work\[MASTER]test.xlsx"
['L3SW1', 'FE 1/1', 'FastEthernet 1/1', 'Auto', 'Auto', '1000BASE-T']
['L3SW2', 'GE 0/0', 'GigabitEthernet 0/0', 'Auto', 'Auto', '1000BASE-T']

#python .\network_sketcher.py show l2_interface --master "C:\work\[MASTER]test.xlsx"
['L3SW1', '', 'Vlan 201', 'Vlan100', '']
['L3SW1', '', 'Vlan 200', 'Vlan200', '']
['L3SW1', '', 'Vlan 300', 'Vlan300', '']
['L3SW1', 'FastEthernet 1/1', '', 'Vlan100,Vlan200,Vlan300', '']
['L3SW2', '', 'Vlan 201', 'Vlan100', '']
['L3SW2', '', 'Vlan 999', 'Vlan200', '']
['L3SW2', '', 'Vlan 202', 'Vlan300', '']
['L3SW2', 'GigabitEthernet 0/0', '', 'Vlan100,Vlan200,Vlan300', '']

#python .\network_sketcher.py show l3_interface --master "C:\work\[MASTER]test.xlsx"
['L3SW1', 'Vlan 201', '', '']
['L3SW1', 'Vlan 200', '', '']
['L3SW1', 'Vlan 300', '', '']
['L3SW2', 'Vlan 201', '', '']
['L3SW2', 'Vlan 999', '', '']
['L3SW2', 'Vlan 202', '', '']

rename port_info_bulk

複数のポートの情報 (Speed、Duplex、Port_Type) を一括で変更します。

構文

python [file path]/network_sketcher.py rename port_info_bulk [port_info_array] --master [master file path]

ポート配列部のフォーマット

ポート情報配列は次の形式を使用します。

[["device_name1","port_name1",["Speed1","Duplex1","Port_Type1"]],["device_name2","port_name2",["Speed2","Duplex2","Port_Type2"]]]

パラメータ

パラメータ	説明
device_name	The name of the device
port_name	The port name (abbreviated form like "TE 1/0/1" or full form like "TenGigabitEthernet 1/0/1")
Speed	Port speed value (e.g., "Auto", "1Gbps", "10Gbps", "N/A")
Duplex	Duplex mode (e.g., "Auto", "Full", "Half", "N/A")
Port_Type	Port type (e.g., "1000BASE-T", "10GBASE-SR", "N/A")

注記

ポート名は省略形（例：TE 1/0/1）または完全形（例：TenGigabitEthernet 1/0/1）で指定できます。
1回のコマンドで複数のポートを更新できます。
ポートが見つからない場合は、結果メッセージにその旨が報告されます。

例
例 1: 単一ポート情報の更新

#python .\network_sketcher.py rename port_info_bulk "[['DIST-CORE-SW1','TE 1/0/1',['10Gbps','Full','10GBASE-SR']]]" --master "C:\work[MASTER]test.xlsx"

例 2: 複数のポートの更新
python .\network_sketcher.py rename port_info_bulk "[['DIST-CORE-SW1','TE 1/0/1',['10Gbps','Full','10GBASE-SR']],['DIST-CORE-SW2','TE 1/0/1',['10Gbps','Full','10GBASE-SR']],['ACCESS-SW1','GE 1/0/1',['1Gbps','Full','1000BASE-T']]]" --master "C:\work[MASTER]test.xlsx"

完全な例

+BEFORE+

#python .\network_sketcher.py show l1_interface --master "C:\work[MASTER]test.xlsx" ['DIST-CORE-SW1', 'TE 1/0/1', 'TenGigabitEthernet 1/0/1', 'N/A', 'N/A', 'N/A'] ['DIST-CORE-SW1', 'TE 1/0/2', 'TenGigabitEthernet 1/0/2', 'N/A', 'N/A', 'N/A'] ['DIST-CORE-SW2', 'TE 1/0/1', 'TenGigabitEthernet 1/0/1', 'N/A', 'N/A', 'N/A'] ['ACCESS-SW1', 'GE 1/0/1', 'GigabitEthernet 1/0/1', 'N/A', 'N/A', 'N/A']

+Port info bulk renamed+

#python .\network_sketcher.py rename port_info_bulk "[['DIST-CORE-SW1','TE 1/0/1',['10Gbps','Full','10GBASE-SR']],['DIST-CORE-SW1','TE 1/0/2',['10Gbps','Full','10GBASE-LR']],['ACCESS-SW1','GE 1/0/1',['1Gbps','Full','1000BASE-T']]]" --master "C:\work[MASTER]test.xlsx" --- Port info bulk rename completed --- Successfully updated: 3 port(s) Updated: DIST-CORE-SW1 TE 1/0/1, DIST-CORE-SW1 TE 1/0/2, ACCESS-SW1 GE 1/0/1

+AFTER+

#python .\network_sketcher.py show l1_interface --master "C:\work[MASTER]test.xlsx" ['DIST-CORE-SW1', 'TE 1/0/1', 'TenGigabitEthernet 1/0/1', '10Gbps', 'Full', '10GBASE-SR'] ['DIST-CORE-SW1', 'TE 1/0/2', 'TenGigabitEthernet 1/0/2', '10Gbps', 'Full', '10GBASE-LR'] ['DIST-CORE-SW2', 'TE 1/0/1', 'TenGigabitEthernet 1/0/1', 'N/A', 'N/A', 'N/A'] ['ACCESS-SW1', 'GE 1/0/1', 'GigabitEthernet 1/0/1', '1Gbps', 'Full', '1000BASE-T']

共通値

カテゴリ	共通の値(以下の値に限定されません)
Speed	Auto, N/A, 100Mbps, 1Gbps, 10Gbps, 25Gbps, 40Gbps, 100Gbps
Duplex	Auto, N/A, Full, Half
Port_Type	N/A, 1000BASE-T, 10GBASE-SR, 10GBASE-LR, 25GBASE-SR, 40GBASE-SR4, 100GBASE-SR4

Author

Yusuke Ogawa - Security Architect, Cisco | CCIE#17583

License

SPDX-License-Identifier: Apache-2.0

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.

8‐4. Rename Commands_jp

本手順でできること

基本構文

rename area

rename attribute_bulk

rename device

rename l3_instance

rename port

rename port_info_bulk

Author

License

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!