Ansible ping モジュールによる接続テスト | ネットワーク接続確認の自動化

はじめに

Ansible は、インフラストラクチャの管理とデプロイを簡素化する強力なオープンソースの自動化ツールです。Ansible の重要なモジュールの 1 つに、ホストの接続性と可用性をテストできる "ping" モジュールがあります。このチュートリアルでは、Ansible ping モジュールを効果的に使用して、インフラストラクチャの接続性を確保する方法を探ります。

これは Guided Lab です。学習と実践を支援するためのステップバイステップの指示を提供します。各ステップを完了し、実践的な経験を積むために、指示に注意深く従ってください。過去のデータによると、この初級レベルの実験の完了率は 86%です。学習者から 100% の好評価を得ています。

Ansible のインストールと基本の理解

Ansible のセットアップ

Ansible ping モジュールを使用する前に、システムに Ansible をインストールする必要があります。まず、Ansible のインストールから始めましょう。

sudo apt update
sudo apt install -y ansible

インストールが完了したら、Ansible のバージョンを確認して、正しくインストールされていることを確認します。

ansible --version

次のような出力が表示され、Ansible のバージョンと設定情報が表示されます。

ansible [core 2.12.x]
  config file = /etc/ansible/ansible.cfg
  configured module search path = ['/home/labex/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python3/dist-packages/ansible
  ansible collection location = /home/labex/.ansible/collections:/usr/share/ansible/collections
  executable location = /usr/bin/ansible
  python version = 3.10.x (default, Mar 15 2023, 06:23:28) [GCC 12.2.0]
  jinja version = 3.0.3
  libyaml = True

Ansible インベントリファイルの作成

Ansible は、管理するホストを定義するためにインベントリファイルを使用します。プロジェクトディレクトリに簡単なインベントリファイルを作成しましょう。

cd ~/project
mkdir -p ansible
cd ansible

次に、VS Code エディタを使用して、hosts という名前のインベントリファイルを作成します。

WebIDE の左側のサイドバーにある「Explorer」アイコンをクリックします。
/home/labex/project/ansible に移動します。
ansible フォルダを右クリックし、「New File」を選択します。
ファイル名を hosts とします。
ファイルに次の内容を追加します。

[local]
localhost ansible_connection=local

[webservers]
localhost ansible_connection=local

このインベントリファイルは、テスト目的で localhost を両方含む、local と webservers の 2 つのグループを定義しています。

Ansible Ping モジュールの理解

Ansible ping モジュールは、Ansible がホストに接続して管理できるかどうかを確認するシンプルなテストモジュールです。従来の ICMP ping とは異なり、Ansible の ping は、ターゲットホストでの SSH 接続と Python の可用性をチェックします。

ping モジュールを使用するための基本的な構文は次のとおりです。

- hosts: [target_hosts]
  tasks:
    - name: [task_description]
      ping:

次のステップでは、ping モジュールを使用して最初の Ansible プレイブックを作成し、実行します。

最初の Ansible Ping プレイブックの作成と実行

基本的な Ping プレイブックの作成

Ansible をインストールし、インベントリファイルが準備できたので、ping モジュールを使用して接続性をテストする最初の Ansible プレイブックを作成しましょう。

hosts ファイルを作成したのと同じディレクトリに、新しいプレイブックファイルを作成しましょう。

WebIDE で、まだそこにいない場合は /home/labex/project/ansible に移動します。
ansible フォルダを右クリックし、「New File」を選択します。
ファイル名を ping.yml とします。
ファイルに次の内容を追加します。

---
- hosts: local
  gather_facts: no
  tasks:
    - name: Ping the local host
      ping:

このシンプルなプレイブックは、インベントリの local グループをターゲットとし、そこで ping モジュールを実行します。

Ping プレイブックの実行

次に、プレイブックを実行して、localhost への接続性をテストしましょう。

cd ~/project/ansible
ansible-playbook -i hosts ping.yml

次のような出力が表示されるはずです。

PLAY [local] *********************************************************************

TASK [Ping the local host] *******************************************************
ok: [localhost]

PLAY RECAP **********************************************************************
localhost                  : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

出力は、Ansible が localhost に正常に接続し、ping モジュールから肯定的な応答を受け取ったことを示しています。

Ping モジュール応答の理解

出力の ok ステータスは、ping が成功したことを意味します。ping モジュールは、ホストに正常に接続すると、単純な "pong" 応答を返します。

-v (verbose) フラグを追加することで、より詳細な出力を確認できます。

ansible-playbook -i hosts ping.yml -v

これにより、モジュールからの実際の応答が表示されます。

TASK [Ping the local host] *******************************************************
ok: [localhost] => {"changed": false, "ping": "pong"}

応答には以下が含まれます。

"changed": false - ping モジュールがシステムに変更を加えていないことを示します。
"ping": "pong" - 接続を確認する標準的な応答です。

次のステップでは、より高度な ping モジュールの使用例とオプションを探ります。

高度な Ping モジュールオプションと複数のグループのターゲット設定

複数のホストグループへの Ping

インベントリから複数のグループに ping を実行するようにプレイブックを拡張しましょう。 ping_all.yml という名前の新しいファイルを作成します。

WebIDE で、/home/labex/project/ansible に移動します。
ansible フォルダを右クリックし、「New File」を選択します。
ファイル名を ping_all.yml とします。
ファイルに次の内容を追加します。

---
- hosts: all
  gather_facts: no
  tasks:
    - name: Ping all hosts in the inventory
      ping:

このプレイブックは、インベントリファイル内のすべてのホストをターゲットにします。次のコマンドで実行します。

ansible-playbook -i hosts ping_all.yml

インベントリ内のすべてのホストからの ping 応答が成功したことを示す出力が表示されるはずです。

Ping モジュールでのカスタムデータの使用

Ansible ping モジュールを使用すると、変更されていないことを確認するためにカスタムデータを送信できます。これは、より複雑な接続シナリオをテストするのに役立ちます。

ping_data.yml という名前の新しいプレイブックを作成します。

WebIDE で、/home/labex/project/ansible ディレクトリに ping_data.yml という名前の新しいファイルを作成します。
次の内容を追加します。

---
- hosts: webservers
  gather_facts: no
  tasks:
    - name: Ping with custom data
      ping:
        data: "Hello from Ansible Lab"

このプレイブックを実行します。

ansible-playbook -i hosts ping_data.yml -v

詳細な出力には、応答にカスタムデータが表示されます。

TASK [Ping with custom data] **************************************************
ok: [localhost] => {"changed": false, "ping": "Hello from Ansible Lab"}

特定のホストに対する Ping の実行

プレイブックを作成せずに、コマンドラインから直接 ping モジュールを実行することもできます。これは、迅速な接続チェックに役立ちます。

ansible local -i hosts -m ping

このコマンドは、local グループ内のすべてのホストに ping を実行し、結果を表示します。次のように表示されるはずです。

localhost | SUCCESS => {
    "changed": false,
    "ping": "pong"
}

複数のグループまたはパターンを指定することもできます。

ansible 'webservers:local' -i hosts -m ping

このコマンドは、webservers グループと local グループの両方のすべてのホストに ping を実行します。

引数を使用した Ping モジュール

コマンドラインから直接、ping モジュールに引数を渡すこともできます。

ansible all -i hosts -m ping -a "data='Command line test'"

このコマンドは、カスタムデータ文字列 "Command line test" を使用してすべてのホストに ping を実行し、結果を表示します。

出力には、カスタムメッセージを含む各ホストの応答が表示されます。

localhost | SUCCESS => {
    "changed": false,
    "ping": "Command line test"
}

これらの例は、さまざまな方法で管理対象ホストへの接続を確認するための Ansible ping モジュールの汎用性を示しています。

Ansible Ping のトラブルシューティングとベストプラクティス

Ansible Ping に関する一般的な問題

Ansible ping モジュールを使用すると、いくつかの一般的な問題が発生する可能性があります。

1. SSH 接続の問題

Ansible は、リモートホストに接続するために SSH を使用します。接続の問題が発生した場合、次のようなエラーが表示される可能性があります。

UNREACHABLE! => {"changed": false, "msg": "Failed to connect to the host via ssh", "unreachable": true}

（この実験ではなく）リモートホストを使用していた場合、以下を確認します。

リモートホストが SSH 経由で到達可能であること
正しい SSH 認証情報を持っていること
リモートホストの SSH サーバーが実行されていること

2. ターゲットホストに Python がない

Ansible は、ターゲットホストに Python が必要です。Python がない場合、次のように表示される可能性があります。

FAILED! => {"changed": false, "module_stderr": "/bin/sh: 1: /usr/bin/python: not found\n", "module_stdout": "", "msg": "MODULE FAILURE", "rc": 127}

実際の環境では、これを解決するために、ターゲットホストに Python をインストールします。

包括的な Ping プレイブックの作成

エラー処理とレポートを組み込んだ、より包括的なプレイブックを作成しましょう。

WebIDE で、/home/labex/project/ansible ディレクトリに ping_comprehensive.yml という名前の新しいファイルを作成します。
次の内容を追加します。

---
- hosts: all
  gather_facts: no
  tasks:
    - name: Ping all hosts
      ping:
      register: ping_result
      ignore_errors: yes

    - name: Display success message
      debug:
        msg: "Successfully connected to {{ inventory_hostname }}"
      when: ping_result is succeeded

    - name: Display failure message
      debug:
        msg: "Failed to connect to {{ inventory_hostname }}: {{ ping_result.msg if 'msg' in ping_result else 'Unknown error' }}"
      when: ping_result is failed

このプレイブックは次のことを行います。

すべてのホストに ping を実行しようとします。
ping 操作の結果を登録します。
一部のホストが失敗した場合でも実行を続行します (ignore_errors: yes)。
ping の結果に基づいて、成功または失敗のメッセージを表示します。