共用方式為


命令行活動精靈

命令行活動精靈可讓您將命令、自變數和參數封裝成Microsoft .NET 元件(.DLL),在 Orchestrator 中快速建立新的活動。 精靈會使用 Orchestrator SDK 自動建立 C# 原始程式碼,並為您編譯。 使用此元件,您可以使用 .NET Integration Pack(Integration Toolkit 的一部分)來測試您的活動,然後使用整合套件精靈將元件封裝成自定義整合套件,就像其他整合套件一樣散發和部署。

元件可以包含一或多個活動(命令),而且活動可以是一或多個可用的命令類型(Command、Command Line、PowerShell 或 SSH 命令)。 您可以定義活動名稱、命令結構、輸入參數,甚至是已發佈的數據(輸出)。

Orchestrator 中的活動概觀

活動是 Orchestrator Runbook 的單一功能部分。 活動是 Runbook 內實際工作的作業,並使用可使用條件定義的連結來聯結在一起,以建立工作流程分支。 使用 Runbook 設計工具建置 Runbook 時,您會將活動從 [活動] 窗格拖放到 Runbook,並將它們連結在一起以形成工作流程。 當 Runbook 執行時,它會依連結的方式依序叫用每個活動。 每個活動都會執行特定職責,並可從 Orchestrator 數據總線收集輸入數據,並將其輸出發佈至相同的數據總線。 每個活動都能夠從 Runbook 中執行之前執行的任何活動擷取已發佈的數據,而發佈輸出數據可讓下列活動存取它。

活動範圍從簡單到複雜。 您可以使用命令行活動精靈來建立活動,只可將文字回應至輸出屬性。 您也可以建立執行複雜、多步驟動作的單一活動,例如虛擬機部署。 您必須定義每個活動將執行的動作。 不過,您的目標應該是定義封裝單一功能集的活動,以便在許多不同類型的情況下輕鬆重複使用。 關鍵是彈性。 最好建立一組 10 個不同的活動,每個活動都會執行特定動作,並以 20 種不同的方式使用這些活動,而不是建立 20 個不同的活動來解決特定的個別案例。 本檔稍後將涵蓋最佳做法的詳細資訊。

建立新的活動元件

請遵循下列步驟來建立新的命令列活動元件:

  1. 選取 [啟動所有程式>] Microsoft System Center 2012 > Orchestrator Integration Toolkit > Orchestrator > > 命令行活動精靈

  2. 選取 [下一步]。

  3. 在 [元件詳細數據] 頁面上,輸入以字母開頭的 Name,後面接著零個或多個英數位元。 此名稱會作為元件和活動的 C# 命名空間識別碼。

  4. 元件檔案中,輸入此精靈將建立之元件檔案的路徑和檔名。 如果此檔案已經存在,系統會提示您覆寫檔案。

  5. 選取 [元件資訊]。 您可以在這裡輸入將成為元件檔案的屬性,透過檔案屬性在 Windows 檔案總管中可見的資訊。 屬性值定義於下表中。 這項資訊是選擇性的,不需要建置元件。

    屬性 描述
    標題 指定元件的標題,該元件會顯示為 Windows 檔案總管屬性中的檔案描述 屬性
    描述 指定元件選擇性描述,該元件不會出現在 Windows 檔案總管屬性中
    Products 指定元件的產品名稱,該元件會顯示為 Windows 檔案總管屬性中的 [產品名稱 ] 屬性
    公司 指定元件的公司名稱,該元件不會出現在 Windows 檔案總管屬性中
    著作權 指定元件的著作權通知,該元件在 Windows 檔案總管屬性中顯示為著作權
    商標 指定元件的商標,該元件在 Windows 檔案總管屬性中顯示為法律商標
    版本 指定元件版本和檔案版本。 這些內容會出現在 Windows 檔案總管屬性中,做為 檔案版本產品版本

    版本號碼有四個部分,如下所示:

    <主要版本>.<次要版本>.<組建編號>.<修訂>
  6. 當您完成輸入元件資訊時,請選取 [ 確定 ]。

  7. 選取 [下一步]。 [ 命令] 頁面隨即顯示。

  8. 依照將命令新增至元件提供的指示,新增一或多個命令。

  9. 當您完成活動的定義時,請選取 [ 確定]。 對話框會關閉,而且您的新活動會新增至 [命令] 頁面上的清單。 如果您需要返回並編輯命令,請選取清單中的命令,然後選取 [編輯]。 如果您需要刪除命令,請選取清單中的命令,然後選取 [ 移除]。

  10. 當您完成新增和修改命令時,請選取 [ 下一步]。 在精靈開始時指定的元件檔案會編譯,而且當程式完成時,最後一個精靈頁面就會顯示。

  11. 如果您想要立即從這個新元件建置整合套件,請選取 [建置整合套件 ] 按鈕,以啟動 [整合套件精靈],並從元件預先載入資訊。 然後,依照建立新的整合套件中的指示來建立整合套件。

  12. 如果您想要使用 [叫用 .NET] 活動來測試元件,或只略過目前 IP 建置程式,請選取 [ 完成]。

