파이썬 netmiko 라이브러리로 네트워크 장비 접속

1. netmiko

네트워크 장비에 접속하기 위한 파이썬 라이브러리

지원 가능한 네트워크 장비 OS가 별도로 있음

netmiko/PLATFORMS.md

Supported Platforms

Regularly tested

• Arista vEOS
• Cisco ASA
• Cisco IOS
• Cisco IOS-XE
• Cisco IOS-XR
• Cisco NX-OS
• Cisco SG300
• HP ProCurve
• Juniper Junos
• Linux

Limited testing

• 6Wind
• Adtran OS
• Alcatel AOS6/AOS8
• Apresia Systems AEOS
• Broadcom ICOS
• Calix B6
• Centec Networks
• Cisco AireOS (Wireless LAN Controllers)
• CloudGenix ION
• Dell OS9 (Force10)
• Dell OS10
• Dell PowerConnect
• Ericsson IPOS
• Extreme ERS (Avaya)
• Extreme VSP (Avaya)
• Extreme VDX (Brocade)
• Extreme MLX/NetIron (Brocade/Foundry)
• HPE Comware7
• Huawei
• Huawei OLT
• Huawei SmartAX
• IP Infusion OcNOS
• Juniper ScreenOS
• Mellanox
• MikroTik RouterOS
• MikroTik SwitchOS
• NetApp cDOT
• Netgear ProSafe
• Nokia/Alcatel SR OS
• OneAccess
• Palo Alto PAN-OS
• Pluribus
• Ruckus ICX/FastIron
• Ruijie Networks
• Supermicro SMIS
• TPLink JetStream
• Ubiquiti EdgeSwitch
• Vyatta VyOS
• Yamaha
• ZTE ZXROS

Experimental

• A10
• Accedian
• Allied Telesis AlliedWare Plus
• Aruba
• Brocade Fabric OS
• C-DOT CROS
• Ciena SAOS
• Citrix Netscaler
• Cisco Telepresence
• Cisco Viptela
• Check Point GAiA
• Coriant
• Dell OS6
• Dell EMC Isilon
• Eltex
• Enterasys
• Endace
• Extreme EXOS
• Extreme Wing
• Extreme SLX (Brocade)
• F5 TMSH
• F5 Linux
• Fortinet
• MRV Communications OptiSwitch
• MRV LX
• Nokia/Alcatel SR-OS
• QuantaMesh
• Rad ETX
• Raisecom ROAP
• Sophos SFOS
• Ubiquiti Unifi Switch
• Versa Networks FlexVNF
• Watchguard Firebox
• 6WIND TurboRouter

아래 사이트들을 통하여 라이브러리의 다양한 정보들을 참고할 수 있음!

netmiko ▶️ https://ktbyers.github.io/netmiko/docs/netmiko/index.html

netmiko API documentation

netmiko github ▶️ https://github.com/ktbyers/netmiko

GitHub - ktbyers/netmiko: Multi-vendor library to simplify Paramiko SSH connections to network devices

 

2. netmiko 설치

▶️ pip3 install netmiko

 

3. 장비 접속

device type 확인 후 접속을 위한 정보(IP, Account 정보, Port 등) 입력

'device_type' currently supported platforms are: 

