dpManagerCommands

1. Overview
2. dpExport
3. dpGetManager
4. dpGetManagerStatus
5. dpImport
6. dpSetManager
7. dpStopManager
8. dpAddAppliance
9. dpGetAllApplianceIds
10. dpGetAllMSApplianceIds
11. dpGetAppliance
12. dpManageAppliance
13. dpRemoveAppliance
14. dpSetAppliance
15. dpUnmanageAppliance
16. dpAddManagedSet
17. dpGetAllManagedSetIds
18. dpGetManagedSet
19. dpRemoveManagedSet
20. dpSetManagedSet
21. dpSynchManagedSet
22. dpAddFirmwareVersion
23. dpGetAllFirmwareIds
24. dpGetAllFirmwareVersionIds
25. dpGetAllMSIdsUsingFirmwareVersion
26. dpGetBestFirmware
27. dpGetFirmware
28. dpGetFirmwareVersion
29. dpRemoveFirmwareVersion
30. dpSetFirmwareVersion
31. dpCopyMSDomainVersion
32. dpGetAllDomainNames
33. dpGetAllMSDomainIds
34. dpGetAllMSDomainVersionIds
35. dpGetMSDomain
36. dpGetMSDomainVersion
37. dpManageDomain
38. dpRemoveMSDomainVersion
39. dpSetMSDomain
40. dpSetMSDomainVersion
41. dpUnmanageDomain
42. dpCopyMSSettingsVersion
43. dpGetAllMSSettingsVersionIds
44. dpGetMSSettings
45. dpGetMSSettingsVersion
46. dpRemoveMSSettingsVersion
47. dpSetMSSettings
48. dpSetMSSettingsVersion
49. dpGetAllTaskIds
50. dpGetTask
51. dpPurgeTask

Overview

Use the commands in the dpManagerCommands group to query, configure, and administer the DataPower appliance manager.

Before beginning, verify that each appliance to manage has a 3.6.0.4 or higher level of firmware. Additionally, verify that the Appliance Management Protocol (AMP) endpoint is enabled for each appliance. If the XML Management interface AMP endpoint was disabled during installation, use the DataPower WebGUI to enable the AMP endpoint.

The DataPower Web GUI is different from the DataPower appliance manager in the administrative console.

dpExport

Export the DataPower appliance manager configuration and versions.

Target object: None.

Required parameters

-file

Local system file to which the DataPower appliance manager exports the configuration and versions. (String, required)

Return value: Return the ID of the task the system creates.

Batch mode example usage

• Use Jython string:

  (Windows)

  AdminTask.dpExport('-file c:/temp/DPManager.export_doc')

  (AIX) (Solaris) (Linux) (HPUX) (iSeries) (ZOS)

  AdminTask.dpExport('-file /temp/DPManager.export')

