はじめに

先日開催された「Ansibleもくもく会 ( サーバ編 ) 2019.12 in 札幌」に、リモートメンターとして参加させていただきました。

その際、参加者の方から以下のご質問をいただきました。

モジュールの数が多いためやりたいことに適したモジュールを探すのが大変です。よい方法はありますか？

Ansible 2.9 現在で 3,000 モジュール以上あるので、たしかに大変な面はあると思います。

その場でもドキュメントに書いてお答えしたのですが、改めてブログとして3つまとめておきたいと思います。

特に裏技があるわけでもないですが・・・

■ 方法1: 公式ドキュメントの Module Index のカテゴリから探す

おそらく一番王道パターンだと思います。

公式ドキュメントには、以下のようにモジュールをカテゴリごとにまとめられています。ここから探す方法です。

docs.ansible.com

例:

ファイルに関すること（コピーや圧縮など）であれば、Files modules
パッケージ管理（yum や dnf など）であれば、Packaging modules
ネットワーク機器に関することであれば、Network modules
Windows　に関することであれば、Windows modules

■ 方法2: 公式ドキュメントのすべてのモジュール一覧から探す

「いやぁ、そもそもどのカテゴリに属するかも分からないんだよねぇ・・」という方は、こちら。

以下の1ページに、すべての標準モジュールが掲載されています。モジュール名と合わせて概要の説明文もあるので、このページ内をブラウザの検索機能で探す方法です。

docs.ansible.com

なお、ansible-doc コマンドでも ansible-doc -l や ansible-doc -l -j（ -jは Ansible 2.9から）を実行することで、モジュールの一覧や概要を表示できます。

$ ansible-doc -l -j
{
    "a10_server": "Manage A10 Networks AX/SoftAX/Thunder/vThunder devices' server object",
    "a10_server_axapi3": "Manage A10 Networks AX/SoftAX/Thunder/vThunder devices",
    "a10_service_group": "Manage A10 Networks AX/SoftAX/Thunder/vThunder devices' service groups",
    "a10_virtual_server": "Manage A10 Networks AX/SoftAX/Thunder/vThunder devices' virtual servers",
    "aci_aaa_user": "Manage AAA users (aaa:User)",
    "aci_aaa_user_certificate": "Manage AAA user certificates (aaa:UserCert)",
...(略)...
}