コンテンツにスキップ

プレイブック

これCLIとかコマンドってタイトルの方がいいか

共通

-e | --extra-vars

スペースを含む値を与える場合

$ ansible-playbook ... -e 'key="foo bar baz"'

あるいはJSON形式で。(JSONだと辞書もリストもいける)

$ ansible-playbook ... -e '{key: "foo bar baz"}'

変数ファイルを指定する場合

---
netbox_url: http://netbox.example.org/
netbox_token: hogehoge

こんなファイルをnetbox-vars.ymlとして用意しておき、ansible-playbook実行時に

$ ansible-playbook ... -e @/path/to/netbox-vars.yml

で、このファイルで定義した変数を実行時にextra varsとして参照できる。

-l | --limit

playbookのhostsで指定してあるホストグループの内、特定のホストだけに処理したい場合に使う。

$ ansible-playbook ... -l host1

こうすると、playbookで例えばhosts: serversと指定されており、serversグループに host1, host2, host3 が有ったとしても、このansible-playbook実行のタスクは host1 のみが処理対象で実行される。

開発やデバッグのお供に。

--connection-password-file

リモートへのログインに使用するパスワードが書かれたファイルを指定し、対話的処理を回避する。

ansible-playbook playbook.yml -i inventory.ini --connection-password-file password.txt 

指定するファイルはパスワードのみがtext/plainで書かれている。

ansible-playbook コマンド

--check

いわゆるDry Runで実行する。
checkに対応しているcopyモジュールの場合は以下の通り。

  - name: command sample
    copy:
      src: /home/zaki/tmp.yml
      dest: /var/tmp
      mode: '0644'
    register: result

このplaybook、コピー先が存在しない状態で、実際に動かすとchangedになる状態で--check付けて実行すると

(ansible4) [zaki@cloud-dev shell (master)]$ ls /var/tmp/tmp.yml 
ls: /var/tmp/tmp.yml にアクセスできません: そのようなファイルやディレクトリはありません
(ansible4) [zaki@cloud-dev shell (master)]$ ansible-playbook copy.yml --check

PLAY [localhost] ********************

TASK [command sample] ***************
changed: [localhost]

TASK [print result] *****************
ok: [localhost] => 
  msg:
    changed: true
    diff: []
    failed: false
:
:
(ansible4) [zaki@cloud-dev shell (master)]$ ls /var/tmp/tmp.yml 
ls: /var/tmp/tmp.yml にアクセスできません: そのようなファイルやディレクトリはありません

このとおりchangedとして処理され、resultもchangedになる。
ファイルが存在してokとなる状態で--checkで実行すると、以下の通り。

(ansible4) [zaki@cloud-dev shell (master)]$ ls /var/tmp/tmp.yml
/var/tmp/tmp.yml
(ansible4) [zaki@cloud-dev shell (master)]$ ansible-playbook copy.yml --check
PLAY [localhost] ********************

TASK [command sample] ***************
ok: [localhost]

TASK [print result] *****************
ok: [localhost] => 
  msg:
    changed: false
    checksum: e4012c7ec05eb3bd3d27774fa73b772426c02d74
    dest: /var/tmp/tmp.yml
    diff:
      after:
        path: /var/tmp/tmp.yml
      before:
        path: /var/tmp/tmp.yml
    failed: false
    gid: 1000
    group: zaki
    mode: '0644'
    owner: zaki
    path: /var/tmp/tmp.yml
    secontext: unconfined_u:object_r:user_home_t:s0
    size: 5447
    state: file
    uid: 1000

タスク単位でチェックモードを指定するcheck_modeパラメタについてはdirectives参照。

--list-tasks

同時に指定する--tagsなどの実行条件を踏まえて、どのプレイとタスクが実行対象となるかをリストアップする。dry runのもう1段階手前な感じ。

$ ansible-playbook setup.yml --list-tasks

playbook: setup.yml

  play #1 (rhel): rhel  TAGS: []
    tasks:
      subscription      TAGS: [subscription]
      install packages  TAGS: [packages]

  play #2 (rhel): rhel  TAGS: []
    tasks:
      ssh user config   TAGS: [ssh]
      git config        TAGS: [git]
      get git-prompt.sh TAGS: [git]
      add prompt with git config        TAGS: [git]
      add source gitprompt      TAGS: [git]
      create venv       TAGS: [python]
      clone repository (linux)  TAGS: [repository]
      clone repository (container)      TAGS: [repository]

--tags指定ありの場合

$ ansible-playbook setup.yml --list-tasks --tags git

playbook: setup.yml

  play #1 (rhel): rhel  TAGS: []
    tasks:

  play #2 (rhel): rhel  TAGS: []
    tasks:
      git config        TAGS: [git]
      get git-prompt.sh TAGS: [git]
      add prompt with git config        TAGS: [git]
      add source gitprompt      TAGS: [git]

--start-at

指定タスクから処理を開始する。開発・デバッグのお供に。

---
- hosts: localhost
  gather_facts: false

  tasks:
  - name: exec 1st task
    debug:
      msg: "hello world"

  - name: exec 2nd task
    debug:
      msg: "hello worlds"

  - name: exec 3rd task
    debug:
      msg: "hello worlds!!"
$ ansible-playbook sample.yml --start-at "exec 2nd task"

実行結果

PLAY [localhost] *****************************************************************************

TASK [exec 2nd task] *************************************************************************
ok: [localhost] => 
  msg: hello worlds

TASK [exec 3rd task] *************************************************************************
ok: [localhost] => 
  msg: hello worlds!!

roleの場合は、ロール名含めて指定すればよい。(実行時のTASK [***]***の部分を指定する)

$ ansible-playbook -i inventory-oci-l-dev.ini playbook.yml -v
:
:
TASK [build_awx/awx-ee : clone repository] ***************************************************
fatal: [oci-l-a1-ubuntu]: FAILED! => {"before": "54de4047be742783f69678f942a515e991c097ab", "changed": false, "msg": "Local modifications exist in repository (force=no)."}

PLAY RECAP ***********************************************************************************
oci-l-a1-ubuntu            : ok=33   changed=5    unreachable=0    failed=1    skipped=3    rescued=0    ignored=0   

:
:
$ ansible-playbook -i inventory-oci-l-dev.ini playbook.yml -v --start-at "build_awx/awx-ee : create working directory"

sample

playbook

- hosts: localhost
  gather_facts: false

  tasks:
  - name: hello
    debug:
      msg: hello world

inventory

[server]
192.168.0.1