Windows 上で Ansible をマスターする：あなたの信頼できるエキスパートガイド – techsyncer

たとえAnsibleがSSHを使用してLinuxノードを管理するために知られているとしても、Windows上のAnsibleが同様にうまく機能することをご存知ですか？Windows Remote Management（WinRM）を使用すると、Windows上のAnsibleはすべてのWindowsノードを効果的に管理できます！

Windows上のAnsibleを使用すると、パッチのデプロイ、Windowsサーバーの管理、PowerShellスクリプトの実行などのタスクを実行できます。

このチュートリアルでは、最初のWindowsノードをAnsibleで管理する方法と、そのノードに対してコマンドとプレイブックを実行する方法を学びます。

前提条件

チュートリアルに従いたい場合は、次のものを用意してください。

An Ansible controller host – このチュートリアルでは、IPアドレスが10.111.4.53のUbuntu 18.04.5 LTSマシンでAnsible v2.9.18を使用します。 Windowsは制御ノードとしてサポートされていません。管理ノードのみです。
AnsibleコントローラホストにPythonがインストールされていること – このチュートリアルではPython v2を使用しますが、v3でも同様に機能するはずです。
Ansibleコントローラにpipパッケージがインストールされていること
A Windows 2012 R2 or greater computer for Ansible to manage – This tutorial will use two Windows Server 2012 R2 Standard machines as remote nodes with IP addresses of 52.242.251.213 and 10.111.4.106.
A Windows workstation – This tutorial will perform some basic pre-configuration to the node that Windows will manage with Ansible and will require you to sitting at a Windows workstation.
管理するWindowsサーバーにはPowerShellリモーティングが有効になっていること
A user account in the local Administrators group on the Windows computer. This tutorial will use an account called adminuser.

Windows上でWinRMリスナーを設定する

Ansible がリモートの Windows ノードと通信できるようにするには、それに接続できる必要があります。これは、Microsoft プロトコルの WinRM を介して行われます。WinRM は、PowerShell Remoting が PowerShell 内からリモートコマンドを実行するために使用するプロトコルと同じです。

この時点では、Ansible は管理プロトコルとして SSH をサポートしていますが、これは実験的な機能です。

Windows ノードとの通信に WinRM を使用するためには、WinRM を構成する必要があります。これを行うには、Ansible がさまざまな WinRM オプションを設定する PowerShell スクリプトが提供されています。

Red Hat が提供する WinRM を構成するための PowerShell スクリプトはテストされており、安全ですが、それを読み、その行う作業の高レベルで理解することが重要です。

最初のタスクは、構成スクリプトをダウンロードして Windows ノード上で Ansible を実行することです。これを行うには、対象の Windows コンピューターですでに PowerShell Remoting が有効になっており、Windows ワークステーションにいると仮定します。

ローカルのWindowsコンピューターにConfigureRemotingForAnsible.ps1 PowerShellスクリプトをダウンロードします。このチュートリアルでは、~\Downloadsに保存されていると仮定します。

WindowsノードAnsibleが管理するように構成スクリプトを実行します。これにはInvoke-Commandコマンドを使用します。以下のコマンドは、チュートリアルの2つのデモマシンでコマンドを実行し、Windowsノードのローカルadminuserアカウントのパスワードを求めます。

Invoke-Command -ComputerName 52.242.251.213, 10.111.4.106 -FilePath '~\Downloads\ConfigureRemotingForAnsible.ps1' -Credential (Get-Credential -UserName adminuser)

デフォルトでは、構成スクリプトは基本的なHTTP認証用にWinRMを構成します。より安全な接続を使用するようにAnsibleを設定したい場合は、AnsibleのためにWinRMをHTTPS経由で構成する方法を学んでください。

Windows上のAnsibleコントローラーの構成

WindowsノードがAnsibleに対応したので、Ansibleコントローラーを構成して、Ansibleがどのように通信するかを示します。

1. 好きなSSHクライアントを使用して、AnsibleコントローラーホストにSSHで接続します。

2. pywinrm Pythonモジュールをインストールします。 pywinrm Pythonモジュールは、Windows上のAnsibleがWinRMプロトコル経由でホストに通信するために必要です。

pip install pywinrm

