はじめに
この記事はシスコの同志による Advent Calendar の一部として投稿しています
- 2017年版: https://qiita.com/advent-calendar/2017/cisco
- 2018年版: https://qiita.com/advent-calendar/2018/cisco
- 2019年版: https://qiita.com/advent-calendar/2019/cisco
- 2020年版: https://qiita.com/advent-calendar/2020/cisco
- 2020年版(2枚目): https://qiita.com/advent-calendar/2020/cisco2
- 2021年版: https://qiita.com/advent-calendar/2021/cisco
- 2021年半(2枚目): https://qiita.com/advent-calendar/2021/cisco2
本記事は2021年版Advent Calendarの２２日目の投稿です。私個人としては初めての投稿になります。
Node-REDとは
Node-JSベースのローコードプログラミングツールで、フローチャートのような図を描いてロジックを実装していくことができます。
Node-REDの良いところ
プログラミングの知識がなくても使える
ネットワーク機器のコマンドだったら慣れているけど、プログラミングは未経験という方は多いと思います。基礎的なプログラミングはOSPFやBGPなどのオプションを全て覚えるのに比べると簡単だと思いますが、慣れていないから分からない・近寄りたくないという方にとっても気軽に始められる点で非常に優れているツールであると思います。ネットワークにまつわるAPIで必要な入出力が完備されている
HTTPのI N/OUTが標準装備で、ngrokモジュールも公開されたものがありますので、固定のグローバルIPアドレスがなくてもWebhookを受信する子もできます。また、私が所属するMeraki関連ではMQTTのPublisher/Subscriberにもなれますので、これ一つでMeraki関連のAPIを扱うことができます。作ったプログラムを簡単に共有できる
作成したプログラムはフローと呼びますが、JSON形式で簡単にエクスポートして他の人と共有できるほか、GitHubを経由して公開することも可能です。
Node-REDを使ってみる
インストール
Node-REDはNode.jsというサーバサイドJavaScriptで動きますので、色々な環境で利用することができます。私は手元のMacBookで動かすことにしましたので、以下の手順でインストールしました。
＃Node.jsのインストール
brew install node
#Node-Redのインストール
sudo npm install -g --unsafe-perm node-red
#Node-Redの実行
node-red
Windowsやラズパイで動かすこともできますが、インストールの仕方はオフィシャルサイトをご覧いただくかググってみてください。
Node-REDのエディタにアクセスする
デフォルトではtcp/1880で動作しますので、ブラウザに http://localhost:1880/ と入力してアクセスすると白紙のキャンバスが見えてきます。
Hello World!!してみる
まず、この図のように[HTTP IN]-[CHANGE]-[HTTP RESPONSE]の順に並べてワイヤで繋ぎます。
次に一番左のHTTP INをダブルクックしてプロフパティを開きます。ここではアクセス先のパスを指定する必要がありますので、なんでも良いのですが /hello としてみました。
次に真ん中のCHANGEノードをダブルクリックして、表示させたい"Hello World!!"を入力します。
最後に画面右上のDeployボタンをクリックして完了です。このボタンが赤いときは変更が反映されていませんので、変更した後には必ずクリックしてから動かすようにしましょう。
動作確認としてブラウザでアクセスしてみます。
http://localhost:1880/hello
Hello World!!できました。
少し解説
何気なくぽちぽちノードを並べて繋げただけで、簡単なアプリケーションが出来上がりました。ここで一つ理解しておいた方が良い重要なことが起きていました。それはノードとノードを繋いでいるワイヤが何をしてくれているのか？ということです。答えから先に書くと、このワイヤは msg という変数をノード間で受け渡しています。HTTP INとHTTP RESPONSEは必ずセットで使う必要があるのですが、アクセスがあったときに返す値をmsg.payloadという部分から取り出してきます。msg.payloadは本当によく使うのですが、 msg というオブジェクト型変数の一部になります。
msg をやりとりしてプログラムが成立するというのは本当に大切なことなので、もう少し深掘りしてみたいと思います。まず、debugノードをこのように配置して、Deployします。
その後もう一度Hello World!!の画面をリロードしてみます。先ほどと同じようにHello World!!と表示されるだけですが、その後Node-REDの画面に戻ってきて、画面右上の虫さんマークをクリックします。
そうすると、HTTP INでは値がない状態でしたがCHANGEノードを通過することによってHello World!!に書き換えられたことがわかります。今度はこのDEBUGノードでmsg全体を見てみます。ノードをダブルクリックしてdebugの対象をmsg全体に広げます。
両方ともを変更して、忘れずにDeployをクリックした後に、再度Hello World!!を読み込んでみると、Node-REDのdebugには次にような表示が出ることかと思います。
実は表示しているメッセージだけではなく、セッションのIDとかリクエスト・レスポンスのパラメータなんかも持ち運ばれていたことがわかってきます。
まずはmsgというNode-RED独特の変数が使われることと、この変数にはPayload以外の属性も含まれているということを理解しておくと後々悩むことが減る思いますので、少し長くなりましたが解説してみました。
Meraki APIでやりとりをしてみる
Webhookの受信
クラウドサービスのsyslogと思えば良いかと思いますが、Webサービスで何かイベントが起きた時の通知の手段です。
インターネットからメッセージが飛んできますので、家庭やオフィスで利用しているPCが受信できるようにngrokを利用します。ngrokを単体で利用しても良いのですが、便利なノードがありましたので使ってみました。
右上のメニューからManage paletteをクリックします。
Installタブでnode-red-contrib-ngrokを検索してインストールします。
今回は受信するだけですのでこのようにフローを作りました。
まず、ngrokを有効にします。ノードの左側にある薄緑のところをクリックすると有効になり、debugのところにアクセス先となるURLが表示されると思います。
このURLをコピーして、MerakiダッシュボードでWebhookの設定を行います。［ネットワーク全体］→［アラート］のページの下ほうにWebhookの設定はあります。URLの部分にはngrokで生成されたホスト名にノードで指定しているパス（この例では/webhook）を追加してあげる必要があります。共有パスワードはなんでも良いのですが、cisco123としてみました。
テストWebhookを送信というボタンをクリックするとテストメッセージが受信できると思います。
syslogみたいなものと例えましたが、メッセージの中身はsyslogよりも充実してそうですね。
ここで少しセキュリティ対策を施します。Webhookの送り先は言ってみればただのWebサーバですから、基本的には誰でもアクセス可能です。もし悪意のある人がこの宛先を知って、偽のメッセージを投げてこられたら困りますよね？実際には起きてない障害が起きたことになって、バタバタするかもしれません。このような事態を回避するために共有パスワードを受信時にチェックして、信頼できる送信元かどうかをチェックすることができます。この例ではすでにcisco123とセットしてありますから、チェックする仕組みをフローに組み込みます。
今回利用するのはスイッチノードです。HTTP INとHTTP RESPONSEの間にドロップすると自動的にワイヤも再接続してくれます。賢いやつですね。プロパティはこのようにmsg.payload.sharedSecretがcisco123と完全一致しているかどうかを定義して、他のものであったら捨てます。
これで再度テストする際にcisco１２３４などと少しでも変更すると、エラーになると思います。このように条件分岐する際にはスイッチノードを使います。
Dashboard APIをコールしてみる
Dashboard APIは文字通りダッシュボード上で行う設定だったりステータスの確認等をREST API経由で行うものです。作成するフローはこのようになります。
WebhookやHello World!!ではWebアクセスによってその後のフローが動作していましたが、今回は手動でフローを開始する必要がありますので、インジェクトノードを最初に置きます。その後ろにHTTP REQUESTを置いて完了ですが、動作確認のためのDebugを最後に置いています。HTTP REQUESTは、URLの設定だけですが今回はオーガナイゼーション一覧を取得するためのURLを指定しました。
認証に使うAPIキーの設定などはインジェクトノードの中で行なっています。CHANGEノードと同じように値のセットを行うことができます。
準備としてDashboard APIを受け付けるようにオーガナイゼーションの設定を行うことと、Meraki Dashboardアカウントに対するAPIキーの生成が必要になります。
［オーガナイゼーション］→［設定］
［画面右上のメールアドレス］→［プロファイル］
なお、最新のDashboard APIに関するドキュメントはこちらで確認できます。
https://developer.cisco.com/meraki/api-v1/
これでインジェクトノードの左にあるボタンをクリックすることで実行でき、応答をdebugで確認できるかと思います。
ただ、ここで気がつく方もいるかもしれませんが、JSONの形式で表記された文字列として取り扱われています。このため、この先の処理をしやすくするために少し工夫をします。HTTP REQUESTノードのプロパティを開き、JSON Parseするように変更します。
もしくはこのようにJSON Parseのノードを挟みます。
これによりdebugが次のように変化し、後で扱いやすくなります。
便利なパレット
ここまででAPIに触れることができ、同じような方法でMeraki以外のAPIも触れることができるようになると思います。Merakiでは簡単にAPIをご利用いただくためにいくつか専用のパレットを準備しています。
node-red-contrib-meraki-cmxはSanning APIという無線アクセスポイントで検出したMACアドレスの位置情報を取得するためのノードになります。今回は使いません。
node-red-contrib-meraki-dashboard-api-v1を入れておくと、先ほどのDashboard APIへのアクセスもより簡単になります。
DashboardノードのプロパティからAPIエンドポイントの一覧を探すことができますので、ドキュメントを読まなくもダッシュボードの操作に慣れている方でしたら探していくことができるようになっています。
以下のようなフローにすることでHTTP REQUESTノードで作った時と同じように動きます。
おわりに
今までプログラミングが苦手でAPIな話題には耳を塞いでいた方も、Node-REDを利用すれば自分でもできるんじゃないかな？と思われたのではないでしょうか？実際、私の同僚の数名はNode-REDを知ることでAPIを使ったプログラムを作り始めました。Node-REDは今日紹介したこと以外にもLINEに通知を出すためのパレットなども備えていますので、実用的なアプリケーションを作るために便利な要素が詰まっています。また、子供向けのプログラミング学習で電子工作キットなどでも利用されていて、仕事の場面以外でも役に立つと思います。この記事がきっかけで、少しでもプログラミングアレルギーをお持ちの方が減ると嬉しいです。
免責事項
本サイトおよび対応するコメントにおいて表明される意見は、投稿者本人の個人的意見であり、シスコの意見ではありません。本サイトの内容は、情報の提供のみを目的として掲載されており、シスコや他の関係者による推奨や表明を目的としたものではありません。各利用者は、本 Web サイトへの掲載により、投稿、リンクその他の方法でアップロードした全ての情報の内容に対して全責任を負い、本 Web サイトの利用に関するあらゆる責任からシスコを免責することに同意したものとします。