MarketplaceStudioToolPowerShell Drive and Cmdlets for Orchestrator

Create your first automation in just a few minutes.Try Studio Web

PowerShell Drive and Cmdlets for Orchestrator

PowerShell Drive and Cmdlets for Orchestrator

by Internal Labs

2

Tool

External Clicks

<100

masuo ohara
Posted 5 months ago

Update-OrchMachine machine01 -RobotUsers robot01 で、テナントレベルでマッピングできることが分かりました。

Orchestratorの画面での下記操作に対応する、フォルダーを指定して、特定のアカウントとマシンのマッピングを実行する場合のコマンドレットの使い方を教えてください。

【Orchestrator画面での操作手順】

(1)左側フォルダ表示で対象フォルダ「Shared\folder01」を選択

(2)[設定]タブを表示して、[マシン]を表示

(3)マシン「machine01」の右端の[その他のアクション]メニューから[フォルダーのアカウントのマッピングを更新]を選択

(4)[このフォルダーに対して特定のアカウントとマシンのマッピングを指定]を選択

(5)アカウント「robot01」を選択して[更新]ボタンをクリック

================================

【2024/12/2追記】

回答いただいた内容で、質問した通りの設定ができました。ありがとうございました。

Yoshifumi Tsuda
Posted 5 months ago ago

ご質問をありがとうございます。

UiPathOrch 0.9.8.19 において、次の3つの cmdlet を追加しました。

  • Get-OrchFolderMachineAccountMapping
  • Enable-OrchFolderMachineAccountMapping
  • Disable-OrchFolderMachineAccountMapping

お問合せの操作は、次のように実現できます。お試しください。

PS C:\> cd Orch1:\Shared\folder01

PS Orch1:\Shared\folder01> Enable-OrchFolderMachineAccountMapping machine01 robot01

よろしくお願い致します。

================================

【2024/12/3追記】

設定できたとのこと、ご共有をありがとうございます! 安心致しました。また不明な点が出ましたら、お気軽にご質問下さい。どうぞよろしくお願い致します。

masuo ohara
Posted 5 months ago

下記①~④まで完了した状態で、ロボットのアカウント「robot01」をマシン「machine01」にマッピングするコマンドレットの使い方を教えてください。

①ロボットアカウント名の作成

Set-OrchPmRobotAccount -UserName robot01

②ロボットアカウントの定義

Add-OrchUser -UserName robot01 -Type DirectoryRobot -Roles 'Allow to be Automation User' -UR_UserName dm01\user01 -UR_Password pwd01

③フォルダーにマシン割り付け

Add-OrchFolderMachine -Path Shared\folder01 -Name machine01

④フォルダーにロボットアカウントを割り付け

Add-OrchFolderUser -Path Shared\folder01 -UserName robot01 -Type DirectoryRobot -Roles 'Automation User'

Yoshifumi Tsuda
Posted 5 months ago ago

ご質問をありがとうございます。

先のご質問にても回答しておりますが、マシンを更新するには次のようにします。

PS Orch1:\> Update-OrchMachine machine01 -RobotUsers robot01

Update-OrchMachine cmdlet の -RobotUsers パラメータは、UiPathOrch 0.9.8.18 で追加されていますことにご留意下さい。

もし上記を実行してエラーとなった場合には、次のコマンドでエラーの詳細をご確認下さい。$error 配列変数には、これまでに発生した例外が含まれております。

PS> $error[0] | Format-List * -Force

なお、当該のフォルダ Shared\folder01 に割り当てられているマシンとユーザー(ロボット)がそれぞれ machine01 と robot01 のみであれば、machine01 と robot01 をマッピングする必要はないかと存じます。このフォルダにおいては、このマシンとロボットの組み合わせのみが有効となるためです。

よろしくお願い致します。

masuo ohara
Posted 5 months ago

マシンテンプレート、ロボットアカウント、フォルダーを指定して無人オートメーションを作成したいときのコマンドレットを教えてください。(マシンテンプレート、ロボットアカウント、フォルダーは既に作成済です。)

Orchestratorの[テナント] - [マシン]タブにある[無人オートメーションの設定]をクリックして行う下記操作を、コマンドレットで行う方法についての質問です。

(1)インフラストラクチャーの構成を選択 →セルフホスト(Unattendedロボット) →マシンテンプレート(静的)

(2)マシンテンプレートを作成または選択 →「machine01」を選択

(3)Unattendedロボットのアカウントを作成または選択 →「robot01」を選択

(4)フォルダーを選択 →「folder01」、「folder02」を選択

Yoshifumi Tsuda
Posted 5 months ago ago

ご質問をありがとうございます。

マシンを作成するには、次のようにします。なお、UiPathOrch 0.9.8.18 以降をお使い下さい。

