てくなべ (tekunabe)

ansible / network automation / 学習メモ

JANOG47 Meeting in Fukuoka 参加レポート

はじめに

2020/01/27-29 にオンラインで開催された JANOG47 Meeting in Fukuoka に参加ました。

前回の JANOG 46 では、現地とオンラインのハイブリッドでの開催でしたが、今回はオンラインのみとなりました。 このような制約があるなかでも開催されたことがありがたいです。

本記事では、自動化に関する以下の2つプログラムについて簡単にレポートします。

エンタープライズ向けVPNサービスNW 運用自動化への挑戦

★ 現在アーカイブ動画公開中(2021/03/21まで)

www.janog.gr.jp

P10(資料右下の数字) では、自動化後の構成が示されていました。StackStorm で定期的にオーダーを取得しにいく仕組みが興味深いなと思いました。

P20 では、自動化前後のフロー比較がされていました。自動化するとこよって、事後に行っていた設定も当日に行うことができ、負荷軽減やミス撲滅につながったそうです。日を跨ぐか跨がないかというのは、人のアサインにも大きく関わってくると思うので、なかなか大きな違いな気がします。良いですね。

P21 では、クライアントPCからはじめとする処理の流れが示されていました。 AWX を直接の作業インターフェースにせず、API 受付するのも AWX の活用方法の一つですね。 特に必要になるパラメータが大量で複雑になる場合は、AWX の画面で指定するよりも、スクリプトで処理してAPI リクエストを生成するほうが効率がよいかもしれません。

P23 では Ansible のロールの構成が示されていました。特にロールの階層が興味深かったです。 例えば、roles/(NW装置名)/Port/Add。途中まで名詞ベースのロールで、最後は動詞です。

(NW装置名) といういのが、純粋に機器1台ずつのことなのか、それともある程度役割でグループ化されているのかは聞きそびれてしまいました。機器1台だとするとロールの数かなり多くなると思うのですが、どうなのでしょう。

お二人の発表で、自動化する範囲をきちんと決められている点が共通していました。 やはりなんでも自動化しようとするのではなく、難易度や見込める効果などの観点で判断するのが良いとのだと思いました。


走りながら作るネットワークテンプレートシステム

★ 現在アーカイブ動画公開中(2021/03/21まで)

www.janog.gr.jp

P19 の Kubernetes との比較がおもしろかったです。確かにネットワーク機器は、プロトコルレベルで自立分散で動くなぁと。 ただ、そこから「あるべき形の宣言 = ネットワーク装置の設定」であるとの考えまでに私は至らなかったので、なるほどと思いました。

私含めて、私の周りの人が関心を寄せていたのが、P30 の Patch という自由記入欄を設ける考え方です。 標準化できないから自動化をしない、のではなく、標準化できない部分はそれはそれとして自由記入欄で受け入れる余地を残すという考え方。

この折り合いの付け方が素敵だなと思いました。

■ おわりに

はじめにも書きましたが、このような状況下でも開催された事自体が本当にありがとうと思います。

当初は現地開催も予定されていたと記憶していますが、オンラインのみにするという決断も相当大変だったのではないかと思います。

オンラインでも JANOG らしさの一つである、ディスカッションはスムーズになされていました。 このあたりは、前回の JANOG 46 である程度確立されたように思います。

スタッフ、関係者、登壇者みなさま、ありがとうごぎざいました!

次回 JANOG48 は、2021/07/14-16 に岐阜県大垣市にて開催予定(ホスト: 株式会社ミライコミュニケーションネットワーク)です。

今度こそ、安心して現地開催ができる世の中になっていればよいなと願っております。

参加された方でアンケートがまだの方はぜひこちらから。 アンケート | JANOG47

参考

私と JANOG

[Ansible] 「つまずき Ansible 【Part32】凡ミスTOP5」ふりかえり

はじめに

2021/02/27 に、YouTube Live で「つまずき Ansible 【Part32】凡ミスTOP5」という配信をしました。

実際に作業しながら(ときには)エラーと戦って進めるシリーズです。

tekunabe.connpass.com

今回は、私がよくやりがちな Playbook 上のミスを6個ほど紹介しました。

TOP5というタイトルですが、厳密につまずき回数をカウントしているわけではなく、なんとなくです。


動画

www.youtube.com

  • 0:00 オープニング
  • 1:30 気になり Ansible
  • 3:15 1.Python キーワードの利用
  • 9:38 2.モジュール名間違い
  • 13:32 3.パラメーター名間違い
  • 17:52 4.)閉じ忘れ
  • 22:46 5.インデント間違い
  • 26:40 6.変数のみ定義
  • 28:42 おわりに

(冒頭のおまけコーナー) 気になり Ansible 👀

ここ一週間くらいで気になった issue や PR、リリースを紹介するコーナーです。

今回は以下を取り上げました。

気になり リリース


以下、本編。

1. Python 的なキーワードを変数のキーとして使ってしまう

問題のある Playbook

- hosts: ios
  gather_facts: false

  vars:
    targets:
      items:
        - dest: 192.168.1.1
          count: 4
        - dest: 192.168.1.2
          count: 4

  tasks:
    - name: ping
      cisco.ios.ios_ping:
        dest: "{{ item.dest }}"
        count: "{{ item.count }}"
      loop: "{{ targets.items }}"

エラー

loop では リストの指定が期待されているが、リストでない。

