PowerShellタスクエンジン

PowerShellタスクエンジン

お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

これらのステートは、PowerShellコマンドを使用してプライベートネットワーク内のWindowsマシンで操作を実行するために使用されます。

PowerShell Task Engineでは、さまざまな操作を実行するために6種類のステートを利用できます。

  • PowerShell Engine

  • WindowsAppのインストール

  • WindowsAppのアンインストール

  • サービスの開始

  • サービスの停止

  • WindowsServerの再起動

Notesほぼすべての操作はPowerShell Engineステートで実行できますが、再利用しやすいように、よく使用される一部の操作は個別のステートとして提供されています。

前提条件
  • 有効なBridgeエージェントこちらを参照して、Bridgeをインストールして設定します。

  • PowerShell Task Engineで接続するアプリケーションに必要な認証情報を作成します。

Bridgeの[PowerShell Engine]タブ、キーおよびその説明の詳細については、こちらをクリックしてください。

ユースケース例資産割り当てプロセスでは、従業員向けのWindows OSのインストールをPowerShell Engineステートを通じて実行できます。PowerShell Engineを使用すると、システム管理者は従業員のマシンに接続し、リモートコマンドを実行してOSやその他のソフトウェアをインストールしたり、サービスを開始または停止したりできます。

[Builder View][Code View]で、各種PowerShell Task Engineステートを設定する方法を見てみましょう。

PowerShell Engine

添付されたPowerShellスクリプトファイルを、プライベートネットワーク内のWindowsマシンで実行します。

[Builder View]でステートをーキットに関連付けるには:
  1. 左ペインから必要なPowerShell Engine ステートをサーキットにドラッグ&ドロップするか、サーキット内の必要なステートをクリックします。

  2. [Configuration]で、共通ステート項目の属性を更新します。

  3. [Bridge/Cluster ID]:タスクを実行する適切なブリッジまたはクラスターをドロップダウンリストから選択します。

  4.  Add Configuration セクションで、次の項目を入力します。

    • [Credential ID] - ドロップダウンリストから認証情報を選択します。PSHタブの種類として作成されたすべての認証情報のCredential IDがリストに表示されます。これらは、リモートマシンへのアクセスを認証するために使用されます。

    • [Host] - PowerShellコマンドまたはスクリプトを実行するマシンのホスト名を入力します。Bridgeがインストールされている同じマシンでスクリプトを実行する場合は、localhostを使用します。

    • [Execution Type]-   [Command]または[File]の2つのモードから選択します。

      • [Command]実行するPowerShellコマンドを入力します。直接コマンドを入力することも、ローカルスクリプトファイルを参照するコマンドを入力することもできます。

      • [File]スクリプトファイルを実行する場合は、次の詳細を指定します。

        • [Script ID]:実行するスクリプトを、[Scripts]タブで作成したPowerShellスクリプトのリストから選択します。新しいスクリプトファイルを作成するには、[Scripts]に移動します。

  5. Variableセクションで、[追加]をクリックします。項目が展開され、PowerShellスクリプトで実行する必要のある変数を追加できます。変数名とそのパラメーター値を入力します。

  6. Add Credentialsセクションで、[追加]をクリックし、PowerShellスクリプトを通じて接続するWindowsマシンの認証情報を入力します。

    1. [Var name]:認証情報の名前を指定します。

    2. [Name]:PowerShellスクリプトを通じて接続する必要がある認証情報名をドロップダウンリストから選択します。

    Notes
    追加した変数または認証情報を削除するには、項目の下の行にカーソルを合わせ、[削除]をクリックします。


 [Code View]では、CircuitでPowerShellコマンドを実行し、PowerShellタスクを実行するためのJSONは次のとおりです。
{ 'Windows OS Installation': { 'type': 'powershell_engine', 'next': 'Licence Key Activation Windows', 'start': true, 'bridge_id': 'Bridge_1368_1', 'payload': {       'credential_id': 'PSH Credential for OS installation',
      'execution_type': 'command',
      'command': '$devicename',
      'host': 'localhost',
      'variables': {
       'os_filename': 'windows.iso'
      },
      'credentials': [
      {
      'variable': 'Windows_SK01',
      'credential_id': 'psh_cred_5'
      }
      ]
} } }