將命令新增至元件

請遵循下列步驟,將命令新增至元件:

  1. 在 [ 命令] 頁面上,您可以定義一或多個將新增至元件的命令(變成活動)。 若要新增命令,請選取 [ 新增]。

  2. [ 新增/編輯命令] 對話框會顯示並包含三個索引標籤: 一般自變數已發佈數據。 輸入命令的名稱。 這會成為活動 Runbook Designer 中顯示的名稱。 您也可以選擇性地輸入 命令的描述

  3. Mode 屬性選取器包含四個選項:執行命令、執行 Windows PowerShell、執行程式及執行 SSH 命令。 如果您選取 [ 執行程式 ] 模式,[ 程式 ] 欄位就會變成作用中。 選取省略號按鈕 (...) 並瀏覽您要執行的程式。

    注意

    在執行程式命令中選取的程式,將會在 Runbook Server 上叫用包含此活動的 Runbook。 因此,此程式必須存在於您預期執行 Runbook 的所有 Runbook 伺服器上。

  4. 選取 [ 自變數] 索引標籤

  5. 在 [ 命令行] 欄位中,輸入活動所需的命令或命令行參數。 如果您的命令會採用您想要使用者指定的參數,則必須在下方的 [參數 ] 清單中新增參數,然後使用 [插入 ] 按鈕將它們新增至命令行。

    重要

    如果您為 Mode 指定執行 Windows PowerShell,而且您正在參考整合套件隨附的 PowerShell 腳本,則必須在腳本名稱前面加上點和斜線字元來參考本機目錄。 例如,會為名為 MyScript.ps1 的腳本指定 .\MyScript.ps1。 這是因為腳本檔案會複製到整合套件的預設目錄。 當 Windows PowerShell 從本機目錄執行腳本時,它必須指定這個表示法。

  6. 若要提供命令行的參數,請選取 [ 新增]。 [ 新增/編輯參數 ] 對話框隨即出現。

  7. 在 [名稱] 欄位中,輸入您要新增的參數名稱。 這是活動 [屬性] 列表中所顯示之參數的顯示名稱。

  8. 從[使用模式] 下拉式清單中,選取您將用於 參數的模式。 使用模式有兩個選項:

    使用模式 描述
    命令自變數 選取此選項可在命令列中使用這個自變數作為參數(使用 [插入] 按鈕)。 例如,名為 「Folder」 的命令自變數參數可以放在命令行中,如下所示:

    Dir $(folder)注意:如果命令行自變數包含空格(例如資料夾名稱),您可能需要以引號括住命令才能正常運作。 例如:Dir "$(folder)"
    環境變數 選取即可使用此自變數作為將在命令行執行之前設定的環境變數。 它可以做為命令行參數,或做為執行腳本內的環境變數。

    例如,名為 「Folder」 的環境變數參數可以放在命令行中,如下所示:

    Dir %Folder%重要:環境變數名稱已存在於使用者或系統環境中;命令將會失敗,並出現類似下列的錯誤訊息:已新增專案。字典中的索引鍵:正在新增的 'folder' 索引鍵: 'folder'。 您可以選取 [ 啟動 > 執行],然後輸入 MSINFO32.EXE來判斷本機或遠端計算機上存在哪些環境變數。 然後選取 [軟體環境變數>]。 若要選取另一部計算機,請按 <CTRL+R>,選取 [網络上的遠端計算機],輸入計算機名稱,然後選取 [ 確定]。
  9. 從 [ 顯示樣式 ] 下拉式清單中,選取您將用來顯示參數的樣式。 顯示樣式會決定使用者在向用戶呈現時,如何與輸入互動。 選項如下所述:

    顯示樣式 描述
    Text 使用者將會以自由格式文本框顯示,以輸入值
    加密文字 使用者將會看到遮罩文字框。 此欄位中的數據將會在資料庫內加密,而且不會顯示在任何記錄中
    True/False 用戶可以從快顯對話框中選取 True 或 False
    具有選取範圍的文字 用戶可以從您指定的選項群組中選取
    日期/時間 用戶可以使用日期/時間選擇器控件來選取值
    檔案 用戶可以使用 [檔案瀏覽器] 控制器來選取值
    Folder 用戶可以使用資料夾瀏覽器控制項來選取值
    電腦 用戶可以使用電腦瀏覽器控制項來選取值
  10. 如果參數需要或您想要提供預設值,請在 [預設值] 字段中輸入它

  11. 如果您選取 [具有選取範圍的文字],則會啟用 [ 選項 ] 字段。 若要新增使用者可以選取的選項值,請選取 [選項] 字段旁邊的省略號按鈕,然後輸入。 每個選項都會列在個別行上。 完成新增選項之後,請選取 [ 確定]。

  12. 當您完成參數定義時,請選取 [ 確定]。

  13. 如果定義為 Command Parameter,現在可以將游標放在命令行中所需的插入點,然後選取 [插入 ] 按鈕並選取參數名稱,將參數新增至命令行。 如果定義為 環境變數,則必須在命令行中手動輸入變數(格式 為 %variable%)。

  14. 如果您選擇 [執行程式] 或 [執行命令行] 模式,則會啟用 [包含工作目錄] 參數複選框。

  15. 選取 [ 已發佈的數據] 索引標籤。此索引標籤上的設定可讓您將輸出數據發佈至 Orchestrator 數據總線,讓其他活動可以使用資訊。

  16. 若要新增已發佈的數據屬性,請選取 [ 新增]。

  17. 如果您從 [新增/編輯命令] 對話方塊的 [一般] 索引卷標上的 [模式] 下拉式清單中選取 [執行命令]、[執行程式] 或 [執行 SSH 命令] 選項,下列專案會出現在 [新增/編輯已發佈的數據] 對話框中:

    項目 描述
    名稱 您要建立之已發佈資料項的顯示名稱
    來源 已發佈數據項的來源。 您可以從命令列選擇標準輸出資料流標準錯誤數據流
    [模式] 您想要用來選取已發佈資料的模式。

    使用 比對模式 來判斷在來源內是否找到指定的模式。 這會傳回 TrueFalse

    使用 擷取群組 來擷取符合您指定模式的每個數據專案
    模式 套用至 Mode 設定的正規表示式
    描述 Runbook Designer 中已發佈數據屬性旁顯示的描述文字。 (選用)
  18. 如果您從 [新增/編輯命令] 對話方塊的 [一般] 索引卷標上的 [模式] 下拉式清單中選取 [執行 Windows PowerShell] 選項,下列專案會出現在 [新增/編輯已發佈的數據] 對話框中:

    項目 描述
    名稱 您要建立之已發佈資料項的顯示名稱
    屬性 將儲存至已發佈數據項的 Windows PowerShell 屬性名稱。 這個屬性必須包含在腳本期間PowerShell管線的物件輸出中,而且不能是物件(應該能夠轉換成字串)。
    描述 Runbook Designer 中已發佈數據屬性旁顯示的描述文字。 (選用)
  19. 選取 [ 確定 ] 以完成新增已發佈的數據項。 針對您想要新增的每個已發佈資料項重複步驟 16-18。

  20. 選取 [確定 ] 以關閉 [新增/編輯命令] 對話框,然後返回 [命令] 對話框。