AnsibleインベントリファイルでリモートWindowsノードを定義します。Ansibleインベントリは、ホスト名またはIPアドレスで定義されたリモートホストのコレクションです。定義された後、Ansibleインベントリをコマンドやプレイブックでターゲットにすることができます。これから見ていきます。

デフォルトのAnsibleインベントリファイルは、/etc/ansible/hostsディレクトリにあります。

以下のサンプルインベントリファイルは、各Windowsノードを含むwindows ホストグループを作成しています。チュートリアルでは、後で複数のWindowsノードを一度にターゲットにしやすくするために、ここでホストグループを使用しています。

[windows]
 54.242.251.213
 10.111.4.106

4. 次に、インベントリファイル内のWindowsホストに接続する際にAnsibleが使用するいくつかの必要な変数をwindows:varsグループとして定義します。

[windows:vars]
 ansible_user=localadmin ## ansibleが通信するためのWindowsのユーザー名
 ansible_password=s3crect ## ansibleが通信するためのWindowsのパスワード
 ansible_connection=winrm ## ansibleがリモートWindowsノードと接続する方法
 ansible_winrm_server_cert_validation=ignore ## 証明書検証を無視する（Ansibleに付属する自己署名証明書のみを使用するため）

5. 今、Ansibleのwin_pingモジュールを使用して、ステップ＃3で定義されたwindowsホストグループ内のホストに対して簡単な接続テストを実行します。

# windowsはホストグループです
# -mはAnsibleにwin_pingモジュールを使用するよう指示します
 ansible windows -m win_ping

実行した後、以下のようにAnsibleがSUCCESSメッセージとともに緑色のテキストを返すことがわかります。成功したping試行を示しています。

出力は、AnsibleコントローラーホストがWinRM経由でWindowsリモートホストと正常に通信できることを確認しています。

Windowsホストでアドホックコマンドを実行する

この時点で、AnsibleがWindowsノードを制御を開始できる準備が整っています。これをテストするために、インベントリファイルのwindowsホストグループで定義されたWindowsノード上でアドホックコマンドを実行します。アドホックコマンドは、最初にplaybookを作成せずにノード上で簡単なコマンドを実行する必要がある場合に便利です。

これを行うには、引き続きAnsibleコントローラーノードにSSH接続されていると仮定します。

1. 今回はwin_featureモジュールを呼び出す(-m)ことにします。このモジュールはnameとstateの2つの引数(-a)を受け取ります。これらはWindowsの機能名とそれが取るべき状態を示します。

# ここでwindowsはホストのグループです
# win_featureはモジュールの名前です
# state=presentはパッケージやサービスをインストールすることを意味します
 ansible windows -m win_feature -a "name=Telnet-Client state=present"

上記のコマンドを実行すると、すべてがうまくいけば、Ansibleはwindowsホストグループのすべてのノードに接続し、それぞれのノードでwin_featureコマンドを実行し、Telnet-Client Windows機能が存在しない場合はインストールします。

2. Ansibleは成功を示しますが、確実を期すために、手動でWindowsノードにPowerShellで接続し、Telnet Client Windows機能がインストールされていることを確認してください。ローカルのWindowsワークステーションで、Invoke-Commandを実行して、各WindowsコンピュータでGet-WindowsFeature PowerShellコマンドを実行します。

Invoke-Command -ComputerName 52.242.251.213, 10.111.4.106 -ScriptBlock { Get-WindowsFeature -Name 'Telnet-Service' } -Credential (Get-Credential -UserName adminuser)

この時点で、好きなWindowsモジュールをアドホックなコマンドとして実行できます！

Windows Playbooksの作成と実行

Windows管理ノードでのアドホックコマンドの実行の技術をマスターしたら、次のタスクはプレイブックを作成して実行することです。Ansibleプレイブックはコマンドを1つの場所にまとめ、複雑なロジックを記述して複雑な自動化シナリオを実行できます。

win_commandモジュールを使用してリモートWindowsコマンドを実行する

まだAnsibleコントローラーホストに接続されていると仮定します。

1. ホームディレクトリーの下にansible-windows-demoという名前のフォルダーを作成し、移動します。このフォルダーにはプレイブックが格納されます。

mkdir ~/ansible-windows-demo 
cd ~/ansible-windows-demo

2. お気に入りのテキストエディタを開き、ansible-windows.ymlという名前のファイルを ~/ansible-windows-demoディレクトリに作成して保存します。