WindowsAppのインストール  

この状態では、PowerShellを使用してWindowsマシンにアプリをインストールできます。

この状態は、共通の項目属性に加えて、[Builder View]でインストールするアプリのMSIファイルの場所を[MSI Filepath]項目に入力して、[Add Configuration]セクションで設定できます。


[Code View]でCircuitのPowerShellタスクを使用してWindowsアプリをインストールするためのJSON

{ 'Install an Application': { 'type': 'install_windows_app', 'next': 'End', 'start': true, 'bridge_id': 'bridge-employee onboarding', 'payload': { 'credential_id': 'PWSH Credential for OS installation', 'host': 'localhost', 'msi_file_path': 'C:\\Users\\Administrator\\Downloads\\tortoisehg-5.8.0-x64.msi' } } }

WindowsAppのアンインストール  

この状態を使用すると、Windowsマシンから既存のアプリをアンインストールできます。

Windowsマシンからアプリをアンインストールするには、[Builder View]で共通の状態項目属性を入力します。[Add Configuration][App Name]に、Windowsマシンからアンインストールするアプリ名を入力します。 

[Code View]では、CircuitのPowerShellタスクを使用してWindowsアプリをアンインストールするJSONは以下のとおりです。

{ 'Uninstall Windows App': { 'type': 'uninstall_windows_app', 'next': 'End', 'start': true, 'bridge_id': '<bridge_name>', 'payload': { 'credential_id': '<credential_name>', 'host': '<host_name>', 'app_name': '<application_name>' } } }

サービスの開始  

状態を使用すると、バックエンドのWindowsサーバーでサービスを開始できます。
サービスの開始を設定するには、[Builder View]で共通の項目属性を入力し、[Add Configuration][Service Name]に、Windowsマシンで開始するサービス名を入力します。


[Code View]では、CircuitのPowerShellエンジンのタスクを使用してサービスを開始するために、以下のJSONを使用します。

{ 'Start App Management Service': { 'type': 'start_service', 'next': 'End', 'start': true, 'bridge_id': 'bridge-1368_1', 'payload': { 'credential_id': 'pwsh_cred_5', 'host': 'localhost', 'service_name': 'AppMgmt' } } }

サービスの停止  

この状態を使用すると、バックエンドのWindowsサーバーで実行中のサービスを停止できます。

サービスの停止状態を設定するには、[Builder View]で共通の状態項目属性を入力します。[Add Configuration][Service Name]項目に、Windowsマシンで停止するサービス名を入力します。

[Code View]では、CircuitのPowerShellエンジンのタスクを使用してサービスを停止するために、以下のJSONを使用します。
{ 'Stop a Service': { 'type': 'stop_service', 'next': 'End', 'start': true, 'bridge_id': '<bridge_name>', 'payload': {       'credential_id': '<credential_name>',
      'host': '<host_name>',
      'service_name': '<service_name>'
} } }
  

Windows Serverの再起動  

この状態は、Windowsサーバーのオペレーティングシステムを再起動するために使用します。これにより、サーバー上で実行中のすべてのプロセスとサービスが停止され、その後システム全体が再起動されます。システム更新の適用、問題の解決、定期メンテナンス作業の実行のためによく使用されます。

[ビルダービュー]で状態を設定するには、[設定の追加]で、[認証情報ID]を選択し、再起動するWindowsマシンのホスト名を入力します。

[コードビュー]では、Windowsサーバーを再起動するために次のJSONを使用します。

{ 'Restart WindowsW10': { 'type': 'restart_windows_server', 'next': 'End', 'start': true, 'bridge_id': '<bridge_name>', 'payload': { 'credential_id': '<credential_name>', 'host': '<host_name>' } } }





次へADタスク

    • Related Articles

    • Circuitの状態の概要

      お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 ステートは、タスクの実行、判断、またはあるステートから別のステートへの出力の受け渡しを行うサーキットの構成要素です。ステートは、サーキットのその区間で実行する必要がある特定のタスクやプロセスを定義します。 サーキットのステートは次のように分類されます。 フロー制御 機能 通知 ...