小粋空間  -  a cheap joke and a play on words site

ansibleでコマンドを実行する方法

ansibleでコマンドを実行する方法を紹介します。

１．問題点

下記のコマンドをansibleで実行したいのですが、方法がわかりません。

# echo "hoge"

ということで、ansibleでコマンドを実行する方法を紹介します。

ここでは基本的な実行方法のみを解説します。

２．ansibleでコマンドを実行する

ansibleでコマンドを実行するには、commandモジュールまたはshellモジュールを使用します。ここではcommandモジュールの例で記載します。

inventory

[all]
test_host ansible_host=192.168.1.23

test.yml

- hosts: test_host
  tasks:
  - name: コマンド実行
    command: echo "hoge"
    changed_when: false

実行

# ansible-playbook -i inventory test.yml
 
PLAY [test] ***************************************************************************************************
 
TASK [Gathering Facts] ****************************************************************************************
Enter passphrase for key '/home/hoge/.ssh/id_rsa':
ok: [test_host]
 
TASK [コマンド実行] *************************************************************************************************
ok: [test_host]
 
PLAY RECAP ****************************************************************************************************
test_host                      : ok=2    changed=0    unreachable=0    failed=0

３．解説

commandモジュールの中にcmdオプションを指定し、そこに実行したいコマンドを記述します。

    command: echo "hoge"
    changed_when: false

changed_whenは、実行結果でchangedと判断する条件を定義するモジュールで、ここでは必ずfalseを指定します。

３．changed_whenを指定する理由

changed_whenを指定する理由ですが、commandモジュールやshellモジュールでコマンドを実行する場合、実行結果が必ず”changed”になってしまいます。

以下は先のサンプルでchanged_whenを指定しなった場合の実行結果です。最後の行のchangedが"1"になっています。

# ansible-playbook -i inventory test4.yml
 
PLAY [test] ***************************************************************************************************
 
TASK [Gathering Facts] ****************************************************************************************
Enter passphrase for key '/home/hoge/.ssh/id_rsa':
ok: [test_host]
 
TASK [コマンド実行] *************************************************************************************************
changed: [test_host]
 
PLAY RECAP ****************************************************************************************************
test_host                      : ok=2    changed=1    unreachable=0    failed=0

このchangedを"0"にするために、changed_whenにfalseを指定します。

４．shellモジュールとcommandモジュールとの違い

shellモジュールは、"command"の部分を"shell"に書き換えればOKです。

  - name: コマンド実行
    shell: echo "hoge"
    changed_when: false

commandモジュールとshellモジュールの違いは下記の通りです。

• command：ユーザ環境変数や、パイプ・リダイレクトを使用できない
• shell：ユーザ環境変数や、パイプ・リダイレクトを使用できる

よってコマンドによってcommandモジュールとshellモジュールを使い分けてください。