TASK [ping] *************************************************************************************************************************************************************************************
fatal: [ios01]: FAILED! => {"msg": "Invalid data passed to 'loop', it requires a list, got this instead: <built-in method items of dict object at 0x7f1e6c33ba68>. Hint: If you passed a list/dict of just one element, try adding wantlist=True to your lookup invocation or use q/query instead of lookup."}

items

https://docs.ansible.com/ansible/latest/user_guide/playbooks_variables.html#referencing-key-value-dictionary-variables

に掲載されているように、ドットのキーの指定はできない。

--syntax-check では検出できない。

対処

自分で変数の構造を変えられる場合は、問題ないキーに変更する。

APIからの応答などにより、自分で構造を変えられない場合は、targets.itemstargets['items'] のように指定する。


2. モジュール名のスペルミス

問題のある Playbook

- hosts: ios
  gather_facts: false

  tasks:
    - name: configure lldp
      cisco.ios.ios_lldp_interface:
        config:
          - name: GigabitEthernet0/1
            receive: true
            transmit: true
            state: merge

エラー

ios_lldp_interface ではなく、ios_lldp_interfacesが正しい。

(a210) [admin@gitlab stumble]$ ansible-playbook -i inventory.ini bonmiss02.yml
ERROR! couldn't resolve module/action 'cisco.ios.ios_lldp_interface'. This often indicates a misspelling, missing collection, or incorrect module path.

The error appears to be in '/home/admin/general/vagrant/nwlab/stumble/bonmiss02.yml': line 5, column 7, but may
be elsewhere in the file depending on the exact syntax problem.

The offending line appears to be:

  tasks:
    - name: configure lldp
      ^ here

--syntax-check でも検出できる。

対処

正しいモジュール名、ios_lldp_interfacesに修正する。


3. オプション名のミス

問題のある Playbook

- hosts: ios
  gather_facts: false

  tasks:
    - name: configure interface
      cisco.ios.ios_interfaces:
        config:
          - name: GigabitEthernet0/1
            description: pukupuku
            state: merge

エラー

cisco.ios.ios_interfaces モジュールの config 内で、state が指定されたがサポートされていない。

TASK [configure interface] **********************************************************************************************************************************************************************
fatal: [ios01]: FAILED! => {"ansible_facts": {"discovered_interpreter_python": "/usr/bin/python"}, "changed": false, "msg": "Unsupported parameters for (cisco.ios.ios_interfaces) module: state found in config. Supported parameters include: description, duplex, enabled, mtu, name, speed"}

--syntax-check では検出できない。

state オプションは、config と同じならびが正しいので一旦修正。

    - name: configure interface
      cisco.ios.ios_interfaces:
        config:
          - name: GigabitEthernet0/1
            description: pukupuku
        state: merge

ただし、これでもまだ以下のエラー。

TASK [configure interface] **********************************************************************************************************************************************************************
fatal: [ios01]: FAILED! => {"ansible_facts": {"discovered_interpreter_python": "/usr/bin/python"}, "changed": false, "msg": "value of state must be one of: merged, replaced, overridden, deleted, rendered, parsed, gathered, got: merge"}

やはり、--syntax-check では検出できない。

state オプションが取りうる値は、

  • merged
  • replaced
  • overridden
  • deleted
  • rendered
  • parsed
  • gathered

であるのに対して、merge が指定された。

対処

正しいオプションの位置、正しい値に修正。

- hosts: ios
  gather_facts: false

  tasks:
    - name: configure interface
      cisco.ios.ios_interfaces:
        config:
          - name: GigabitEthernet0/1
            description: pukupuku
        state: merged


4. ) の閉じ忘れ

問題のある Playbook

- hosts: ios
  gather_facts: false

  vars:
    default:
      a:
        x: default_x
        y: default_x
      b: default_b
      c: default_c
    patch:
      a:
        y: patch_y
        z: patch_x
      b: patch_b

  tasks:
    - name: debug
      ansible.builtin.debug:
        msg: "{{ default | combine(patch, recursive=True }}"

エラー

) を期待している箇所に } がある。

TASK [debug] ************************************************************************************************************************************************************************************
fatal: [ios01]: FAILED! => {"msg": "template error while templating string: unexpected '}', expected ')'. String: {{ default | combine(patch, recursive=True }}"}

--syntax-check では検出できない。(おそらく文字列として扱われている中のため)

対処

以下のように修正。

        msg: "{{ default | combine(patch, recursive=True) }}"

ちなみに、以下の結果になる。

TASK [debug] ***************************************************
ok: [ios01] => {
    "msg": {
        "a": {
            "x": "default_x",
            "y": "patch_y",
            "z": "patch_x"
        },
        "b": "patch_b",
        "c": "default_c"
    }
}

5. インデント間違い

問題のある Playbook

- hosts: ios
  gather_facts: false

  tasks:
    - name: debug
      debug:
        msg: "hello {{ item }}"
     loop:
        - 1
        - 2
        - 3

エラー

loop のインデント位置がおかしい。

(a210) [admin@gitlab stumble]$ ansible-playbook -i inventory.ini bonmiss05.yml 
ERROR! We were unable to read either as JSON nor YAML, these are the errors we got from each:
JSON: Expecting value: line 1 column 1 (char 0)

Syntax Error while loading YAML.
  did not find expected '-' indicator

The error appears to be in '/home/admin/general/vagrant/nwlab/stumble/bonmiss05.yml': line 8, column 6, but may
be elsewhere in the file depending on the exact syntax problem.

