AdminTask 对象的 dpManagerCommands 命令组
要通过 wsadmin 工具配置 DataPower® 设备管理器,可以使用 Jython 脚本编制语言来实现。IBM WebSphere® DataPower 设备管理器提供了一组用于管理 DataPower 设备的功能。使用 dpManagerCommands 组中的命令和参数来查询、配置和管理 DataPower 设备管理器。
IBM WebSphere DataPower SOA Appliance 是易于部署的特定用途网络设备,用于简化、帮助保护以及加快 XML 和 Web Service 部署。第一次使用 DataPower 设备管理器时,不存在任何设备、受管集合或固件版本。必须创建设备、添加固件版本和创建受管集合。
在开始之前,请验证要管理的每个设备是否都具有 3.6.0.4 或更高级别的固件。另外,请验证是否对每个设备启用了设备管理协议 (AMP) 端点。如果在安装期间禁用了 XML 管理接口 AMP 端点,请使用 DataPower WebGUI 来启用 AMP 端点。
dpExport
dpExport 命令导出 DataPower 设备管理器配置和版本。
目标对象
无。
必需参数
- -file
- 指定 DataPower 设备管理器将配置和版本导出到其中的本地系统文件。(字符串,必需)
返回值
该命令返回系统创建的任务的标识。
批处理方式示例用法
- 使用 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 参数指定值,那么该命令会返回它创建的任务标识。
批处理方式示例用法
- 使用 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 设备管理器用来对设备进行访问的用户标识。(字符串,必需)
- -password
- 指定 DataPower 设备管理器用来对设备进行访问的基本 64 位编码密码。(字符串,必需)
返回值
该命令返回系统创建的任务的标识。当任务结束时,任务中结果属性的值包含新设备的标识。
批处理方式示例用法
- 使用 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 设备管理器设备的标识。
目标对象
无。
返回值
该命令返回一个包含配置中每个设备标识的字符串数组。对于设备,该标识是 DataPower 设备的序列号。
批处理方式示例用法
- 使用 Jython 字符串和列表:
AdminTask.dpGetAllApplianceIds()
dpGetAllMSApplianceIds
dpGetAllMSApplianceIds 命令显示 DataPower 设备管理器受管集合中每个设备的标识。
目标对象
无。
必需参数
- -managedSetId
- 指定相关受管集合的标识。(字符串,必需)
返回值
该命令返回一个包含相关受管集合中设备标识的字符串数组。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.dpGetAllMSApplianceIds('[-managedSetId myManagedSet]')
- 使用 Jython 列表:
AdminTask.dpGetAllMSApplianceIds(['-managedSetId', 'myManagedSet'])
交互方式示例用法
- 使用 Jython:
AdminTask.dpGetAllMSApplianceIds('-interactive')
dpGetAppliance
dpGetAppliance 命令显示特定 DataPower 设备管理器设备。
目标对象
无。
必需参数
- -applianceId
- 指定要显示的 DataPower 设备管理器中设备的标识。(字符串,必需)
返回值
[ [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 | 显示相关设备的标识。 |
managedSetId | 显示设备作为其成员的受管集合的标识。如果设备不受管,那么该命令不会返回此属性。 |
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 设备管理器用来对设备进行访问的用户标识。 |
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.dpGetAppliance('-applianceId "00605 20356"')
- 使用 Jython 列表:
AdminTask.dpGetAppliance(['-applianceId', '00605 20356'])
交互方式示例用法
- 使用 Jython:
AdminTask.dpGetAppliance('-interactive')
dpManageAppliance
dpManageAppliance 命令将设备添加到受管集合以及用来开始管理设备。
目标对象
无。
必需参数
- -managedSetId
- 指定设备作为其成员的受管集合的标识。(字符串,必需)
- -applianceId
- 指定 DataPower 设备管理器中要添加到受管集合的设备的标识。(字符串,必需)
可选参数
- -asMaster
- 指定是否将设备设置为受管集合的主设备。即使未指定此参数,添加到受管集合的第一个设备也会被设置为主设备。(字符串,可选)
返回值
该命令返回它创建的任务的标识。当任务完成时,结果属性的值为设备的标识。
批处理方式示例用法
- 使用 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 设备管理器中要从受管集合中除去的设备的标识。对于设备,该标识是 DataPower 设备的序列号。(字符串,必需)
返回值
此命令不会返回输出。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.dpRemoveAppliance('[-applianceId "00605 20356"]')
- 使用 Jython 列表:
AdminTask.dpRemoveAppliance(['-applianceId', '00605 20356'])
交互方式示例用法
- 使用 Jython:
AdminTask.dpRemoveAppliance('-interactive')
dpSetAppliance
dpSetAppliance 命令修改设备的 DataPower 设备管理器配置。
目标对象
无。
必需参数
- -applianceId
- 指定要修改的 DataPower 设备管理器中设备的标识。(字符串,必需)
可选参数
- -hostname
- 指定设备的主机名或 IP 地址。(字符串,可选)
- -hlmPort
- 指定 DataPower 设备管理器用来与设备进行通信的端口号。缺省值为 5550。(整数,可选)
- -name
- 指定 DataPower 设备管理器中的设备的唯一名称。请不要在 name 参数中指定下列字符:\\/,#$@:;\"*?<>|=+&%'(字符串,可选)
- -userId
- 指定 DataPower 设备管理器用来对设备进行访问的用户标识。(字符串,可选)
- -password
- 指定 DataPower 设备管理器用来对设备进行访问的基本 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
- 指定设备作为其成员的受管集合的标识。(字符串,必需)
- -applianceId
- 指定 DataPower 设备管理器中要从受管集合中除去的设备的标识。(字符串,必需)
返回值
该命令返回它创建的任务。
批处理方式示例用法
- 使用 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 设备管理器受管集合的标识。
目标对象
无。
返回值
该命令返回一个包含每个受管集合标识的字符串数组。
批处理方式示例用法
- 使用 Jython 字符串和列表:
AdminTask.dpGetAllManagedSetIds()
dpGetManagedSet
dpGetManagedSet 命令显示特定 DataPower 设备管理器受管集合的信息。
目标对象
无。
必需参数
- -managedSetId
- 指定相关受管集合的标识。(字符串,必需)
返回值
属性 | 描述 |
---|---|
managedSetId | 显示受管集合的标识。 |
masterApplianceId | 显示受管集合的主设备的标识。 |
desiredFirmwareVersionId | 显示要用于受管集合的固件版本的标识。 |
name | 显示与受管集合关联的名称。 |
rollupOperationalStatus | 显示受管集合的操作状态。 |
rollupManagementStatus | 显示受管集合的管理状态。 |
settingsId | 显示受管集合的设置的标识。 |
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.dpGetManagedSet('-managedSetId testMS1')
- 使用 Jython 列表:
AdminTask.dpGetManagedSet(['-managedSetId', 'testMS1'])
交互方式示例用法
- 使用 Jython:
AdminTask.dpGetManagedSet('-interactive')
dpRemoveManagedSet
dpRemoveManagedSet 命令从 DataPower 设备管理器中除去受管集合。
目标对象
无。
必需参数
- -managedSetId
- 指定要除去的受管集合的标识。(字符串,必需)
返回值
此命令不会返回输出。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.dpRemoveManagedSet('-managedSetId testMS')
- 使用 Jython 列表:
AdminTask.dpRemoveManagedSet(['-managedSetId', 'testMS'])
交互方式示例用法
- 使用 Jython:
AdminTask.dpRemoveManagedSet('-interactive')
dpSetManagedSet
dpSetManagedSet 命令修改 DataPower 设备管理器受管集合。
目标对象
无。
必需参数
- -managedSetId
- 指定要修改的受管集合的标识。(字符串,必需)
可选参数
- -masterApplianceId
- 指定要设置为受管集合主设备的设备的标识。此设备必须为受管集合的成员。此参数与 desiredFirmwareVersionId 参数互斥。(字符串,可选)
- -desiredFirmwareVersionId
- 指定要与受管集合中每个设备同步的固件版本的标识。此参数与 masterApplianceId 参数互斥。(字符串,可选)
返回值
该命令返回它创建的任务的标识。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.dpSetManagedSet('-managedSetId myManagedSet -masterApplianceId "00605 20356"')
- 使用 Jython 列表:
AdminTask.dpSetManagedSet(['-managedSetId', 'myManagedSet', '-masterApplianceId', '"00605 20356"'])
交互方式示例用法
- 使用 Jython:
AdminTask.dpSetManagedSet('-interactive')
dpSynchManagedSet
dpSynchManagedSet 命令用于手动使 DataPower 设备管理器受管集合同步。该管理器会自动尝试使成员设备同步。
目标对象
无。
必需参数
- -managedSetId
- 指定要同步的受管集合的标识。(字符串,必需)
返回值
该命令返回它创建的任务的标识。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.dpSynchManagedSet('-managedSetId myManagedSet')
- 使用 Jython 列表:
AdminTask.dpSynchManagedSet(['-managedSetId', 'myManagedSet'])
交互方式示例用法
- 使用 Jython:
AdminTask.dpSynchManagedSet('-interactive')
dpAddFirmwareVersion
dpAddFirmwareVersion 命令将固件版本添加到 DataPower 设备管理器。
目标对象
无。
必需参数
- -file
- 指定 DataPower 设备管理器文件系统中包含要存储在固件版本中的固件映像的文件。(字符串,必需)
可选参数
- -userComment
- 指定要存储在固件版本中的注释。(字符串,可选)
返回值
该命令返回它创建的任务的标识。当任务结束时,结果属性的值显示新固件版本的标识。
批处理方式示例用法
- 使用 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 设备管理器固件的标识。
目标对象
无。
返回值
该命令返回 DataPower 设备管理器配置中每个固件标识的字符串数组。
批处理方式示例用法
- 使用 Jython 字符串和列表:
AdminTask.dpGetAllFirmwareIds()
dpGetAllFirmwareVersionIds
dpGetAllFirmwareVersionIds 命令显示每个 DataPower 设备管理器固件版本的标识。固件版本表示可以部署到 DataPower 设备上的固件映像。
目标对象
无。
必需参数
- -firmwareId
- 指定要查询的固件的标识。(字符串,必需)
返回值
该命令返回一个包含配置中每个固件版本的字符串数组。
批处理方式示例用法
- 使用 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 命令显示使用固件版本的受管集合的标识。
目标对象
无。
必需参数
- -firmwareVersionId
- 指定相关固件版本的标识。(字符串,必需)
返回值
该命令返回一个包含受管集合(它们使用相关固件版本)的标识的字符串数组。
批处理方式示例用法
- 使用 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 | 显示固件标识。 |
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
- 指定相关固件的标识。(字符串,必需)
返回值
属性 | 描述 |
---|---|
firmwareId | 显示固件标识。 |
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
- 指定相关固件版本的标识。(字符串,必需)
返回值
属性 | 描述 |
---|---|
firmwareVersionId | 显示固件版本的标识。 |
firmareId | 显示包含固件版本的固件的标识。 |
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
- 指定要除去的固件版本的标识。(字符串,必需)
返回值
此命令不会返回输出。
批处理方式示例用法
- 使用 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
- 指定要修改的固件版本的标识。(字符串,必需)
可选参数
- -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
- 指定相关受管集合的标识。(字符串,必需)
- -msDomainVersionId
- 指定要复制的受管域版本的标识。(字符串,必需)
返回值
该命令返回它创建的任务的标识。
批处理方式示例用法
- 使用 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 设备管理器中设备的标识。(字符串,必需)
可选参数
- -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 设备管理器受管集合中每个域的标识。
目标对象
无。
必需参数
- -managedSetId
- 指定相关受管集合的标识。(字符串,必需)
返回值
该命令返回一个包含受管集合中域标识的字符串数组。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.dpGetAllMSDomainIds('[-managedSetId myManagedSet]')
- 使用 Jython 列表:
AdminTask.dpGetAllMSDomainIds(['-managedSetId', 'myManagedSet'])
交互方式示例用法
- 使用 Jython:
AdminTask.dpGetAllMSDomainIds('-interactive')
dpGetAllMSDomainVersionIds
dpGetAllMSDomainVersionIds 命令显示 DataPower 设备管理器受管集合中域的每个域版本的标识。
目标对象
无。
必需参数
- -msDomainId
- 指定要显示的受管域的标识。(字符串,必需)
返回值
该命令返回为受管集合域存在的每个域版本的标识。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.dpGetAllMSDomainVersionIds('[-msDomainId ms1:domain1]')
- 使用 Jython 列表:
AdminTask.dpGetAllMSDomainVersionIds(['-msDomainId', 'ms1:domain1'])
交互方式示例用法
- 使用 Jython:
AdminTask.dpGetAllMSDomainVersionIds('-interactive')
dpGetMSDomain
dpGetMSDomain 命令显示 DataPower 设备管理器受管集合中的域。
目标对象
无。
必需参数
- -msDomainId
- 指定要显示的受管域的标识。(字符串,必需)
返回值
属性 | 描述 |
---|---|
msDomainId | 显示域的标识。 |
managedSetId | 显示域所属受管集合的标识。 |
name | 显示域的名称。 |
desiredDomainVersionId | 显示受管集合用于域的域版本的标识。 |
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.dpGetMSDomain('[-msDomainId ms1:domain1]')
- 使用 Jython 列表:
AdminTask.dpGetMSDomain(['-msDomainId', 'ms1:domain1'])
交互方式示例用法
- 使用 Jython:
AdminTask.dpGetMSDomain('-interactive')
dpGetMSDomainVersion
dpGetMSDomainVersion 命令显示 DataPower 设备管理器受管域版本。
目标对象
无。
必需参数
- -msDomainVersionId
- 指定相关受管域版本的标识。(字符串,必需)
返回值
属性 | 描述 |
---|---|
msDomainVersionId | 显示受管域版本的标识。 |
msDomainId | 显示受管域的标识。 |
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
- 指定要管理的受管集合的标识。(字符串,必需)
- -domain
- 指定要管理的主设备上域的名称。(字符串,必需)
返回值
该命令返回它创建的任务的标识。当任务完成时,结果属性的值包含新域的标识。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.dpManageDomain('[-managedSetId testMS1 -domain default]')
- 使用 Jython 列表:
AdminTask.dpManageDomain(['-managedSetId', 'testMS1', '-domain', 'default'])
交互方式示例用法
- 使用 Jython:
AdminTask.dpManageDomain('-interactive')
dpRemoveMSDomainVersion
dpRemoveMSDomainVersion 命令从 DataPower 设备管理器中除去受管域版本。
目标对象
无。
必需参数
- -msDomainVersionId
- 指定要除去的受管域版本的标识。(字符串,必需)
返回值
此命令不会返回输出。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.dpRemoveMSDomainVersion('[-msDomainVersionId ms1:domain1:1]')
- 使用 Jython 列表:
AdminTask.dpRemoveMSDomainVersion(['-msDomainVersionId', 'ms1:domain1:1'])
交互方式示例用法
- 使用 Jython:
AdminTask.dpRemoveMSDomainVersion('-interactive')
dpSetMSDomain
dpSetMSDomain 命令修改 DataPower 设备管理器受管域。
目标对象
无。
必需参数
- -msDomainId
- 指定要修改的受管域的标识。(字符串,必需)
可选参数
- -desiredDomainVersionId
- 指定要与受管集合中每个设备同步的域版本的标识。(字符串,可选)
返回值
该命令返回它创建的任务的标识。
批处理方式示例用法
- 使用 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
- 指定要修改的受管域版本的标识。(字符串,必需)
可选参数
- -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
- 指定要从受管集合中除去的受管域的标识。(字符串,必需)
可选参数
- -clean
- 从受管集合内每个设备中删除域。(字符串,可选)
返回值
如果指定 clean 参数,那么该命令返回系统创建的任务的标识。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.dpUnmanageDomain('-msDomainId testMS1:default -clean')
- 使用 Jython 列表:
AdminTask.dpUnmanageDomain(['-msDomainId', 'testMS1:default', '-clean'])
交互方式示例用法
- 使用 Jython:
AdminTask.dpUnmanageDomain('-interactive')
dpCopyMSSettingsVersion
dpCopyMSSettingsVersion 命令将 DataPower 设备管理器受管设置版本复制到新的受管集合。
目标对象
无。
必需参数
- -managedSetId
- 指定相关受管集合的标识。(字符串,必需)
- -msSettingsVersionId
- 指定要复制的受管设置版本的标识。(字符串,必需)
返回值
该命令返回它创建的任务的标识。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.dpCopyMSSettingsVersion('[-managedSetId myManagedSet -msSettingsVersionId "myManagedSet1:1"]')
- 使用 Jython 列表:
AdminTask.dpCopyMSSettingsVersion(['-managedSetId', 'myManagedSet', ,-msSettingsVersionId', 'myManagedSet1:1'])
交互方式示例用法
- 使用 Jython:
AdminTask.dpCopyMSSettingsVersion('-interactive')
dpGetAllMSSettingsVersionIds
dpGetAllMSSettingsVersionIds 命令显示 DataPower 设备管理器受管集合中每个设置版本的标识。
目标对象
无。
必需参数
- -msSettingsId
- 指定相关受管设置的标识。(字符串,必需)
返回值
该命令返回一个包含相关受管集合设置版本的标识的字符串数组。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.dpGetAllMSSettingsVersionIds('-msSettingsId ms1:2')
- 使用 Jython 列表:
AdminTask.dpGetAllMSSettingsVersionIds(['-msSettingsId', 'ms1:2'])
交互方式示例用法
- 使用 Jython:
AdminTask.dpGetAllMSSettingsVersionIds('-interactive')
dpGetMSSettings
dpGetMSSettings 命令显示设置所属的受管集合的标识。
目标对象
无。
必需参数
- -msSettingsId
- 指定相关受管设置的标识。(字符串,必需)
返回值
属性 | 描述 |
---|---|
msSettingsId | 显示设置的标识。 |
managedSetId | 显示对其指定设置的受管集合的标识。 |
desiredSettingsVersionId | 显示受管集合使用的设置版本的标识。 |
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.dpGetMSSettings('-msSettingsId ms1:2')
- 使用 Jython 列表:
AdminTask.dpGetMSSettings(['-msSettingsId', 'ms1:2'])
交互方式示例用法
- 使用 Jython:
AdminTask.dpGetMSSettings('-interactive')
dpGetMSSettingsVersion
dpGetMSSettingsVersion 命令显示 DataPower 设备管理器受管设置版本。
目标对象
无。
必需参数
- -msSettingsVersionId
- 指定相关受管设置版本的标识。(字符串,必需)
返回值
属性 | 描述 |
---|---|
msSetSettingsVersionId | 显示受管集合设置版本的标识。 |
msSettingsId | 指定相关受管集合设置的标识。 |
timestamp | 显示系统创建副本的日期。 |
versionNumber | 显示版本号。 |
userComment | 显示与受管集合设置版本关联的注释。 |
isInUse | 显示受管集合使用的设置版本的标识。 |
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.dpGetMSSettingsVersion('-msSettingsVersionId ms1:2')
- 使用 Jython 列表:
AdminTask.dpGetMSSettingsVersion(['-msSettingsVersionId', 'ms1:2'])
交互方式示例用法
- 使用 Jython:
AdminTask.dpGetMSSettingsVersion('-interactive')
dpRemoveMSSettingsVersion
dpRemoveMSSettingsVersion 命令从 DataPower 设备管理器中除去受管设置版本。
目标对象
无。
必需参数
- -msSettingsVersionId
- 指定要除去的受管设置版本的标识。(字符串,必需)
返回值
此命令不会返回输出。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.dpRemoveMSSettingsVersion('-msSettingsVersionId ms1:2')
- 使用 Jython 列表:
AdminTask.dpRemoveMSSettingsVersion(['-msSettingsVersionId', 'ms1:2'])
交互方式示例用法
- 使用 Jython:
AdminTask.dpRemoveMSSettingsVersion('-interactive')
dpSetMSSettings
dpSetMSSettings 命令修改 DataPower 设备管理器受管设置。
目标对象
无。
必需参数
- -msSettingsId
- 指定要修改的受管设置的标识。(字符串,必需)
可选参数
- -desiredSettingsVersionId
- 指定要与受管集合中每个设备同步的设置版本的标识。(字符串,可选)
返回值
该命令返回它创建的任务的标识。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.dpSetMSSettings('-msSettingsId ms1 -desiredSettingsVersionId ms1:1')
- 使用 Jython 列表:
AdminTask.dpSetMSSettings(['-msSettingsId', 'ms1', '-desiredSettingsVersionId', 'ms1:1'])
交互方式示例用法
- 使用 Jython:
AdminTask.dpSetMSSettings('-interactive')
dpSetMSSettingsVersion
dpSetMSSettingsVersion 命令修改 DataPower 设备管理器受管设置版本。
目标对象
无。
必需参数
- -msSettingsVersionId
- 指定要修改的受管设置版本的标识。(字符串,必需)
可选参数
- -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 设备管理器任务的标识。
目标对象
无。
返回值
该命令返回 DataPower 设备管理器中当前存在的每个异步任务标识的列表。
批处理方式示例用法
- 使用 Jython 字符串和列表:
AdminTask.dpGetAllTaskIds()
dpGetTask
dpGetTask 命令显示特定 DataPower 设备管理器任务的信息。
目标对象
无。
必需参数
- -taskId
- 指定相关任务的标识。(字符串,必需)
返回值
属性 | 描述 |
---|---|
taskId | 显示任务的唯一标识。 |
taskDescription | 显示任务的描述。 |
creationDate | 显示系统创建任务的日期和时间。 |
createdByUser | 显示创建了任务的用户。 |
currentStep | 显示任务的当前步骤编号。 |
currentStepDescription | 显示当前步骤的描述。 |
currentStepTimestamp | 显示上次在任务中更新当前步骤的时间和日期。当系统构造对象、更新步骤、标记任务完成或遇到异常时,系统会更新 currentTimeStamp 属性。 |
error | 显示导致任务结束的异常的错误消息(如果适用)。 |
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 设备管理器中任务的标识。(字符串,必需)
返回值
此命令不会返回输出。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.dpPurgeTask('-taskId 1')
- 使用 Jython 列表:
AdminTask.dpPurgeTask(['-taskId', '1'])
交互方式示例用法
- 使用 Jython:
AdminTask.dpPurgeTask('-interactive')