Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

Junos PyEZを使用してJunosデバイスに接続する

Junos PyEZアプリケーションでさまざまな接続方法とプロトコルを使用して、Junosデバイスまたは接続されたコンソールサーバーに接続します。

Junos PyEZは、Junosデバイスを管理できるPython用のJunosマイクロフレームワークです。Junos PyEZは、各デバイスを jnpr.junos.device.Deviceクラス のインスタンスとしてモデル化します。 Device クラスでは、シリアルコンソール接続、Telnet、またはSSH経由のNETCONFセッションを使用してJunosデバイスに接続できます。Junos PyEZは、コンソールサーバーへのTelnetまたはSSH接続を介したデバイスへの接続もサポートしています。コンソールサーバーは、ターミナルサーバーとも呼ばれ、デバイスの帯域外管理コンソールポートへのネットワーク接続を提供する特殊なデバイスです。さらに、Junos PyEZ を使用して、要塞やジャンプ ホストなどの中間デバイスを介して Junos デバイスに接続することもできます。

このトピックでは、Junos PyEZでサポートされている接続方法の概要と、さまざまな方法を使用してJunosデバイスに接続する方法について説明します。Junos PyEZの例ではさまざまな認証方法を使用していますが、ユーザー認証の詳細については、 Junos PyEZユーザーの認証を参照してください。

接続方法の概要

Junos PyEZでは、シリアルコンソール接続、telnet、またはSSH経由のNETCONFセッションを使用して、Junosデバイスに接続できます。デバイスの コンソール ポートに物理的に接続している場合は、シリアル コンソール接続を使用する必要があります。telnet または SSH を使用して、デバイスの管理インターフェイス、またはデバイスの CONSOLE ポートに接続されているコンソール サーバーに接続できます。Junos PyEZは、要塞ホストまたはジャンプホストを介したデバイスへのSSH接続もサポートしています。さらに、Junos PyEZはアウトバウンドSSH接続をサポートしており、この接続ではJunosデバイスがクライアント管理アプリケーションとの接続を開始します。

工場出荷時のデフォルト設定の新規デバイスまたはゼロ化されたデバイスには、コンソール接続からアクセスする必要があります。Junos PyEZを使用して、リモートアクセス用にまだ構成されていないデバイスを最初に構成できます。デバイスに直接接続している場合はシリアルコンソール接続を使用するか、デバイスに接続されているコンソールサーバーを介してtelnetまたはSSHを使用することができます。

デフォルトでは、Junos PyEZはSSHを使用してデバイスに接続します。別の接続タイプを指定するには、Device引数リストにmodeパラメーターを含める必要があります。デバイスにtelnetするには、引数mode='telnet'を含めます。シリアルコンソール接続を使用してデバイスに接続するには、mode='serial'引数を含めます。表1は、Junos PyEZの接続方法、特定のパラメーターのデフォルト値、および必要なJunos OS設定をまとめたものです。

表1:Junos PyEZ接続モード

接続モード

引数 mode 値

デフォルトポート

必要なJunos OS設定

SSHを介したNETCONF(デフォルト)

–

830

[edit system services]
netconf {
    ssh;
}

シリアルコンソール接続

シリアル

/dev/ttyUSB0

–

Telnet から Junos デバイス

Telnet

23

[edit system services]
telnet;

コンソール サーバー経由の Telnet

Telnet

23

–

コンソールサーバーを介したSSH

–

22

–

ジャンプホストを介したSSH

–

22

[edit system services]
netconf {
    ssh;
}

アウトバウンドSSH

–

–

[edit system services]
outbound-ssh {     
    ...
}
注:

Telnet または NETCONF over SSH を使用してデバイスの管理インターフェイスにアクセスする前に、まず [edit system services] 階層レベルで適切なサービスを有効にする必要があります。詳細については、「 Junos PyEZマネージドノードの設定」を参照してください。Telnet はクリアテキストパスワードを使用するため(セキュリティ上の潜在的な脆弱性が生じる可能性があるため)、SSH の使用を推奨します。

注:

環境に適した安全な方法で資格情報を取得します。ベストプラクティスとして、認証情報を暗号化されていない形式で保存するのではなく、スクリプトを実行するたびに認証情報の入力を求めます。