測試活動元件

建立元件之後,您可以使用叫用 .NET 活動來測試它(包含在 .NET 的 Integration Toolkit IP 中),以確認它是否如預期般運作,然後再將它轉換成自定義整合套件。

測試元件

請遵循下列步驟來測試元件:

  1. 開啟 Runbook 設計工具。

  2. 建立新的 Runbook。

  3. 在 [活動] 窗格中,選取 [Integration Toolkit] 類別來展開它,然後將 [叫用 .NET] 活動拖曳到新的 Runbook 中。

  4. 按兩下 [叫用 .NET 物件] 以檢視 [ 屬性 ] 對話框。

  5. 在 [ 元件 ] 欄位中,選取欄位右側的省略號按鈕 (...) 來瀏覽您使用 [命令行活動精靈] 建立的元件檔案(或使用 SDK 的自定義開發)。 選取檔案,然後選取 [ 開啟]。

  6. 選取 [類別] 字段右邊的省略號按鈕,以檢視元件中個別命令的清單。 選取命令類別,然後選取 [ 確定]。 這個類別的參數會出現在 對話框的 [屬性] 索引標籤上。

  7. [ 設定 ] 欄位只能由使用 Orchestrator SDK 搭配 OrchestratorData 屬性的自定義開發類別使用。 如需 SDK 的詳細資訊,請參閱 System Center Orchestrator Integration Toolkit SDK

  8. 選取屬性索引標籤。

  9. 視需要提供每個屬性的資訊。

  10. 選取 [ 完成 ] 以儲存設定並返回 Runbook。

  11. 在 Runbook Designer 工具列中選取 [Runbook Tester ]。 Runbook Tester 隨即啟動。

  12. 選取工具列中的 [ 執行至斷點 ]。 Runbook 隨即啟動,並執行您的活動。 活動的結果會顯示在 [ 執行記錄 ] 窗格中。

  13. 選取 [執行記錄] 窗格中活動名稱底下的 [顯示 詳細數據],以查看詳細結果,包括輸入屬性和已發佈的數據。

