この記事はシスコの有志による Webex Advent Calendar 2021 の 25 日目として投稿しています。
Webex Advent Calendar 2021: https://qiita.com/advent-calendar/2021/webex
はじめに
コテコテののネットワークエンジニアです。APIはビギナーなんですが、時流に乗ってWebex APIを初めてに叩いてみました。
他の方のようなテクはないので、「初めてやるとこんなところにつまづくんだなー」という記録のためにAdvent Calendarに参加します。
＃アドベントカレンダー最終日にこんな記事でいいのか・・・
やりたいこと
使い古しかもしれないですが、コテネットエンジニアらしく、EEM(Embedded Event Manager)からWebexにメッセージを飛ばすというのをやってみます。
やりたいことはこれです。
ルータで何か事件が発生(インターフェイスダウンとか、config変更とか) --> Webexにメッセージを送信！
以下の手順で進めます。
- サンプルコードをDevNetから探す
- Webexの開発者用サイトから必要な情報を取得する
- ルータにEEM設定して、コード(python)をルータに置く
- エラーが出るのでデバッグする！
環境
EEM用に以下のルータと、インターネット接続環境を用意
C1111X-8P (IOS-XE version 17.03.04a)
免責事項
スクリプトの実行は自己責任でお願いします。本スクリプトを実行することにより生じるいかなる問題に関しましても、筆者は一切責任を負いません。
さあ、やってみよう
1. サンプルコードをDevNetから探す
https://developer.cisco.com/ にアクセスします。Code Exchangeから使えそうなコードを探します。
Code Exchangeでは"eem"をキーワードにして検索してみました。
今回はこれを使ってみることにします！
コードはGithubで管理されているようです。View on GitHubをクリックします。
クリックした先のページには、ファイルのリンクとREAMD.mdが表示されています。READMEを読んでみます。
ざっとみて
- 条件等の説明
- Config方法 (EEMとguestshell)
- 使い方
が書いてあるようです。今回は細かいカスタマイズはせず、単純に使ってみるだけなので詳細はすっ飛ばし、pythonファイル(configDiff.pyとmytokens.py)をローカルPCにコピーしましょう。
mytokens.pyを開いてみると、"access token"と"room id"が必要そうです。
access_token = "your.webex.token"
teams_room = "your.teams.room.id"
http_proxy = "http://proxy.your.server.com:port"
webex_webhook_url = "https://your.webhook.url"
slack_webhook_url = "https://your.webhook.url"
microsoft_webhook_url = "https://your.webhook.url"
これらはwebexでroomに投稿する際に必要なものです。
誰が投稿するのか＝Access Tokenで識別
どのスペースに投稿するのか＝Room IDで識別
します。
Access TokenとRoom IDはWebexの開発者用サイトからゲットします。
2. Webexの開発者用サイトから必要な情報を取得する
https://developer.webex.com にアクセスします。Log in後、Documentationをクリックしましょう。(アカウントがない場合はSign upからアカウントを作成します)
まず投稿用のスペースを作成し、そのRoom IDを取得します。
左ペインの"Webex APIs"から"Messaging">"Reference">"Rooms"を探します。
"Create a Room"からWebex内にメッセージ投稿用のスペースを作成しましょう。
右ペインに現れた項目のうち、titleが必須項目です。ここにスペース名を記入します。なお、下の"isAnnouncementOnly"のチェックは外しておきましょう。
Runをクリックすると結果が表示されます。200/OKが出ていれば成功です。
↑この一番上の行の"id"が"Room ID"です。コピーして控えておきましょう。
次に"Access Token"です。自分の名前で投稿する場合には、右ペイン一番上にある"Authorization"に表示されている(隠れている？)ものがAccess Tokenです。
これを使うこともできるのですが、自分のAccess Tokenが漏れてしまった場合、そのTokenを使ってあなたになりすまして（権限の範囲内で）何でもできてしまうため、コードに埋め込むのはセキュリティ上おすすめしません。
ということで、投稿用のbotを作成します。
ブラウザ画面上部右にある自分のアイコンをクリックし、"My Webex Apps"をクリックします。
"Create a New App"をクリックします。Create a New App画面がでるので、Create a Botをクリックします。
必要な項目を入力して、"Add Bot"ボタンをクリックします。
正常に作成できました。このbotのAccess Tokenは、"Copy Token"をクリックします。コピーして控えておきましょう。
さて、ゲットできたAccess TokenとRoom IDをmytokens.pyに記入します。
"your.webex.token"と"your.teams.room.id"を、先ほどゲットしたAccess TokenとRoom IDに置き換えます。
さて、pythonファイルの修正で注意すべきことがあります。
- ファイル内のインデント(字下げ)がTABになっていると、ルータがエラーを吐くことがあります。TABはスペースに置き換えた方が無難です。
- テキストエディタで修正する場合、半角/全角や文字コードに注意しましょう。エディタが気を利かせて勝手に書き換える場合があります。コードの修正はVisual Studio Codeなどのコードエディタを使うことをお勧めします。
- 今回のサンプルはpython version 3でしたが、古いサンプルだとpython 2を使っている場合があります。ルータのOSが新しい場合はpython 3なので、python 2 --> python 3の書き換えが必要です。
3. ルータにEEM設定して、コード(python)をルータに置く
DevNet(というかGitHub)に戻りましょう。READMEを読むと、ルータに設定すべき設定がすべて書かれています。
EEMのconfigとIOxのconfigをルータに設定します。
さて、pythonファイルはどこに置いたらいいのでしょうか？
ルータの設定後、guestshellを起動してみましょう。
C1111X-8P-1#guestshell
[guestshell@guestshell ~]$ cd /
[guestshell@guestshell /]$ ls
bin cisco etc lib lost+found opt run srv usr
boot data flash lib64 media proc sbin sys var
bootflash dev home local mnt root selinux tmp
[guestshell@guestshell /]$ cd flash
[guestshell@guestshell flash]$ ls
guest-share
[guestshell@guestshell flash]$
guestshellからは、ルータのflashにマウントされているのですが、guestshellから見えるのは、flashの中のguest-shareディレクトリのみのようです。
pythonファイルはguest-shareディレクトリにコピーするようにしてください。
EEMのconfigに記載するpythonファイルのパスも上記に合わせて修正するのも忘れずに。
4. エラーが出るのでデバッグする！
さあ、動かしてみましょう！
READMEにやり方は書いてありますよ。
そして一発で動けば幸運です。エラーが出た場合は、変数をprint()で表示させながら、どこまで正常に動作しているのか確認しながら進めます。
前述の3つ(TABはスペースに書き換える、文字コードに注意、python3に修正)が適切になっているか、確認しましょう。
さいごに
今回は初歩の初歩の話でした。developer.webex.comだけでなく、DevNetも活用することで、サンプルコードを使ったお手軽API体験ができます。
多少pythonの知識は必要となるサンプルですが、一から作るより随分ハードルは下がります。2つのディベロッパーサイトをフル活用にチャレンジしてみてください。私も来年頑張ります！
メリークリスマス＆パッピーニューイヤー＆ハッピーWebex！！！