Junos PyEZ は、コンテキスト マネージャー (with ...as 構文)を使用します。コンテキストマネージャーを使用すると、Junos PyEZはデバイスへの接続と切断のために open() メソッドと close() メソッドを自動的に呼び出します。コンテキストマネージャーを使用しない場合は、アプリケーションで open() メソッドと close() メソッドを明示的に呼び出す必要があります。コンソール接続にはコンテキストマネージャーを使用することをお勧めします。コンテキストマネージャーは接続の閉鎖を自動的に処理しますが、接続を閉じないと予期しない結果が生じる可能性があります。

Junos PyEZ接続プロパティについて

Junosデバイスに接続すると、Junos PyEZは現在の接続に関する情報を Device インスタンスのプロパティとして保存します。 表2は 、使用可能な接続プロパティの概要を示しています。

表2:デバイスのプロパティ

プロパティ

タイプ

説明

connected

ブール値

接続の現在の状態。接続されると True を返します。

hostname

文字列

アプリケーションが接続されているデバイスのホスト名。

master

ブール値

アプリケーションが接続されているルーティングエンジンがプライマリルーティングエンジンである場合に True を返します。

port

整数または文字列

接続に使用するポート。

re_name

文字列

アプリケーションが接続されているルーティングエンジン名。

timeout

整数

秒単位のRPCタイムアウト値。

uptime

整数

現在のルーティングエンジンが起動されてからの秒数。

user

文字列

Junosデバイスにアクセスするユーザー。

たとえば、デバイスに接続した後、 connected プロパティを照会して、接続の現在の状態を返すことができます。 SessionListener はセッションを監視し、 TransportError 例外を発生させ、 Device.connected プロパティを False に設定することで、トランスポート エラーに対応します。

次のサンプル コードでは、Junos デバイスへの接続後とセッションを閉じた後に connected プロパティの値を出力します。

プログラムを実行すると、 connected プロパティは、アプリケーションがデバイスに接続されている間は True を返し、接続が閉じられた後は False を返します。

SSHを使用してデバイスに接続する

Junos PyEZ Device クラスは、SSH を使用した Junos デバイスへの接続をサポートしています。Junos PyEZは、以下の接続をサポートしています。

  • デバイスの管理インターフェイスに直接接続します

  • デバイスの コンソール ポートに直接接続されたコンソールサーバーを介して接続します

  • 要塞またはジャンプホストを介して接続する

SSHサーバーは、「 Junos PyEZユーザーの認証」で説明されているように、標準のSSH認証メカニズムを使用してユーザーを認証できる必要があります。SSH経由でNETCONFセッションを確立するには、「 Junos PyEZマネージドノードの設定」で説明されている要件も満たす必要があります。

SSH を使用してデバイスに接続する場合、Junos PyEZ はまず SSH 公開鍵ベースの認証を試み、次にパスワードベースの認証を試みます。パスワードベースの認証を使用する場合、提供されたパスワードがデバイスパスワードとして使用されます。SSHキーが使用されている場合、提供されたパスワードがプライベートキーのロックを解除するためのパスフレーズになります。SSHキーエージェントにキーをロードする場合、またはSSHプライベートキーのパスフレーズが空の場合は、パスワードを指定する必要はありません。ただし、空のパスフレーズでSSHプライベートキーを使用することはお勧めしません。

Junos PyEZは、~/.ssh/configにあるデフォルトのSSH設定ファイル(存在する場合)に自動的にクエリーを実行します。Junos PyEZは、ユーザーやアイデンティティファイルなど、Device引数によって上書きされないSSH設定ファイルの関連設定を使用します。別のSSH設定ファイルを使用するには、Deviceを定義する際にファイルパスにssh_configを設定します。次に例を示します。

Junos PyEZ リリース 2.7.2 以降、Junos PyEZ クライアントは、Junos デバイスに接続するときに SSH ホストキー検証を有効にできるようになりました。クライアントは、デバイスのホストキーフィンガープリントが、クライアントの known_hosts ファイル内の信頼できるキーと一致することを検証して、リモートデバイスのIDを検証します。提示されたホストキーが信頼できるキーと一致しない場合、接続は拒否されます。該当する場合は、ホストキー検証を使用して、中間者攻撃を防止します。

デフォルトでは、Junos PyEZはSSHホストキー検証を無効にし、サーバーの公開キーをクライアントのknown_hostsファイルに登録しなくても接続を続行できるようにします。ホストキーの検証を有効にするには、Deviceを定義するときにhostkey_verify=Trueを含めます。ホストキーの検証を有効にした場合、デバイスに接続する前に、デバイスのホストキーをknown_hostsファイルに読み込む必要があります。それ以外の場合、接続に失敗します。

