Cisco Active Network Abstraction 3.6.7 カスタマイゼーション ユーザ ガイド
Cisco ANA シェルの動作について
Cisco ANA シェルの動作について
発行日;2012/02/01 | 英語版ドキュメント(2009/11/06 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 3MB) | フィードバック

目次

Cisco ANA シェルの動作について

概要

シェル プロンプトおよびモード

シェル エラー

エラーの形式

コマンド完了エラー

出力の形式

テーブル

パラグラフ

出力のリダイレクション

バックグラウンド処理

基本コマンド

Inline Help("?")

Exit Shell

Exit Current Mode

Help

Terminal Length

Show History

Clear History

Access History

Execute Script

ノード管理

AVM の管理

Show AVM List

Show AVM VNEs

VNE の管理

Show All VNEs

Show VNE Information

Add AVM

Remove AVM

Load AVM

Unload AVM

Add VNE

Remove VNE

Load VNE

Unload VNE

Add Static Topology Link

Remove Static Topology Link

サーベイランス

Show Links

Drools ルールの管理

Show All Rules

Show Specific Rules

Reload Rules

Validate Rule

Cisco ANA シェルの動作について

この章では、Cisco ANA シェル モード、エラー、および出力形式について説明します。また、基本コマンド、ユニット管理コマンド、およびサーベイランス コマンドについても説明します。

この章では、次の事項について説明します。

「概要」

「Cisco ANA シェル プロンプトおよびモード」

「Cisco ANA シェル エラー」

「出力の形式」

「出力のリダイレクション」

「バックグラウンド処理」

「基本コマンド」

「ノード管理」

「サーベイランス」

概要

Cisco ANA シェル CLI は、Cisco IOS インターフェイスに類似したガイドラインに従います。

インターフェイスには、次のものが含まれます。

コマンドの完了:Tab キーを押すと、部分的に入力されたコマンド全体が表示されます。複数の有効なコマンドが存在する場合、Cisco ANA シェルによって、警告音が鳴らされます。

完了音通知:コマンド候補が使用可能ではない場合に、短い警告通知が鳴らされます。

高速ヘルプ メカニズム: ? を入力すると、すべての有効な候補のリストが表示されます。

エラー メッセージ:「Cisco ANA シェル エラー」を参照してください。

大文字と小文字が区別されるインターフェイス。

部分的なシンタックス認知。

入力の確認。

Cisco ANA Manage およびユニット マシンに接続しているときに Cisco ANA シェル シンタックスを使用:ユニットへの接続に Telnet を使用すると、単一マシンに関連するすべての管理機能を使用できます。

More コマンドおよびターミナル長に対するサポート。

Cisco ANA シェル プロンプトおよびモード

Cisco ANA ゲートウェイにログイン後、次のコマンドを入力し、Cisco ANA シェル モード(エントランス モード)に入ります。

# su - bos

 
Sheer Networks
 
BOS Starting up...
 
MetroShell>
 

表 19-1 に、4 つの Cisco ANA シェル モードの区別について説明します。

 

表 19-1 Cisco ANA シェル モード

モード名
コマンド
プロンプト
説明

exec

--

MetroShell>

エントランス モード:オペレータ ユーザに対し、一般的な詳細を表示する目的で設計されています。

enable

enable

MetroShell#

拡張ユーザ モード:さらなる詳細および設定を使用できます。このモードの起動には、パスワードを使用して認証されます。

configure

configure

または

config

MetroShell(CONFIG)#

コンフィギュレーション モード:異なるアトリビュートの設定に使用されます。このモードの起動は、イネーブル モードからのみ認証され、使用可能になります。

このモードに変更する前に、イネーブル モードに入る必要があります。

manage

manage

MetroShell(MANAGE)#

管理モード:システム上で管理操作の実行に使用されます。このモードには認証が必要です。

このモードに変更する前に、イネーブル モードに入る必要があります。


) 各レベルには、すべての前のレベルが含まれます。? と入力すると、各モードでサポートされるすべてのコマンドを確認できます。


Cisco ANA シェル エラー

ここではシェル エラーに関する次の事項について説明します。

「エラーの形式」

「コマンド完了エラー」

エラーの形式

エラーで機能が強制終了されると、エラーでは、次の形式が使用されます。

ERROR (error code): error message

次の例を参考にしてください。

ERROR(10443): IP address already in use
 

