dpManagerCommands


 

+

Search Tips   |   Advanced Search

 

Use dpManagerCommands with wsadmin to administer the DataPower appliance manager.

The first time you use DataPower appliance manager, there are no...

You must create them.

Before beginning, verify that each appliance to manage has a 3.6.0.4 or higher level of firmware.

Additionally, verify 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 DataPower Web GUI is different from the DataPower appliance manager in the admin console.

To administer the DataPower appliance manager:

To administer appliances:

To administer managed sets:

To administer firmware:

To administer domains and domain versions:

To administer settings and settings versions:

To manage tasks:

 

dpExport

The dpExport command exports 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

ID of the task that the system creates.

Batch mode...

Interactive mode...

 

dpGetManager

Display the properties of the DataPower appliance manager.

Target object

None.

Return value

Properties object that contains the current settings of the DataPower appliance manager.

Batch mode...

 

dpGetManagerStatus

Display the status of the DataPower appliance manager.

Target object

None.

Return value

Description of the DataPower appliance manager status.

Batch mode...

 

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

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

Return value

The command does not return output.

Batch mode...

Interactive mode...

 

dpSetManager

Modify the DataPower appliance manager configuration.

Target object

None.

Optional parameters

-maxVersionsToStore

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

-versionsDirectory

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...

Interactive mode...

 

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...

 

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 value 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 ID of the task that 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...

Interactive mode...

 

dpGetAllApplianceIds

Display the ID of each DataPower appliance manager appliance.

Target object

None.

Return value

String array that contains each appliance ID in the configuration. For appliances, the ID is the serial number of the DataPower appliance.

Batch mode...

 

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

String array that contains the IDs of the appliances in the managed set of interest.

Batch mode...

Interactive mode...

 

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 that contains 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 ID of the appliance of interest.
managedSetId 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 Level of the firmware of the appliance.
featureLicenses Displays a list of feature entitlements for the appliance such as MQ, TAM, and so on.
guiPort Appliance port for the DataPower WebGUI interface.
hlmPort Port number for communication between the DataPower appliance manager and the appliance.
hostname Host name or internet protocol (IP) address of the appliance.
isManaged True if the DataPower appliance manager manages the appliance.
isMaster True if the appliance is the master appliance in the managed set. Is not displayed if the appliance is not managed by the DataPower appliance manager.
modelType Model type of the appliance.
applianceType Appliance type.
settingsManagementStatus Management status of the settings on the appliance. This attribute is also referred to as the synchronization status on the DataPower WebGUI.
firmwareManagementStatus Management status of the firmware on the appliance. This attribute is also referred to as the synchronization status on the DataPower WebGUI.
domainManagementStatus Management status of a specific domain on the appliance. This attribute is also referred to as the synchronization status on the DataPower WebGUI.
domainOperationalStatus Operational status of a specific domain on the appliance.
rollupManagementStatus 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 Aggregated operational status of the firmware, settings, and domains on the appliance.
serialNumber Serial number of the appliance of interest.
name Name of the appliance in the DataPower appliance manager.
userId User ID that the DataPower appliance manager uses to access the appliance.

Batch mode...

Interactive mode...

 

dpManageAppliance

Add the appliance to a managed set and 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...

Interactive mode...

 

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. 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...

Interactive mode...

 

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 value 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...

Interactive mode...

 

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

The command returns the task that the command creates.

Batch mode...

Interactive mode...

 

dpAddManagedSet

Adds 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...

Interactive mode...

 

dpGetAllManagedSetIds

Display the IDs of each DataPower appliance manager managed set.

Target object

None.

Return value

String array that contains each managed set ID.

Batch mode...

 

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 that contains the attributes for the managed set.

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

Batch mode...

Interactive mode...

 

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...

Interactive mode...

 

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...

Interactive mode...

 

dpSynchManagedSet

Manually synchronizes 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...

Interactive mode...

 

dpAddFirmwareVersion

Add a firmware version to the DataPower appliance manager.

Target object

None.

Required parameters

-file

File in the DataPower appliance manager file system that contains 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...