次のセクションでは、SSHを使用してデバイスに接続するさまざまな方法について説明します。

デバイスに直接接続する

Junos PyEZでは、Junos OSを実行しているデバイスまたはJunos OS Evolvedを実行しているデバイスに直接接続できます。 Device オブジェクトをインスタンス化するときに、ターゲットデバイスのホスト名またはIPアドレス、および必要なユーザー資格情報を指定します。

Junos PyEZクライアントが、構成管理サーバー(CMS)上の特定のローカル送信元IPアドレスを使用して接続を確立する必要がある場合、 bind_addr 引数を含めてアドレスを指定できます。例えば、CMSが複数のネットワークインターフェイスとIPアドレスを使用していて、ネットワークデバイスから到達できるアドレスのサブセットしかない場合など、接続用のローカル送信元アドレスの設定が必要になることがあります。

JunosデバイスとのSSH経由でNETCONFセッションを確立し、デバイスのファクトを出力するJunos PyEZアプリケーションを作成するには:

  1. Deviceクラスと、タスクに必要なその他のモジュールまたはオブジェクトをインポートします。

  2. デバイスインスタンスを作成し、ホスト名、認証に必要なパラメーター、オプションのパラメーターを指定します。

  3. (オプション)Junosデバイスがデフォルト(830)以外のポートでNETCONFを設定する場合は、 port 引数を含めてポートを指定します。

  4. (オプション)接続の確立に使用するローカル送信元アドレスを指定する必要がある場合は、 bind_addr 引数を含み、使用するIPアドレスを指定します。

  5. たとえば、 open() メソッドを呼び出してデバイスに接続します。

  6. デバイスのファクトを印刷します。

  7. 必要なタスクを実行した後、デバイスへの接続を閉じます。

ここでは、サンプル・プログラムの全文 (オプション・パラメータは省略) を示します。

または、デバイスに接続するときにコンテキストマネージャーを使用することもできます。コンテキストマネージャーは、 open() メソッドと close() メソッドを自動的に呼び出します。次に例を示します。

コンソールサーバーを介してデバイスに接続する

Junos PyEZクライアントは、コンソールサーバーへのSSH接続を介してJunosデバイスに接続できます。この場合、コンソールサーバーとJunosデバイスの両方のログイン資格情報を指定する必要があります。 Device 引数リストで、 cs_user 引数と cs_passwd 引数にコンソールサーバーの資格情報を含めます。SSHキーを使用している場合は、 cs_passwd 引数をプライベートキーのパスフレーズを含む変数に設定します。さらに、該当する場合は、 port 引数をTTYデバイスにマッピングするTCPポートに設定します。

コンソールサーバーはシリアル接続を介してJunosデバイスに接続しますが、これは遅くなることがあります。コンソール サーバーを介した Junos PyEZ 接続のデフォルト接続タイムアウト値は 0.5 秒です。クライアントアプリケーションが接続を確立するのに十分な時間を確保するには、 timeout=seconds 引数を含めて接続タイムアウト間隔を増やす必要がある場合があります。

次の Junos PyEZ の例では、コンソール サーバー、次に Junos デバイスで認証します。接続タイムアウトは、クライアントが接続を確立するのに十分な時間を確保するために、6秒に設定されています。

要塞またはジャンプ ホストを介してデバイスに接続する

Junos PyEZでは、中間ホスト(要塞ホストまたはジャンプホスト)を介してターゲットデバイスにアクセスできます。ターゲットデバイスに直接ログインできない場合は、要塞ホストまたはジャンプホストの使用が必要になることがあります。たとえば、デバイスがファイアウォールの内側にある場合があります。

SSHを使用して中間デバイスを介して接続するには、以下のいずれかのオプションを使用できます。

  • SSH設定ファイルで、ターゲットデバイスのエントリを追加し、ProxyCommandオプションを指定します。

  • Device引数リストに、proxy_commandパラメーターを含めます。

Device proxy_command引数は、SSH設定ファイルのProxyCommandオプションよりも優先されます。両方のオプションを設定する場合、Junos PyEZ は proxy_command 引数のみを使用します。次のセクションでは、各オプションの使用方法について詳しく説明します。

例:SSH設定ファイルでProxyCommandを使用する

SSH設定ファイルで要塞ホストまたはジャンプホストを設定するには、Junosホストのエントリを追加し、ProxyCommandオプションを含めます。ProxyCommand 文字列は、中間デバイスへの接続を定義します。例えば、以下の設定は、netcatをサポートする中間ホストを介して接続します。

