YNOエージェント機能

$Date: 2018/04/02 09:07:41 $


概要

YNOエージェントは、ヤマハネットワーク機器を「Yamaha Network Organizer (YNO)」で遠隔管理するための機能です。YNOエージェント機能を有効にしたヤマハネットワーク機器はインターネット経由でYNOマネージャーへ接続し、必要に応じて以下の処理を実施します。


用語の説明

用語 説明
ACS Auto Configuration Serverの略。YNOマネージャーの中に設置されるサーバーで、ヤマハネットワーク機器の管理を行う。
CWMP CPE WAN Management Protocolの略。YNOエージェントとACSの間の通信方式。
XMPP Extensible Messaging and Presence Protocolの略。ヤマハネットワーク機器がNAT配下にいる場合でもACSが即座にメッセージを送信できるようにする仕組み。
GFW GUI Forwarderの略。YNOマネージャーのGUIを経由してヤマハネットワーク機器のGUIを表示できるようにする仕組み。

注意事項

YNOエージェント機能には以下の条件を満たすインターネット回線が必要です。

※ WANインターフェースの場合、以下のような設定が該当します。

#
#
#
wan1 auto connect on
wan1 disconnect time 60
no wan1 always-on

YNOエージェント機能はYNOマネージャーと定常的に通信するほか、以下の操作により大容量のデータ通信が発生する場合があります。

意図しない高額な課金を避けるため、定額制インターネット回線での使用を推奨します。なお、ヤマハネットワーク機器および上位ネットワーク機器でNAT/NAPT機能が存在することによる動作への支障はありません。

通信速度が低い、または遅延の大きいモバイル等の回線を使用している場合、GUI Forwarderによるヤマハネットワーク機器GUIの表示に時間がかかる場合があります。十分な検証の上で使用してください。


対応機種とファームウェアリビジョン

以下の機種およびファームウェアで、YNOエージェント機能をサポートしています。なお、ファームウェアリビジョンにより対応機能に差異があります。

機種 ファームウェア 基本機能 HTTPSプロキシ接続 GUI Forwarder
RTX830 Rev.15.02.01以降
NVR510 Rev.15.01.06以降
NVR700W Rev.15.00.07以降
RTX1210 Rev.14.01.14以降
Rev.14.01.26以降
FWX120 Rev.11.03.22以降
RTX810 Rev.11.01.28以降

詳細

機能説明

ヤマハネットワーク機器動作状態の通知

YNOエージェント機能は必要に応じてYNOマネージャーへヤマハネットワーク機器の最新の動作状態を送信します。送信タイミングは、YNOマネージャーから要求を受けた場合と、ヤマハネットワーク機器で動作状況が変化した場合の2種類です。動作状況が変化した場合で、特に管理者へ知らせる必要がある情報は「アラーム」としてYNOマネージャーへ通知されます。

ヤマハネットワーク機器の動作状態としてYNOマネージャーへ送信される情報は、ハードウェア情報、インターフェース情報、経路情報、LAN一覧マップ情報、SYSLOGなどです。また、YNOマネージャーへ通知するアラームについては以下を参照してください。

CONFIGの送信・適用・保存

YNOエージェント機能は必要に応じてYNOマネージャーへCONFIGを送信したり、YNOマネージャーから受信したCONFIGをヤマハネットワーク機器に適用・保存します。YNOマネージャーでRunning configの取得操作を行うと、ヤマハネットワーク機器で実行中のCONFIGがYNOマネージャーへ送信されます。また、YNOマネージャーで一時保存CONFIGの送信操作を行うと、以下に示すヤマハネットワーク機器のCONFIGファイルが更新されます。なお、CONFIGファイル更新時にはヤマハネットワーク機器でCONFIG履歴が自動生成されます。

一時保存CONFIGの反映方法 更新されるCONFIGファイル
即時反映 実行中のCONFIG、およびフラッシュROMまたは外部メモリ上のCONFIGファイル (※)
次回起動時に反映 フラッシュROMまたは外部メモリ上のCONFIGファイル (※)

