コマンドラインインターフェイスの概要

この章は、次の項で構成されています。

コマンドラインインターフェイス（CLI）へのアクセス

コマンドラインインターフェイスには、SSH または Telnet のサービスがイネーブルに設定されている IP インターフェイスで SSH または Telnet 経由、またはシリアルポートで端末エミュレーションソフトウェアを使用してアクセスできます。工場出荷時のデフォルトでは、管理ポートに SSH および Telnet が設定されています。これらのサービスをディセーブルにするには、interfaceconfig コマンドを使用します。

CLI へのアクセスは、アプライアンスのセットアップ時に選択した管理接続方式によって異なります。工場出荷時のデフォルトユーザ名およびパスフレーズを次に示します。当初は、admin ユーザアカウントだけが CLI にアクセスできます。admin アカウントを介してコマンドラインインターフェイスに初回アクセスしたうえで、さまざまな許可レベルの他のユーザを追加できますシステムセットアップウィザードで、admin アカウントのパスフレーズを変更するように要求されます。admin アカウントのパスフレーズは、passphrase コマンドを使用して、任意の時点で直接再設定することもできます。

イーサネットを介して接続する場合は、工場出荷時のデフォルト IP アドレスの 192.168.42.42 を使用して SSH セッションまたは Telnet セッションを開始します。SSH は、ポート 22 を使用するように設定されています。Telnet は、ポート 23 を使用するように設定されています。下記のユーザ名とパスフレーズを入力します。

シリアル接続を介して接続する場合は、パーソナルコンピュータのシリアルケーブルが接続されている通信ポートを使用して端末セッションを開始します。詳細については、「Setup and Installation」の章を参照してください。下記のユーザ名とパスフレーズを入力します。

下記のユーザ名およびパスフレーズを入力してアプライアンスにログインします。

工場出荷時のデフォルトユーザ名とパスフレーズ

ユーザ名：admin
パスフレーズ：ironport

次に例を示します。

login: admin

passphrase: ironport

コマンドラインインターフェイスの表記法

ここでは、AsyncOS CLI のルールおよび表記法について説明します。

コマンドプロンプト

最上位のコマンドプロンプトは、完全修飾ホスト名に続いて大なり（>）記号とスペース 1 つで構成されます。次に例を示します。


`mail3.example.com>`

アプライアンスが集中管理機能を使用したクラスタの一部として設定されている場合、CLI のプロンプトが現在のモードを示すように変更されます。次に例を示します。


`(Cluster Americas) >`

または


`(Machine los_angeles.example.com) >`

詳細については、ユーザガイドの「Centralized Management」を参照してください。

コマンドを実行すると、CLI によりユーザの入力が要求されます。CLI がユーザの入力を待機している場合は、コマンドプロンプトとして、角カッコ（[]）で囲まれたデフォルト入力値の後に大なり（>）記号が表示されます。デフォルトの入力値がない場合、コマンドプロンプトのカッコ内は空です。

次に例を示します。


`Please create a fully-qualified hostname for this Gateway (Ex: "mail3.example.com"): []> mail3.example.com`

デフォルト設定がある場合は、コマンドプロンプトのカッコ内にその設定が表示されます。次に例を示します。


`Ethernet interface: 1. Data 1 2. Data 2 3. Management [1]> 1`

デフォルト設定が表示される場合に Return を入力すると、デフォルト値を入力したことになります。


`Ethernet interface: 1. Data 1 2. Data 2 3. Management [1]> (type Return)`

コマンドの構文

インタラクティブモードで動作している場合、CLI コマンド構文は単一のコマンドから構成されます。空白スペースを含まず、引数やパラメータもありません。次に例を示します。


`mail3.example.com> systemsetup`

選択リスト

入力できる複数の選択肢がある場合、コマンドによっては番号付きリストを使用します。プロンプトで選択する番号を入力します。

次に例を示します。


`Log level: 1. Error 2. Warning 3. Information 4. Debug 5. Trace [3]> 3`

Yes/No クエリー

yes または no のオプションがある場合、質問はデフォルト値（カッコ内表示）を付けて表示されます。Y、N、Yes、または No で返答できます。大文字と小文字の区別はありません。

次に例を示します。


`Do you want to enable FTP on this interface? [Y]> n`

サブコマンド

コマンドによっては、サブコマンドを使用する場合があります。サブコマンドには、NEW、EDIT、および DELETE などの命令があります。EDIT および DELETE の機能の場合、これらのコマンドは、システムですでに設定されているレコードのリストを提供します。

次に例を示します。