PS Orch1:\> Add-OrchMachine machine01 -UnattendedSlots 1 -RobotUsers robot01

マシンを更新するには、次のようにします。

PS Orch1:\> Update-OrchMachine machine01 -RobotUsers robot01

作成したマシンをフォルダーに割り当てるには、次のようにします。

PS Orch1:\> Add-OrchFolderMachine -Path folder01,folder02 machine01

よろしくお願い致します。

masuo ohara
Posted 5 months ago

Automation Cloud環境へのエンティティを設定するときに、コマンドレットでどのようにパラメーターを指定すべきなのか知りたいので、問い合せする次第です。

(1)ロボットアカウント作成

下記操作によりロボットアカウント作成ができましたが、コマンドレット「Set-OrchPmRobotAccount」のパラメーターの補完機能で「-UserName」は表示しませんでした。このやり方で合っているでしょうか?

【操作例】

Set-OrchPmRobotAccount -UserName robot01

(2)ロールをロボットアカウントに割り付け

上記(1)で作成したrobot01に、ロール「Allow to be AutomationUser」、ドメイン\ユーザー名「dm01\user01」、 パスワード「pwd01」を割り付けたい場合に使用するコマンドレットを教えてください。

(3)無人オートメーションの設定

マシンテンプレート、ロボットアカウント、フォルダーを指定して無人オートメーションを作成したいときのコマンドレットを教えてください。

Yoshifumi Tsuda
Posted 5 months ago ago

ご質問をありがとうございます。

(1)ロボットアカウント作成 ご使用方法は合っております。Set-OrchPmRobotAccount cmdlet の -UserName パラメータは、意図せず非表示になっておりました。この問題は 0.9.8.16 で修正されております。

なお、テナント間でロボットアカウントをコピーするには、Copy-OrchPmRobotAccount cmdlet が便利です。次のようにします。
PS Src:\> Copy-OrchPmRobotAccount <ロボット名> Dst: -WhatIf

ロボット名は、ワイルドカードとカンマ区切りを使って複数を指定できます。* を指定すると、すべてのロボットアカウントをコピーします。問題がないことを確認したら、-WhatIf を除去して再実行してください。

(2)ロールをロボットアカウントに割り付け 次をお試し下さい。なお、0.9.8.17 以降をお使い下さい。
PS Dst:\> Add-OrchUser DirectoryRobot RobotAccount01 'Allow to be Automation User' -UR_UserName dm01\user01 -UR_Password pwd01 -WhatIf

問題がないことを確認したら、-WhatIf を除去して再実行してください。

(3)無人オートメーションの設定 パッケージがテナントフィード(もしくはフォルダーフィード)に追加済みであれば、次のコマンドでプロセスを追加できます。
PS Dst:\Shared> Add-OrchProcess <プロセス名> <バージョン番号> -WhatIf

問題がないことを確認したら、-WhatIf を除去して再実行してください。

ただし、プロセス追加時にはマシンテンプレートとロボットアカウントは指定できません。これらはジョブを開始するときに指定します。UiPathOrch では、Start-OrchJob cmdlet でジョブを開始できますが、現時点ではこの cmdlet にはマシンテンプレートとロボットアカウントを指定するパラメータがありません。今後の更新をお待ち下さい。

よろしくお願い致します。

福原 勝実
Posted 7 months ago

Yoshifumi Tsuda

>この症状の原因には、設定ファイル UiPathOrchConfig.json に指定するスコープが不足していることが考えられます。

>このツールの機密アプリの設定においては、最低限、OR.Folders.Read OR.Settings.Read が必要となります。

>また非機密アプリの設定においては、上記に加えて OR.Users.Read も必要です。

スレッド返信できないのですね。

UiPathOrchConfig.json へ今回不足していた「OR.Settings.Read 」を追加 & 機密アプリにスコープ追加したところ、問題は解決いたしました。

Yoshifumi Tsuda
Posted 7 months ago ago

問題が解消したとのこと、安心致しました。お知らせ頂きありがとうございます!

ほかにも何か出ましたら、お気軽にご質問下さい。どうぞよろしくお願い致します。

福原 勝実
Posted 8 months ago

機密アプリ(Conf App)でアクセスすると、以下の様な動作になります。

 ・初回NGで2回目はOK ( dir 'test:')

 ・初回NGを出した後に Clear-OrchCache しないと2回目以降も失敗する (Get-OrchUser -Path test:)

非機密アプリでは問題が発生しません。

機密アプリの動きは不具合なのでしょうか?

■環境

PowerShell 7.4.5

UiPathOrch 0.9.6.23

Automation Cloud(Community)

■Example 1

PowerShell 7.4.5

PS C:&gt; Import-Module UiPathOrch

PS C:&gt; dir test:

Get-ChildItem: "test:": You are not authorized!