※ ヤマハネットワーク機器の起動時に使用したCONFIGファイル (configN.M形式のファイルで起動した場合はconfigNが更新されます)

ファームウェアの更新

YNOエージェント機能は、YNOマネージャーからの要求を受けファームウェアのリビジョンアップを実施します。

リビジョンアップ中はコンソールに以下のメッセージ1が表示され、完了後ヤマハネットワーク機器は自動的に再起動します。また、リビジョンアップ完了後に"show status boot"コマンドを実行すると以下のメッセージ2が表示され、YNOエージェント機能によりリビジョンアップが行われたことを確認できます。

メッセージ1 (リビジョンアップ中のコンソール表示)

>
YNO-Agent Firmware Revision Update: Downloading... -> Check & Writing... -> Done
Restarting ...

メッセージ2 ("show status boot" コマンドの実行結果)

> show status boot
 Running EXEC: RTX1210 Rev.14.01.XX (XXX XXX 00 00:00:00 2016)
Previous EXEC: RTX1210 Rev.14.01.XX (XXX XXX 00 00:00:00 2016)
Restart by YNO revision-up

コマンドの実行

YNOエージェント機能はYNOマネージャーから要求されたコマンドを実行します。コマンドは管理ユーザー権限で実行され、実行結果(成功・失敗・出力メッセージ)がYNOマネージャーへ返答されます。

以下のコマンドは本機能で実行することができません。

GUI Forwarder (GFW)

GUI Forwarderにより、YNOマネージャーのGUIを経由してヤマハネットワーク機器のGUIを表示することができます。また、以下のようにYNOマネージャーにより管理されているヤマハネットワーク機器がL2MSマスターである場合、LANマップを経由してL2MSスレーブとなっているヤマハネットワーク機器のGUIを表示することも可能です。

L2MSとの連携

ヤマハネットワーク機器がYNOマネージャーに接続できる環境であれば、ヤマハネットワーク機器、あるいはその上位ネットワーク機器の設定を変更する必要はありません。

GUI Forwarderによりヤマハネットワーク機器のGUIを表示する場合、以下の制約があります。

動作概略

YNOエージェント機能は以下のコマンドが投入された時点、または以下のコマンドを含むCONFIGでヤマハネットワーク機器を起動した時点で動作を開始します。一方または両方のコマンドを"no"で取り消した場合や、"yno use off"コマンドを投入した場合には動作を停止します。

動作開始後、YNOエージェント機能は以下の通りYNOマネージャーの各サーバーに対して3種類の接続を行います。これらの接続はすべて暗号化されています。各サーバーとの通信状態はshow status ynoコマンドで確認することができます。

接続形態

ヤマハネットワーク機器の上位にHTTPSプロキシサーバーが存在する場合は、yno https-proxyコマンドでHTTPSプロキシサーバーのアドレスとポート番号を設定することで、YNOマネージャーと通信することが可能です。

ファームウェアをダウンロードする場合は、上記とは異なるサーバー (ヤマハWebサイト) にHTTP接続します。以下のコマンドにより、HTTPプロキシサーバー、ダウンロードタイムアウト時間を設定することができます。

各接続の詳細情報を以下にまとめます。

接続の種類 接続先 送信元ポート番号 宛先ポート番号 接続タイミング
CWMP YNOマネージャー (ACS) 不定 (TCP) 443 (TCP) 定期通信 (10分間隔)・その他必要時
XMPP※1 YNOマネージャー (XMPPサーバー) 常時接続 (5分間隔でキープアライブ通信を実施)
GFW※2 YNOマネージャー (GFWサーバー) 常時接続 (5秒間隔※3でキープアライブ通信を実施)
ファームウェアダウンロード ヤマハWebサイト 80 (TCP) ファームウェア更新時

※1 XMPP接続に失敗する環境でもYNOエージェント機能は動作しますが、YNOマネージャーの一部操作に最大10分程度の待ち時間を要することがあります。