解析またはタイプ チェック エラーが発生した場合(たとえば、整数の代わりにストリングを入力したなど)、エラーが含まれているフレーズを指す矢印付きで、コマンドが再表示されます。解析またはタイプ チェック エラーではない場合、コマンドは再表示されません。

たとえば、 show ip 192.168.1 と入力すると、次のような結果になります。

ERROR (203): Invalid Value
show ip 192.168.1
^

コマンド完了エラー

 

エラー例
エラー メッセージ

show momomo

^

未知のコマンド:認識されない最初の文字に、カレット(^)でマークが付けられます。

ip change <cr>

不完全なコマンド:より多くの引数が必要です。

s <TAB>

複数のコマンドが s で始まっている場合、警告音が鳴らされます。

出力の形式

ここでは、Cisco ANA シェルによって返される可能性がある出力の形式に関する次の事項について説明します。

「テーブル」

「パラグラフ」

exit コマンドなど、一部のコマンドには、出力はありません。

テーブル

Cisco ANA シェルにより、次のアトリビュートでテーブルに出力が生成されます。

ヘッダー

カラムの名前のリストが表示されます。

各ページではなく、テーブルの最初で一度だけ表示されます。

テーブルの行からヘッダーを区別する水平ルーラー。

すべてのテーブル フィールドは、左揃えにされます。

次の例を参考にしてください。

 

番号
IP
名前
タイプ
動作時間

1

192.168.2.3

asam1

ASAM1000

29.04.02 13:12

10

192.168.2.4

asam2

ASAM1000

1.05.02 9:43

11

192.168.2.45

RedBack2

SMS500

1.05.02 9:44

100

192.168.2.46

RedBack3

SMS500

1.05.02 9:44

パラグラフ

Cisco ANA シェルでは、次の形式を使用するテキスト パラグラフで出力を生成できます。

<objectname>:
<attribute name> = <value>
...
 

次の例を参考にしてください。

192.168.2.3:
IP address = 192.168.2.3
Name = asam1
Type = ASAM1000
Vendor = Alcatel
Uptime = 1.05.02 13:13
Status = OK

出力のリダイレクション

出力のリダイレクションを使用すると、コマンドの出力をファイルに書き込めます。

Cisco ANA シェルにより、出力リダイレクションの 2 つのオプションが提供されます。

> filename :コマンドの最後に入力すると、新しいファイルが作成され、コマンド出力がそのファイルにリダイレクトされます。ファイルがすでに存在する場合、新しいファイルによって古いファイルが上書きされます。出力ファイルの作成時にエラーが発生した場合、コマンドは実行されません。

例: show device > out.txt

>> filename :コマンドの最後に入力すると、既存ファイルに出力が付加されます。ファイルがまだ存在しない場合、作成されます。

例: show device >> devices0515.text

バックグラウンド処理

各 Cisco ANA シェル コマンドは、コマンドの最後にアンパーサンド(&)を含めることにより、バックグラウンドで実行できます。たとえば、コマンド show link > links.txt & を入力すると、バックグラウンドで show link コマンドが実行され、すべての出力がファイル links.txt にリダイレクトされます。リダイレクションが指定されていない場合、バックグラウンド コマンドの出力は、デフォルトで、Cisco ANA シェル ターミナルにリダイレクトされます。

基本コマンド

ここでは、次の基本コマンドについて説明します。

「Inline Help("?")」

「Exit Cisco ANA Shell」

「Exit Current Mode」

「Help」

「Terminal Length」

「Show History」

「Clear History」

「Access History」

「Execute Script」

Inline Help("?")

 

プロパティ
説明

Name

Inline Help。

Description

入力中にコマンド候補の全体を表示します。

Mode

すべてのモード。

Usage

?

General

コマンドは、Enter キーを押さずに実行されます。

Example

show ?

Output Format

パラグラフ

各オプションの簡潔な説明とともに、有効なオプションのリストが表示されます。

説明が 1 行を超える場合、2 行目以降は、インデントされます。

Exit Cisco ANA Shell

 

プロパティ
説明

Name

Exit Cisco ANA Shell。

Description

Cisco ANA シェル インターフェイスが終了します。

Mode

exec

Usage

exit

General

Cisco ANA シェルがマシンのシェルの役割を果たす場合、ログイン ウィンドウに戻ります。

Example

exit

Output Format

なし。

Exit Current Mode

 

プロパティ
説明

Name