• a10
• accedian
• adtran_os
• alcatel_aos
• alcatel_sros
• allied_telesis_awplus
• apresia_aeos
• arista_eos
• aruba_os
• aruba_osswitch
• aruba_procurve
• avaya_ers
• avaya_vsp
• broadcom_icos
• brocade_fastiron
• brocade_fos
• brocade_netiron
• brocade_nos
• brocade_vdx
• brocade_vyos
• calix_b6
• cdot_cros
• centec_os
• checkpoint_gaia
• ciena_saos
• cisco_asa
• cisco_ftd
• cisco_ios
• cisco_nxos
• cisco_s300
• cisco_tp
• cisco_wlc
• cisco_xe
• cisco_xr
• cloudgenix_ion
• coriant
• dell_dnos9
• dell_force10
• dell_isilon
• dell_os10
• dell_os6
• dell_os9
• dell_powerconnect
• dlink_ds
• eltex
• eltex_esr
• endace
• enterasys
• ericsson_ipos
• extreme
• extreme_ers
• extreme_exos
• extreme_netiron
• extreme_nos
• extreme_slx
• extreme_vdx
• extreme_vsp
• extreme_wing
• f5_linux
• f5_ltm
• f5_tmsh
• flexvnf
• fortinet
• generic
• generic_termserver
• hp_comware
• hp_procurve
• huawei
• huawei_olt
• huawei_smartax
• huawei_vrpv8
• ipinfusion_ocnos
• juniper
• juniper_junos
• juniper_screenos
• keymile
• keymile_nos
• linux
• mellanox
• mellanox_mlnxos
• mikrotik_routeros
• mikrotik_switchos
• mrv_lx
• mrv_optiswitch
• netapp_cdot
• netgear_prosafe
• netscaler
• nokia_sros
• oneaccess_oneos
• ovs_linux
• paloalto_panos
• pluribus
• quanta_mesh
• rad_etx
• raisecom_roap
• ruckus_fastiron
• ruijie_os
• sixwind_os
• sophos_sfos
• supermicro_smis
• tplink_jetstream
• ubiquiti_edge
• ubiquiti_edgerouter
• ubiquiti_edgeswitch
• ubiquiti_unifiswitch
• vyatta_vyos
• vyos
• watchguard_fireware
• yamaha
• zte_zxros

from netmiko import ConnectHandler

inform = {
    'device_type': '장비 TYPE',
    'ip': '장비 IP',
    'username': '접속 ID',
    'password': '접속 Password',
    'secret': 'Enable Password',
    'port': 'SSH Port(22면 생략)',
}

net_connect = ConnectHandler(**inform) #dict 형태이기 때문에 ** 붙여주세요

 

4. Enable 모드 접속

Enable 모드가 필요한 커맨드일 경우 Eanble 모드로 변경

net_connect.enable() #접속
net_connect.exit_enable_mode() #종료

net_connect.check_enable_mode #Enable 모드면 True, 아니면 False

 

5. Config 모드 접속

Config 모드가 필요한 커맨드일 경우 Config 모드로 변경

net_connect.config_mode() #접속
net_connect.exit_config_mode() #종료

net_connect.check_config_mode #Config 모드면 True, 아니면 False

 

5. 커맨드  전송

send_command('커맨드')

- 한개의 커맨드 전송

 

send_config_set('커맨드')

- Config 모드에서 여러개의 커맨드 전송

 

send_config_from_file('파일 이름')

- Config 모드에서 파일 전송

net_connect.send_command('커맨드')
net_connect.send_config_set('커맨드')
net_connect.send_config_from_file('파일 이름')

 

6. 그 외

find_prompt()

-현재 프롬프트 반환

 

commit()

- commit(commit이 필요한 OS만 사용)

 

disconnect()

- ssh 종료

net_connect.find_prompt()
net_connect.commit()
net_connect.disconnect()

 

7. 활용

목적

- 1분 간격으로 Interface Input Statistics 중 정상적이지 않은 패킷 모니터링

 

파이썬 코드

- netmiko : 네트워크 장비 접속하여 커맨드 전송

- matplotlib : 데이터 시각화

- pandas : 데이터 전처리

- 소프트웨어 개발자가 아니라,,, 효율적인 좋은 코드가 아닐 수도 있습니다 🤔

- 일단은 결과 확인을 위하여 1분 간격으로 5분의 데이터를 확인해보겠습니다

from netmiko import ConnectHandler
from datetime import datetime
import matplotlib.pyplot as plt
import pandas as pd
import time

inform = {
    'device_type': '생략',
    'ip': '생략',
    'username': '생략',
    'password': '생략',
    'secret': '생략',
    'port': '생략',
}
start_now = datetime.now()
input_df = pd.DataFrame({'runts': 0,
                         'giants': 0,
                         'throttles': 0,
                         'CRC': 0,
                         'overrun': 0,
                         'discarded': 0},
                         index=[start_now],
                         columns=['runts', 'giants', 'throttles', 'CRC', 'overrun', 'discarded'])
input_dict = {}

#SSH 접속
net_connect = ConnectHandler(**inform)