※2 GFW接続に失敗する環境ではGUI Forwarderによりヤマハネットワーク機器のGUIを表示することはできません。

※3 yno gui-forwarder timeoutコマンドで変更可能です。

YNOマネージャーへの接続に失敗した場合、YNOエージェント機能は以下のインターバルを置いた後、YNOマネージャーへの接続をリトライします。リトライまでのインターバルはリトライした回数に比例して徐々に長くなっていき、最長で10分前後になります。また、インターバルはリトライ回数毎に決められた一定の範囲の中からランダムに決定します。ただしリトライ回数は状況によりリセットされることがあります。

リトライ回数 インターバル
1回目 35秒前後
2回目 50秒前後
3回目 70秒前後
4回目 90秒前後
5回目 130秒前後
6回目 175秒前後
7回目 240秒前後
8回目 330秒前後
9回目 455秒前後
10回目以降 625秒前後

ただちに接続をリトライする必要がある場合は、以下のコマンドを実行しYNOエージェント機能を再起動してください。

#
#
yno use off
yno use on

コマンド


設定例

例1. PPPoEでインターネットに接続する場合

構成図

設定例1の構成図

設定例

#
# 経路設定
#
ip route default gateway pp 1

#
# LANの設定
#
ip lan1 address 192.168.100.1/24

#
# プロバイダとの接続設定
#
pp select 1
 pp always-on on
 pppoe use lan2
 pppoe auto disconnect off
 pp auth accept pap chap
 pp auth myname (プロバイダに接続するID) (プロバイダに接続するパスワード)
 ppp lcp mru on 1454
 ppp ipcp ipaddress on
 ppp ipcp msext on
 ppp ccp type none
 ip pp secure filter in 2000
 ip pp secure filter out 3000 dynamic 10 11 12
 ip pp nat descriptor 1
 pp enable 1
dns server pp 1

#
# フィルタの設定
#
ip filter 2000 reject * *
ip filter 3000 pass * *
ip filter dynamic 10 * * domain
ip filter dynamic 11 * * www
ip filter dynamic 12 * * https

#
# NATの設定
#
nat descriptor type 1 masquerade

#
# YNOの設定
#
yno use on
yno access code (オペレーターID) (アクセスコード)

例2. ファイアウォール (NAT) 経由でインターネットに接続する場合

構成図

設定例2の構成図

設定例

#
# 経路設定
#
ip route default gateway dhcp lan2

#
# LANの設定
#
ip lan1 address 192.168.100.1/24
ip lan2 address dhcp
ip lan2 nat descriptor 1

#
# NATの設定
#
nat descriptor type 1 masquerade
nat descriptor address outer 1 primary

#
# DNSの設定
# 
dns server dhcp lan2

#
# YNOの設定
#
yno use on
yno access code (オペレーターID) (アクセスコード)

例3. HTTP/HTTPSプロキシサーバー経由でインターネットに接続する場合

構成図

設定例3の構成図

設定例

#
# 経路設定
#
ip route default gateway 10.0.0.1/8

#
# LANの設定
#
ip lan1 address 192.168.100.1/24
ip lan2 address 10.0.0.10/8
ip lan2 nat descriptor 1

#
# NATの設定
#
nat descriptor type 1 masquerade
nat descriptor address outer 1 primary

#
# DNSの設定
# 
dns server 10.0.0.1

#
# HTTPリビジョンアップの設定
#
http revision-up proxy 10.0.0.1 8080

#
# YNOの設定
#
yno use on
yno access code (オペレーターID) (アクセスコード)
yno https-proxy 10.0.0.1 8080

SYSLOGメッセージ一覧

本機能において出力されるSYSLOGメッセージを以下に示します。実際に出力されるメッセージには接続の種類により異なるプレフィックスが付加されます。

"[YNO_AGENT]" のプレフィックスが付加されるSYSLOG

「タイプ」に記載があるSYSLOGは、yno log コマンドの TYPE に当該タイプが設定されている場合のみ出力されます。

