connection プラグイン
connection プラグインにより、Ansible はターゲットホストに接続してそのホストにあるタスクを実行できるようにします。Ansible には多くの connection プラグインが同梱されていますが、一度に使用できるのは 1 つのみとなります。
By default, Ansible ships with several connection plugins. The most commonly used are the paramiko SSH, native ssh (just called ssh), and local connection types. All of these can be used in playbooks and with /usr/bin/ansible to decide how you want to talk to remote machines. If necessary, you can create custom connection plugins.
このような接続タイプの基本情報は、getting started のセクションで説明しています。
ssh プラグイン
ssh は、システム管理で使用されるデフォルトのプロトコルであり、Ansible で最も使用されるプロトコルでもあるため、コマンドラインツールに ssh オプションが含まれています。詳細は、「ansible-playbook」を参照してください。
connection プラグインの追加
カスタムのプラグインを connection_plugins ディレクトリーに置いて、他のトランスポート (SNMP やメッセージバスなど) をサポートするように Ansible を拡張できます。
connection プラグインの使用
connection プラグインは、設定、コマンドライン (-c、--connection)を経由するか、プレイの キーワード として使用するか、インベントリーにある 変数 を設定すること (もっとも多い例) で設定できます。たとえば、Windows マシンでは winrm プラグインをインベントリー変数として設定できます。
ほとんどの connection プラグインは最小設定で動作します。デフォルトでは インベントリーのホスト名 を使用し、デフォルトではターゲットホストを検索します。
プラグインは自己文書化されています。各プラグインは、その設定オプションを文書化する必要があります。以下は、ほとんどの connection プラグインに共通する接続変数です。
- ansible_host
接続するホストの名前 (インベントリー のホスト名と異なる場合)。
- ansible_port
The ssh port number, for ssh and paramiko_ssh it defaults to 22.
- ansible_user
ログインに使用するデフォルトのユーザー名。ほとんどのプラグインはデフォルトで Ansible を実行している現在のユーザーです。
プラグインごとに、一般的なバージョンを上書きする特定の変数バージョンが存在する場合もあります。たとえば、ssh プラグインの場合は ansible_ssh_host です。
プラグイン一覧
ansible-doc -t connection -l を使用して、利用可能なプラグインの一覧を表示します。ansible-doc -t connection <plugin name> を使用して、詳細なドキュメントと例を参照してください。
参考
- Working with Playbooks
Playbook の概要
- callback プラグイン
callback プラグイン
- filter プラグイン
filter プラグイン
- test プラグイン
test プラグイン
- lookup プラグイン
lookup プラグイン
- vars プラグイン
vars プラグイン
- User Mailing List
ご質問はございますか。Google Group をご覧ください。
- リアルタイムチャット
Ansible チャットチャンネルへの参加方法