同様に、以下の設定では、中間デバイスを介してターゲットホストとポートにクワイエットモードで接続します。これにより、警告が抑制されます。

例: Device proxy_command引数を使用する

Deviceを定義する際には、proxy_command引数を含めて、中間デバイスを介して接続することができます。proxy_command文字列は、要塞ホストまたはジャンプ ホストへの接続を定義します。必要に応じて、Junos PyEZはジャンプホストのパスワードまたはSSHプライベートキーパスフレーズの入力を求めます。

次の例では、ジャンプ ホストを介して Junos デバイスに接続します。この例では、Junos PyEZは、SSHキーエージェントにロードされたパスフレーズで保護されたSSHキーを使用して、各デバイスで認証します。

SSHキーエージェントでジャンプホストとネットワークデバイスのSSHキーを読み込む場合、Junos PyEZアプリケーションでプライベートキーパスやパスフレーズを指定する必要はありません。ただし、必要なキーをSSHキーエージェントにロードしない場合は、デフォルト以外の場所にあるパスフレーズで保護されたキーのパスとパスフレーズを提供する必要があります。 ssh_private_key_file 引数と password 引数は、Junosデバイスでの認証に使用する秘密鍵のパスとパスフレーズを指定します。 proxy_command 引数で、 -i path オプションを使用して、ジャンプホストとの認証に使用するプライベートキーのパスを指定します。スクリプトを実行すると、Junos PyEZは対応するプライベートキーパスフレーズの入力を求めます。次に例を示します。

スクリプトを実行すると、スクリプトはプライベートキーのパスフレーズの入力を求めます。

アウトバウンド SSH を使用してデバイスに接続する

クライアントが接続を開始しようとすると(デバイスがファイアウォールの内側にある場合など)、ブロックされるクライアント管理アプリケーションとのTCP/IP接続を開始するようにJunosデバイスを設定できます。 outbound-ssh 設定は、クライアント管理アプリケーションとのTCP/IP接続を作成し、デバイスのIDを転送するようにデバイスに指示します。接続が確立されると、管理アプリケーションがクライアントとして機能してSSHシーケンスを開始し、Junosデバイスがサーバーとして機能してクライアントを認証します。

注:

JunosデバイスでアウトバウンドSSHを設定してコミットすると、デバイスはコミットされた設定に基づいてアウトバウンドSSH接続を開始します。デバイスは、成功するまでこの接続の作成を繰り返し試みます。デバイスとクライアント管理アプリケーション間の接続が切断された場合、デバイスは成功するまで新しいアウトバウンドSSH接続の作成を再試行します。この接続は、アウトバウンドSSH設定が削除または非アクティブ化されるまで維持されます。

アウトバウンド SSH 接続用に Junos デバイスを設定するには、[edit system services] 階層レベルで outbound-ssh ステートメントを含めます。次の例では、Junosデバイスがポート2200の198.51.100.101にあるホストとの接続を開始しようとします。

アウトバウンドSSHを使用してJunosデバイスとの接続を確立するために、Junos PyEZアプリケーションは、Deviceコンストラクタのsock_fd引数を既存のソケットのファイル記述子と等しく設定し、host引数を省略するか、Noneに設定します。

次の Junos PyEZ の例では、設定された TCP ポートで Junos デバイスからの受信 SSH セッションをリッスンします。アプリケーションは着信接続を受け入れ、その接続のソケットのファイル記述子を取得し、 sock_fd 引数の値に使用されます。クライアントアプリケーションは、デバイスとのSSH接続を確立し、デバイスのファクトを収集して出力し、デバイスからの接続を切断し、さらなる接続を待ちます。

JunosデバイスでのアウトバウンドSSHの設定に関する詳細については、 アウトバウンドSSHサービスの設定を参照してください。

Telnet を使用してデバイスに接続する

Junos PyEZ Deviceクラスは、ネットワークデバイスへの暗号化されていないアクセスを提供するTelnetを使用したJunosデバイスへの接続をサポートしています。デバイスの管理インターフェイス、またはデバイスの CONSOLE ポートに直接接続されているコンソール サーバーに telnet 接続できます。管理インターフェイスへのアクセスを必要とするすべてのデバイスで、[edit system services]階層レベルでtelnetステートメントを設定する必要があります。コンソール サーバーを介してデバイスにアクセスすると、リモート アクセス用にまだ構成されていない新しいデバイスまたはゼロ化されたデバイスを最初に構成できます。

