Cisco Nexus 3000 シリーズ NX-OS Python API リファレンス ガイド リリース 5.0(3)U3(1)

偏向のない言語

この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。

翻訳について

このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。

マニュアルのコンテンツ
このマニュアル内で検索
ご利用いただける言語
Download Options

Book Title

Cisco Nexus 3000 シリーズ NX-OS Python API リファレンス ガイド リリース 5.0(3)U3(1)

Chapter Title

アプリケーション プログラミング インターフェイス（API）関数

検索結果

Updated:
2017年6月7日

章のタイトル： アプリケーション プログラミング インターフェイス（API）関数

アプリケーション プログラミング インターフェイス（API）関数

この章では、次の Python アプリケーション プログラミング インターフェイス（API）関数について説明します。この章は、次の内容で構成されています。

• 「Routes()」

• 「showArpTable()」

• 「showVshRoutes()」

• 「showHwRoutes()」

• 「verifyRoutes()」

• 「verifyArpTable()」

• 「CheckPortDiscards()」

• 「クラス BufferDepthMonitor(CLI)」

• 「getTotalInstantUsage()」

• 「GetRemainingInstantUsage()」

• 「getMaxCellUsage()」

• 「getSwitchCellCount()」

• 「transfer()」

• 「CLI()」

• 「get_output()」

• 「rerun()」

• 「History()」

• 「get_history()」

• 「clear_history()」

Routes()

概要

Routes() - Class Object

構文

Routes()

説明

Routes クラスのオブジェクトをインスタンス化します。

パラメータ

なし。

戻り値

Routes クラスのオブジェクト。

例

rObj = Routes()

showArpTable()

概要

showArpTable()

構文

Routes.showArpTable()

説明

show ip arp コマンドを実行し、出力を返します。

パラメータ

なし。

戻り値

スイッチの ARP テーブル エントリを返します。

例

routeObj = Routes()
data = routeObj.showArpTable().get_output()

出力例

Flags: D - Static Adjacencies attached to down interface
 
IP ARP Table for context default
Total number of entries: 4
Address Age MAC Address Interface
50.1.201.2 00:02:10 547f.ee40.5a7c Vlan201
50.1.1.10 00:07:53 547f.ee62.f801 Ethernet1/34
50.1.2.10 00:08:31 547f.ee62.f801 Ethernet1/35
50.1.3.10 00:08:31 547f.ee62.f801 Ethernet1/35.1
 
<cisco.CLI object at 0xb7c1462c>

showVshRoutes()

概要

showVshRoutes()

構文

Routes.showVshRoutes()

説明

show ip fib route を実行し、出力を返します。

パラメータ

なし。

戻り値

ソフトウェア ルート エントリを返します。

例

routeObj = Routes()
data = routeObj.showVshRoutes().get_output()

出力例

IPv4 routes for table default/base
 
------------------+------------------+---------------------
Prefix | Next-hop | Interface
------------------+------------------+---------------------
0.0.0.0/32 Drop Null0
50.1.1.0/24 Attached Ethernet1/34
50.1.1.0/32 Drop Null0
50.1.1.10/32 50.1.1.10 Ethernet1/34
50.1.1.100/32 Receive sup-eth1
50.1.1.255/32 Attached Ethernet1/34
50.1.2.0/24 Attached Ethernet1/35
50.1.2.0/32 Drop Null0
50.1.2.10/32 50.1.2.10 Ethernet1/35
50.1.2.100/32 Receive sup-eth1
50.1.2.255/32 Attached Ethernet1/35
50.1.3.0/24 Attached Ethernet1/35.1
50.1.3.0/32 Drop Null0
50.1.3.10/32 50.1.3.10 Ethernet1/35.1
50.1.3.100/32 Receive sup-eth1
50.1.3.255/32 Attached Ethernet1/35.1
 
<cisco.CLI object at 0xb7b0a6ac>

showHwRoutes()

概要

showHwRoutes()

構文

Routes.showHwRoutes()

説明

ハードウェア ルートを計算し、出力を返します。

パラメータ

なし。

戻り値

ハードウェア ルート エントリを返します。

例

routeObj = Routes()
data = routeObj.showHwRoutes()

出力例

------------------+------------------+---------------------
Prefix | Next-hop | Interface
------------------+------------------+---------------------
50.1.1.100/32 Receive sup-eth1
50.1.2.100/32 Receive sup-eth1
50.1.201.1/32 Receive sup-eth1
0.0.0.0/32 Drop Null0
50.1.3.0/32 Drop Null0
50.1.201.0/32 Drop Null0
50.1.2.255/32 Attached sup-hi
50.1.1.255/32 Attached sup-hi
60.1.1.0/32 Drop Null0
50.1.3.255/32 Attached sup-hi
50.1.201.255/32 Attached sup-hi
255.255.255.255/32 Receive sup-eth1
 

verifyRoutes()

概要

verifyRoutes()

構文

Routes.verifyRoutes()

説明

ソフトウェアとハードウェアのルートを確認します。

パラメータ

なし。

戻り値

ハードウェアとソフトウェアの間で一致したルートおよび一致しないルートの数を返します。