Exit Current Mode。

Description

現在の Cisco ANA シェル モードが終了し、前のモードに戻ります。

Mode

enable, config, manage

Usage

exit

General

イネーブル モードで終了を実行すると、EXEC モードに戻ります。

設定モードで終了を実行すると、イネーブル モードに戻ります。

管理モードで終了を実行すると、イネーブル モードまたは EXEC モードのいずれかの、ユーザが入っていた元のモードに戻ります。

Example

exit

Output Format

なし。

Help

 

プロパティ
説明

Name

Help。

Description

一般的なヘルプを表示します。各コマンドの簡潔な説明とともに、すべてのコマンドのリストが表示されます。

Mode

すべてのモード。

Usage

help

General

--

Example

help

Output Format

固定長のヘルプ メッセージが含まれるパラグラフ。

Terminal Length

 

プロパティ
説明

Name

Terminal Length。

Description

ターミナルの長さを設定します。

Mode

all modes

Usage

terminal length <integer>

General

ポーズなしの場合は長さ 0 が使用されます。

Example

terminal length 40

Output Format

なし。

Show History

 

プロパティ
説明

Name

Show History。

Description

前に実行されたコマンドを表示します。

Mode

all modes

Usage

history

General

履歴には、最後の 100 コマンドが含まれます。ユーザがこれを設定することはできません。

Example

history

Output Format

テーブル。

カラム
説明

Index

コマンドのインデックス。Index 1 により、前のコマンドが参照されます。

Command

コマンドのストリング。

Clear History

 

プロパティ
説明

Name

Clear History。

Description

履歴バッファに保存されているコマンド リストをクリアします。

Mode

all modes

Usage

history clear

General

--

Example

history clear

Output Format

なし。

Access History

 

プロパティ
説明

Name

Access History。

Description

履歴バッファのコマンドに対して実行します。

Mode

all modes

Usage

history <integer>

General

1 の指定は、(現在の履歴コマンドに含まれていない)最後のコマンドを示します。2 の指定は、その前のコマンドを示します。

Example

history 3

Output Format

なし。

Execute Script

 

プロパティ
説明

Name

Execute Script。

Description

Cisco ANA シェル コマンドのスクリプト ファイルを実行します。

Mode

すべてのモード。

Usage

run <filename> [async] [silent]

General

スクリプトは、Cisco ANA シェルが実行されている UNIX マシンのディレクトリ /Main に存在させる必要があります。このディレクトリは、システムがインストールされたディレクトリの下に存在する必要があります。ファイルは、FTP を使用して、このディレクトリまたはそのサブディレクトリに転送される必要があります。スクリプトが /Main のサブディレクトリにある場合、スクリプトの名前で関連パスを含めます。

サイレント オプションにより、コマンドによってターミナルに送信される出力が抑制されます。

をコマンドに付加することによって、スクリプトをバックグラウンドで実行できます。

Example

run provision.cmd

run scripts/provision.cmd

Output Format

なし。

ノード管理

ここでは、ユニット ノードの管理に必要なコマンドについて説明します。ユニット ノードの管理には、AVM プロセスおよび AVM 内の VNE の管理が含まれます。次の事項について説明します。

「AVM の管理」

「VNE の管理」

AVM の管理

AVM 管理コマンドには、次のコマンドが含まれます。

「Show AVM List」

「Show AVM VNEs」

Show AVM List

 

プロパティ
説明

Name

Show AVM List。

Description

プロパティの最小セットで、AVM のリストを表示します。

Mode

manage

Usage

show [unit [<IPAddress>]] avm

General

IP アドレスが指定された場合、このコマンドにより、指定されたマシンだけの AVM が表示されます。IP アドレスが指定されていない場合、このコマンドにより、すべてのマシンの AVM が表示されます。

ユニットが指定されていない場合、コマンドは現在のマシンを参照します。

Example

show unit avm

Output Format

テーブル。

カラム
説明

Machine

AVM があるマシンの IP アドレス。

ID

AVM ID。

PID

プロセス ID。

Port

管理ポート。

Uptime

プロセスの動作時間(日付形式)。

Version

AVM のバージョン。

Show AVM VNEs

 

プロパティ
説明

Name

Show AVM VNEs。

Description

特定の AVM のすべての VNE のリストを表示します。

Mode

manage

Usage

show [unit <IPAddress>] avm <integer> | all agent [detailed]

General