Junos PyEZを使用してJunosデバイスにtelnetするには、Device引数リストにmode='telnet'を含め、オプションでポートを指定するportパラメーターを含める必要があります。mode='telnet'を指定してportパラメーターを省略すると、portの値はデフォルトで23になります。アプリケーションがコンソールサーバーを介して接続する場合、コンソールサーバーがJunosデバイスに接続するポートを指定します。

Junos PyEZを使用してJunosデバイスにtelnetし、デバイスの事実を印刷するには:

  1. Deviceクラスと、タスクに必要なその他のモジュールまたはオブジェクトをインポートします。
  2. mode='telnet'引数を使用してデバイスインスタンスを作成し、デフォルトと異なる場合は接続ポートを指定し、ホスト名、認証に必要なパラメーター、およびオプションのパラメーターを指定します。
  3. open()メソッドを呼び出してデバイスに接続します。
  4. デバイスのファクトを印刷します。
  5. 必要なタスクを実行した後、デバイスへの接続を閉じます。

ここでは、サンプルプログラムの全文を紹介します。

または、デバイスに接続時にコンテキストマネージャーを使用して、接続のオープンとクローズを処理することもできます。次に例を示します。

場合によっては、バナーメッセージを出力するコンソールサーバーに接続する場合、メッセージの後に Enter キーを押してログインプロンプトに到達する必要がある場合があります。この場合、アプリケーションがログイン プロンプトを受信できず、接続がハングする可能性があります。

Junos PyEZリリース2.6.2以降、Junos PyEZはコンソールサーバーのバナーを自動的に処理します。Junos PyEZ リリース 2.1.0 から 2.6.1 では、Junos PyEZ アプリケーションは、バナーメッセージを出力するコンソールサーバーを処理するために、Device引数リストにconsole_has_banner=Trueを含めることができます。

console_has_banner=True引数を含める場合、初期接続時にアプリケーションがログイン プロンプトを受信しない場合、アプリケーションは 5 秒間待機します。その後、アプリケーションは改行 (\n) 文字を出力し、コンソールサーバーからログインプロンプトが発行されます。引数を省略して接続がハングした場合、アプリケーションは代わりに <close-session/> RPC を発行して接続を終了します。

シリアルコンソール接続を使用してデバイスに接続する

Junos PyEZ Device クラスでは、シリアルコンソール接続を使用してJunosデバイスに接続できます。シリアルコンソール接続は、リモートアクセス用にまだ設定されていない新しいデバイスまたはゼロ化されたデバイスを最初に設定する必要がある場合に便利です。この接続方法を使用するには、 CONSOLE ポートを介してデバイスに物理的に接続する必要があります。デバイスの コンソール ポートへの接続に関する詳細な手順については、特定のデバイスのハードウェア マニュアルを参照してください。

注:

Junos PyEZは、シリアルコンソール接続でのコンテキストマネージャーの使用をサポートしています。コンソール接続にはコンテキストマネージャーを使用することをお勧めします。コンテキストマネージャーは接続のオープンとクローズを自動的に処理するためです。接続を閉じないと、予期しない結果が生じる可能性があります。

Junos PyEZを使用してシリアルコンソール接続を介してJunosデバイスに接続するには、Device引数リストにmode='serial'を含める必要があります。オプションで port パラメーターを含めてポートを指定することができます。mode='serial' を指定して port パラメーターを省略すると、port の値はデフォルトで /dev/ttyUSB0 になります。

Junos PyEZを使用して、シリアルコンソール接続を使用してJunosデバイスに接続し、設定をロードしてコミットするには:

  1. Deviceクラスと、タスクに必要なその他のモジュールまたはオブジェクトをインポートします。
  2. mode='serial'引数を使用してデバイスインスタンスを作成し、デフォルトと異なる場合は接続ポートを指定します。認証に必要なパラメータとオプションのパラメータを指定します。
    注:

    Junos OSを実行しているすべてのプラットフォームでは、デフォルトでrootユーザーのみが設定されており、パスワードは設定されていません。新しいデバイスまたはゼロ化されたデバイスの場合は、 user='root' を使用し、 passwd パラメーターを省略します。

  3. デバイス上に設定をロードしてコミットします。
  4. 必要なエラー処理を含めます。

ここでは、サンプルプログラムの全文を紹介します。