The offending line appears to be:

        msg: "hello {{ item }}"
     loop:
     ^ here

--syntax-check でも検出できる。

対処

インデントを正しく修正する。

- hosts: ios
  gather_facts: false

  tasks:
    - name: debug
      debug:
        msg: "hello {{ item }}"
      loop:
          - 1
          - 2
          - 3

6. 変数のみ定義

問題のある Playbook

- hosts: ios
  gather_facts: false

  vars:
    msg: pukupuku

  tasks:
    - name: debug
      debug:
        msg: "hello {{ mgs }}"

エラー

msg 変数を定義したのに対して、誤って mgs を参照しようとしている。

TASK [debug] ************************************************************************************************************************************************************************************
fatal: [ios01]: FAILED! => {"msg": "The task includes an option with an undefined variable. The error was: 'mgs' is undefined\n\nThe error appears to be in '/home/admin/general/vagrant/nwlab/stumble/bonmiss06.yml': line 8, column 7, but may\nbe elsewhere in the file depending on the exact syntax problem.\n\nThe offending line appears to be:\n\n  tasks:\n    - name: debug\n      ^ here\n"}

--syntax-check では検出できない。

対処

変数名を正しく修正。

    - name: debug
      debug:
        msg: "hello {{ msg }}"


Part33にむけて

以下のネタを検討中です。気が向いたものをやります。 connpass申込時のアンケートでいただいたものも含めています。

  • connection: local ななにか
  • Windows
  • cli_parse モジュール(Part15 の続き)
  • Ansible 2.10 関連
  • Ansible 3.0.0 関連
  • モジュールのテスト
  • Tower / AWX
  • role と Playbook のリポジトリ分割と読み込み
  • AWXとの共存を念頭に入れたDirectory構成

[Ansible] 「つまずき Ansible 【Part31】Katacoda Ansible 101 をやってみる」ふりかえり

はじめに

2021/02/13 に、YouTube Live で「つまずき Ansible 【Part31】Katacoda Ansible 101 をやってみる」という配信をしました。

実際に作業しながら(ときには)エラーと戦って進めるシリーズです。

tekunabe.connpass.com

今回は、先日の Ansible Night Online 2021.02のクロージングでも案内があった、Katacoda Ansible のコースをやってみました。

このコースは、@irix_jpさん作成のコースで、ブラウザのみでAnsibleを体験しながら学習できる、初心者向けのものです。

実際にやったのは Ansible 101 というコースです。

www.katacoda.com


動画

youtu.be

  • 0:00 イントロダクション
  • 1:40 今週の気になりAnsible
  • 7:00 Ansible 101 Step 1
  • 10:56 Ansible 101 Step 2
  • 23:50 Ansible 101 Step 3
  • 28:13 Ansible 101 Step 4
  • 40:10 おわりに

■ (おまけコーナー) 気になり Ansible 👀

せっかくだいたい毎週配信できてるので、もっとタイムリーな情報があってもいいかなと思いました。 そこで、気になりAnsibleというかたちで、ここ一週間くらいで気になった issue や PR、リリースを紹介する時間を設けました。

今回は以下を取り上げました。

気になり リリース

気になり PR

■ やったこと

(ログを消失してしまったため、コース紹介兼ねて項目だけ・・)

対象コース

www.katacoda.com

Step 1

  • 準備作業

Step 2

  • Ansible の基礎、インベントリー、認証情報
  • 演習環境での Ansible の実行
  • ansible.cfg の確認
  • インベントリーの確認
  • 認証情報の確認
    • 【補足】 21:28あたりで、ansible コマンドの -u オプションで指定したユーザー名より、インベントリファイルで指定した ansible_user 変数が優先されたのは、正しい挙動です。公式ドキュメントに記載があります。

Step 3

  • Ad-Hocコマンドとモジュール
  • モジュールとは
  • モジュールの一覧 (andible-doc)
  • Ad-hoc コマンド
  • ping モジュールの実行
  • shell モジュールの実行
  • yum モジュールの実行
  • setup モジュールの実行

Step 4

  • Playbookの記述と実行
  • Playbook の基礎
  • playbook の作成
    • yum モジュールと、service モジュール
  • play パート
  • task パート
  • playbook の実行
  • タスクの追加
    • copy モジュール
  • 冪等性(べきとうせい)


おわりに

ブラウザだけでお手軽に Ansible を体験できてとても便利です。

参考

rheb.hatenablog.com


Part32にむけて

以下のネタを検討中です。気が向いたものをやります。 connpass申込時のアンケートでいただいたものも含めています。

  • 凡ミスTOP3(変数名間違いなど)
  • connection: local ななにか
  • Windows
  • cli_parse モジュール(Part15 の続き)
  • Ansible 2.10 関連
  • Ansible 3.0.0 関連
  • モジュールのテスト
  • AWXとの共存を念頭に入れたDirectory構成

[Ansible] 「つまずき Ansible 【Part30】Ansible 3.0.0b1 を少し探る」ふりかえり

はじめに

2021/02/07 に、YouTube Live で「つまずき Ansible 【Part30】Ansible 3.0.0b1 を少し探る」という配信をしました。

実際に作業しながら(ときには)エラーと戦って進めるシリーズです。

今回は、まだベータですが先日リリースされた Ansible 3.0.0b1 を少し探ります。

connpass.com

  • 環境
    • Ansible 3.0.0b1

参考: [Ansible] Ansible 2.10 の次は 3.0.0 - てくなべ (tekunabe)