指定された AVM のすべての VNE のリストが表示されます。

ユニットが指定されていない場合、コマンドは現在のマシンを参照します。

詳細が指定されていない場合、DA だけが表示されます。したがって、すべてのエージェント タイプ(Device Agent(DA)、Collector Agent(CA)、および Instrumentor Agent(IA))が表示されます。

すべての引数により、現在のマシンのすべての AVM が参照されます。

また、コマンドにより、XML で設定されているがロードされていない、設定済みの VNE も表示されます。このシナリオでは、すべての非関連フィールドが空です。

Example

show unit 192.168.2.10 avm 32 agent

Output Format

テーブル。

カラム
説明

IP address

VNE の先頭 IP アドレス。

Type

エージェント タイプ:DA、IA、または CA。

State

VNE の状態:Idle、Wait、Block、Running、または Configured。

Runtime

VNE 処理メッセージによって費やされる合計時間。

Wait time

VNE 待ち状態によるメッセージ処理によって費やされる合計時間。

Last run

VNE がスケジューラを訪問した最後の時間。単位は、現在に対するミリ秒です。

Transport address

16 進数形式での VNE トランスポート アドレス。

Parent

親 VNE。親 VNE のトランスポート アドレス。

Show All VNEs

 

プロパティ
説明

Name

Show All VNEs。

Description

ユニットにあるすべての AVM のすべての VNE の基本情報を表示します。

Mode

manage

Usage

show agent [detailed]

General

詳細が指定されていない場合、DA だけが表示されます。したがって、すべてのエージェント タイプ(DA、CA、および IA)が表示されます。

Example

show agent

Output Format

「Show AVM VNEs」を参照してください。

Show VNE Information

 

プロパティ
説明

Name

Show VNE Information。

Description

特定の VNE の情報を表示します。

Mode

manage

Usage

show agent <IPAddress | name>

General

パラメータは、VNE または デバイス名の先頭 IP アドレスである場合があります。

Example

show agent 192.168.2.2

Output Format

パラグラフ。

フィールド
説明

IP Address

VNE の先頭 IP アドレス。

Type

エージェント タイプ:DA、IA、または CA。

Machine

VNE がインストールされているマシンの IP アドレス。

AVM

VNE がインストールされている AVM 番号。

Transport address

16 進数形式での VNE のトランスポート アドレス。

State

VNE の状態:Idle、Wait、Block、Running、または Configured。

Runtime

VNE 処理メッセージによって費やされる合計時間。

Wait time

VNE 待ち状態によるメッセージ処理によって費やされる合計時間。

Last run

VNE がスケジューラを訪問した最後の時間。単位は、現在に対するミリ秒です。

Parent

親 VNE。親 VNE のトランスポート アドレス。

Add AVM

 

プロパティ
説明

Name

Add AVM。

Description

ユニットに新しい AVM を追加します。

Mode

manage

Usage

unit <IPAddress> avm <integer> add

General

整数パラメータは、追加する AVM の ID を表します。

Example

unit 192.168.2.10 avm 32 add

Output Format

なし。

Remove AVM

 

プロパティ
説明

Name

Remove AVM。

Description

ユニット マシンから AVM を削除します。

Mode

manage

Usage

unit <IPAddress> avm <integer> remove

General

整数パラメータは、削除する AVM の ID を表します。

Example

unit 192.168.2.10 avm 32 remove

Output Format

なし。

Load AVM

 

プロパティ
説明

Name

Load AVM。

Description

ユニット ブートストラップ リストに、設定されている AVM を追加します。

Mode

manage

Usage

unit <IPAddress> avm <integer> load

General

整数パラメータは、ロードする AVM の ID を表します。

新たにロードされた AVM がただちに開始され、システムのすべての連続した再起動で開始されます。

Example

unit 192.168.2.10 avm 32 load

Output Format

なし。

Unload AVM

 

プロパティ
説明

Name

Unload AVM。

Description

ブートストラップ リストから AVM を削除します。

Mode

manage

Usage

unit <IPAddress> avm <integer> unload

General

AVM が現在実行中の場合、自動的に停止されます。

整数パラメータは、アンロードする AVM の ID を表します。

Example

unit 192.168.2.10 avm 32 unload

Output Format

なし。

Add VNE

 

プロパティ
説明

Name

Add VNE。

Description

該当する AVM の設定データベースに VNE を追加します。

Mode

manage

Usage

