Citrix DaaS Remote PowerShell SDK の利用手順一例

こんにちは。Citrix製品のサポートを担当している川東（かわひがし）です。

今回は、Citrix DaaS（旧名称：Citrix Virtual Apps and Desktopsサービス）の環境で「Citrix DaaS Remote PowerShell SDK」を利用する手順の一例をご紹介します。

※弊社のCitrixヘルプデスク契約があるお客様は本記事についてお問い合わせ頂くことも可能です

「Citrix DaaS Remote PowerShell SDK」は、Citrix DaaSに登録されている情報の確認や、設定変更をコマンドを使用して実施することができますが、コマンド実行時にCitrix Cloudのユーザ認証が要求されるため、毎回の認証のためにログインアカウントを入力する作業が煩わしく感じると思います。
Citrix Cloudのアクセスキーを使用することで、ログインアカウントの入力をスキップすることができます。

本記事は、アクセスキーを使用しない場合と使用する場合の２パターンの手順をご紹介します。

（１）本資料で使用した検証環境の構成
（２）Citrix DaaS Remote PowerShell SDKのインストール手順
　　　【インストール手順】
（３）アクセスキーを使用しない場合の利用手順
　　　【コマンド実行手順】
（４）アクセスキーを使用する場合の利用手順
　　　【アクセスキーの取得と登録の手順】
　　　【プロファイルを使用したコマンド実行手順】
　　　【登録したプロファイルを削除する場合】
（５）参考情報
（６）まとめ

本記事は、以下の構成の検証環境を使用しています。

■ご注意ください
Citrix社の製品ドキュメントにて、Citrix DaaS Remote PowerShell SDKはCitrix Cloud Connectorマシンにインストールしないこと、同じリソースの場所内のドメイン参加済みマシンにはインストールできることが記載されています。

他の注意点の記載もございますので、以下のドキュメントをご参照ください。

SDKおよびAPI
→「Remote PowerShell SDKをインストールして使用する」の「注」をご確認ください。

１．こちらのサイト から、Remote PowerShell SDKをダウンロードします。
　　※ダウンロードページを開く際に、CitrixのMyAccountのログインを要求されます。

2.「Virtual Apps and Desktops Remote PowerShell SDK」にて「Download File」をクリックします。

３．ダウンロードした「CitrixPoshSdk.exe」を実行します。
※.NetFramework 4.8がインストールされていない場合、自動インストールされます。こちらのインストール後、自動再起動されます。インストールに時間がかかる場合がございます。

４．「ライセンス契約書に同意する」にチェック後、「Next」をクリックします。

５．インストールが開始されます。

6.「インストールが正しく完了しました」画面にて「閉じる」をクリックします。

以下の画面は、「View the readme...」にチェックを付けているため、Readmeのファイルが開きます。こちらは閉じてください。

アクセスキーを使用しない場合、PowerShellのプロンプト画面を開いてコマンド実行する際にCitrix Cloudのログインが必要になります。

バッチ実行する場合も、実行のたびにログインが必要になります。

１．PowerShellのプロンプトを開き、以下のコマンドを実行します。

　　> Add-PSSnapin Citrix*

　　実行が成功した場合はメッセージは表示されません。

２．以下のコマンド実行後、CitrixCloudの管理者アカウントでログインします。

　　> Get-XDAuthentication

３．顧客情報を選択して「Select」をクリックします。
※アカウントに紐づいている顧客情報が１つの場合は、以下の画面は表示されません。

４．コマンドを実行します。
※以下は、Get-BrokerMachineコマンドを実行しています。
※利用できるコマンドは、こちら をご参照ください。

最初に1度「アクセスキーの取得と登録の手順」を実施しプロファイルを登録します。以降は、CitrixのPowerShellコマンド実行前にGet-XDAuthentication -ProfileName “プロファイル名”を実行することでCitrix Cloudのログインが不要になります。
バッチ実行する場合も、実行のたびにログインが不要になります。

１．Citrix Cloudのポータル画面にログインします。

２．画面左上の三本線をクリック後、「IDおよびアクセス管理」をクリックします。

3.「APIアクセス」をクリックします。