例

routeObj = Routes()
found,nfound = routeObj.verifyRoutes()

出力例

Routes verified and found: 26
 
Routes not found:
50.1.205.0/24 3
51.1.1.0/24 3
51.1.2.0/24 4
51.1.3.0/24 6
100.1.1.0/24 7
100.1.2.0/24 7
100.1.3.0/24 7
101.1.1.0/24 7
101.1.2.0/24 7
101.1.3.0/24 7
120.1.1.0/24 7

verifyArpTable()

概要

verifyArpTable()

構文

Routes.verifyArpTable()

説明

ソフトウェアとハードウェアの ARP テーブル エントリを確認します。

パラメータ

なし。

戻り値

ハードウェアとソフトウェアの間で一致した ARP テーブル エントリおよび一致しなかった ARP テーブル エントリの数を返します。

例

routeObj = Routes()
found,notfound = routeObj.verifyArpTable()

出力例

Flags: D - Static Adjacencies attached to down interface
 
IP ARP Table for context default
Total number of entries: 4
Address Age MAC Address Interface
50.1.201.2 00:02:31 547f.ee40.5a7c Vlan201
50.1.1.10 00:08:15 547f.ee62.f801 Ethernet1/34
50.1.2.10 00:08:53 547f.ee62.f801 Ethernet1/35
50.1.3.10 00:08:53 547f.ee62.f801 Ethernet1/35.1
 
mac address:54:7f:ee:40:5a:7c
Arp entry for 50.1.201.2 547f.ee40.5a7c Vlan201 found in HW
mac address:54:7f:ee:62:f8:01
Arp entry for 50.1.1.10 547f.ee62.f801 Ethernet1/34 found in HW
mac address:54:7f:ee:62:f8:01
Arp entry for 50.1.2.10 547f.ee62.f801 Ethernet1/35 found in HW
mac address:54:7f:ee:62:f8:01
Arp entry for 50.1.3.10 547f.ee62.f801 Ethernet1/35.1 found in HW

CheckPortDiscards()

概要

CheckPortDiscards(<port>)

構文

CheckPortDiscards('ethernet1/1')

説明

特定のポートでの入力廃棄を確認します。廃棄が 0 を超える場合は、broadcom から廃棄の理由を照会して印刷します。

パラメータ

port

戻り値

なし。

例

c = CheckPortDiscards('eth1/1')

出力例

Ethernet1/1 is up
Hardware: 100/1000/10000 Ethernet, address: 547f.ee57.dd28 (bia 547f.ee57.dd28)
MTU 1500 bytes, BW 10000000 Kbit, DLY 10 usec,
reliability 255/255, txload 1/255, rxload 1/255
Encapsulation ARPA
Port mode is trunk
full-duplex, 10 Gb/s, media type is 10G
Beacon is turned off
Input flow-control is off, output flow-control is off
Rate mode is dedicated
Switchport monitor is off
EtherType is 0x8100
Last link flapped 00:42:16
Last clearing of "show interface" counters never
30 seconds input rate 5016 bits/sec, 627 bytes/sec, 6 packets/sec
30 seconds output rate 3232 bits/sec, 404 bytes/sec, 5 packets/sec
Load-Interval #2: 5 minute (300 seconds)
input rate 4.69 Kbps, 7 pps; output rate 2.82 Kbps, 4 pps
RX
297 unicast packets 20588 multicast packets 5 broadcast packets
20890 input packets 1848701 bytes
0 jumbo packets 0 storm suppression packets
0 giants 0 input error 0 short frame 0 overrun 0 underrun
0 watchdog 0 if down drop
0 input with dribble 0 input discard(includes ACL drops)
0 Rx pause
TX
262 unicast packets 16151 multicast packets 5 broadcast packets
16418 output packets 1407200 bytes
0 jumbo packets
0 output errors 0 collision 0 deferred 0 late collision
0 lost carrier 0 no carrier 0 babble
0 Tx pause
2 interface resets
 
zero discards

クラス BufferDepthMonitor(CLI)

概要

BufferDepthMonitor()

構文

monitorObj = BufferDepthMonitor()

説明

このクラスは、show hardware internal buffer info pkt-stats コマンドの出力を分析し、バッファの使用量を返すメソッドにアクセスできるようにします。

パラメータ

なし。

戻り値

このクラスのオブジェクト インスタンス。

例

b = BufferDepthMonitor()

出力例

|-----------------------------------------------------------------------------------------|
 
Total Instant Usage 0
Remaining Instant Usage 46080
Max Cell Usage 19
Switch Cell Count 46080
|-----------------------------------------------------------------------------------------|
<cisco.BufferDepthMonitor object at 0xb7c1462c>

getTotalInstantUsage()

概要

getTotalInstantUsage()

構文

monitorObj = BufferDepthMonitor()
totUsage = monitorObj.getTotalInstantUsage()

説明

show hardware internal buffer info pkt-stats コマンドの出力からその瞬間の合計使用量を返すメソッド。

パラメータ

なし。

戻り値

その瞬間の合計使用量を返します。

例