動画

youtu.be

  • 0:00 イントロダクション
  • 1:40 概要の概要
  • 4:50 ポーティングガイド
  • 8:55 インストール・バージョン確認
  • 13:45 collection の確認
  • 18:30 Playbook の実行
  • 27:15 おわりに

■ やったこと

資料

インストール

まだベータバージョンなので、バージョン指定が必要。

(a300) [admin@gitlab stumble]$ pip install ansible==3.0.0b1
Collecting ansible==3.0.0b1
  Using cached https://files.pythonhosted.org/packages/3e/0e/de3d605e101d7220807fa7c3234aada8b99c1277ec1a68a95b355f726b74/ansible-3.0.0b1.tar.gz
...(略)...

バージョンの確認

ansible --version では、ansible-base としてのバージョン 2.10.5 が表示される。

(a300) [admin@gitlab meta]$ ansible --version
ansible 2.10.5
  config file = None
  configured module search path = ['/home/admin/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /home/admin/envs/a300/lib64/python3.6/site-packages/ansible
  executable location = /home/admin/envs/a300/bin/ansible
  python version = 3.6.8 (default, Nov 16 2020, 16:55:22) [GCC 4.8.5 20150623 (Red Hat 4.8.5-44)]

pip freeze では、ansibleansible-base の両方が表示される。

(a300) [admin@gitlab stumble]$ pip freeze
ansible==3.0.0b1
ansible-base==2.10.5
cffi==1.14.4
cryptography==3.3.1
Jinja2==2.11.3
MarkupSafe==1.1.1
packaging==20.9
pycparser==2.20
pyparsing==2.4.7
PyYAML==5.4.1
six==1.15.0

同梱コレクションの確認

ansible-galaxy collection list

# /home/admin/envs/a300/lib/python3.6/site-packages/ansible_collections
Collection                    Version
----------------------------- -------
amazon.aws                    1.3.0  
ansible.netcommon             1.5.0  
ansible.posix                 1.1.1  
ansible.utils                 2.0.0  
ansible.windows               1.3.0  
arista.eos                    1.3.0  
awx.awx                       17.0.1 
azure.azcollection            1.4.0  
check_point.mgmt              2.0.0  
chocolatey.chocolatey         1.0.2  
cisco.aci                     2.0.0  
cisco.asa                     1.0.4  
cisco.intersight              1.0.10 
cisco.ios                     1.3.0  
cisco.iosxr                   1.2.1  
cisco.meraki                  2.2.0  
cisco.mso                     1.1.0  
cisco.nso                     1.0.3  
cisco.nxos                    1.4.0  
cisco.ucs                     1.6.0  
cloudscale_ch.cloud           2.0.0  
community.aws                 1.3.0  
community.azure               1.0.0  
community.crypto              1.4.0  
community.digitalocean        1.0.0  
community.docker              1.2.1  
community.fortios             1.0.0  
community.general             2.0.0  
community.google              1.0.0  
community.grafana             1.1.0  
community.hashi_vault         1.0.0  
community.hrobot              1.1.0  
community.kubernetes          1.1.1  
community.kubevirt            1.0.0  
community.libvirt             1.0.0  
community.mongodb             1.2.0  
community.mysql               1.2.0  
community.network             2.0.0  
community.okd                 1.0.1  
community.postgresql          1.1.0  
community.proxysql            1.0.0  
community.rabbitmq            1.0.1  
community.routeros            1.1.0  
community.skydive             1.0.0  
community.sops                1.0.3  
community.vmware              1.7.0  
community.windows             1.2.0  
community.zabbix              1.2.0  
containers.podman             1.4.1  
cyberark.conjur               1.1.0  
cyberark.pas                  1.0.5  
dellemc.openmanage            3.0.0  
dellemc.os10                  1.1.1  
dellemc.os6                   1.0.6  
dellemc.os9                   1.0.3  
f5networks.f5_modules         1.7.1  
fortinet.fortimanager         2.0.1  
fortinet.fortios              1.1.8  
frr.frr                       1.0.3  
gluster.gluster               1.0.1  
google.cloud                  1.0.1  
hetzner.hcloud                1.2.1  
ibm.qradar                    1.0.3  
infinidat.infinibox           1.2.4  
inspur.sm                     1.1.2  
junipernetworks.junos         1.3.0  
kubernetes.core               1.1.1  
mellanox.onyx                 1.0.0  
netapp.aws                    20.9.0 
netapp.elementsw              20.11.0
netapp.ontap                  21.1.1 
netapp_eseries.santricity     1.1.0  
netbox.netbox                 2.0.0  
ngine_io.cloudstack           2.0.0  
ngine_io.exoscale             1.0.0  
ngine_io.vultr                1.1.0  
openstack.cloud               1.2.1  
openvswitch.openvswitch       1.1.0  
ovirt.ovirt                   1.3.0  
purestorage.flasharray        1.5.1  
purestorage.flashblade        1.4.0  
sensu.sensu_go                1.8.0  
servicenow.servicenow         1.0.3  
splunk.es                     1.0.2  
t_systems_mms.icinga_director 1.13.0 
theforeman.foreman            1.5.1  
vyos.vyos                     1.1.1  
wti.remote                    1.0.1  

# /home/admin/envs/a300/lib64/python3.6/site-packages/ansible_collections
Collection                    Version
----------------------------- -------
amazon.aws                    1.3.0  
ansible.netcommon             1.5.0  
ansible.posix                 1.1.1  
ansible.utils                 2.0.0  
ansible.windows               1.3.0  
arista.eos                    1.3.0  
awx.awx                       17.0.1 
azure.azcollection            1.4.0  
check_point.mgmt              2.0.0  
chocolatey.chocolatey         1.0.2  
cisco.aci                     2.0.0  
cisco.asa                     1.0.4  
cisco.intersight              1.0.10 
cisco.ios                     1.3.0  
cisco.iosxr                   1.2.1  
cisco.meraki                  2.2.0  
cisco.mso                     1.1.0  
cisco.nso                     1.0.3  
cisco.nxos                    1.4.0  
cisco.ucs                     1.6.0  
cloudscale_ch.cloud           2.0.0  
community.aws                 1.3.0  
community.azure               1.0.0  
community.crypto              1.4.0  
community.digitalocean        1.0.0  
community.docker              1.2.1  
community.fortios             1.0.0  
community.general             2.0.0  
community.google              1.0.0  
community.grafana             1.1.0  
community.hashi_vault         1.0.0  
community.hrobot              1.1.0  
community.kubernetes          1.1.1  
community.kubevirt            1.0.0  
community.libvirt             1.0.0  
community.mongodb             1.2.0  
community.mysql               1.2.0  
community.network             2.0.0  
community.okd                 1.0.1  
community.postgresql          1.1.0  
community.proxysql            1.0.0  
community.rabbitmq            1.0.1  
community.routeros            1.1.0  
community.skydive             1.0.0  
community.sops                1.0.3  
community.vmware              1.7.0  
community.windows             1.2.0  
community.zabbix              1.2.0  
containers.podman             1.4.1  
cyberark.conjur               1.1.0  
cyberark.pas                  1.0.5  
dellemc.openmanage            3.0.0  
dellemc.os10                  1.1.1  
dellemc.os6                   1.0.6  
dellemc.os9                   1.0.3  
f5networks.f5_modules         1.7.1  
fortinet.fortimanager         2.0.1  
fortinet.fortios              1.1.8  
frr.frr                       1.0.3  
gluster.gluster               1.0.1  
google.cloud                  1.0.1  
hetzner.hcloud                1.2.1  
ibm.qradar                    1.0.3  
infinidat.infinibox           1.2.4  
inspur.sm                     1.1.2  
junipernetworks.junos         1.3.0  
kubernetes.core               1.1.1  
mellanox.onyx                 1.0.0  
netapp.aws                    20.9.0 
netapp.elementsw              20.11.0
netapp.ontap                  21.1.1 
netapp_eseries.santricity     1.1.0  
netbox.netbox                 2.0.0  
ngine_io.cloudstack           2.0.0  
ngine_io.exoscale             1.0.0  
ngine_io.vultr                1.1.0  
openstack.cloud               1.2.1  
openvswitch.openvswitch       1.1.0  
ovirt.ovirt                   1.3.0  
purestorage.flasharray        1.5.1  
purestorage.flashblade        1.4.0  
sensu.sensu_go                1.8.0  
servicenow.servicenow         1.0.3  
splunk.es                     1.0.2  
t_systems_mms.icinga_director 1.13.0 
theforeman.foreman            1.5.1  
vyos.vyos                     1.1.1  
wti.remote                    1.0.1  

Playbook の実行

以下の Playbook を利用。

---
- hosts: ios
  gather_facts: false

  tasks:
    - name: show
      ios_command:
      # cisco.ios.ios_command:   # もちろん FQCN でも可
        commands:
          - show interfaces
      register: res_show
    
    - name: debug
      debug:
        msg: "{{ res_show.stdout_lines[0] }}"

paramiko のインストール。

pip install paramiko

実行結果

(a300) [admin@gitlab stumble]$ ansible-playbook -i inventory.ini test.yml 

PLAY [ios] *********************************************************************

TASK [show] ********************************************************************
ok: [ios01]

TASK [debug] *******************************************************************
ok: [ios01] => {
    "msg": [
        "GigabitEthernet0/0 is up, line protocol is up ",
        "  Hardware is iGbE, address is 5254.0001.xxxx (bia 5254.0001.xxx)",
        "  Internet address is 192.168.1.11/24",
        "  MTU 1500 bytes, BW 1000000 Kbit/sec, DLY 10 usec, ",
        "     reliability 255/255, txload 1/255, rxload 1/255",
        "  Encapsulation ARPA, loopback not set",
        "  Keepalive set (10 sec)",
        "  Auto Duplex, Auto Speed, link type is auto, media type is RJ45",
        "  output flow-control is unsupported, input flow-control is unsupported",
        "  ARP type: ARPA, ARP Timeout 04:00:00",
        "  Last input 00:00:00, output 
...(略)...


Part31にむけて

以下のネタを検討中です。気が向いたものをやります。 connpass申込時のアンケートでいただいたものも含めています。

  • Katakoda Ansible 101
  • connection: local ななにか
  • Windows
  • cli_parse モジュール(Part15 の続き)
  • Ansible 2.10 関連
  • Ansible 3.0.0 関連
  • モジュールのテスト
  • AWXとの共存を念頭に入れたDirectory構成

[Ansible] 「つまずき Ansible 【Part29】フィルター」ふりかえり

はじめに

2021/02/06 に、YouTube Live で「つまずき Ansible 【Part29】フィルター」という配信をしました。

実際に作業しながら(ときには)エラーと戦って進めるシリーズです。

今回は、値を変換したり抽出したりするフィルターをいくつか試しました。

参考 https://docs.ansible.com/ansible/latest/user_guide/playbooks_filters.html

tekunabe.connpass.com

  • 環境
    • Ansible 2.9.16


動画

youtu.be

  • 0:00 イントロダクション
  • 4:11 抽出系
    • gt のとこを「以上」と説明してしまいましたが、正しくは「より大きい」です。失礼しました。
  • 13:11 変換系
  • 13:53 結合系
  • 15:05 正規表現
  • 16:29 パス操作系
  • 17:57 ネットワーク系
  • 22:22 その他
  • 23:30 試行錯誤1 ansible-console
  • 25:32 試行錯誤2 debugger
  • 29:37 おわりに

■ やったこと

抽出系

selectattr フィルター

条件にあったものを抽出。

---
- hosts: localhost
  gather_facts: no
  connection: local
  debugger: always

  vars:
    users:
      - name: yamada
        age: 42
      - name: tanaka
        age: 26
      - name: suzuki
        age: 32
      - name: sato
        age: 27

  tasks:
    - name: debug 1
      debug: #  select * from users where age > 30 のようなイメージ
        msg: "{{ users | selectattr('age', 'gt', 30) | list }}" # gt は > でも可

実行結果

ok: [localhost] => {
    "msg": [
        {
            "age": 42,
            "name": "yamada"
        },
        {
            "age": 32,
            "name": "suzuki"
        }
    ]
}

map フィルター

様々な機能がある。今回は SQL でいうカラムの選択。

    - name: debug 2
      debug:  # select name from users where age >= 30  のようなイメージ
        msg: "{{ users | selectattr('age', 'gt', 30) | map(attribute='name') | list }}"

実行結果

ok: [localhost] => {
    "msg": [
        "yamada",
        "suzuki"
    ]
}

以下は説明のみ

  • json_query: jmethpath を利用した複雑なクエリー

変換系

説明のみ

結合系

説明のみ

正規表現

regex_replace フィルター

正規表現を使用した置換。後方参照利用できる。

    - name: regex
      debug:
        msg:  "{{ 'foobar' | regex_replace('^f.*o(.*)$', '\\1') }}"

実行結果

ok: [localhost] => {
    "msg": "bar"
}

パス操作系

説明のみ


ネットワーク系

parse_cli_textfsm フィルター

TextFSM テンプレートを利用して、ネットワーク機器の show コマンドの実行結果を構造化データにパースする。

---
- hosts: ios
  gather_facts: false

  tasks:
    - name: show
      ios_command:
        commands:
          - show interfaces
      register: res

    - name: debug
      debug:
        msg: "{{ res.stdout[0] | parse_cli_textfsm(path_template) }}"
      vars:
        path_template: "/home/admin/envs/a29/lib/python3.6/site-packages/ntc_templates/templates/cisco_ios_show_interfaces.textfsm"

実行結果

ok: [ios01] => {
    "msg": [
        {
            "ABORT": "",
            "ADDRESS": "5254.00xx.xxxx",
            "BANDWIDTH": "1000000 Kbit",
            "BIA": "5254.00xx.xxxx",
            "CRC": "0",
            "DELAY": "10 usec",
            "DESCRIPTION": "",
            "DUPLEX": "Auto Duplex",
            "ENCAPSULATION": "ARPA",
            "HARDWARE_TYPE": "iGbE",
            "INPUT_ERRORS": "0",
            "INPUT_PACKETS": "854394",
            "INPUT_RATE": "0",
            "INTERFACE": "GigabitEthernet0/0",
            "IP_ADDRESS": "192.168.1.11/24",
            "LAST_INPUT": "00:00:00",
            "LAST_OUTPUT": "00:00:00",
            "LAST_OUTPUT_HANG": "never",
            "LINK_STATUS": "up",
            "MEDIA_TYPE": "RJ45",
            "MTU": "1500",
            "OUTPUT_ERRORS": "0",
            "OUTPUT_PACKETS": "127122",
            "OUTPUT_RATE": "0",
            "PROTOCOL_STATUS": "up",
            "QUEUE_STRATEGY": "fifo",
            "SPEED": "Auto Speed"
        },
// ....(略)...

参考: show コマンド結果をパースする方法あれこれ(TextFSM / Genie Parser と Netmiko / Ansible の組み合わせ) - てくなべ (tekunabe)

その他

説明のみ

試行錯誤に便利

フィルターを色々試したい時に便利な方法。

ansible-console

ansible-console コマンド

対話的な操作。

(a29) [admin@gitlab stumble]$ ansible-console -i localhost, 
Welcome to the ansible console.
Type help or ? to list commands.

admin@all (1)[f:5]$ debug msg="{{ [1,2,3] | max  }} "
localhost | SUCCESS => {
    "msg": "3 "
}
admin@all (1)[f:5]$ debug msg="{{ [1,2,3] | min  }} "
localhost | SUCCESS => {
    "msg": "1 "
}

参考: [Ansible] フィルターを手軽に試行錯誤したいときの ansible-console コマンドの使い方 - てくなべ (tekunabe)

Playbook Debugger

Playbook Debugger

たとえば、Play に debugger: always を指定すると、各タスク実行後にデバッガーが起動する。

---
- hosts: localhost
  gather_facts: no
  connection: local
  debugger: always    # ここ

以下が、デバッガーが起動した状態。

[localhost] TASK: debug 1 (debug)>

task.args で、タスクのオプションの書き換えができる。そのが r で再実行できる。

[localhost] TASK: debug 1 (debug)> task.args['msg'] = "{{ users | selectattr('age', 'gt', 40) | list }}"
[localhost] TASK: debug 1 (debug)> r
ok: [localhost] => {
    "msg": [
        {
            "age": 42,
            "name": "yamada"
        }
    ]
}


おわりに

フィルターは数も多く、奥が深いです。

全ては覚えられないので、フィルター的なことをしたい場合は、Ansible や Jinja2 の公式ドキュメントを眺めて探しています。

Filters — Ansible Documentation

Jinja — Jinja Documentation (2.11.x)


Part30にむけて

ベータですが、Ansible 3.0.0b1 がリリースされたので、こちらを扱ってみます。

tekunabe.connpass.com

他、以下のネタを検討中です。気が向いたものをやります。 connpass申込時のアンケートでいただいたものも含めています。

  • Katakoda Ansible 101
  • connection: local ななにか
  • Windows
  • cli_parse モジュール(Part15 の続き)
  • Ansible 2.10 関連
  • Ansible 3.0.0 関連
  • モジュールのテスト
  • AWXとの共存を念頭に入れたDirectory構成

[Ansible] cisco.ios.ios_ping モジュールに size と df_bit オプションを追加しました

はじめに

Cisco IOS のネットワーク機器 から 指定の宛先に ICMP による Ping を実行する cisco.ios.ios_ping というモジュールがあります。

指定した宛先などのオプションに基づいて ping コマンドを生成し、IOS の機器上で実行して結果を表示します。

[Ansible] -----> [IOS] -- ICMP Ping -->[dest指定先]

この cisco.ios.ios_ping モジュールに、ping コマンドの df-bitsize オプションに相当するオプションを追加しました。cisco.ios collection 1.3.0 としてリリースされました。

この2つのオプションの使い方をご紹介します。

  • 動作確認環境
    • Ansible 2.10.6 / 2.9.17
    • cisco.ios collection 1.3.0

オプションの説明

オプション名 デフォルト 説明
df_bit bool false DF bit を立てるかどうかの指定 。ping コマンドの df-bit オプションに相当
size int モジュールとしてはデフォルトなし サイズの指定。ping コマンドの size オプションに相当

使用例

size のみ指定

サイズを指定する例です。

- hosts: ios
  gather_facts: false

  tasks:
    - name: size
      cisco.ios.ios_ping:
        dest: 192.168.1.1
        size: 1400

ping 192.168.1.1 size 1400 コマンドが実行されます。

df-bit のみ指定

DF bit を指定する例です。

- hosts: ios
  gather_facts: false

  tasks:
    - name: df_bit
      cisco.ios.ios_ping:
        dest: 192.168.1.1
        df_bit: true

ping 192.168.1.1 df-bit コマンドが実行されます。

df_bitsize の指定

併用もできます。

- hosts: ios
  gather_facts: false

  tasks:
    - name: size and df_bit
      cisco.ios.ios_ping:
        dest: 192.168.1.1
        size: 1400
        df_bit: true

ping 192.168.1.1 size 1400 df-bit コマンドが実行されます。

トラブルシューティング

もし、Playbook 実行時に、以下のように指定されたオプションはサポートされない旨のエラーが出た場合は、cisco.ios collection 1.3.0 以上ががインストールされているかどうか、それを Playbook が参照しているかをご確認ください。モジュール名を ios_ping と指定してだめでしたら cisco.ios.ios_ping のような FQCN 表記を試してみてください。

"msg": "Unsupported parameters for (ios_ping) module: df_bit Supported parameters include: auth_pass, authorize, count, dest, host, password, port, provider, source, ssh_keyfile, state, timeout, username, vrf"

おわりに(おまけ)

今回、はじめて機能追加をしてみました。追加したい処理そのものより、ansible-test によるテストの実行方法を調べるほうが時間がかかってしまいました。

参考: Testing Ansible — Ansible Documentation

試行錯誤記録(スレッド続きます)

[Ansible] 「つまずき Ansible 【Part28】ping 系モジュールを試す」ふりかえり

はじめに

2021/01/30 に、YouTube Live で「つまずき Ansible 【Part28】ping 系モジュールを試す」という配信をしました。

実際に作業しながら(ときには)エラーと戦って進めるシリーズです。

今回は、pingios_ping や win_ping などの ping 系モジュールの違いを確認しながら、試しました。

tekunabe.connpass.com

  • 環境
    • Ansible 2.10.6

参考: 【Ansible】ping 系モジュールまとめ(ping/win_ping/ios_ping/nxos_ping/net_ping) - てくなべ (tekunabe)


動画

youtu.be

■ やったこと

ping モジュール

pingモジュールは、ターゲットノードへのAnsible的な接続や認証の正常性を確認する。

ICMP ではなく、通常は SSH を利用する。

[A] --- SSH ---> [linux]
  • 実行ログ
$  ansible -i inventory.ini linux  -m ping
linux01 | SUCCESS => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/bin/python"
    },
    "changed": false,
    "ping": "pong"
}
  • Playbook の場合
---
- hosts: linux
  gather_facts: false

  tasks:
    - ping:

win_ping モジュール

win_ping モジュールは、Windows ターゲットのターゲットノードへのAnsible的な接続や認証の正常性を確認する。

通常は、WinRM を利用する。

[A] -- WinRM --> [Windows]
  • 実行ログ
$ ansible -i inventory.ini win -m win_ping
win01 | SUCCESS => {
    "changed": false,
    "ping": "pong"
}

おまけ: うっかり Windows 相手に ping モジュールを使った場合のエラー

$ ansible -i inventory.ini win -m ping
[WARNING]: No python interpreters found for host win01 (tried ['/usr/bin/python', 'python3.7', 'python3.6', 'python3.5',
'python2.7', 'python2.6', '/usr/libexec/platform-python', '/usr/bin/python3', 'python'])
win01 | FAILED! => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/bin/python"
    },
    "changed": false,
    "module_stderr": "Exception calling \"Create\" with \"1\" argument(s): \"At line:4 char:21\r\n+ def _ansiballz_main():\r\n+                     ~\r\nAn expression was expected after '('.\r\nAt line:13 char:27\r\n+     except (AttributeError, OSError):\r\n+                           ~\r\nMissing argument in parameter list.\r\nAt line:15 char:29\r\n+     excludes = set(('', '.', scriptdir))\r\n+                             ~\r\nMissing expression after ','.\r\nAt line:15 char:30\r\n+     excludes = set(('', '.', scriptdir))\r\n+                              ~~~~~~~~~\r\nUnexpected token 'scriptdir' in expression or statement.\r\nAt line:15 char:29\r\n+     excludes = set(('', '.', scriptdir))\r\n+                             ~\r\nMissing closing ')' in expression.\r\nAt line:15 char:39\r\n+     excludes = set(('', '.', scriptdir))\r\n+                                       ~\r\nUnexpected token ')' in expression or statement.\r\nAt line:15 char:40\r\n+     excludes =

ios_ping モジュール

ios_ping モジュールは、Cisco IOS 機器から指定した宛先への疎通確認をする。

ターゲットノード「へ」ではなく「から」。

[A] ------------ [ios]--- ICMP ---> [dest先]
  • 実行ログ
$ ansible -i inventory.ini ios -m ios_ping -a "dest=192.168.1.1"
ios01 | SUCCESS => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/bin/python"
    },
    "changed": false,
    "commands": [
        "ping 192.168.1.1"
    ],
    "packet_loss": "0%",
    "packets_rx": 5,
    "packets_tx": 5,
    "rtt": {
        "avg": 1,
        "max": 2,
        "min": 1
    }
}
  • Playbook の場合