レベル タイプ 出力メッセージ 意味
INFO - YNO session was established YNO マネージャーとのセッションが確立した。
- YNO session was disconnected YNO マネージャーとのセッションが切断された。
- succeeded in updating access code アクセスコードの更新に成功した。
- succeeded in replacing running-config 実行中のCONFIGの置き換えに成功した。
- succeeded in replacing config ([file name]) CONFIGが置き換えられた。([ファイル名])
DEBUG - initializing YNO Agent... YNO エージェント機能を初期化中。
- succeeded in initializing YNO Agent YNO エージェント機能の初期化に成功した。
- failed to initialize YNO Agent, will be retried YNO エージェント機能の初期化に失敗した。再試行予定。
- starting YNO Agent... YNO エージェント機能を起動中。
- succeeded in starting YNO Agent YNO エージェント機能の起動に成功した。
- failed to start YNO Agent YNO エージェント機能の起動に失敗した。
- stopping YNO Agent... YNO エージェント機能を停止中。
- succeeded in stopping YNO Agent YNO エージェント機能の停止に成功した。
- failed to stop YNO Agent YNO エージェント機能の停止に失敗した。
- connecting to YNO Manager... YNO マネージャーへの接続試行中。
- connection to YNO Manager was established YNO マネージャーへ接続した。
- failed to connect to YNO Manager YNO マネージャーへの接続に失敗した。
- failed to communicate with YNO Manager YNO マネージャーとの通信に失敗した。
- received invalid response from YNO Manager ([point]) YNO マネージャーから不正な返答を受信した。([不正箇所])
- disconnected from YNO Manager YNO マネージャーから切断した。
inform connecting to YNO Manager... (inform) YNO マネージャーへの接続試行中。(定期通信)
inform connection to YNO Manager was established (inform) YNO マネージャーへ接続した。(定期通信)
inform disconnected from YNO Manager (inform), next: [N] sec later YNO マネージャーから切断した。次回の定期通信は [N] 秒後。
- connection to HTTPS proxy server was established HTTPS プロキシサーバーへ接続した。
- inform interval was set to [N] sec 定期通信間隔が [N] 秒に設定された。
- connecting to XMPP server... ([host name]:[port number]) XMPP サーバーへの接続試行中。(接続先: [ホスト名]:[ポート番号])
- XMPP connection was established XMPP サーバーへ接続した。
- XMPP connection was established via HTTPS proxy server HTTPS プロキシサーバー経由で XMPP サーバーへ接続した。
- failed to connect to XMPP server ([DNS/encrypt/auth/timeout/other]) XMPP サーバーへの接続に失敗した。(要因: DNS/暗号化/認証/時間切れ/その他)
- disconnected from XMPP server XMPP サーバーから切断した。
- failed to communicate with XMPP server ([timeout/other]) XMPP サーバーとの通信に失敗した。(要因: 時間切れ/その他)
- connection request was accepted YNO マネージャーへの接続要求を受理した。
- failed to accept connection request ([auth/other]) YNO マネージャーへの接続要求を受理できなかった。(要因: 認証/その他)
- received device management state YNO マネージャーによるヤマハネットワーク機器の管理状況を受信した。
- device became managed ヤマハネットワーク機器は YNO マネージャーの管理対象となった。
- device became unmanaged ([code]) ヤマハネットワーク機器は YNO マネージャーの管理対象外となった。([要因番号])
- unmanaged reason was changed ([code]) YNO マネージャーの管理対象外である要因が変わった。([要因番号])
- failed to accept device management state YNO マネージャーによるヤマハネットワーク機器管理状況の受理に失敗した。
- update of access code was requested アクセスコードの更新を要求された。
- failed to update access code アクセスコードの更新に失敗した。
- alarm was raised, notifying... ([type]) アラームが生成された。YNO マネージャーへ通知中。([アラーム種別番号])
- alarm was raised ([type]) アラームが生成された。([アラーム種別番号])
- failed to raise alarm ([type]) アラームの生成に失敗した。([アラーム種別番号])
- alarm was canceled, notifying... ([type]) アラームが解消した。YNO マネージャーへ通知中。([アラーム種別番号])
- alarm was canceled ([type]) アラームが解消した。([アラーム種別番号])
- failed to cancel alarm ([type]) アラームの解消に失敗した。([アラーム種別番号])
- succeeded in alarm notification YNO マネージャーへのアラーム通知に成功した。
- failed to notify alarm YNO マネージャーへのアラーム通知に失敗した。
action-read gathering device status was requested ヤマハネットワーク機器動作状態の取得を要求された。
action-read succeeded in gathering device status ヤマハネットワーク機器動作状態の取得に成功した。
- failed to gather device status ヤマハネットワーク機器動作状態の取得に失敗した。
action-read updates of device status was detected ヤマハネットワーク機器動作状態の変化を検知した。
action-read getting config was requested ([file name]) CONFIGの取得を要求された。([ファイル名])
action-read succeeded in getting config CONFIGの取得に成功した。
- failed to get config CONFIGの取得に失敗した。
- replacement of running-config was requested ([comment]) 実行中のCONFIGの置き換えを要求された。([コメント])
- failed to replace running-config 実行中のCONFIGの置き換えに失敗した。
- replacement of config was requested ([file name], [comment]) CONFIGの置き換えを要求された。([ファイル名], [コメント])
- failed to replace config CONFIGの置き換えに失敗した。
- command execution was requested コマンド実行を要求された。
- succeeded in command execution コマンド実行に成功した。
- failed to execute command コマンド実行に失敗した。
- critical command failed 致命的なコマンド実行に失敗した。
- discontinued command execution コマンド実行を中断した。
- command timed out ([timeout]): '[command]' コマンド実行がタイムアウトした ([タイムアウト時間]): '[コマンド名]'
- firmware revision-up was requested ファームウェアのリビジョンアップを要求された。
- downloading firmware... ([progress]) ファームウェアをダウンロード中。([進捗率])
- succeeded in downloading firmware ファームウェアのダウンロードに成功した。
- failed to download firmware ([timeout/DNS/connection/other]) ファームウェアのダウンロードに失敗した。(要因: 時間切れ/DNSエラー/接続不良/その他)
- downloading firmware was aborted ファームウェアのダウンロードが中断された。
- failed to abort updating firmware ファームウェアのアップデート中断に失敗した。
- updating firmware... ファームウェアを更新中。
- succeeded in updating firmware, restarting... ファームウェアの更新に成功した。現在再起動中。
- failed to update firmware ([timeout/broken/other]) ファームウェアの更新に失敗した。(要因: 時間切れ/ファイル破損/その他)
- updating firmware was aborted ファームウェアの更新が中断された。
- restart was requested 再起動を要求された。
- failed to allocate memory ([ID]) メモリの確保に失敗した。(識別ID)

"[GFWC]" のプレフィックスが付加されるSYSLOG

レベル 出力メッセージ 意味
INFO Session was established GFWセッションが確立された
Session was disconnected GFWセッションが切断された
DEBUG Activated GFWが有効化された
Inactivated GFWが無効化された
Could not start session. Retrying... GFWセッションを開始できなかったため再試行する
Could not receive message GFWサーバーからメッセージを受信できなかった
Timeout occurred 通信がタイムアウトした
Error occurred: (理由) 通信エラーが発生した
Could not connect: (理由) サーバーへの接続に失敗した
Authentication failed GFWサーバーへ接続する際の認証に失敗した
Received illegal message type GFWサーバーから不正なメッセージタイプを受信した
Received illegal message GFWサーバーから不正なフォーマットのメッセージを受信した
Connection closed by remote host GFWサーバーからコネクションを切断された
Could not resolve proxy プロキシサーバーの名前解決に失敗した
Could not connect to proxy server: (理由) プロキシサーバーに接続できなかった

関連文書