agent <IPAddress> add unit <IPAddress> avm <integer> name <name> vendor <string> type <string>

General

名前が指定されていない場合、IP アドレスがデバイス名として使用されます。

Example

agent 192.168.2.3 add unit 192.168.2.10 avm 32 vendor alcatel type asam1000

Output Format

なし。

Remove VNE

 

プロパティ
説明

Name

Remove VNE。

Description

該当する AVM から VNE を削除します。

Mode

manage

Usage

agent <IPAddress> remove

General

VNE が現在実行中の場合、停止します。

VNE がロードされている場合、ブートストラップ リストからアンロードされます。

Example

agent 192.168.2.3 remove

Output Format

なし。

Load VNE

 

プロパティ
説明

Name

Load VNE。

Description

新たにロードされた VNE がただちに開始され、システムが再起動されるたびにロードされます。

Mode

manage

Usage

agent <IPAddress> load

General

--

Example

agent 192.168.2.3 load

Output Format

なし。

Unload VNE

 

プロパティ
説明

Name

Unload VNE。

Description

AVM ブートストラップ リストから VNE をアンロードします。VNE が現在実行中の場合、ブートストラップ リストからアンロードされる前に停止します。

Mode

manage

Usage

agent <IPAddress> unload

General

--

Example

agent 192.168.2.3 unload

Output Format

なし。

Add Static Topology Link

 

プロパティ
説明

Name

Add Static Topology Link。

Description

ネットワークの 2 つのデバイス間に、スタティック リンクを追加します。

Mode

manage

Usage

topology link source <IPAddress> [shelf <integer>] module <integer> [submodule <integer>] port <integer> destination <IPAddress> [shelf <integer>] module <integer> [submodule <integer>] port <integer> add [unidirectional]

General

デフォルトで、リンクは双方向で、自動的にイネーブルにされます。

単方向は、単方向リンクを表します。

Example

topology link source 192.168.2.3 module 1 port 1 destination 192.168.2.4 module 2 port 1 add

Output Format

なし。

Remove Static Topology Link

 

プロパティ
説明

Name

Remove Static Topology Link。

Description

既存のスティック トポロジ リンクを削除します。

Mode

manage

Usage

topology link source <IPAddress> [shelf <integer>] module <integer> [submodule <integer>] port <integer> destination <IPAddress> [shelf <integer>] module <integer> [submodule <integer>] port <integer> remove [unidirectional]

General

--

Example

topology link source 192.168.2.3 module 1 port 1 destination 192.168.2.4 module 2 port 1 remove

Output Format

なし。

サーベイランス

ここでは、Cisco ANA シェル インターフェイスによってサポートされるサーベイランス コマンドについて説明します。サーベイランス コマンドには、次のコマンドが含まれます。

「Show Links」

「Drools ルールの管理」

Show Links

 

プロパティ
説明

Name

Show Links。

Description

ユニットによって管理されているトポロジ リンクを表示します。

Mode

enable

Usage

show link

General

--

Example

show link

Output Format

テーブル。

カラム
説明

Index

実行中の固有のインデックス。

From

A 側の場所。

To

Z 側の場所。

State

Automatic、Static、Configured。

Drools ルールの管理

Drools ルール エンジンの詳細については、「Drools ルールの管理」を参照してください。

ここでは、次の事項について説明します。

「Show All Rules」

「Show Specific Rules」

「Reload Rules」

「Validate Rule」

Show All Rules

 

プロパティ
説明

Name

Show All Rules。

Description

すべてのルールを表示します。

Mode

enable

Usage

show rule

General

--

Example

show rule

Output Format

ContextId、Rule Name、is valid。

Show Specific Rules

 

プロパティ
説明

Name

Show Specific Rules。

Description

特定のコンテキストのルールを表示します。

Mode

enable

Usage

show rule <contextID>

General

--

Example

show rule pre

Output Format

ContextId、Rule Name、is valid。

Reload Rules

 

プロパティ
説明

Name

Reload Rules。

Description

特定のコンテキストのすべてのルールをリロードします。

Mode

config

Usage

rule <contextID> reload

General

--

Example

rule Post reload

Output Format

--

Validate Rule

 

プロパティ
説明

Name

Validate Rule。

Description

特定のルールを確認します。

Mode

config

Usage

rule <contextID> <ruleName> validate

General

--

Example

rule pre sendGenericEvents validate

Output Format

--