• Use Jython list:

  (Windows)

  AdminTask.dpExport(['-file', 'C:/temp/DPManager.export'])

  (AIX) (Solaris) (Linux) (HPUX) (iSeries) (ZOS)

  AdminTask.dpExport(['-file', '/temp/DPManager.export'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpExport('-interactive')

dpGetManager

Display the properties of the DataPower appliance manager.

Target object: None.

Return value: Properties object containing the current settings of the DataPower appliance manager.

Batch mode example usage

• Use Jython string and list:
  AdminTask.dpGetManager()

dpGetManagerStatus

Display the status of the DataPower appliance manager.

Target object: None.

Return value: Returns a description of the DataPower appliance manager status.

Batch mode example usage

• Use Jython string and list:
  AdminTask.dpGetManagerStatus()

dpImport

Import the DataPower appliance manager configuration and versions. The command replaces the existing configuration and versions with the imported configuration and versions.

Target object: None.

Required parameters:

-file

The DataPower appliance manager system file containing the configuration and versions to import. (String, required)

Return value: The command does not return output.

Batch mode example usage

• Use Jython string:

  (Windows)

  AdminTask.dpImport('-file c:/temp/DPManager.import')

  (AIX) (Solaris) (Linux) (HPUX) (iSeries) (ZOS)

  AdminTask.dpImport('-file /temp/DPManager.import')

• Use Jython list:

  (Windows)

  AdminTask.dpImport(['-file', 'C:/temp/DPManager.export'])

  (AIX) (Solaris) (Linux) (HPUX) (iSeries) (ZOS)

  AdminTask.dpImport(['-file', '/temp/DPManager.export'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpImport('-interactive')

dpSetManager

Modify the DataPower appliance manager configuration.

Target object: None.

Optional parameters

-maxVersionsToStore

New maximum number of versions to keep. (Integer, optional)

-versionsDirectory

The DataPower appliance manager system directory where the manager creates the versions. The command moves the existing versions from the current versions directory to the new versions directory. (String, optional)

Return value: If we specify a value for the versionsDirectory parameter, the command returns the ID of the task that the command creates.

Batch mode example usage

• Use Jython string:
  AdminTask.dpSetManager('-maxVersionsToStore 20 -versionsDirectory newDir')

• Use Jython list:
  AdminTask.dpSetManager(['-maxVersionsToStore', '20', '-versionsDirectory', 'newDir'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpSetManager('-interactive')

dpStopManager

Stop the DataPower appliance manager. The manager automatically restarts the next time the DataPower appliance manager is used.

Target object: None.

Return value: The command does not return output.

Batch mode example usage

• Use Jython string and list:
  AdminTask.dpStopManager()

dpAddAppliance

Add an appliance to the DataPower appliance manager.

Target object: None.

Required parameters

-hostname

Host name or IP address of the appliance. (String, required)

-hlmPort

Port number that the DataPower appliance manager uses to communicate to the appliance. The default is 5550. (Integer, required)

-name

Unique name of the appliance in the DataPower appliance manager. Do not specify the following characters within the name parameter: \\/,#$@:;\"*?<>|=+&%' (String, required)

-userId

User ID that the DataPower appliance manager uses to access the appliance. (String, required)

-password

Base-64 encoded password that the DataPower appliance manager uses to access the appliance. (String, required)

Return value: The command returns the ID of the task the system creates. When the task ends, the value of the result attribute in the task contains the ID of the new appliance.

Batch mode example usage

• Use Jython string:
  AdminTask.dpAddAppliance('[-hostname myappliance.ibm.com -name myappliance -userId admin -password mypassword]')

• Use Jython list:
  AdminTask.dpAddAppliance(['-hostname', 'myappliance.ibm.com', '-name', 'myappliance', '-userId', ' admin', '-password', 'mypassword'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpAddAppliance('-interactive')

dpGetAllApplianceIds

Display the ID of each DataPower appliance manager appliance.

Target object: None.

Return value: The command returns a string array containing each appliance ID in the configuration. For appliances, the ID is the serial number of the DataPower appliance.

Batch mode example usage

• Use Jython string and list:
  AdminTask.dpGetAllApplianceIds()

dpGetAllMSApplianceIds

Display the IDs of each appliance in a DataPower appliance manager managed set.

Target object: None.

Required parameters:

-managedSetId

ID of the managed set of interest. (String, required)

Return value: The command returns a string array containing the IDs of the appliances in the managed set of interest.

Batch mode example usage

• Use Jython string:
  AdminTask.dpGetAllMSApplianceIds('[-managedSetId myManagedSet]')

• Use Jython list:
  AdminTask.dpGetAllMSApplianceIds(['-managedSetId', 'myManagedSet'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpGetAllMSApplianceIds('-interactive')

dpGetAppliance

Display a specific DataPower appliance manager appliance.

Target object: None.

Required parameters

-applianceId

ID of the appliance in the DataPower appliance manager to display. (String, required)

Return value: Properties object containing the attributes of the appliance of interest, as the following sample output displays:

[ [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] ]

Attribute	Description
applianceId	Display the ID of the appliance of interest.
managedSetId	Display the ID of the managed set for which the appliance is a member. If the appliance is not managed, the command does not return this attribute.
actualFirmwareLevel	Display the level of the firmware of the appliance.
featureLicenses	Display a list of feature entitlements for the appliance such as MQ, TAM, and so on.
guiPort	Display the appliance port for the DataPower WebGUI interface.
hlmPort	Display the port number for communication between the DataPower appliance manager and the appliance.
hostname	Display the host name or internet protocol (IP) address of the appliance.
isManaged	Display a value of true if the DataPower appliance manager manages the appliance.
isMaster	Display a value of true if the appliance is the master appliance in the managed set. This property is not displayed if the appliance is not managed by the DataPower appliance manager.
modelType	Display the model type of the appliance.
applianceType	Display the appliance type.
settingsManagementStatus	Display the management status of the settings on the appliance. This attribute is also referred to as the synchronization status on the DataPower WebGUI.
firmwareManagementStatus	Display the management status of the firmware on the appliance. This attribute is also referred to as the synchronization status on the DataPower WebGUI.
domainManagementStatus	Display the management status of a specific domain on the appliance. This attribute is also referred to as the synchronization status on the DataPower WebGUI.
domainOperationalStatus	Display the operational status of a specific domain on the appliance.
rollupManagementStatus	Display the aggregated management status of the firmware, settings, and domains on the appliance. This attribute is also referred to as the synchronization status on the DataPower WebGUI.
rollupOperationalStatus	Display the aggregated operational status of the firmware, settings, and domains on the appliance.
serialNumber	Display the serial number of the appliance of interest.
name	Display the name of the appliance in the DataPower appliance manager.
userId	Display the user ID that the DataPower appliance manager uses to access the appliance.

Batch mode example usage

• Use Jython string:
  AdminTask.dpGetAppliance('-applianceId "00605 20356"')

• Use Jython list:
  AdminTask.dpGetAppliance(['-applianceId', '00605 20356'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpGetAppliance('-interactive')

dpManageAppliance

Add the appliance to a managed set and to start managing the appliance.

Target object:

None.

Required parameters:

-managedSetId

ID of the managed set for which the appliance is a member. (String, required)

-applianceId

ID of the appliance in the DataPower appliance manager to add to the managed set. (String, required)

Optional parameters:

-asMaster

Specifies whether to set the appliance as the master appliance of the managed set. The first appliance added to the managed set is set as the master appliance, even if this parameter is not specified. (String, optional)

Return value: ID of the task that the command creates. When the task completes, the value of the result attribute is the ID of the appliance.

Batch mode example usage

• Use Jython string:
  AdminTask.dpManageAppliance('-managedSetId testMS1 -applianceId "00605 20351"')

• Use Jython list:
  AdminTask.dpManageAppliance(['-managedSetId', 'testMS1', '-applianceId', '00605 20351'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpManageAppliance('-interactive')

dpRemoveAppliance

Remove an appliance from the DataPower appliance manager. Also, the command removes the appliance from a managed set, if it is a member. We cannot remove an appliance that is a master in a managed set. We must select a different appliance as the master before removing a master appliance.

Target object: None.

Required parameters:

-applianceId

ID of the appliance in the DataPower appliance manager to remove from the managed set. For appliances, the ID is the serial number of the DataPower appliance. (String, required)

Return value: The command does not return output.

Batch mode example usage

• Use Jython string:
  AdminTask.dpRemoveAppliance('[-applianceId "00605 20356"]')

• Use Jython list:
  AdminTask.dpRemoveAppliance(['-applianceId', '00605 20356'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpRemoveAppliance('-interactive')

dpSetAppliance

Modify the DataPower appliance manager configuration for an appliance.

Target object: None.

Required parameters:

-applianceId

ID of the appliance in the DataPower appliance manager to modify. (String, required)

Optional parameters:

-hostname

Host name or IP address of the appliance. (String, optional)

-hlmPort

Port number that the DataPower appliance manager uses to communicate to the appliance. The default is 5550. (Integer, optional)

-name

Unique name of the appliance in the DataPower appliance manager. Do not specify the following characters within the name parameter: \\/,#$@:;\"*?<>|=+&%' (String, optional)

-userId

User ID that the DataPower appliance manager uses to access the appliance. (String, optional)

-password

Base-64 encoded password that the DataPower appliance manager uses to access the appliance. (String, optional)

Return value: The command does not return output.

Batch mode example usage

• Use Jython string:
  AdminTask.dpSetAppliance('[-applianceId "00605 20356" -hostname myappliance2.ibm.com -name myappliance2 -hlmPort 4500 -userId admin2 -password myPassword]')

• Use Jython list:
  AdminTask.dpSetAppliance(['-applianceId', '00605 20356', '-hostname', 'myappliance2.ibm.com', '-name', 'myappliance2', '-hlmPort', '4500', '-userId', 'admin2', '-password', 'myPassword'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpSetAppliance('-interactive')

dpUnmanageAppliance

Remove the appliance of interest from its managed set. The appliance is no longer managed, but remains defined to the manager.

Target object: None.

Required parameters

-managedSetId

ID of the managed set for which the appliance is a member. (String, required)

-applianceId

ID of the appliance in the DataPower appliance manager to remove from the managed set. (String, required)

Return value: Task that the command creates.

Batch mode example usage

• Use Jython string:
  AdminTask.dpUnmanageAppliance('[-managedSetId testMS1 -applianceId "00605 20351"]')

• Use Jython list:
  AdminTask.dpUnmanageAppliance(['-managedSetId', 'testMS1', '-applianceId "00605 20351"'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpUnmanageAppliance('-interactive')

dpAddManagedSet

Add a managed set to the DataPower appliance manager.

Target object: None.

Required parameters

-name

Unique name of the appliance in the DataPower appliance manager. Do not specify the following characters within the name parameter: \\/,#$@:;\"*?<>|=+&%' (String, required)

Return value: The command does not return output.

Batch mode example usage

• Use Jython string:
  AdminTask.dpAddManagedSet('-name testMS')

• Use Jython list:
  AdminTask.dpAddManagedSet(['-name testMS'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpAddManagedSet('-interactive')

dpGetAllManagedSetIds

Display the IDs of each DataPower appliance manager managed set.

Target object: None.

Return value: String array containing each managed set ID.

Batch mode example usage

• Use Jython string and list:
  AdminTask.dpGetAllManagedSetIds()

dpGetManagedSet

Display information for a specific DataPower appliance manager managed set.

Target object: None.

Required parameters:

-managedSetId

ID of the managed set of interest. (String, required)

Return value: Properties object containing the attributes for the managed set.

Attribute	Description
managedSetId	Display the ID of the managed set.
masterApplianceId	Display the ID of the master appliance of the managed set.
desiredFirmwareVersionId	Display the ID of the firmware version to use for the managed set.
name	Display the name associated with the managed set.
rollupOperationalStatus	Display the operational status of the managed set.
rollupManagementStatus	Display the management status of the managed set.
settingsId	Display the ID of the settings for the managed set.

Batch mode example usage

• Use Jython string:
  AdminTask.dpGetManagedSet('-managedSetId testMS1')

• Use Jython list:
  AdminTask.dpGetManagedSet(['-managedSetId', 'testMS1'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpGetManagedSet('-interactive')

dpRemoveManagedSet

Remove a managed set from the DataPower appliance manager.

Target object: None.

Required parameters

-managedSetId

ID of the managed set to remove. (String, required)

Return value: The command does not return output.

Batch mode example usage

• Use Jython string:
  AdminTask.dpRemoveManagedSet('-managedSetId testMS')

• Use Jython list:
  AdminTask.dpRemoveManagedSet(['-managedSetId', 'testMS'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpRemoveManagedSet('-interactive')

dpSetManagedSet

Modify a DataPower appliance manager managed set.

Target object: None.

Required parameters

-managedSetId

ID of the managed set to modify. (String, required)

Optional parameters:

-masterApplianceId

ID of the appliance to set as the master appliance for the managed set. This appliance must be a member of the managed set. This parameter is mutually exclusive with the desiredFirmwareVersionId parameter. (String, optional)

-desiredFirmwareVersionId

ID of the firmware version to synchronize to each appliance in the managed set. This parameter is mutually exclusive with the masterApplianceId parameter. (String, optional)

Return value: ID of the task that the command creates.

Batch mode example usage

• Use Jython string:
  AdminTask.dpSetManagedSet('-managedSetId myManagedSet -masterApplianceId "00605 20356"')

• Use Jython list:
  AdminTask.dpSetManagedSet(['-managedSetId', 'myManagedSet', '-masterApplianceId', '"00605 20356"'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpSetManagedSet('-interactive')

dpSynchManagedSet

Manually synchronize a DataPower appliance manager managed set. The manager automatically attempts to synchronize the member devices.

Target object: None.

Required parameters

-managedSetId

ID of the managed set to synchronize. (String, required)

Return value: ID of the task that the command creates.

Batch mode example usage

• Use Jython string:
  AdminTask.dpSynchManagedSet('-managedSetId myManagedSet')

• Use Jython list:
  AdminTask.dpSynchManagedSet(['-managedSetId', 'myManagedSet'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpSynchManagedSet('-interactive')

dpAddFirmwareVersion

Add a firmware version to the DataPower appliance manager.

Target object: None.

Required parameters

-file

File in the DataPower appliance manager file system containing the firmware image to store in the firmware version. (String, required)

Optional parameters:

-userComment

Comment to store in the firmware version. (String, optional)

Return value: ID of the task that the command creates. When the task ends, the value of the result attribute displays the ID of the new firmware version.

Batch mode example usage

• Use Jython string:

  (Windows)

  AdminTask.dpAddFirmwareVersion('[-file "C:/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2" -userComment "my new firmware"]')

  (AIX) (Solaris) (Linux) (HPUX) (iSeries) (ZOS)

  AdminTask.dpAddFirmwareVersion('[-file "/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2" -userComment "my new firmware"]')

• Use Jython list:

  (Windows)

  AdminTask.dpAddFirmwareVersion(['-file', '"C:/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2"', '-userComment', '"my new firmware"'])

  (AIX) (Solaris) (Linux) (HPUX) (iSeries) (ZOS)

  AdminTask.dpAddFirmwareVersion(['-file', '"/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2"', '-userComment', '"my new firmware"'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpAddFirmwareVersion('-interactive')

dpGetAllFirmwareIds

Display the IDs of each DataPower appliance manager firmware in the configuration.

Target object: None.

Return value: String array for each firmware ID in the DataPower appliance manager configuration.

Batch mode example usage

• Use Jython string and list:
  AdminTask.dpGetAllFirmwareIds()

dpGetAllFirmwareVersionIds

Display the IDs of each DataPower appliance manager firmware version. A firmware version represents a firmware image you can deploy to a DataPower appliance.

Target object: None.

Required parameters

-firmwareId

ID of the firmware to query. (String, required)

Return value: String array containing each firmware version in the configuration.

Batch mode example usage

• Use Jython string:
  AdminTask.dpGetAllFirmwareVersionIds('-firmwareId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;"')

• Use Jython list:
  AdminTask.dpGetAllFirmwareVersionIds(['-firmwareId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpGetAllFirmwareVersionIds('-interactive')

dpGetAllMSIdsUsingFirmwareVersion

Display the IDs of the managed sets that use a firmware version.

Target object: None.

Required parameters:

-firmwareVersionId

ID of the firmware version of interest. (String, required)

Return value: String array containing the IDs of the managed sets that use the firmware version of interest.

Batch mode example usage

• Use Jython string:
  AdminTask.dpGetAllMSIdsUsingFirmwareVersion('-firmwareVersionId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15"')

• Use Jython list:
  AdminTask.dpGetAllMSIdsUsingFirmwareVersion(['-firmwareVersionId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpGetAllMSIdsUsingFirmwareVersion('-interactive')

dpGetBestFirmware

Display the firmware in the DataPower appliance manager that best matches the parameters. The firmware in the DataPower appliance manager contains one or more firmware versions that represent different versions of the firmware. This command does not identify the optimal firmware release from DataPower. The command identifies the firmware version that matches the appliance.

Target object: None.

Required parameters

-applianceType

Appliance type of the DataPower appliance for which to display the firmware. (String, required)

-modelType

Model type of the DataPower appliance for which to display the firmware. (String, required)

-applianceFeatures

Appliance features of the DataPower appliance for which to display the firmware. (String, required)

Optional parameters:

-level

Level of the firmware version to contain in the returned firmware. (String, optional)

Return value: Properties object containing the attributes of the firmware.

Attribute	Description
firmwareId	Display the firmware ID.
applianceType	Display the appliance type for which the firmware is used.
modelType	Display the model type of the firmware.
strictFeatures	Display the strict features for which the firmware is used.
nonStrictFeatures	Display the non strict features for which the firmware is used.

Batch mode example usage

• Use Jython string:
  AdminTask.dpGetBestFirmware('-applianceType "XS40" -modelType "9002" -applianceFeatures "JAXP-API" -level "3.6.0.4"')

• Use Jython list:
  AdminTask.dpGetBestFirmware(['-applianceType', 'XS40', '-modelType', '9002', '-applianceFeatures', 'JAXP-API', '-level', '3.6.0.4'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpGetBestFirmware('-interactive')

dpGetFirmware

Display attributes for a specific DataPower appliance manager firmware.

Target object: None.

Required parameters:

-firmwareId

ID of the firmware of interest. (String, required)

Return value: Properties object containing the attributes of the firmware of interest.

Attribute	Description
firmwareId	Display the firmware ID.
applianceType	Display the appliance type for which the firmware is used.
modelType	Display the model type of the firmware.
strictFeatures	Display the strict features for which the firmware is used.
nonStrictFeatures	Display the non strict features for which the firmware is used.

Batch mode example usage

• Use Jython string:
  AdminTask.dpGetFirmware('-firmwareId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;"')

• Use Jython list:
  AdminTask.dpGetFirmware(['-firmwareId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpGetFirmware('-interactive')

dpGetFirmwareVersion

Display a specific DataPower appliance manager firmware version. A firmware version represents a firmware image that we can deploy to a DataPower appliance.

Target object: None.

Required parameters

-firmwareVersionId

ID of the firmware version of interest. (String, required)

Return value:

Return a properties object containing the attributes of the firmware version.

Attribute	Description
firmwareVersionId	Display the ID of the firmware version.
firmareId	Display the ID of the firmware containing the firmware version.
level	Display the level of the firmware.
manufactureDate	Display the date that the firmware was manufactured.
timestamp	Display the date that the firmware image was loaded to the DataPower appliance manager.
userComment	Display the comment stored with the firmware version.
isInUse	Displays whether a managed set uses the firmware version.

Batch mode example usage

• Use Jython string:
  AdminTask.dpGetFirmwareVersion('-firmwareVersionId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15"')

• Use Jython list:
  AdminTask.dpGetFirmwareVersion(['-firmwareVersionId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpGetFirmwareVersion('-interactive')

dpRemoveFirmwareVersion

Remove a firmware version from the DataPower appliance manager. The firmware the system associates with the firmware version remains. Verify that a managed set is not currently using the firmware version to remove before we run this command.

Target object: None.

Required parameters:

-firmwareVersionId

ID of the firmware version to remove. (String, required)

Return value: The command does not return output.

Batch mode example usage

• Use Jython string:
  AdminTask.dpRemoveFirmwareVersion('-firmwareVersionId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15"')

• Use Jython list:
  AdminTask.dpRemoveFirmwareVersion(['-firmwareVersionId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpRemoveFirmwareVersion('-interactive')

dpSetFirmwareVersion

Modify a DataPower appliance manager firmware version.

Target object: None.

Required parameters

-firmwareVersionId

ID of the firmware version to modify. (String, required)

Optional parameters:

-userComment

Comment to store in the firmware version. (String, optional)

Return value: The command does not return output.

Batch mode example usage

• Use Jython string:
  AdminTask.dpSetFirmwareVersion('-firmwareVersionId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15" -userComment "new user comment"')

• Use Jython list:
  AdminTask.dpSetFirmwareVersion(['-firmwareVersionId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15', '-userComment', 'new user comment'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpSetFirmwareVersion('-interactive')

dpCopyMSDomainVersion

Copy a DataPower appliance manager managed domain version to a new managed set.

Target object: None.

Required parameters:

-managedSetId

ID of the managed set of interest. (String, required)

-msDomainVersionId

ID of the managed domain version to copy. (String, required)

Return value: ID of the task that the command creates.

Batch mode example usage

• Use Jython string:
  AdminTask.dpCopyMSDomainVersion('[-managedSetId myManagedSet -msDomainVersionId "myManagedSet:default:1"]')

• Use Jython list:
  AdminTask.dpCopyMSDomainVersion(['-managedSetId', 'myManagedSet', '-msDomainVersionId', 'myManagedSet:default:1'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpCopyMSDomainVersion('-interactive')

dpGetAllDomainNames

Display the names of each of the domains on a DataPower appliance.

Target object: None.

Required parameters

-applianceId

ID of the appliance in the DataPower appliance manager to display. (String, required)

Optional parameters:

-managed

Indicates whether to return the managed domains. The command returns the name of each domain on the appliance if we do not specify the managed or unmanaged parameters, or if we specify both parameters. (String, optional)

-unmanaged

Indicates whether the command returns the unmanaged domains. The command returns the name of each domain on the appliance if we do not specify the managed or unmanaged parameters, or if we specify both parameters. (String, optional)

Return value:

Return a string array of the names of the domains in the appliance.

Batch mode example usage

• Use Jython string:
  AdminTask.dpGetAllDomainNames('[-applianceId "00605 20356" -managed -unmanaged]')

• Use Jython list:
  AdminTask.dpGetAllDomainNames(['-applianceId', '00605 20356', '-managed', '-unmanaged'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpGetAllDomainNames('-interactive')

dpGetAllMSDomainIds

Display the IDs of each domain in a DataPower appliance manager managed set.

Target object: None.

Required parameters:

-managedSetId

ID of the managed set of interest. (String, required)

Return value: String array containing the IDs of the domains in the managed set.

Batch mode example usage

• Use Jython string:
  AdminTask.dpGetAllMSDomainIds('[-managedSetId myManagedSet]')

• Use Jython list:
  AdminTask.dpGetAllMSDomainIds(['-managedSetId', 'myManagedSet'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpGetAllMSDomainIds('-interactive')

dpGetAllMSDomainVersionIds

Display the ID of each domain version for a domain in a DataPower appliance manager managed set.

Target object: None.

Required parameters

-msDomainId

ID of the managed domain to display. (String, required)

Return value: ID for each domain version that exists for the managed set domain.

Batch mode example usage

• Use Jython string:
  AdminTask.dpGetAllMSDomainVersionIds('[-msDomainId ms1:domain1]')

• Use Jython list:
  AdminTask.dpGetAllMSDomainVersionIds(['-msDomainId', 'ms1:domain1'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpGetAllMSDomainVersionIds('-interactive')

dpGetMSDomain

Display a domain in a DataPower appliance manager managed set.

Target object: None.

Required parameters

-msDomainId

ID of the managed domain to display. (String, required)

Return value:

Returns a properties object containing the attributes for the managed set domain of interest.

Attribute	Description
msDomainId	Display the ID of the domain.
managedSetId	Display the ID of the managed set to which the domain belongs.
name	Display the name of the domain.
desiredDomainVersionId	Display the ID of the domain version that the managed set uses for the domain.

Batch mode example usage

• Use Jython string:
  AdminTask.dpGetMSDomain('[-msDomainId ms1:domain1]')

• Use Jython list:
  AdminTask.dpGetMSDomain(['-msDomainId', 'ms1:domain1'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpGetMSDomain('-interactive')

dpGetMSDomainVersion

Display a DataPower appliance manager managed domain version.

Target object: None.

Required parameters:

-msDomainVersionId

ID of the managed domain version of interest. (String, required)

Return value: Properties object containing the attributes of the managed set domain version of interest.

Attribute	Description
msDomainVersionId	Display the ID of the managed domain version.
msDomainId	Display the ID of the managed domain.
versionNumber	Display the version number.
timestamp	Display the date the system created the copy.
userComment	Display the comment stored with the managed set domain version.
isInUse	Displays whether the managed set uses the domain version for the domain.

Batch mode example usage

• Use Jython string:
  AdminTask.dpGetMSDomainVersion('[-msDomainVersionId ms1:domain1:1]')

• Use Jython list:
  AdminTask.dpGetMSDomainVersion(['-msDomainVersionId', 'ms1:domain1:1'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpGetMSDomainVersion('-interactive')

dpManageDomain

Add the domain to a managed set, and starts managing the domain.

Target object: None.

Required parameters:

-managedSetId

ID of the managed set to manage. (String, required)

-domain

Name of the domain on the master appliance to manage. (String, required)

Return value:

Return the ID of the task that the command creates. When the task completes, the value of the result attribute contains the ID of the new domain.

Batch mode example usage

• Use Jython string:
  AdminTask.dpManageDomain('[-managedSetId testMS1 -domain default]')

• Use Jython list:
  AdminTask.dpManageDomain(['-managedSetId', 'testMS1', '-domain', 'default'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpManageDomain('-interactive')

dpRemoveMSDomainVersion

Removes a managed domain version from the DataPower appliance manager.

Target object: None.

Required parameters

-msDomainVersionId

ID of the managed domain version to remove. (String, required)

Return value: The command does not return output.

Batch mode example usage

• Use Jython string:
  AdminTask.dpRemoveMSDomainVersion('[-msDomainVersionId ms1:domain1:1]')

• Use Jython list:
  AdminTask.dpRemoveMSDomainVersion(['-msDomainVersionId', 'ms1:domain1:1'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpRemoveMSDomainVersion('-interactive')

dpSetMSDomain

Modify a DataPower appliance manager managed domain.

Target object: None.

Required parameters

-msDomainId

ID of the managed domain to modify. (String, required)

Optional parameters:

-desiredDomainVersionId

ID of the domain version to synchronize to each appliance in the managed set. (String, optional)

Return value: ID of the task that the command creates.

Batch mode example usage

• Use Jython string:
  AdminTask.dpSetMSDomain('[-msDomainId ms1:domain1 -desiredDomainVersionId ms1:domain1:1]')

• Use Jython list:
  AdminTask.dpSetMSDomain(['-msDomainId', 'ms1:domain1', '-desiredDomainVersionId', 'ms1:domain1:1'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpSetMSDomain('-interactive')

dpSetMSDomainVersion

Modify a DataPower appliance manager managed domain version.

Target object: None.

Required parameters:

-msDomainVersionId

ID of the managed domain version to modify. (String, required)

Optional parameters:

-userComment

Comment to store in the domain version. (String, optional)

Return value: The command does not return output.

Batch mode example usage

• Use Jython string:
  AdminTask.dpSetMSDomainVersion('[-msDomainVersionId ms1:domain1:2 -userComment "New Web Service proxy for banking application"]')

• Use Jython list:
  AdminTask.dpSetMSDomainVersion(['-msDomainVersionId', 'ms1:domain1:2', '-userComment', 'New web service proxy for banking application'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpSetMSDomainVersion('-interactive')

dpUnmanageDomain

Remove the domain from a managed set, and stops managing the domain.

Target object: None.

Required parameters:

-msDomainId

ID of the managed domain to remove from the managed set. (String, required)

Optional parameters:

-clean

Deletes the domain from each appliance in the managed set. (String, optional)

Return value:

If we specify the clean parameter, the command returns the ID of the task the system creates.

Batch mode example usage

• Use Jython string:
  AdminTask.dpUnmanageDomain('-msDomainId testMS1:default -clean')

• Use Jython list:
  AdminTask.dpUnmanageDomain(['-msDomainId', 'testMS1:default', '-clean'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpUnmanageDomain('-interactive')

dpCopyMSSettingsVersion

Copy a DataPower appliance manager managed settings version to a new managed set.

Target object: None.

Required parameters:

-managedSetId

ID of the managed set of interest. (String, required)

-msSettingsVersionId

ID of the managed settings version to copy. (String, required)

Return value: ID of the task that the command creates.

Batch mode example usage

• Use Jython string:
  AdminTask.dpCopyMSSettingsVersion('[-managedSetId myManagedSet -msSettingsVersionId "myManagedSet1:1"]')

• Use Jython list:
  AdminTask.dpCopyMSSettingsVersion(['-managedSetId', 'myManagedSet',,-msSettingsVersionId', 'myManagedSet1:1'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpCopyMSSettingsVersion('-interactive')

dpGetAllMSSettingsVersionIds

Display the IDs of each settings version in a DataPower appliance manager managed set.

Target object: None.

Required parameters:

-msSettingsId

ID of the managed settings of interest. (String, required)

Return value: String array containing the IDs of the versions of the managed set settings of interest.

Batch mode example usage

• Use Jython string:
  AdminTask.dpGetAllMSSettingsVersionIds('-msSettingsId ms1:2')

• Use Jython list:
  AdminTask.dpGetAllMSSettingsVersionIds(['-msSettingsId', 'ms1:2'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpGetAllMSSettingsVersionIds('-interactive')

dpGetMSSettings

Display the ID of the managed set to which the settings belong.

Target object: None.

Required parameters

-msSettingsId

ID of the managed settings of interest. (String, required)

Return value: Properties object containing the attributes of the settings of interest.

Attribute	Description
msSettingsId	Display the ID of the settings.
managedSetId	Display the ID of the managed ID to which the settings are assigned.
desiredSettingsVersionId	Display the ID of the settings version that the managed set uses.

Batch mode example usage

• Use Jython string:
  AdminTask.dpGetMSSettings('-msSettingsId ms1:2')

• Use Jython list:
  AdminTask.dpGetMSSettings(['-msSettingsId', 'ms1:2'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpGetMSSettings('-interactive')

dpGetMSSettingsVersion

Display a DataPower appliance manager managed settings version.

Target object: None.

Required parameters:

-msSettingsVersionId

ID of the managed settings version of interest. (String, required)

Return value: Properties object containing the attributes of the managed set settings version of interest.

Attribute	Description
msSetSettingsVersionId	Display the ID of the managed set settings version.
msSettingsId	Display the ID of the managed set settings of interest.
timestamp	Display the date the system created the copy.
versionNumber	Display the number of the version.
userComment	Display the comment associated with the managed set settings version.
isInUse	Display the ID of the settings version that the managed set uses.

Batch mode example usage

• Use Jython string:
  AdminTask.dpGetMSSettingsVersion('-msSettingsVersionId ms1:2')

• Use Jython list:
  AdminTask.dpGetMSSettingsVersion(['-msSettingsVersionId', 'ms1:2'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpGetMSSettingsVersion('-interactive')

dpRemoveMSSettingsVersion

Remove a managed settings version from the DataPower appliance manager.

Target object: None.

Required parameters

-msSettingsVersionId

ID of the managed settings version to remove. (String, required)

Return value: The command does not return output.

Batch mode example usage

• Use Jython string:
  AdminTask.dpRemoveMSSettingsVersion('-msSettingsVersionId ms1:2')

• Use Jython list:
  AdminTask.dpRemoveMSSettingsVersion(['-msSettingsVersionId', 'ms1:2'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpRemoveMSSettingsVersion('-interactive')

dpSetMSSettings

Modify the DataPower appliance manager managed settings.

Target object: None.

Required parameters

-msSettingsId

ID of the managed settings to modify. (String, required)

Optional parameters:

-desiredSettingsVersionId

ID of the settings version to synchronize to each appliance in the managed set. (String, optional)

Return value: ID of the task that the command creates.

Batch mode example usage

• Use Jython string:
  AdminTask.dpSetMSSettings('-msSettingsId ms1 -desiredSettingsVersionId ms1:1')

• Use Jython list:
  AdminTask.dpSetMSSettings(['-msSettingsId', 'ms1', '-desiredSettingsVersionId', 'ms1:1'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpSetMSSettings('-interactive')

dpSetMSSettingsVersion

Modify a DataPower appliance manager managed settings version.

Target object: None.

Required parameters:

-msSettingsVersionId

ID of the managed settings version to modify. (String, required)

Optional parameters:

-userComment

Comment to store in the settings version. (String, optional)

Return value: The command does not return output.

Batch mode example usage

• Use Jython string:
  AdminTask.dpSetMSSettingsVersion('[-msSettingsVersionId ms1:2 -userComment "has new timeserver added"]')

• Use Jython list:
  AdminTask.dpSetMSSettingsVersion(['-msSettingsVersionId', 'ms1:2', '-userComment', 'has new timeserver added'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpSetMSSettingsVersion('-interactive')

dpGetAllTaskIds

Display the IDs of each of the DataPower appliance manager tasks.

Target object: None.

Return value: List of each asynchronous task ID that currently exists in the DataPower applance manager.

Batch mode example usage

• Use Jython string and list:
  AdminTask.dpGetAllTaskIds()

dpGetTask

Display information for a specific DataPower appliance manager task.

Target object: None.

Required parameters

-taskId

ID of the task of interest. (String, required)

Return value:

Attribute	Description
taskId	Display the unique ID of the task.
taskDescription	Display a description of the task.
creationDate	Display the date and time the system created the task.
createdByUser	Display the user that created the task.
currentStep	Display the current step number for the task.
currentStepDescription	Display a description of the current step.
currentStepTimestamp	Display the time and date that the current step was last updated in the task. The system updates the currentTimeStamp attribute when the system constructs the object, updates a step, marks the task complete, or experiences an exception.
error	Display the error message of the exception that caused the task to end, if applicable.
totalSteps	Display the estimated total number of steps for the task. Do not use this argument to determine if the task is complete. Refer to the isComplete attribute to determine if the task is complete.
hasError	Display a value of true if the task is not successfully completed.
hasUpdate	Display a value of true if the task is updated.
isComplete	Display a value of true if the task is complete.
taskStatus	Display an integer that represents the status of the task. If the returned value is 0, then the task is in a queue and the system has not started the task. If the returned value is 1, then the task is in progress. If the returned value is 2, then the task completed successfully. If the returned value is 3, then the task experienced an exception.
result	Display the result that the task returns. Refer to the specific command to determine if the command returns output.

Batch mode example usage

• Use Jython string:
  AdminTask.dpGetTask('-taskId 1')

• Use Jython list:
  AdminTask.dpGetTask(['-taskId', '1'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpGetTask('-interactive')

dpPurgeTask

Purge a specific DataPower appliance manager task. The system automatically deletes tasks after 24 hours.

Target object: None.

Required parameters:

-taskId

ID of the task in the DataPower appliance manager to purge. (String, required)

Return value: The command does not return output.

Batch mode example usage

• Use Jython string:
  AdminTask.dpPurgeTask('-taskId 1')

• Use Jython list:
  AdminTask.dpPurgeTask(['-taskId', '1'])

Interactive mode example usage

• Use Jython:
  AdminTask.dpPurgeTask('-interactive')

Related:

WebSphere DataPower appliance manager overview

Set up the DataPower appliance manager using scripting

Copy DataPower appliance domains between managed sets using scripting

Update firmware versions for DataPower appliances using scripting

Administer managed domains, firmware, and settings versions using scripting

Modify DataPower appliance manager settings