Interactive mode...

 

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...

 

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 that contains each firmware version in the configuration.

Batch mode...

Interactive mode...

 

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 that contains the IDs of the managed sets that use the firmware version of interest.

Batch mode...

Interactive mode...

 

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 that contains the attributes of the firmware.

Attribute Description
firmwareId Firmware ID.
applianceType Appliance type for which the firmware is used.
modelType Model type of the firmware.
strictFeatures Strict features for which the firmware is used.
nonStrictFeatures Non strict features for which the firmware is used.

Batch mode...

Interactive mode...

 

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 that contains the attributes of the firmware of interest.

Attribute Description
firmwareId Firmware ID.
applianceType Appliance type for which the firmware is used.
modelType Model type of the firmware.
strictFeatures Strict features for which the firmware is used.
nonStrictFeatures Non strict features for which the firmware is used.

Batch mode...

Interactive mode...

 

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

Properties object that contains the attributes of the firmware version.

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

Batch mode...

Interactive mode...

 

dpRemoveFirmwareVersion

Remove a firmware version from the DataPower appliance manager. The firmware that the system associates with the firmware version remains. Verify that a managed set is not currently using the firmware version to remove before you 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...

Interactive mode...

 

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...

Interactive mode...

 

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...

Interactive mode...

 

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

The command returns a string array of the names of the domains in the appliance.

Batch mode...

Interactive mode...

 

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 that contains the IDs of the domains in the managed set.

Batch mode...

Interactive mode...

 

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...

Interactive mode...

 

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

Properties object that contains the attributes for the managed set domain of interest.

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

Batch mode...

Interactive mode...

 

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 that contains the attributes of the managed set domain version of interest.

Attribute Description
msDomainVersionId ID of the managed domain version.
msDomainId ID of the managed domain.
versionNumber Version number.
timestamp Date that the system created the copy.
userComment Comment that is stored with the managed set domain version.
isInUse Displays whether the managed set uses the domain version for the domain.

Batch mode...

Interactive mode...

 

dpManageDomain

Add the domain to a managed set, and start 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

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...

Interactive mode...

 

dpRemoveMSDomainVersion

Remove 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...

Interactive mode...

 

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...

Interactive mode...

 

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...

Interactive mode...

 

dpUnmanageDomain

Remove the domain from a managed set, and stop 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 that the system creates.

Batch mode...

Interactive mode...

 

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...

Interactive mode...

 

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 that contains the IDs of the versions of the managed set settings of interest.

Batch mode...

Interactive mode...

 

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 that contains the attributes of the settings of interest.

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

Batch mode...

Interactive mode...

 

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 that contains the attributes of the managed set settings version of interest.

Attribute Description
msSetSettingsVersionId ID of the managed set settings version.
msSettingsId ID of the managed set settings of interest.
timestamp Date that the system created the copy.
versionNumber Number of the version.
userComment Comment associated with the managed set settings version.
isInUse ID of the settings version that the managed set uses.

Batch mode...

Interactive mode...

 

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...

Interactive mode...

 

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...

Interactive mode...

 

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...

Interactive mode...

 

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...

 

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 Unique ID of the task.
taskDescription Description of the task.
creationDate Date and time that the system created the task.
createdByUser User that created the task.
currentStep Current step number for the task.
currentStepDescription Displays a description of the current step.
currentStepTimestamp 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 Error message of the exception that caused the task to end, if applicable.
totalSteps 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 True if the task is not successfully completed.
hasUpdate True if the task is updated.
isComplete True if the task is complete.
taskStatus Displays 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 Result that the task returns. Refer to the specific command to determine if the command returns output.

Batch mode...

Interactive mode...

 

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...

Interactive mode...




Related concepts

WebSphere DataPower appliance manager overview

 

Related tasks

Set up the DataPower appliance manager using scripting
Copy DataPower appliance domains between managed sets using scripting
Updating firmware versions for DataPower appliances using scripting
Administer managed domains, firmware, and settings versions using scripting
Modify DataPower appliance manager settings