---
# ios
- hosts: ios
  gather_facts: no

  tasks:
    # ansible -i inventory.ini ios -m ios_ping -a "dest=192.168.1.1"
    - name: ping for ios
      ios_ping:
        dest: 192.168.1.1

net_ping モジュール

ios_ping モジュールは、ios_pingjunos_ping モジュールなどを抽象化したもの。

  • Playbook
---
# ios
- hosts: ios
  gather_facts: no

  tasks:
    - name: ping for ios
      net_ping:
        dest: 192.168.1.1

番外編1: ネットワーク機器に ping モジュールを使ったら?

配信後にご質問をいただきました。

はい、SUCCESS になってしまいます。(たしか Ansible 2.9 頃からの仕様)

  • 認証情報が誤っていてもSUCCESS
$ ansible -i inventory.ini ios -m ping -e ansible_user=tekitoutekiyou
ios01 | SUCCESS => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/bin/python"
    },
    "changed": false,
    "ping": "pong"
}
  • 接続先が誤っていても SUCCESS
$ ansible -i inventory.ini ios -m ping -e ansible_host=tekitoudesuuuuuuu
ios01 | SUCCESS => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/bin/python"
    },
    "changed": false,
    "ping": "pong"
}

番外編2:ICMP による ping

[A] ---- ICMP ---> [dest先]