for i in range(1,6):
    
    #커맨드 전송
    interface_output = net_connect.send_command('show interfaces port-channel 90')

    #데이터 전처리(pandas 라이브러리 사용)
    interface_output = interface_output.splitlines()

    temp = interface_output[18:20]
    temp_1 = temp[0][5:].replace(",", "")
    temp_2 = temp[1][5:].replace(",", "")
    temp = temp_1 + " " + temp_2
    temp = temp.split(" ")
    input_dict = {temp[j + 1]: int(temp[j]) for j in range(0, len(temp), 2)}

    #전처리된 데이터 입력(현재 시간)
    now = datetime.now()
    input_df.loc[now] = [input_dict['runts'], input_dict['giants'], input_dict['throttles'], input_dict['CRC'], input_dict['overrun'], input_dict['discarded']]

    #1분 간격
    time.sleep(60)

#데이터 출력
print(input_df)

#데이터 시각화(matplotlib 라이브러리 사용)
input_df.plot()
plt.title("INPUT Interface")
plt.xlabel("date")
plt.ylabel("packet numbers")
plt.xlim(start_now, now)
plt.ylim(0, 5)
plt.show()

#SSH 종료
net_connect.disconnect()

 

show interface 커맨드 결과(참고용)

Hostname# show interfaces port-channel 90
Port-channel 90 is up, line protocol is up
Description: ## 생략 ##
Hardware address is 생략, Current address is 생략
Interface index is 1258337280
Minimum number of links to bring Port-channel up is 1
Internet address is not set
Mode of IPv4 Address Assignment : NONE
DHCP Client-ID :4cd98fe7008a
MTU 9216 bytes, IP MTU 9198 bytes
LineSpeed 80000 Mbit
Members in this channel:  Fo 1/53(U) Fo 1/54(U)
ARP type: ARPA, ARP Timeout 04:00:00
Queueing strategy: fifo
Input Statistics:
     94018423348 packets, 49109219847541 bytes
     14519700479 64-byte pkts, 35400750260 over 64-byte pkts, 7641522857 over 127-byte pkts
     4760648399 over 255-byte pkts, 4503678737 over 511-byte pkts, 27192122616 over 1023-byte pkts
     634507634 Multicasts, 386427039 Broadcasts, 92997488675 Unicasts
     0 runts, 0 giants, 0 throttles #18번 라인 필요한 데이터
     0 CRC, 0 overrun, 0 discarded #19번 라인 필요한 데이터
Output Statistics:
     6062097275 packets, 5141949517949 bytes, 0 underruns
     235353000 64-byte pkts, 1543441098 over 64-byte pkts, 262688975 over 127-byte pkts
     416740508 over 255-byte pkts, 642126887 over 511-byte pkts, 2961746807 over 1023-byte pkts
     1315188671 Multicasts, 447752699 Broadcasts, 4299155905 Unicasts
     0 throttles, 0 discarded, 0 collisions, 0 wreddrops
Rate info (interval 299 seconds):
     Input 91.00 Mbits/sec,      14632 packets/sec, 0.12% of line-rate
     Output 08.00 Mbits/sec,        848 packets/sec, 0.01% of line-rate
Time since last interface status change: 57w4d10h

 

결과물

                            runts  giants  throttles  CRC  overrun  discarded
2021-07-23 15:38:40.733063      0       0          0    0        0          0
2021-07-23 15:38:50.547603      0       0          0    0        0          0
2021-07-23 15:39:51.487370      0       0          0    0        0          0
2021-07-23 15:40:52.432861      0       0          0    0        0          0
2021-07-23 15:41:53.380364      0       0          0    0        0          0
2021-07-23 15:42:54.219639      0       0          0    0        0          0

#runts : 수신한 패킷의 크기가 64Byte 보다 작아 drop된 패킷 수
#giants : 수신한 패킷의 크기가 인터페이스에 설정된 MTU Size 보다 커 drop된 패킷 수
#throttles : 수신한 패킷 내에 PAUSE Frame이 포함된 패킷 수(패킷 전송량 감소)
#CRC : 수신한 패킷에서 CRC/FCS check 결과 Error로 drop된 패킷 수
#overrun : 패킷을 수신한 인터페이스 내의 Buffer에서 FIFO 정책에 의해 drop된 패킷 수
#discarded : 수신한 패킷 중 drop된 패킷 합

다 값이 0이라서 그래프에 보이지 않는,,, 하지만 0인게 다행인?!