PS C:&gt; dir test:

Directory: test:\

 Id DisplayName Description FolderType FeedType  ProvisionType

 -- ----------- ----------- ---------- --------  -------------

xxxxxxxx Shared Standard Processes Automatic

xxxxxxxx UR Standard Processes Automatic

PS C:&gt;

■Example 2

PowerShell 7.4.5

PS C:&gt; Import-Module UiPathOrch

PS C:&gt; Get-OrchUser -Path test: | Select-Object FullName,Type

Get-OrchUser: "test:": You are not authorized!

PS C:&gt; Get-OrchUser -Path test: | Select-Object FullName,Type

Get-OrchUser: "test:": You are not authorized!

PS C:&gt; Clear-OrchCache

PS C:&gt; Get-OrchUser -Path test: | Select-Object FullName,Type

FullName Type


Administrators DirectoryGroup

Automation Developers DirectoryGroup

Automation Users DirectoryGroup

Citizen Developers DirectoryGroup

Everyone DirectoryGroup

fk DirectoryUser

intec DirectoryUser

てすとろぼ DirectoryRobot

PS C:&gt;

Yoshifumi Tsuda
Posted 7 months ago ago

ご質問をありがとうございます。

この症状の原因には、設定ファイル UiPathOrchConfig.json に指定するスコープが不足していることが考えられます。

このツールの機密アプリの設定においては、最低限、OR.Folders.Read OR.Settings.Read が必要となります。

また非機密アプリの設定においては、上記に加えて OR.Users.Read も必要です。

要件に合わせて、上記以外のスコープも追加して頂けたらと思います。各 cmdlet の実行に必要となるスコープは、Get-Help <cmdlet name> でご確認頂けます。

ご確認下さい。どうぞよろしくお願い致します。

Chris Tsurumaki
Posted 10 months ago

Thank you so much for your reply Yoshi... I opened uipath tech support ticket Case #:02430583

Yoshifumi Tsuda
Posted 10 months ago ago

Hi Chris,

Thank you very much for updating your review!

Please note that UiPathOrch has many functionalities. If you are migrating classic folders to modern folders, please try the Copy-Item cmdlet. This cmdlet copies folders to another folder within the same tenant or to a different tenant. When you copy classic folders, they are automatically converted to modern folders.

The following command copies the folder "aFolder" to the current folder. "copy" is an alias for Copy-Item. The period represents the current folder.

PS Src:&gt; copy aFolder .

To copy a modern folder and its subfolders together, specify the -Recurse parameter. The following command copies all folders from one tenant to another tenant.

PS Src:&gt; copy . Dst:\ -Recurse

If you have any other questions, please feel free to ask. Thanks.

Chris Tsurumaki
Posted 10 months ago

Awesome helpful tool.. All is working fine other than we are having trouble trying to create per-user Credential assets when we use our CyberArk credential store vs Orchestrator Database.

example - ExportedCredentialAssets.csv

Path,Name,Description,CredentialStore,UserName,MachineName,CredentialUsername,CredentialPasswordNonProdOrch:\Modern\UAT_Environment_Startup,UAT_TestCred3,,UAT_CyberArk_Managed_Bots,migrated default_uip_rpa_bb_2_193,193_Template,,Operating System-GLICWindowsLinuxSRVAccountManaged-RiskLevel1-glic.com-rb1tst1

When we run:

PS NonProdOrch:\Modern\UAT_Environment_Startup> Import-Csv C:\Users\ctsurum\Desktop\ExportedCredentialAssets.csv | Set-OrchCredentialAsset

We get this error:

Set-OrchCredentialAsset: "NonProdOrch:\Modern\UAT_Environment_Startup\UAT_TestCred3": Password for credentials stored in CyberArkCCP is read-only.

Any idea what might be the issue?

Thanks in advance for any guidance and for providing this excellent tool

Yoshifumi Tsuda
Posted 10 months ago ago

Hi Chris,

Thank you for your question. I apologize for any inconvenience caused.

As I do not have a CyberArk environment at hand, I have not been able to test the CyberArk credential store so far. If possible, I would like to use your environment to make the necessary modifications to this module.

As you know, official support is not provided for this tool, but I am currently working with our technical support team. If it is not too much trouble, please provide our technical support team with your environment information. If you could do that, it would enable me to provide support.

If that is difficult, please manually operate from the Orchestrator web interface and provide the HTTP request and payload when you successfully update the credential asset as intended. This can be captured using the Chrome Developer Tools.

I apologize for the inconvenience and appreciate your cooperation.

Publisher

Internal Labs

Visit publisher's page

License & Privacy

License Agreement

Privacy Terms

Technical

Updated

October 22, 2024

Works with

Studio: 20.10+

Application

Microsoft PowerShell

Support

UiPath Community Support

Resources