`mail3.example.com> interfaceconfig Currently configured interfaces: 1. Management (192.168.42.42/24: mail3.example.com) Choose the operation you want to perform: - NEW - Create a new interface. - EDIT - Modify an interface. - GROUPS - Define interface groups. - DELETE - Remove an interface. []>`


mail3.example.com> interfaceconfig
Currently configured interfaces:
1. Management (192.168.42.42/24: mail3.example.com)
Choose the operation you want to perform:
- NEW - Create a new interface.
- EDIT - Modify an interface.
- GROUPS - Define interface groups.
- DELETE - Remove an interface.
[]>

サブコマンド内からメインコマンドに戻るには、空のプロンプトで Enter または Return を入力します。

エスケープ

サブコマンド内では、いつでも Ctrl+C キーボードショートカットを使用して、すぐに最上位の CLI に戻ることができます。

履歴

CLI は、セッション中に入力するすべてのコマンドの履歴を保持します。最近使用したコマンドの実行リストをスクロールするには、キーボードの↑および↓の矢印キーを使用するか、Ctrl+P キーと Ctrl+N キーを組み合わせて使用します。


`mail3.example.com> (type the Up arrow key)`


`mail3.example.com> interfaceconfig (type the Up arrow key)`


`mail3.example.com> topin (type the Down arrow key)`

コマンドの補完

コマンドラインインターフェイスは、コマンドの補完をサポートします。あるコマンドの先頭数文字を入力して Tab キーを入力すると、CLI によって一意のコマンドのストリングが補完されます。入力した文字が複数のコマンドに該当する場合、CLI はそのセットをさらに「絞り込み」ます。次に例を示します。

mail3.example.com> set (type the Tab key)
setgateway, sethostname, settime, settz
mail3.example.com> seth 
(typing the Tab again completes the entry with sethostname)

CLI の履歴およびファイルの補完機能では、Enter または Return を入力してコマンドを起動する必要があります。

設定の変更

電子メールの通常の動作を妨げることなく、設定を変更できます。

設定変更は、次の処理を行うまでは有効になりません。

手順

ステップ 1	コマンドプロンプトで commit コマンドを発行します。
ステップ 2	commit コマンドに必要な入力値を指定します。
ステップ 3	CLI で commit 処理の確認を受け取ります。

次のタスク

確定されていない設定に対する変更は記録されますが、commit コマンドが実行されるまでは有効になりません。

（注）

一部のコマンドは commit コマンドを実行しなくても有効になります。変更を有効にする前に確定を行う必要があるコマンドの概要については、CLI クイックリファレンスガイドを参照してください。

CLI セッションの終了、システムのシャットダウン、再起動、障害、または clear コマンドの発行により、確定されていない変更はクリアされます。

汎用 CLI コマンド

このセクションでは、変更の確定またはクリア、ヘルプへのアクセス、およびコマンドラインインターフェイスの終了に使用するコマンドについて説明します。

設定変更の確定

アプライアンスに対する設定変更の保存には、commit コマンドが重要です。設定変更の多くは、commit コマンドを入力するまで有効になりません（変更内容を有効にするために commit コマンドを使用する必要がないコマンドも少数あります）。commit コマンドは、commit コマンドまたは clear コマンドが最後に発行されてから行われた設定変更に適用されます。コメントとして最大 255 文字を使用できます。変更内容は、タイムスタンプと共に確認を受け取るまでは、確定されたものとして認められません。

commit コマンドの後のコメントの入力は任意です。

`mail3.example.com> commit Please enter some comments describing your changes: []> Changed "psinet" IP Interface to a different IP address Do you want to save the current configuration for rollback? [Y]> n Changes committed: Fri May 23 11:42:12 2014 GMT`


mail3.example.com> commit
Please enter some comments describing your changes:
[]> Changed "psinet" IP Interface to a different IP address
Do you want to save the current configuration for rollback? [Y]> n
Changes committed: Fri May 23 11:42:12 2014 GMT

（注）

変更を正常に確定するには、最上位のコマンドプロンプトになっている必要があります。コマンドライン階層の 1 つ上のレベルに移動するには、空のプロンプトで Return を入力します。

設定変更のクリア

clear コマンドは、commit または clear コマンドが最後に実行された以降に設定に対して行われた変更をすべてクリアします。


`mail3.example.com> clear Are you sure you want to clear all changes since the last commit? [Y]> y Changes cleared: Mon Jan 01 12:00:01 2003 mail3.example.com>`

コマンドラインインターフェイスセッションの終了

quit コマンドを実行すると、CLI アプリケーションからログアウトします。確定されていない設定変更はクリアされます。quit コマンドは電子メール操作には影響しません。ログアウトはログファイルに記録されます（exit の入力は、quit の入力と同じです）。


