AdminTask 物件的 dpManagerCommands 指令群組
您可以利用 wsadmin 工具,以 Jython Scripting 語言來配置 DataPower® 設備管理程式。IBM WebSphere® DataPower 設備管理程式提供一組用來管理 DataPower 設備的功能。請使用 dpManagerCommands 群組中的指令和參數,來查詢、配置和管理 DataPower 設備管理程式。
「IBM® WebSphere® DataPower SOA 設備」是一些為特定目的而建置且易於部署的網路裝置,可以簡化、協助保護並加速您的 XML 和 Web 服務部署。當您第一次使用 DataPower 設備管理程式時,並不存在任何設備、受管理集或韌體版本。您必須建立設備、新增韌體版本,以及建立受管理集。
在開始之前,請先驗證您想管理的每一部設備都具備 3.6.0.4 或更高層次的韌體。此外,請驗證每一部設備都啟用了「設備管理通訊協定 (AMP)」端點。在安裝期間,如果停用了「XML 管理」介面 AMP 端點,請利用 DataPower WebGUI 來啟用 AMP 端點。
dpExport
dpExport 指令會匯出 DataPower 設備管理程式的配置和版本。
目標物件
無。
必要參數
- -file
- 指定 DataPower 設備管理程式匯出配置和版本時的目標本端系統檔案。(字串,必要)
回覆值
指令會傳回系統所建立之作業的 ID。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpExport('-file c:/temp/DPManager.export_doc')
AdminTask.dpExport('-file /temp/DPManager.export')
- 使用 Jython 清單:
AdminTask.dpExport(['-file', 'C:/temp/DPManager.export'])
AdminTask.dpExport(['-file', '/temp/DPManager.export'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpExport('-interactive')
dpGetManager
dpGetManager 指令會顯示 DataPower 設備管理程式的內容。
目標物件
無。
回覆值
指令會傳回內容物件,內含 DataPower 設備管理程式的現行設定。
批次模式用法範例
- 使用 Jython 字串和清單:
AdminTask.dpGetManager()
dpGetManagerStatus
dpGetManagerStatus 指令會顯示 DataPower 設備管理程式的狀態。
目標物件
無。
回覆值
指令會傳回 DataPower 設備管理程式狀態的說明。
批次模式用法範例
- 使用 Jython 字串和清單:
AdminTask.dpGetManagerStatus()
dpImport
dpImport 指令會匯入 DataPower 設備管理程式的配置和版本。指令會以所匯入的配置和版本,取代現有的配置和版本。
目標物件
無。
必要參數
- -file
- 指定含有要匯入之配置和版本的 DataPower 設備管理程式系統檔案。(字串,必要)
回覆值
指令不傳回輸出。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpImport('-file c:/temp/DPManager.import')
AdminTask.dpImport('-file /temp/DPManager.import')
- 使用 Jython 清單:
AdminTask.dpImport(['-file', 'C:/temp/DPManager.export'])
AdminTask.dpImport(['-file', '/temp/DPManager.export'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpImport('-interactive')
dpSetManager
dpSetManager 指令會修改 DataPower 設備管理程式的配置。
目標物件
無。
選用參數
- -maxVersionsToStore
- 指定新數目,以指出要保留的版本數上限。(整數,選用)
- -versionsDirectory
- 指定 DataPower 設備管理程式系統目錄,讓管理程式在其中建立版本。指令會將現有的版本從現行版本目錄移至新的版本目錄。(字串,選用)
回覆值
如果您指定了 versionsDirectory 參數的值,指令會傳回指令所建立之作業的 ID。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpSetManager('-maxVersionsToStore 20 -versionsDirectory newDir')
- 使用 Jython 清單:
AdminTask.dpSetManager(['-maxVersionsToStore', '20', '-versionsDirectory', 'newDir'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpSetManager('-interactive')
dpStopManager
dpStopManager 指令會停止 DataPower 設備管理程式。下次當使用 DataPower 設備管理程式時,管理程式會自動重新啟動。
目標物件
無。
回覆值
指令不傳回輸出。
批次模式用法範例
- 使用 Jython 字串和清單:
AdminTask.dpStopManager()
dpAddAppliance
dpAddAppliance 指令會將設備新增至 DataPower 設備管理程式。
目標物件
無。
必要參數
- -hostname
- 指定設備的主機名稱或 IP 位址。(字串,必要)
- -hlmPort
- 指定 DataPower 設備管理程式用來與設備通訊的埠號。預設值為 5550。(整數,必要)
- -name
- 指定 DataPower 設備管理程式中之設備的唯一名稱。請勿在 name 參數中指定下列字元:\\/,#$@:;\"*?<>|=+&%'(字串,必要)
- -userId
- 指定 DataPower 設備管理程式用來存取設備的使用者 ID。(字串,必要)
- -password
- 指定 DataPower 設備管理程式用來存取設備的 Base-64 編碼密碼。(字串,必要)
回覆值
指令會傳回系統所建立之作業的 ID。當作業結束時,作業中 result 屬性的值會包含新設備的 ID。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpAddAppliance('[-hostname myappliance.ibm.com – name myappliance -userId admin -password mypassword]')
- 使用 Jython 清單:
AdminTask.dpAddAppliance(['-hostname', 'myappliance.ibm.com', '–name', 'myappliance', '-userId', ' admin', '-password', 'mypassword'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpAddAppliance('-interactive')
dpGetAllApplianceIds
dpGetAllApplianceIds 指令會顯示 DataPower 設備管理程式每一部設備的 ID。
目標物件
無。
回覆值
指令會傳回字串陣列,內含您配置中的每一個設備 ID。對於設備來說,ID 是 DataPower 設備的序號。
批次模式用法範例
- 使用 Jython 字串和清單:
AdminTask.dpGetAllApplianceIds()
dpGetAllMSApplianceIds
dpGetAllMSApplianceIds 指令會顯示 DataPower 設備管理程式受管理集中的每一部設備的 ID。
目標物件
無。
必要參數
- -managedSetId
- 指定您屬意之受管理集的 ID。(字串,必要)
回覆值
指令會傳回字串陣列,內含您屬意之受管理集中的設備 ID。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpGetAllMSApplianceIds('[-managedSetId myManagedSet]')
- 使用 Jython 清單:
AdminTask.dpGetAllMSApplianceIds(['-managedSetId', 'myManagedSet'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpGetAllMSApplianceIds('-interactive')
dpGetAppliance
dpGetAppliance 指令會顯示 DataPower 設備管理程式的特定設備。
目標物件
無。
必要參數
- -applianceId
- 指定 DataPower 設備管理程式中要顯示的設備 ID。(字串,必要)
回覆值
[ [userId admin] [applianceType XI50] [serialNumber [00605 20356]]
[firmwareManagementStatus ManagementStatus.synced] [actualFirmwareLevel 3.6.1.0] [rollupOperationalStatus
OperationalStatus.unknown] [hostname dp3.dyn.webahead.ibm.com] [settingsManagementStatus ManagementStatus.synced]
[rollupManagementStatus ManagementStatus.synced] [applianceId [00605 20356]] [guiPort 8080] [modelType 9002] [isManaged true]
[managedSetId jgMS1] [featureLicenses [MQ, TAM, DataGlue, JAXP-API, PKCS7-SMIME, WebSphere-JMS]] [hlmPort 5550] [isMaster true]
[name dp3] ]
屬性 | 說明 |
---|---|
applianceId | 顯示您屬意之設備的 ID。 |
managedSetId | 顯示該設備所屬受管理集的 ID。如果設備未受管理,指令不會傳回這個屬性。 |
actualFirmwareLevel | 顯示設備的韌體層次。 |
featureLicenses | 顯示設備的特性授權清單,例如 MQ、TAM 等。 |
guiPort | 顯示 DataPower WebGUI 介面的設備埠。 |
hlmPort | 顯示 DataPower 設備管理程式與設備之間的通訊埠號。 |
hostname | 顯示設備的主機名稱或網際網路通訊協定 (IP) 位址。 |
isManaged | 如果 DataPower 設備管理程式會管理該設備,會顯示值 true。 |
isMaster | 如果該設備是受管理集中的主要設備,會顯示值 true。如果該設備不受 DataPower 設備管理程式管理,不會顯示這個內容。 |
modelType | 顯示設備的機型。 |
applianceType | 顯示設備類型。 |
settingsManagementStatus | 顯示設備上之設定的管理狀態。在 DataPower WebGUI 上,這個屬性亦稱為同步化狀態。 |
firmwareManagementStatus | 顯示設備上之韌體的管理狀態。在 DataPower WebGUI 上,這個屬性亦稱為同步化狀態。 |
domainManagementStatus | 顯示設備上之特定網域的管理狀態。在 DataPower WebGUI 上,這個屬性亦稱為同步化狀態。 |
domainOperationalStatus | 顯示設備上之特定網域的作業狀態。 |
rollupManagementStatus | 顯示設備上之韌體、設定和網域的聚集管理狀態。在 DataPower WebGUI 上,這個屬性亦稱為同步化狀態。 |
rollupOperationalStatus | 顯示設備上之韌體、設定和網域的聚集作業狀態。 |
serialNumber | 顯示您屬意之設備的序號。 |
name | 顯示該設備在 DataPower 設備管理程式中的名稱。 |
userId | 指定 DataPower 設備管理程式用來存取設備的使用者 ID。 |
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpGetAppliance('-applianceId "00605 20356"')
- 使用 Jython 清單:
AdminTask.dpGetAppliance(['-applianceId', '00605 20356'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpGetAppliance('-interactive')
dpManageAppliance
dpManageAppliance 指令會將設備新增至受管理集,並開始管理設備。
目標物件
無。
必要參數
- -managedSetId
- 指定該設備所屬受管理集的 ID。(字串,必要)
- -applianceId
- 指定 DataPower 設備管理程式中要新增至受管理集之設備的 ID。(字串,必要)
選用參數
- -asMaster
- 指定是否將該設備設為受管理集的主要設備。即使沒有指定這個參數,都會將第一部新增至受管理集的設備設為主要設備。(字串,選用)
回覆值
指令會傳回指令所建立之作業的 ID。當作業完成時,result 屬性的值會是設備的 ID。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpManageAppliance('-managedSetId testMS1 -applianceId "00605 20351"')
- 使用 Jython 清單:
AdminTask.dpManageAppliance(['-managedSetId', 'testMS1', '-applianceId', '00605 20351'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpManageAppliance('-interactive')
dpRemoveAppliance
dpRemoveAppliance 指令會將設備從 DataPower 設備管理程式移除。此外,如果該設備是受管理集的成員,指令也會將它從受管理集移除。如果設備是受管理集中的主要設備,則無法移除。在移除主要設備之前,必須先選取不同設備作為主要設備。
目標物件
無。
必要參數
- -applianceId
- 指定 DataPower 設備管理程式中要從受管理集移除之設備的 ID。對於設備來說,ID 是 DataPower 設備的序號。(字串,必要)
回覆值
指令不傳回輸出。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpRemoveAppliance('[-applianceId "00605 20356"]')
- 使用 Jython 清單:
AdminTask.dpRemoveAppliance(['-applianceId', '00605 20356'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpRemoveAppliance('-interactive')
dpSetAppliance
dpSetAppliance 指令會修改該設備在 DataPower 設備管理程式中的配置。
目標物件
無。
必要參數
- -applianceId
- 指定 DataPower 設備管理程式中要修改的設備 ID。(字串,必要)
選用參數
- -hostname
- 指定設備的主機名稱或 IP 位址。(字串,選用)
- -hlmPort
- 指定 DataPower 設備管理程式用來與設備通訊的埠號。預設值為 5550。(整數,選用)
- -name
- 指定 DataPower 設備管理程式中之設備的唯一名稱。請勿在 name 參數中指定下列字元:\\/,#$@:;\"*?<>|=+&%'(字串,選用)
- -userId
- 指定 DataPower 設備管理程式用來存取設備的使用者 ID。(字串,選用)
- -password
- 指定 DataPower 設備管理程式用來存取設備的 Base-64 編碼密碼。(字串,選用)
回覆值
指令不傳回輸出。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpSetAppliance('[-applianceId "00605 20356" -hostname myappliance2.ibm.com -name myappliance2 -hlmPort 4500 -userId admin2 -password myPassword]')
- 使用 Jython 清單:
AdminTask.dpSetAppliance(['-applianceId', '00605 20356', '-hostname', 'myappliance2.ibm.com', '-name', 'myappliance2', '-hlmPort', '4500', '-userId', 'admin2', '-password', 'myPassword'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpSetAppliance('-interactive')
dpUnmanageAppliance
dpUnmanageAppliance 指令會將您屬意的設備從其受管理集移除。不再管理該設備,但它仍然定義在管理程式中。
目標物件
無。
必要參數
- -managedSetId
- 指定該設備所屬受管理集的 ID。(字串,必要)
- -applianceId
- 指定 DataPower 設備管理程式中要從受管理集移除之設備的 ID。(字串,必要)
回覆值
該指令會傳回指令所建立的作業。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpUnmanageAppliance('[-managedSetId testMS1 -applianceId "00605 20351"]')
- 使用 Jython 清單:
AdminTask.dpUnmanageAppliance(['-managedSetId', 'testMS1', '-applianceId "00605 20351"'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpUnmanageAppliance('-interactive')
dpAddManagedSet
dpAddManagedSet 指令會將受管理集新增至 DataPower 設備管理程式。
目標物件
無。
必要參數
- -name
- 指定 DataPower 設備管理程式中之設備的唯一名稱。請勿在 name 參數中指定下列字元:\\/,#$@:;\"*?<>|=+&%'(字串,必要)
回覆值
指令不傳回輸出。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpAddManagedSet('-name testMS')
- 使用 Jython 清單:
AdminTask.dpAddManagedSet(['-name testMS'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpAddManagedSet('-interactive')
dpGetAllManagedSetIds
dpGetAllManagedSetIds 指令會顯示 DataPower 設備管理程式的受管理集中每一個網域的 ID。
目標物件
無。
回覆值
指令會傳回字串陣列,內含每一個受管理集 ID。
批次模式用法範例
- 使用 Jython 字串和清單:
AdminTask.dpGetAllManagedSetIds()
dpGetManagedSet
dpGetManagedSet 指令會顯示 DataPower 設備管理程式中特定受管理集的相關資訊。
目標物件
無。
必要參數
- -managedSetId
- 指定您屬意之受管理集的 ID。(字串,必要)
回覆值
屬性 | 說明 |
---|---|
managedSetId | 顯示受管理集的 ID。 |
masterApplianceId | 顯示受管理集的主要設備 ID。 |
desiredFirmwareVersionId | 顯示受管理集所用韌體版本的 ID。 |
name | 顯示受管理集相關聯的名稱。 |
rollupOperationalStatus | 顯示受管理集的作業狀態。 |
rollupManagementStatus | 顯示受管理集的管理狀態。 |
settingsId | 顯示受管理集的設定 ID。 |
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpGetManagedSet('-managedSetId testMS1')
- 使用 Jython 清單:
AdminTask.dpGetManagedSet(['-managedSetId', 'testMS1'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpGetManagedSet('-interactive')
dpRemoveManagedSet
dpRemoveManagedSet 指令會將受管理集從 DataPower 設備管理程式移除。
目標物件
無。
必要參數
- -managedSetId
- 指定要移除之受管理集的 ID。(字串,必要)
回覆值
指令不傳回輸出。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpRemoveManagedSet('-managedSetId testMS')
- 使用 Jython 清單:
AdminTask.dpRemoveManagedSet(['-managedSetId', 'testMS'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpRemoveManagedSet('-interactive')
dpSetManagedSet
dpSetManagedSet 指令會修改 DataPower 設備管理程式的受管理集。
目標物件
無。
必要參數
- -managedSetId
- 指定要修改之受管理集的 ID。(字串,必要)
選用參數
- -masterApplianceId
- 指定要設為受管理集主要設備之設備的 ID。這部設備必須是受管理集的成員。這個參數與 desiredFirmwareVersionId 參數互斥。(字串,選用)
- -desiredFirmwareVersionId
- 指定要同步化到受管理集中之每一部設備的韌體版本的 ID。這個參數與 masterApplianceId 參數互斥。(字串,選用)
回覆值
指令會傳回指令所建立之作業的 ID。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpSetManagedSet('-managedSetId myManagedSet -masterApplianceId "00605 20356"')
- 使用 Jython 清單:
AdminTask.dpSetManagedSet(['-managedSetId', 'myManagedSet', '-masterApplianceId', '"00605 20356"'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpSetManagedSet('-interactive')
dpSynchManagedSet
dpSynchManagedSet 指令可讓您手動將 DataPower 設備管理程式的受管理集同步化。管理程式會自動嘗試將成員裝置同步化。
目標物件
無。
必要參數
- -managedSetId
- 指定要同步化之受管理集的 ID。(字串,必要)
回覆值
指令會傳回指令所建立之作業的 ID。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpSynchManagedSet('-managedSetId myManagedSet')
- 使用 Jython 清單:
AdminTask.dpSynchManagedSet(['-managedSetId', 'myManagedSet'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpSynchManagedSet('-interactive')
dpAddFirmwareVersion
dpAddFirmwareVersion 指令會將韌體版本新增至 DataPower 設備管理程式。
目標物件
無。
必要參數
- -file
- 指定 DataPower 設備管理程式檔案系統中的檔案,這個檔案含有要儲存在韌體版本中的韌體映像檔。(字串,必要)
選用參數
- -userComment
- 指定要儲存在韌體版本中的註解。(字串,選用)
回覆值
指令會傳回指令所建立之作業的 ID。當作業結束時,result 屬性的值會顯示新韌體版本的 ID。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpAddFirmwareVersion('[-file "C:/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2" -userComment "my new firmware"]')
AdminTask.dpAddFirmwareVersion('[-file "/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2" -userComment "my new firmware"]')
- 使用 Jython 清單:
AdminTask.dpAddFirmwareVersion(['-file', '"C:/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2"', '-userComment', '"my new firmware"'])
AdminTask.dpAddFirmwareVersion(['-file', '"/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2"', '-userComment', '"my new firmware"'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpAddFirmwareVersion('-interactive')
dpGetAllFirmwareIds
dpGetAllFirmwareIds 指令會顯示 DataPower 設備管理程式配置中每一個韌體的 ID。
目標物件
無。
回覆值
指令會傳回字串陣列,內含 DataPower 設備管理程式配置中的每一個韌體 ID。
批次模式用法範例
- 使用 Jython 字串和清單:
AdminTask.dpGetAllFirmwareIds()
dpGetAllFirmwareVersionIds
dpGetAllFirmwareVersionIds 指令會顯示 DataPower 設備管理程式中每一個韌體版本的 ID。韌體版本代表您可以部署到 DataPower 設備中的韌體映像檔。
目標物件
無。
必要參數
- -firmwareId
- 指定要查詢的韌體 ID。(字串,必要)
回覆值
指令會傳回字串陣列,內含您配置中的每一個韌體版本。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpGetAllFirmwareVersionIds('-firmwareId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;"')
- 使用 Jython 清單:
AdminTask.dpGetAllFirmwareVersionIds(['-firmwareId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpGetAllFirmwareVersionIds('-interactive')
dpGetAllMSIdsUsingFirmwareVersion
dpGetAllMSIdsUsingFirmwareVersion 指令會顯示使用韌體版本之受管理集的 ID。
目標物件
無。
必要參數
- -firmwareVersionId
- 指定您屬意之韌體版本的 ID。(字串,必要)
回覆值
指令會傳回字串陣列,內含使用您屬意之韌體版本之受管理集的 ID。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpGetAllMSIdsUsingFirmwareVersion('-firmwareVersionId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15"')
- 使用 Jython 清單:
AdminTask.dpGetAllMSIdsUsingFirmwareVersion(['-firmwareVersionId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpGetAllMSIdsUsingFirmwareVersion('-interactive')
dpGetBestFirmware
dpGetBestFirmware 指令會顯示 DataPower 設備管理程式中最符合參數的韌體。DataPower 設備管理程式中的韌體含有一或多個韌體版本,這些版本代表該韌體的不同版本。這個指令不會識別 DataPower 中的最佳韌體版本。指令會識別符合該設備的韌體版本。
目標物件
無。
必要參數
- -applianceType
- 指定要顯示其韌體的 DataPower 設備的設備類型。(字串,必要)
- -modelType
- 指定要顯示其韌體的 DataPower 設備的機型。(字串,必要)
- -applianceFeatures
- 指定要顯示其韌體的 DataPower 設備的設備特性。(字串,必要)
選用參數
- -level
- 指定要包含在所傳回之韌體中的韌體版本層次。(字串,選用)
回覆值
屬性 | 說明 |
---|---|
firmwareId | 顯示韌體 ID。 |
applianceType | 顯示使用該韌體的設備類型。 |
modelType | 顯示韌體的機型。 |
strictFeatures | 顯示使用該韌體的嚴格特性。 |
nonStrictFeatures | 顯示使用該韌體的非嚴格特性。 |
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpGetBestFirmware('-applianceType "XS40" -modelType "9002" -applianceFeatures "JAXP-API" -level "3.6.0.4"')
- 使用 Jython 清單:
AdminTask.dpGetBestFirmware(['-applianceType', 'XS40', '-modelType', '9002', '-applianceFeatures', 'JAXP-API', '-level', '3.6.0.4'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpGetBestFirmware('-interactive')
dpGetFirmware
dpGetFirmware 指令會顯示 DataPower 設備管理程式中特定韌體的屬性。
目標物件
無。
必要參數
- -firmwareId
- 指定您屬意之韌體的 ID。(字串,必要)
回覆值
屬性 | 說明 |
---|---|
firmwareId | 顯示韌體 ID。 |
applianceType | 顯示使用該韌體的設備類型。 |
modelType | 顯示韌體的機型。 |
strictFeatures | 顯示使用該韌體的嚴格特性。 |
nonStrictFeatures | 顯示使用該韌體的非嚴格特性。 |
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpGetFirmware('-firmwareId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;"')
- 使用 Jython 清單:
AdminTask.dpGetFirmware(['-firmwareId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpGetFirmware('-interactive')
dpGetFirmwareVersion
dpGetFirmwareVersion 指令會顯示 DataPower 設備管理程式中特定韌體的屬性。韌體版本代表您可以部署到 DataPower 設備中的韌體映像檔。
目標物件
無。
必要參數
- -firmwareVersionId
- 指定您屬意之韌體版本的 ID。(字串,必要)
回覆值
屬性 | 說明 |
---|---|
firmwareVersionId | 顯示韌體版本的 ID。 |
firmareId | 顯示含有該韌體版本之韌體的 ID。 |
level | 顯示韌體的層次。 |
manufactureDate | 顯示韌體的製造日期。 |
timestamp | 顯示韌體映像檔載入至 DataPower 設備管理程式的日期。 |
userComment | 顯示隨韌體版本一起儲存的註解。 |
isInUse | 顯示受管理集是否使用該韌體版本。 |
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpGetFirmwareVersion('-firmwareVersionId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15"')
- 使用 Jython 清單:
AdminTask.dpGetFirmwareVersion(['-firmwareVersionId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpGetFirmwareVersion('-interactive')
dpRemoveFirmwareVersion
dpRemoveFirmwareVersion 指令會將韌體版本從 DataPower 設備管理程式移除。系統為該韌體版本建立的相關聯韌體仍會留存。執行這個指令之前,請先驗證受管理集目前並未使用所要移除的韌體版本。
目標物件
無。
必要參數
- -firmwareVersionId
- 指定要移除之韌體版本的 ID。(字串,必要)
回覆值
指令不傳回輸出。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpRemoveFirmwareVersion('-firmwareVersionId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15"')
- 使用 Jython 清單:
AdminTask.dpRemoveFirmwareVersion(['-firmwareVersionId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpRemoveFirmwareVersion('-interactive')
dpSetFirmwareVersion
dpSetFirmwareVersion 指令會修改 DataPower 設備管理程式的韌體版本。
目標物件
無。
必要參數
- -firmwareVersionId
- 指定要修改之韌體版本的 ID。(字串,必要)
選用參數
- -userComment
- 指定要儲存在韌體版本中的註解。(字串,選用)
回覆值
指令不傳回輸出。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpSetFirmwareVersion('-firmwareVersionId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15" -userComment "new user comment"')
- 使用 Jython 清單:
AdminTask.dpSetFirmwareVersion(['-firmwareVersionId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15', '-userComment', 'new user comment'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpSetFirmwareVersion('-interactive')
dpCopyMSDomainVersion
dpCopyMSDomainVersion 指令會將 DataPower 設備管理程式的受管理網域版本複製到新受管理集中。
目標物件
無。
必要參數
- -managedSetId
- 指定您屬意之受管理集的 ID。(字串,必要)
- -msDomainVersionId
- 指定要複製之受管理網域版本的 ID。(字串,必要)
回覆值
指令會傳回指令所建立之作業的 ID。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpCopyMSDomainVersion('[-managedSetId myManagedSet -msDomainVersionId "myManagedSet:default:1"]')
- 使用 Jython 清單:
AdminTask.dpCopyMSDomainVersion(['-managedSetId', 'myManagedSet', '-msDomainVersionId', 'myManagedSet:default:1'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpCopyMSDomainVersion('-interactive')
dpGetAllDomainNames
dpGetAllDomainNames 指令會顯示 DataPower 設備上每一個網域的名稱。
目標物件
無。
必要參數
- -applianceId
- 指定 DataPower 設備管理程式中要顯示的設備 ID。(字串,必要)
選用參數
- -managed
- 指出是否傳回受管理網域。如果您沒有指定 managed 或 unmanaged 參數,或者您同時指定這兩個參數,指令會傳回設備中每一個網域的名稱。(字串,選用)
- -unmanaged
- 指出指令是否傳回未受管理網域。如果您沒有指定 managed 或 unmanaged 參數,或者您同時指定這兩個參數,指令會傳回設備中每一個網域的名稱。(字串,選用)
回覆值
指令會傳回字串陣列,內含設備中的網域名稱。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpGetAllDomainNames('[-applianceId "00605 20356" -managed -unmanaged]')
- 使用 Jython 清單:
AdminTask.dpGetAllDomainNames(['-applianceId', '00605 20356', '-managed', '-unmanaged'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpGetAllDomainNames('-interactive')
dpGetAllMSDomainIds
dpGetAllMSDomainIds 指令會顯示 DataPower 設備管理程式的受管理集中每一個網域的 ID。
目標物件
無。
必要參數
- -managedSetId
- 指定您屬意之受管理集的 ID。(字串,必要)
回覆值
指令會傳回字串陣列,內含受管理集中的網域 ID。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpGetAllMSDomainIds('[-managedSetId myManagedSet]')
- 使用 Jython 清單:
AdminTask.dpGetAllMSDomainIds(['-managedSetId', 'myManagedSet'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpGetAllMSDomainIds('-interactive')
dpGetAllMSDomainVersionIds
dpGetAllMSDomainVersionIds 指令會顯示 DataPower 設備管理程式的受管理集中某個網域之每一個網域版本的 ID。
目標物件
無。
必要參數
- -msDomainId
- 指定要顯示之受管理網域的 ID。(字串,必要)
回覆值
指令會傳回受管理集網域的每一個現有網域版本的 ID。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpGetAllMSDomainVersionIds('[-msDomainId ms1:domain1]')
- 使用 Jython 清單:
AdminTask.dpGetAllMSDomainVersionIds(['-msDomainId', 'ms1:domain1'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpGetAllMSDomainVersionIds('-interactive')
dpGetMSDomain
dpGetMSDomain 指令會顯示 DataPower 設備管理程式的受管理集中的某個網域。
目標物件
無。
必要參數
- -msDomainId
- 指定要顯示之受管理網域的 ID。(字串,必要)
回覆值
屬性 | 說明 |
---|---|
msDomainId | 顯示網域的 ID。 |
managedSetId | 顯示該網域所屬受管理集的 ID。 |
name | 顯示網域的名稱。 |
desiredDomainVersionId | 顯示受管理集對於該網域所使用的網域版本 ID。 |
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpGetMSDomain('[-msDomainId ms1:domain1]')
- 使用 Jython 清單:
AdminTask.dpGetMSDomain(['-msDomainId', 'ms1:domain1'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpGetMSDomain('-interactive')
dpGetMSDomainVersion
dpGetMSDomainVersion 指令會顯示 DataPower 設備管理程式的受管理網域版本。
目標物件
無。
必要參數
- -msDomainVersionId
- 指定您屬意之受管理網域版本的 ID。(字串,必要)
回覆值
屬性 | 說明 |
---|---|
msDomainVersionId | 顯示受管理網域版本的 ID。 |
msDomainId | 顯示受管理網域的 ID。 |
versionNumber | 顯示版本號碼。 |
timestamp | 顯示系統建立副本的日期。 |
userComment | 顯示隨受管理集網域版本一起儲存的註解。 |
isInUse | 顯示受管理集是否使用該網域的網域版本。 |
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpGetMSDomainVersion('[-msDomainVersionId ms1:domain1:1]')
- 使用 Jython 清單:
AdminTask.dpGetMSDomainVersion(['-msDomainVersionId', 'ms1:domain1:1'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpGetMSDomainVersion('-interactive')
dpManageDomain
dpManageDomain 指令會將網域新增至受管理集,並開始管理網域。
目標物件
無。
必要參數
- -managedSetId
- 指定要管理之受管理集的 ID。(字串,必要)
- -domain
- 指定主要設備上所要管理之網域的名稱。(字串,必要)
回覆值
指令會傳回指令所建立之作業的 ID。當作業完成時,result 屬性值會包含新網域的 ID。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpManageDomain('[-managedSetId testMS1 -domain default]')
- 使用 Jython 清單:
AdminTask.dpManageDomain(['-managedSetId', 'testMS1', '-domain', 'default'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpManageDomain('-interactive')
dpRemoveMSDomainVersion
dpRemoveMSDomainVersion 指令會將受管理網域版本從 DataPower 設備管理程式移除。
目標物件
無。
必要參數
- -msDomainVersionId
- 指定要移除之受管理網域版本的 ID。(字串,必要)
回覆值
指令不傳回輸出。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpRemoveMSDomainVersion('[-msDomainVersionId ms1:domain1:1]')
- 使用 Jython 清單:
AdminTask.dpRemoveMSDomainVersion(['-msDomainVersionId', 'ms1:domain1:1'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpRemoveMSDomainVersion('-interactive')
dpSetMSDomain
dpSetMSDomain 指令會修改 DataPower 設備管理程式的受管理網域。
目標物件
無。
必要參數
- -msDomainId
- 指定要修改之受管理網域的 ID。(字串,必要)
選用參數
- -desiredDomainVersionId
- 指定要同步化到受管理集中之每一部設備的網域版本的 ID。(字串,選用)
回覆值
指令會傳回指令所建立之作業的 ID。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpSetMSDomain('[-msDomainId ms1:domain1 -desiredDomainVersionId ms1:domain1:1]')
- 使用 Jython 清單:
AdminTask.dpSetMSDomain(['-msDomainId', 'ms1:domain1', '-desiredDomainVersionId', 'ms1:domain1:1'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpSetMSDomain('-interactive')
dpSetMSDomainVersion
dpSetMSDomainVersion 指令會修改 DataPower 設備管理程式的受管理網域版本。
目標物件
無。
必要參數
- -msDomainVersionId
- 指定要修改之受管理網域版本的 ID。(字串,必要)
選用參數
- -userComment
- 指定要儲存在網域版本中的註解。(字串,選用)
回覆值
指令不傳回輸出。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpSetMSDomainVersion('[-msDomainVersionId ms1:domain1:2 -userComment "New Web Service proxy for banking application"]')
- 使用 Jython 清單:
AdminTask.dpSetMSDomainVersion(['-msDomainVersionId', 'ms1:domain1:2', '-userComment', 'New web service proxy for banking application'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpSetMSDomainVersion('-interactive')
dpUnmanageDomain
dpUnmanageDomain 指令會將網域從受管理集移除,並停止管理網域。
目標物件
無。
必要參數
- -msDomainId
- 指定要從受管理集移除之受管理網域的 ID。(字串,必要)
選用參數
- -clean
- 將網域從受管理集中的每一部設備刪除。(字串,選用)
回覆值
如果您指定 clean 參數,指令會傳回系統所建立之作業的 ID。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpUnmanageDomain('-msDomainId testMS1:default -clean')
- 使用 Jython 清單:
AdminTask.dpUnmanageDomain(['-msDomainId', 'testMS1:default', '-clean'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpUnmanageDomain('-interactive')
dpCopyMSSettingsVersion
dpCopyMSSettingsVersion 指令會將 DataPower 設備管理程式的受管理設定版本複製到新受管理集。
目標物件
無。
必要參數
- -managedSetId
- 指定您屬意之受管理集的 ID。(字串,必要)
- -msSettingsVersionId
- 指定要複製之受管理設定版本的 ID。(字串,必要)
回覆值
指令會傳回指令所建立之作業的 ID。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpCopyMSSettingsVersion('[-managedSetId myManagedSet -msSettingsVersionId "myManagedSet1:1"]')
- 使用 Jython 清單:
AdminTask.dpCopyMSSettingsVersion(['-managedSetId', 'myManagedSet', ,-msSettingsVersionId', 'myManagedSet1:1'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpCopyMSSettingsVersion('-interactive')
dpGetAllMSSettingsVersionIds
dpGetAllMSSettingsVersionIds 指令會顯示 DataPower 設備管理程式的受管理集中每一個設定版本的 ID。
目標物件
無。
必要參數
- -msSettingsId
- 指定您屬意之受管理設定的 ID。(字串,必要)
回覆值
指令會傳回字串陣列,內含您屬意之受管理集設定版本的 ID。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpGetAllMSSettingsVersionIds('-msSettingsId ms1:2')
- 使用 Jython 清單:
AdminTask.dpGetAllMSSettingsVersionIds(['-msSettingsId', 'ms1:2'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpGetAllMSSettingsVersionIds('-interactive')
dpGetMSSettings
dpGetMSSettings 指令會顯示設定所屬受管理集的 ID。
目標物件
無。
必要參數
- -msSettingsId
- 指定您屬意之受管理設定的 ID。(字串,必要)
回覆值
屬性 | 說明 |
---|---|
msSettingsId | 顯示設定的 ID。 |
managedSetId | 顯示獲指派這些設定之受管理集的 ID。 |
desiredSettingsVersionId | 顯示受管理集使用的設定版本的 ID。 |
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpGetMSSettings('-msSettingsId ms1:2')
- 使用 Jython 清單:
AdminTask.dpGetMSSettings(['-msSettingsId', 'ms1:2'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpGetMSSettings('-interactive')
dpGetMSSettingsVersion
dpGetMSSettingsVersion 指令會顯示 DataPower 設備管理程式的受管理設定版本。
目標物件
無。
必要參數
- -msSettingsVersionId
- 指定您屬意之受管理設定版本的 ID。(字串,必要)
回覆值
屬性 | 說明 |
---|---|
msSetSettingsVersionId | 顯示受管理集設定版本的 ID。 |
msSettingsId | 指定您屬意之受管理集設定的 ID。 |
timestamp | 顯示系統建立副本的日期。 |
versionNumber | 顯示版本的號碼。 |
userComment | 顯示受管理集設定版本相關聯的註解。 |
isInUse | 顯示受管理集使用的設定版本的 ID。 |
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpGetMSSettingsVersion('-msSettingsVersionId ms1:2')
- 使用 Jython 清單:
AdminTask.dpGetMSSettingsVersion(['-msSettingsVersionId', 'ms1:2'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpGetMSSettingsVersion('-interactive')
dpRemoveMSSettingsVersion
dpRemoveMSSettingsVersion 指令會將受管理設定版本從 DataPower 設備管理程式移除。
目標物件
無。
必要參數
- -msSettingsVersionId
- 指定要移除之受管理設定版本的 ID。(字串,必要)
回覆值
指令不傳回輸出。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpRemoveMSSettingsVersion('-msSettingsVersionId ms1:2')
- 使用 Jython 清單:
AdminTask.dpRemoveMSSettingsVersion(['-msSettingsVersionId', 'ms1:2'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpRemoveMSSettingsVersion('-interactive')
dpSetMSSettings
dpSetMSSettings 指令會修改 DataPower 設備管理程式的受管理設定。
目標物件
無。
必要參數
- -msSettingsId
- 指定要修改之受管理設定的 ID。(字串,必要)
選用參數
- -desiredSettingsVersionId
- 指定要同步化到受管理集中之每一部設備的設定版本的 ID。(字串,選用)
回覆值
指令會傳回指令所建立之作業的 ID。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpSetMSSettings('-msSettingsId ms1 -desiredSettingsVersionId ms1:1')
- 使用 Jython 清單:
AdminTask.dpSetMSSettings(['-msSettingsId', 'ms1', '-desiredSettingsVersionId', 'ms1:1'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpSetMSSettings('-interactive')
dpSetMSSettingsVersion
dpSetMSSettingsVersion 指令會修改 DataPower 設備管理程式的受管理設定版本。
目標物件
無。
必要參數
- -msSettingsVersionId
- 指定要修改之受管理設定版本的 ID。(字串,必要)
選用參數
- -userComment
- 指定要儲存在設定版本中的註解。(字串,選用)
回覆值
指令不傳回輸出。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpSetMSSettingsVersion('[-msSettingsVersionId ms1:2 -userComment "has new timeserver added"]')
- 使用 Jython 清單:
AdminTask.dpSetMSSettingsVersion(['-msSettingsVersionId', 'ms1:2', '-userComment', 'has new timeserver added'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpSetMSSettingsVersion('-interactive')
dpGetAllTaskIds
dpGetAllTaskIds 指令會顯示每一項 DataPower 設備管理程式作業的 ID。
目標物件
無。
回覆值
指令會傳回目前存在於 DataPower 設備管理程式中的每一個非同步作業 ID 清單。
批次模式用法範例
- 使用 Jython 字串和清單:
AdminTask.dpGetAllTaskIds()
dpGetTask
dpGetTask 指令會顯示 DataPower 設備管理程式特定作業的相關資訊。
目標物件
無。
必要參數
- -taskId
- 指定您屬意之作業的 ID。(字串,必要)
回覆值
屬性 | 說明 |
---|---|
taskId | 顯示作業的唯一 ID。 |
taskDescription | 顯示作業的說明。 |
creationDate | 顯示系統建立該作業的日期和時間。 |
createdByUser | 顯示建立該作業的使用者。 |
currentStep | 顯示該作業的現行步驟號碼。 |
currentStepDescription | 顯示現行步驟的說明。 |
currentStepTimestamp | 顯示前次在作業中更新現行步驟的時間和日期。在系統建構物件、更新步驟,將作業標示為完成,或是遇到異常狀況時,系統就會更新 currentTimeStamp 屬性。 |
錯誤 | 在適當的情況下,顯示造成作業結束之異常狀況的錯誤訊息。 |
totalSteps | 顯示預估作業的步驟數目總計。請勿使用這個引數來判斷作業是否完成。如果要判斷作業是否完成,請參閱 isComplete 屬性。 |
hasError | 如果作業未順利完成,會顯示值 true。 |
hasUpdate | 如果作業已更新,會顯示值 true。 |
isComplete | 如果作業已完成,會顯示值 true。 |
taskStatus | 顯示整數,以代表作業的狀態。如果回覆值是 0,表示作業位於佇列中,且系統尚未啟動作業。如果回覆值是 1,表示作業進行中。如果回覆值是 2,表示作業已順利完成。如果回覆值是 3,表示作業遇到異常狀況。 |
result | 顯示作業傳回的結果。如果要判斷指令是否傳回輸出,請參閱特定的指令。 |
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpGetTask('-taskId 1')
- 使用 Jython 清單:
AdminTask.dpGetTask(['-taskId', '1'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpGetTask('-interactive')
dpPurgeTask
dpPurgeTask 指令會清除 DataPower 設備管理程式的特定作業。系統會在 24 小時後自動刪除作業。
目標物件
無。
必要參數
- -taskId
- 指定 DataPower 設備管理程式中要清除之作業的 ID。(字串,必要)
回覆值
指令不傳回輸出。
批次模式用法範例
- 使用 Jython 字串:
AdminTask.dpPurgeTask('-taskId 1')
- 使用 Jython 清單:
AdminTask.dpPurgeTask(['-taskId', '1'])
互動模式用法範例
- 使用 Jython:
AdminTask.dpPurgeTask('-interactive')