b = BufferDepthMonitor()
b. getTotalInstantUsage()

出力例

0

GetRemainingInstantUsage()

概要

getRemainingInstantUsage()

構文

monitorObj = BufferDepthMonitor()
remUsage = monitorObj.getRemainingInstantUsage()

説明

show hardware internal buffer info pkt-stats コマンドの出力からその瞬間の残りの使用量を返すメソッド。

パラメータ

なし。

戻り値

その瞬間の合計使用量を返します。

例

b = BufferDepthMonitor()
b. getRemainingInstantUsage ()

出力例

46080

getMaxCellUsage()

概要

getMaxCellUsage()

構文

monitorObj = BufferDepthMonitor()
cellUsage = monitorObj.getMaxCellUsage()

説明

show hardware internal buffer info pkt-stats コマンドの出力からセル使用量を返すメソッド。

パラメータ

なし。

戻り値

その瞬間の合計使用量を返します。

例

b = BufferDepthMonitor()
b. getMaxCellUsage ()

出力例

19

getSwitchCellCount()

概要

getSwitchCellCount()

構文

monitorObj = BufferDepthMonitor()
cellCount = monitorObj.getSwitchCellCount()

説明

show hardware internal buffer info pkt-stats コマンドの出力からセル カウントの使用量を返すメソッド。

パラメータ

なし。

戻り値

その瞬間の合計使用量を返します。

例

b = BufferDepthMonitor()
b. getSwitchCellCount ()

出力例

46080

transfer()

概要

transfer()

構文

transfer (<protocol>, <host>, <source>, <dest>, <vrf>, <login_timeout>, <user>, <password>)

説明

<source> で指定されたファイルを <host> から <protocol> を使用して <dest> に記載されているパスに転送する API。プロトコルには、scp、tftp、ftp、または sftp を使用できます。

パラメータ

protocol、host、source、dest、vrf、login_timeout、user、password。

戻り値

転送が成功した場合は True を返します。

例

scp を使用する転送:

c = transfer("scp", "10.193.190.100", "/tftpboot/transfer_test_image", "transfer_test_image", user="scpUser", password="scpPasswd")
 

sftp を使用する転送:

c = transfer("sftp", "10.193.190.100", "/tftpboot/transfer_test_image", "transfer_test_image", user="sftpUser", password="sftpPasswd")
 

tftp を使用する転送:

c = transfer("tftp", "10.193.190.100", "/transfer_test_image", "transfer_test_image", user="", password="")

ftp を使用する転送:

c = transfer("ftp", "10.193.190.51", "golden/home/su-ash/transfer_test_image", "transfer_test_image", user="ftpUser", password="ftpPasswd")

CLI()

概要

CLI() - Class Object

構文

CLI (<command>, <do_print>)

説明

<command> で指定された CLI コマンドで CLI クラスのオブジェクトをインスタンス化します。<do_print> を False に設定するとコマンドの出力が印刷されず、True（デフォルト）に設定すると出力が印刷されます。

パラメータ

command、do_print

戻り値

CLI クラスのオブジェクト。

例

c = CLI ('show runn inter eth1/1')

出力例

!Command: show running-config interface Ethernet1/1
!Time: Mon Feb 27 14:33:24 2012
 
version 5.0(3)U3(1)
 
interface Ethernet1/1
switchport mode trunk
udld enable
channel-group 12
 
<cisco.CLI object at 0xb7ae948c>

get_output()

概要

get_output()

構文

CLI.get_output()

説明

CLI コマンドの出力を返します。

パラメータ

なし。

戻り値

CLI コマンドの出力。

例

c = CLI ('show runn inter eth1/1')
c.get_output()

出力例

['', '!Command: show running-config interface Ethernet1/1', '!Time: Mon Feb 27 14:36:10 2012', '', 'version 5.0(3)U3(1)', '', 'interface Ethernet1/1', ' switchport mode trunk', ' udld enable', ' channel-group 12', '', '']

rerun()

概要

rerun()

構文

CLI.rerun()

説明

コマンドを再実行します。

パラメータ

なし。

戻り値

なし。

例

c = CLI ('show runn inter eth1/1')
c.rerun()

出力例

!Command: show running-config interface Ethernet1/1
!Time: Mon Feb 27 14:37:05 2012
 
version 5.0(3)U3(1)
 
interface Ethernet1/1
switchport mode trunk
udld enable
channel-group 12

History()

概要

History() - クラス オブジェクト

構文

History()

説明

History クラスのオブジェクトをインスタンス化します。

パラメータ

なし。

戻り値

History クラスのオブジェクト。

例

a = History()

get_history()

概要

get_history()

構文

History.get_history()

説明

これまでに実行された CLI コマンドの履歴を取得します。

パラメータ

なし。

戻り値

実行されたコマンドの履歴を返します。

例

a = History()
a.get_history()

clear_history()

概要

clear_history()

構文

History.clear_history()

説明

履歴をクリアします。

パラメータ

なし。

戻り値

なし。

例

a = History()
a.clear_history()

 

このドキュメントは役に立ちましたか?

Feedbackフィードバック

シスコに問い合わせ