command モジュール使うくらいしか思い浮かばす・・。

$ ansible -i inventory.ini linux -m command -a "ping {{ ansible_host }} -c 4" -c local
linux01 | CHANGED | rc=0 >>
PING 192.168.1.145 (192.168.1.145) 56(84) bytes of data.
64 bytes from 192.168.1.145: icmp_seq=1 ttl=64 time=0.176 ms
64 bytes from 192.168.1.145: icmp_seq=2 ttl=64 time=0.212 ms
64 bytes from 192.168.1.145: icmp_seq=3 ttl=64 time=0.198 ms
64 bytes from 192.168.1.145: icmp_seq=4 ttl=64 time=0.264 ms

--- 192.168.1.145 ping statistics ---
4 packets transmitted, 4 received, 0% packet loss, time 2999ms
rtt min/avg/max/mdev = 0.176/0.212/0.264/0.035 ms

回数を指定する -c を忘れると無限 ping になって、応答が返ってこない。

ありがとうございます!

参考: [Ansible] コントロールノードから ICMP ping を実行する(ただしcommandモジュール) - てくなべ (tekunabe)


おわりに

名前がよく似てても性質が結構違ったりするので、少し注意が必要でした。 公式ドキュメントに必要な情報は掲載されているので、やっぱりよく確認すべきですね。


Part29 にむけて

以下のネタを検討中です。気が向いたものをやります。 connpass申込時のアンケートでいただいたものも含めています。

  • Ansible 2.10 関連
  • connection: local ななにか
  • Jinja2、フィルター
  • Windows
  • ESXi で VM作成
  • モジュールのテスト
  • AWXとの共存を念頭に入れたDirectory構成