`mail3.example.com> quit Configuration changes entered but not committed. Exiting will lose changes. Type 'commit' at the command prompt to commit changes. Are you sure you wish to exit? [N]> Y`

コマンドラインインターフェイスでのヘルプの検索

help コマンドを実行すると、使用可能なすべての CLI コマンドが表示され、各コマンドの簡単な説明を参照できます。help コマンドは、コマンドプロンプトで help と入力するか、疑問符（?）を 1 つ入力して実行できます。


`mail3.example.com> help`

バッチコマンド

AsyncOS はバッチコマンド形式をサポートしているため、一部の CLI コマンドを新しい単一行 CLI 形式で実行できます。この形式を使用すると、タスクの実行に必要な入力を削減でき、よく行う設定タスクを簡単に自動化できます。バッチコマンドでは、SSH クライアントを使用してコマンドをリモートで実行することもできます。これにより、CLI コマンドのスクリプトを作成し、それを一度に複数のアプライアンスで実行することも簡単にできます。

すべてのコマンドがバッチと同等ではありませんが、すべてのバッチコマンドは、非バッチコマンドとして実行できます。

バッチコマンドの構文は、使用するコマンドによって異なります。使用するコマンドの構文の詳細については、コマンド：参考例の該当する CLI の例を参照してください。

バッチコマンド例

次の例では、送信者グループの REDLIST が作成されます。さらに、その REDLIST がポリシー THROTTLED に関連付けられ、送信者「possible_spammer.com」が送信者グループに追加されます。

このアクションを CLI で実行する場合：

example.com> listenerconfig

Currently configured listeners:

1. IncomingMail (on Management, 192.168.42.42/24) SMTP TCP Port 25 Public

2. OutgoingMail (on Data 2, 192.168.40.42/24) SMTP TCP Port 25 Private

Choose the operation you want to perform:
- NEW - Create a new listener.
- EDIT - Modify a listener.
- DELETE - Remove a listener.
- SETUP - Change global settings.

[]> edit

Enter the name or number of the listener you wish to edit.
[]> IncomingMail

Choose the operation you want to perform:
- NAME - Change the name of the listener.
- INTERFACE - Change the interface.
- LIMITS - Change the injection limits.
- SETUP - Configure general options.
- HOSTACCESS - Modify the Host Access Table.
- RCPTACCESS - Modify the Recipient Access Table.
- BOUNCECONFIG - Choose the bounce profile to use for messages injected on this listener.
- MASQUERADE - Configure the Domain Masquerading Table.
- DOMAINMAP - Configure domain mappings.

[]> HOSTACCESS

There are currently 4 policies defined.
There are currently 5 sender groups.

Choose the operation you want to perform:

- NEW - Create a new entry.
- EDIT - Modify an entry.
- DELETE - Remove an entry.
- MOVE - Move an entry.
- DEFAULT - Set the defaults.
- PRINT - Display the table.
- IMPORT - Import a table from a file.
- EXPORT - Export the table to a file.
- CLEAR - Remove all entries.

[]> NEW

1. New Sender Group
2. New Policy

[1]> 1

Enter a name for this sender group. (optional)

[]> REDLIST

Enter the hosts to add. CIDR addresses such as 10.1.1.0/24 are allowed.
IP address ranges such as 10.1.1.10-20 are allowed. IP subnets such as
10.2.3. are allowed.

Hostnames such as crm.example.com are allowed.

Partial hostnames such as .example.com are allowed.

Ranges of SenderBase Reputation scores such as SBRS[7.5:10.0] are
allowed.

SenderBase Network Owner IDs such as SBO:12345 are allowed.
Remote blacklist queries such as dnslist[query.blacklist.example] are
allowed.

Separate multiple hosts with commas

[]> possible_spammer.com

Select a behavior for this entry.

1. Accept
2. Relay
3. Reject
4. TCP Refuse
5. Continue
6. Policy: ACCEPTED
7. Policy: BLOCKED
8. Policy: THROTTLED
9. Policy: TRUSTED

[1]> 8

Enter a comment for this sender group.
[]>

There are currently 4 policies defined.
There are currently 6 sender groups.

同じアクションを CLI バッチコマンドで実行する場合：

example.com> listenerconfig edit IncomingMail hostaccess new sendergroup 
REDLIST possible_spammer.com Policy: “THROTTLED”

AsyncOS 13.5.1 for Cisco Email Security Appliances CLI リファレンスガイド（一般導入）

Bias-Free Language

Book Title

AsyncOS 13.5.1 for Cisco Email Security Appliances CLI リファレンスガイド（一般導入）

Chapter Title