AnsibleプレイブックはYAMLで記述されます

3. 次に、以下のプレイブックをansible-windows.ymlファイルにコピーして単一のタスクを作成します。このプレイブックは、windowsホストグループ内のすべてのホストでwin_commandWindows Ansibleモジュールを使用してnetstat Windowsコマンドを実行します。

win_commandモジュールは、Windowsリモートホストでコマンドを実行します。特殊文字、改行、大なり記号などの変数を含むコマンドは許可されません。

---
 - name: Ansible win_command module example  
   hosts: windows # モジュールを実行するホストグループ
   tasks: 
   -  name: run an executable command on a remote Windows system
      win_command: netstat -e # win_commandはWindowsモジュールです。

4. 以下のコマンドを実行して、リモートホストでタスクを実行するansible-windows.ymlプレイブックを呼び出します。

ansible-playbook ansible-windows.yml

すべてがうまくいけば、以下のような出力が表示されます。

Ansible successfully executed the netstat command using win_command module

win_shellモジュールを使用して、リモートのcmd.exeコマンド（netstat）を実行するプレイブックを前の例で作成しました。少し難易度を上げて、win_shellモジュールを使用してPowerShellコマンドを実行しましょう。

win_shellモジュールは、デフォルトでWindowsホスト上のPowerShellを実行します。

ローカルのWindowsワークステーションで:

1. まず、お気に入りのテキストエディターをローカルのWindowsワークステーションで開き、サンプルのPowerShellスクリプトを作成し、次のコードをコピーして、one.ps1として保存します。このチュートリアルでは、スクリプトを~\one.ps1に保存します。

以下のコードは、C:\tempディレクトリにtest2.txtという空のテキストファイルを作成します。

Set-Content -Path C:\temp\test2.txt -Value ''

2. one.ps1 PowerShellスクリプトをお好みの方法でWindows管理ノードにコピーします。このチュートリアルでは、one.ps1スクリプトを各WindowsノードのC:\Tempフォルダーにコピーしたと仮定します。

3. サンプルのPowerShellスクリプトがWindowsノードにある場合、Ansibleコントローラーホストに接続し、再度お気に入りのテキストエディターを開きます。今回は、同じ~/ansible-windows-demoディレクトリにansible-windows-shell.ymlという別のPlaybookを作成して保存します。

4. 以下のPlaybookをansible-windows-shell.ymlファイルにコピーして貼り付けます。このPlaybookは、win_shellモジュールをデモンストレーションするために、2つのタスクを実行します。これは、ステップ#2からコピーしたPowerShellスクリプトを呼び出し、スクリプトが全く必要ないことを示すために、PowerShellコードを直接Playbookに挿入します。

win_shellモジュールに複数行のPowerShellコードを渡すには、|パイプ文字を使用します。

---
 - name: Ansible win_shell module example 
   remote_user: localadmin # ローカルWindowsユーザーとの接続
   hosts: windows # リモートホストグループ
   tasks:
    - name: Single line PowerShell # win_shellモジュールを使用して単一のコマンドを実行
      win_shell: C:\temp\one.ps1
    - name: Run multi-lined shell commands 
      win_shell: |
        $text = ' Iam Author of ATA'
       Set-Content -Path C:\temp\test3.txt -Value $text

5. 今、リモートホストでPowerShellを使用して実行される2番目のPlaybookであるansible-windows-shell.ymlを呼び出します。

ansible-playbook ansible-windows-shell.yml

ansible-playbook ansible-windows-shell.yml

6. 必要に応じて、ローカルWindowsワークステーションで、Playbookが既存のスクリプトとPlaybook内のPowerShellコードを実行したことを確認します。

Invoke-Command -ComputerName 52.242.251.213, 10.111.4.106 -ScriptBlock { Test-Path -Path 'C:\Temp\test3.txt','C:\Temp\test2.txt' } -Credential (Get-Credential -UserName adminuser)

Ansible Playbookが正常に実行された場合、PowerShellは今やファイルが存在することを示す2つのTrueステートメントを返します。

結論

このチュートリアルでは、最初のWindows管理ノードをAnsibleでセットアップする方法を学びました。Ansibleは従来、Linuxツールとして知られていましたが、簡単にWindowsでも使用できます！

Ansibleを使用してWindowsを管理するためにどのPlaybookとWindowsモジュールを使用しますか？