CLIのオンラインヘルプ
コマンドラインインターフェイスからオンラインヘルプを取得する
CLI には、コマンドやステートメントに関する情報にアクセスできる、コンテキストに応じたオンライン ヘルプ機能があります。
コマンドに関するヘルプの取得
CLIコマンドとオプションは、プラットフォームやソフトウェアのリリースによって異なる場合があります。CLI コマンド階層の各レベルは、使用可能なコマンドに関する情報を提供します。疑問符 (?) を入力すると、コマンドに関するコンテキスト関連のヘルプを取得できます。
コマンド ライン プロンプトで疑問符を入力すると、CLI に使用可能なコマンドとオプションが一覧表示されます。例えば、トップレベルの動作モード コマンドのリストを表示すると、次のような結果が得られます。
user@host>
?Possible completions: clear Clear information in the system configure Manipulate software configuration information file Perform file operations help Provide help information mtrace Trace mtrace packets from source to receiver. monitor Real-time debugging ping Ping a remote target quit Exit the management session request Make system-level requests restart Restart a software process set Set CLI properties, date, time, craft display text show Show information about the system ssh Open a secure shell to another host start Start a software process telnet Telnet to another host test Diagnostic debugging commands traceroute Trace the route to a remote host user@host>コマンドまたはコマンドオプションの完全名を入力した後に疑問符を入力すると、CLI使用可能なコマンドとオプションが一覧表示され、入力したコマンド名とオプションが再表示されます。
user@host>
clear?Possible completions: arp Clear address-resolution information bgp Clear BGP information chassis Clear chassis information firewall Clear firewall counters igmp Clear IGMP information interfaces Clear interface information ilmi Clear ILMI statistics information isis Clear IS-IS information ldp Clear LDP information log Clear contents of a log file mpls Clear MPLS information msdp Clear MSDP information multicast Clear Multicast information ospf Clear OSPF information pim Clear PIM information rip Clear RIP information route Clear routing table information rsvp Clear RSVP information snmp Clear SNMP information system Clear system status vrrp Clear VRRP statistics information user@host> clearコマンド名の途中に疑問符を入力すると、CLI は、これまでに入力した文字と一致するコマンド補完候補を一覧表示します。その後、入力した文字が再表示されます。たとえば、文字 c で始まるすべての動作モード コマンドを一覧表示するには、次のように入力します。
user@host>
c?Possible completions: clear Clear information in the system configure Manipulate software configuration information user@host> c疑問符またはヘルプ コマンドの使用に関する入門情報については、「
help」と入力して Enter キーを押すこともできます。user@host>
help
ステートメントまたはコマンド内の文字列に関するヘルプの取得
help コマンドを使用して、ステートメントまたはコマンド名に含まれるテキスト文字列に関するヘルプを表示できます。
help apropos string
string は、ヘルプを希望するテキスト文字列です。この文字列は、ステートメント名またはコマンド名に一致させるだけでなく、ステートメントまたはコマンドに表示されるヘルプ文字列とも一致させるために使用します。
文字列にスペースが含まれている場合は、引用符(" ")で囲みます。標準のUNIXスタイルの正規表現構文を使用して、文字列の正規表現を指定することもできます。
STRINGとしてデータ型を入力する必要があるステートメントまたはコマンドの場合、サポートされる文字セットは次のとおりです。
印刷可能な任意のASCII文字
スペースを含む文字の場合は、二重引用符で囲みます。
入力として二重引用符を使用するには、'\'でエスケープする必要があります。
注:二重引用符からエスケープする以外は、文字列でエスケープ文字はサポートされていません。
属性でサポートされている文字の範囲は、0〜65499文字です。
文字列タイプ識別子でサポートされている文字の範囲は、1文字から255文字です。
設定モードでは、このコマンドは、指定された文字列に一致するステートメント名とヘルプテキストを表示します。動作モードでは、このコマンドは、指定された文字列と一致するコマンド名とヘルプテキストを表示します。
設定ステートメントに関するヘルプの取得
help topicおよびhelp referenceコマンドを使用して、ステートメント名に含まれるテキストに基づいてヘルプを表示できます。
help topicwordhelp referencestatement-name
help topicコマンドは、Junos OS Evolved設定ガイドに記載されている情報に基づいて、ステートメントの使用ガイドラインを表示します。help referenceコマンドは、Junos OS Evolved設定ガイドに記載されている概要の説明に基づいて、ステートメントに関する概要情報を表示します。
システムログメッセージに関するヘルプの取得
help syslogコマンドを使用して、システムログタグに基づいてヘルプを表示できます。
help syslog syslog-tag
help syslogコマンドは、システムログメッセージの内容を表示します。
CLIオンラインヘルプ機能
省略されたステートメントに対するヘルプ
特定の階層レベルで必須のステートメントを除外した場合、その階層レベルから移動しようとすると、または設定モードで show コマンドを発行すると、どのステートメントが欠落しているかを示すメッセージが表示されます。例えば:
[edit protocols pim interface et-0/0/0] user@host#topWarning: missing mandatory statement: 'mode' [edit] user@host#showprotocols { pim { interface et-0/0/0 { priority 4; version 2; # Warning: missing mandatory statement(s): 'mode' } } }
CLIコマンド補完の使用
Junos OS Evolved CLI には、入力した最初の数文字に基づいてオペレーティング システムがコマンドとオプションを認識できるようにするコマンド補完オプションが用意されています。つまり、CLI が認識するために完全なコマンド名またはオプション名を常に覚えたり入力したりする必要はありません。
可能なすべてのコマンドまたはオプション補完を表示するには、部分コマンドを入力し、その後に疑問符を付けます。
部分的に入力したコマンドまたはオプションを完了するには、
TabまたはSpaceを押します。部分的に入力された文字がコマンドを一意に識別する文字列で始まる場合は、完全なコマンド名が表示されます。そうでない場合は、あいまいなコマンドを入力したことを示すプロンプトが表示され、可能な補完が表示されます。
コマンド補完は、ファイル名、インターフェイス名、ユーザー名などの他の文字列にも適用されます。使用可能なすべての値を表示するには、部分的な文字列を入力し、その後に疑問符が続きます。文字列を完成させるには、 Tab を押します。
設定モードでのコマンド補完の使用
CLIコマンド補完機能は、設定モードのコマンドや設定ステートメントにも適用されます。具体的には、使用可能なすべてのコマンドまたはステートメントを表示するには、文字列の一部を入力し、その直後に疑問符を付けます。部分的に入力したコマンドまたはステートメントを完成させるには、 Tab または Space を押します。
CLIコマンドに関するヒントの表示
CLIコマンドに関するヒントを得るには、 help tip cli コマンドを発行してください。コマンドを入力するたびに、新しいヒントが表示されます。例えば:
user@host>help tip cliJunos tip: Use 'request system software validate' to validate the incoming software against the current configuration without impacting the running system. user@host>help tip cliJunos tip: Use 'commit and-quit' to exit configuration mode after the commit has succeeded. If the commit fails, you are left in configuration mode.
help tip cli numberを入力して、チップを番号に関連付けることもできます。これにより、後でヒントを思い出すことができます。例えば:
user@host>help tip cli 10JUNOS tip: Use '#' in the beginning of a line in command scripts to cause the rest of the line to be ignored. user@host>help tip cliJUNOS tip: Use the 'apply-groups' statement at any level of the configuration hierarchy to inherit configuration statements from a configuration group. user@host>
関連項目
CLIエクスプローラの概要
CLIエクスプローラは、 Junos OS Evolved の設定ステートメントとコマンドを調べるのに役立つWebアプリケーションです。CLIエクスプローラーには、 Junos OS Evolved がさまざまなプラットフォームやソフトウェアリリースでサポートするすべての設定ステートメントとコマンドが一覧表示されます。
使用可能な設定ステートメントとコマンドを表示するには、以下のフィルタリングオプションのいずれかを使用できます。
製品ファミリーでフィルター—製品ファミリー別のCLI参照情報を見つけるには、「すべての製品」を選択するか、特定の製品を選択します。
例:ACXシリーズ、EXシリーズ。
数字または文字でフィルタリング—CLI参照情報を数字または文字で検索するには、「すべて」を選択するか、数字「3」または「8」または任意の文字(「A」、「B」、「C...」)でフィルタリングします。
たとえば、「A」を選択すると、
aaa、aaa clients (TDF)、aaa-access-profile (L2TP LNS)などのコマンドが表示されます。通常の検索オプションでフィルタリング—このオプションを使用してコマンドとステートメントをフィルタリングするには、検索条件を入力します。
たとえば、数字「3」を入力すると、数字「3」を含むすべてのコマンドとステートメントが検索結果に表示されます。
検索結果でリンクをクリックすると、ユーザーガイドで参照されているコマンドまたはステートメントを説明するページに移動します。
Junos OS Evolvedの設定ステートメントとコマンドについては、CLIエクスプローラーを参照してください。