QIK CLI 活動移轉

如果您有使用 Opalis 6.3 QIK CLI 精靈所建立的元件,您必須先將它轉換成與 Orchestrator 相容,才能在 Orchestrator 整合套件中使用,或透過叫用 .NET 活動直接在 Runbook 中使用。 轉換程序很簡單,每個元件只需要幾秒鐘的時間。

重要

如果Microsoft .NET Framework 3.5,未安裝 Service Pack 1,Orchestrator Integration Toolkit 的安裝將不會失敗,但如果不存在,命令行活動精靈中的不同作業將會失敗。 使用 CLI 之前,請確定已安裝 Microsoft .NET Framework 3.5 Service Pack 1。

轉換 Opalis QIK CLI 元件

請遵循下列步驟來轉換 Opalis QIK CLI 元件:

  1. 選取 [啟動所有程式>] Microsoft System Center 2012 > Orchestrator 命令行活動精靈,啟動 Orchestrator 命令行活動精靈,以啟動 > Orchestrator > 命令行活動精靈

  2. 當精靈載入時,選取第一頁上的 [ 載入現有的元件 ] 按鈕。

  3. 選取現有的元件檔案,然後選取 [ 開啟]。 會顯示元件的名稱和檔案位置。

  4. 修改檔案路徑,以便將變更儲存到新的檔案。 您也可以視需要變更元件的名稱。

  5. 如果您需要進一步變更元件資訊詳細數據,請選取 [ 元件資訊 ] 按鈕並進行這些變更。 完成時選取 [ 確定 ] 以返回 [元件詳細數據] 頁面。

  6. 選取 [下一步 ] 以移至 [命令] 頁面。 您應該會看到先前在元件中定義的命令清單。 如有必要,請檢閱命令,然後選取 [下一步 ] 以繼續進行 [建置元件 ] 頁面。

  7. 系統會為您建置新的元件,並使用您先前定義的路徑和檔名來儲存。

  8. 您現在可以在 Runbook 中搭配叫用 .NET 活動使用新的 Orchestrator 相容元件,或選取 [建置整合套件] 按鈕,從此元件 建置整合套件 。 如果您目前不想建置IP,請選取 [ 關閉 ] 以結束精靈。

Orchestrator 資源

除了 System Center 2012 Orchestrator 所提供的此在線參考之外,還有一些資源可以提供建置 Runbook、使用 Integration Toolkit 和最佳做法的其他資訊。