４．ページ内の以下の文章に記載されている顧客IDの値を確認します。

＊＊＊
このセキュア クライアントを Cloud Connector のサイレント インストールに使用するか、Citrix Cloud API にアクセスするには、顧客 ID パラメーターに顧客IDを使用します。
＊＊＊

顧客IDは、次の項の【コマンド実行手順】にて使用します。


※以下の黄色線の値が顧客IDです

5.「セキュアクライアントの名前を入力」のボックスに、任意の名前を入力後、「クライアントの作成」をクリックします。
（例:Test-Remote-SDK）

6.「ダウンロード」をクリックして「secureclient.csv」をダウンロードします。

７．PowerShellのプロンプトを開き、以下のコマンドを実行します。

　　> Add-PSSnapin Citrix*

　　実行が成功した場合はメッセージは表示されません。

８．以下のコマンドを実行します。

">" 以降を１行で実行してください。

> Set-XDCredentials -CustomerId “アクセスキーの取得手順6の顧客ID” -SecureClientFile “手順１のsecureclient.csvのパス" -ProfileType CloudApi -StoreAs "任意の名前"

※実行例
> Set-XDCredentials -CustomerId “CitrixBlog” -SecureClientFile "C:\Test\secureclient.csv" -ProfileType CloudApi -StoreAs "TestStore"

９．以下のコマンドを実行してProfileが登録されていることを確認します。

> Get-XDCredentials -ListProfiles

１０．PowerShellプロンプト画面を閉じます。

１．PowerShellのプロンプトを開き、以下のコマンドを実行します。

> Add-PSSnapin Citrix*

実行が成功した場合はメッセージは表示されません。

２．登録されているプロファイルを使用して認証するため、以下のコマンドを実行します。

> Get-XDAuthentication -ProfileName "【アクセスキーの取得と登録の手順】の手順８にて「-StoreAs」に設定したプロファイル名"

※実行例
> Get-XDAuthentication -ProfileName "TestStore"

３．任意のコマンドを実行して Citrix Cloud の認証画面が表示されないことを確認します。
※以下は、Get-BrokerMachineコマンドを実行しています。
※利用できるコマンドは、こちら をご参照ください。

以下のコマンドにて削除できます。

> Clear-XDCredentials –ProfileName “【アクセスキーの取得と登録の手順】の手順８にて「-StoreAs」に設定したプロファイル名”

※実行例
> Clear-XDCredentials –ProfileName "TestStore"

SDKおよびAPI
https://docs.citrix.com/ja-jp/citrix-daas/sdk-api.html

Manage Citrix DaaS using Remote PowerShell SDKs
https://developer-docs.citrix.com/projects/citrix-daas-sdk/en/latest/ 　

XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud
https://www.citrix.com/blogs/2016/07/01/introducing-remote-powershell-sdk-v2-for-citrix-cloud/

Citrix DaaS Remote PowerShell SDKの実行はできましたでしょうか。
一連のコマンドをバッチ実行する場合は、「（４）アクセスキーを使用する場合の利用手順」に記載の方法をお試し頂ければと思います。

次回は、すでにCitrix社にてサポートが終了しているCitrix Receiverに関して、弊社のヘルプデスクによくお問い合わせ頂く内容と解決方法をご紹介する予定です。

いつもCitrixサポートブログをご覧いただきありがとうございます。

アシストとCitrix保守契約を締結されている方は、Webサポートセンター「AWSC」をご利用いただけます。本ブログサイトではご紹介しきれないFAQや過去のCitrixヘルプデスクメールマガジンを公開していますので、是非ご利用ください。

また、アシストではCitrixユーザ企業様向けの無償セミナーを多数ご提供しています。Citrix製品を利用するうえで必要となる情報やトラブルシューティング時のノウハウをご紹介するセミナーなどご用意していますので、貴社の課題解決へとお役立てください。アシストと保守契約を締結されていないお客様にもご参加いただけます。

アシストのCitrixサポートセンターに良くある設定・トラブル対処方法のFAQ10選の資料を無料プレゼント中です。また、Citrix XenApp/XenDesktopの問題発生時に原因を切り分ける方法も掲載しております。以下のバナーからお気軽にダウンロードください。