dpManagerCommands command group for the AdminTask object
You can use the Jython scripting language to configure the DataPower® appliance manager with the wsadmin tool. The IBM WebSphere® DataPower appliance manager provides a set of capabilities for managing DataPower appliances. Use the commands and parameters in the dpManagerCommands group to query, configure, and administer the DataPower appliance manager.
IBM® WebSphere® DataPower SOA Appliances are purpose-built, easy-to-deploy network devices that simplify, help secure, and accelerate your XML and web services deployments. The first time you use DataPower appliance manager, no appliances, managed sets, or firmware versions exist. You must create appliances, add firmware versions, and create managed sets.
Before you begin, verify that each appliance that you want 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.
dpExport
The dpExport command exports the DataPower appliance manager configuration and versions.
Target object
None.
Required parameters
- -file
- Specifies the local system file to which the DataPower appliance manager exports the configuration and versions. (String, required)
Return value
The command returns the ID of the task that the system creates.
Batch mode example usage
- Using Jython string:
AdminTask.dpExport('-file c:/temp/DPManager.export_doc')
AdminTask.dpExport('-file /temp/DPManager.export')
- Using Jython list:
AdminTask.dpExport(['-file', 'C:/temp/DPManager.export'])
AdminTask.dpExport(['-file', '/temp/DPManager.export'])
Interactive mode example usage
- Using Jython:
AdminTask.dpExport('-interactive')
dpGetManager
The dpGetManager command displays the properties of the DataPower appliance manager.
Target object
None.
Return value
The command returns a properties object that contains the current settings of the DataPower appliance manager.
Batch mode example usage
- Using Jython string and list:
AdminTask.dpGetManager()
dpGetManagerStatus
The dpGetManagerStatus command displays the status of the DataPower appliance manager.
Target object
None.
Return value
The command returns a description of the DataPower appliance manager status.
Batch mode example usage
- Using Jython string and list:
AdminTask.dpGetManagerStatus()
dpImport
The dpImport command imports 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
- Specifies the 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 example usage
- Using Jython string:
AdminTask.dpImport('-file c:/temp/DPManager.import')
AdminTask.dpImport('-file /temp/DPManager.import')
- Using Jython list:
AdminTask.dpImport(['-file', 'C:/temp/DPManager.export'])
AdminTask.dpImport(['-file', '/temp/DPManager.export'])
Interactive mode example usage
- Using Jython:
AdminTask.dpImport('-interactive')
dpSetManager
The dpSetManager command modifies the DataPower appliance manager configuration.
Target object
None.
Optional parameters
- -maxVersionsToStore
- Specifies the new maximum number of versions to keep. (Integer, optional)
- -versionsDirectory
- Specifies 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 you specify a value for the versionsDirectory parameter, the command returns the ID of the task that the command creates.
Batch mode example usage
- Using Jython string:
AdminTask.dpSetManager('-maxVersionsToStore 20 -versionsDirectory newDir')
- Using Jython list:
AdminTask.dpSetManager(['-maxVersionsToStore', '20', '-versionsDirectory', 'newDir'])
Interactive mode example usage
- Using Jython:
AdminTask.dpSetManager('-interactive')
dpStopManager
The dpStopManager command stops 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
- Using Jython string and list:
AdminTask.dpStopManager()
dpAddAppliance
The dpAddAppliance command adds an appliance to the DataPower appliance manager.
Target object
None.
Required parameters
- -hostname
- Specifies the host name or IP address of the appliance. (String, required)
- -hlmPort
- Specifies the port number that the DataPower appliance manager uses to communicate to the appliance. The default value is 5550. (Integer, required)
- -name
- Specifies the unique name of the appliance in the DataPower appliance manager. Do not specify the following characters within the name parameter: \\/,#$@:;\"*?<>|=+&%' (String, required)
- -userId
- Specifies the user ID that the DataPower appliance manager uses to access the appliance. (String, required)
- -password
- Specifies the 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 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 example usage
- Using Jython string:
AdminTask.dpAddAppliance('[-hostname myappliance.ibm.com –name myappliance -userId admin -password mypassword]')
- Using Jython list:
AdminTask.dpAddAppliance(['-hostname', 'myappliance.ibm.com', '–name', 'myappliance', '-userId', ' admin', '-password', 'mypassword'])
Interactive mode example usage
- Using Jython:
AdminTask.dpAddAppliance('-interactive')
dpGetAllApplianceIds
The dpGetAllApplianceIds command displays the ID of each DataPower appliance manager appliance.
Target object
None.
Return value
The command returns a string array that contains each appliance ID in your configuration. For appliances, the ID is the serial number of the DataPower appliance.
Batch mode example usage
- Using Jython string and list:
AdminTask.dpGetAllApplianceIds()
dpGetAllMSApplianceIds
The dpGetAllMSApplianceIds command displays the IDs of each appliance in a DataPower appliance manager managed set.
Target object
None.
Required parameters
- -managedSetId
- Specifies the ID of the managed set of interest. (String, required)
Return value
The command returns a string array that contains the IDs of the appliances in the managed set of interest.
Batch mode example usage
- Using Jython string:
AdminTask.dpGetAllMSApplianceIds('[-managedSetId myManagedSet]')
- Using Jython list:
AdminTask.dpGetAllMSApplianceIds(['-managedSetId', 'myManagedSet'])
Interactive mode example usage
- Using Jython:
AdminTask.dpGetAllMSApplianceIds('-interactive')
dpGetAppliance
The dpGetAppliance command displays a specific DataPower appliance manager appliance.
Target object
None.
Required parameters
- -applianceId
- Specifies the ID of the appliance in the DataPower appliance manager to display. (String, required)
Return value
[ [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 | Displays the ID of the appliance of interest. |
managedSetId | Displays 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 | Displays the 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 | Displays the appliance port for the DataPower WebGUI interface. |
hlmPort | Displays the port number for communication between the DataPower appliance manager and the appliance. |
hostname | Displays the host name or internet protocol (IP) address of the appliance. |
isManaged | Displays a value of true if the DataPower appliance manager manages the appliance. |
isMaster | Displays 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 | Displays the model type of the appliance. |
applianceType | Displays the appliance type. |
settingsManagementStatus | Displays the management status of the settings on the appliance. This attribute is also referred to as the synchronization status on the DataPower WebGUI. |
firmwareManagementStatus | Displays the management status of the firmware on the appliance. This attribute is also referred to as the synchronization status on the DataPower WebGUI. |
domainManagementStatus | Displays 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 | Displays the operational status of a specific domain on the appliance. |
rollupManagementStatus | Displays 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 | Displays the aggregated operational status of the firmware, settings, and domains on the appliance. |
serialNumber | Displays the serial number of the appliance of interest. |
name | Displays the name of the appliance in the DataPower appliance manager. |
userId | Displays the user ID that the DataPower appliance manager uses to access the appliance. |
Batch mode example usage
- Using Jython string:
AdminTask.dpGetAppliance('-applianceId "00605 20356"')
- Using Jython list:
AdminTask.dpGetAppliance(['-applianceId', '00605 20356'])
Interactive mode example usage
- Using Jython:
AdminTask.dpGetAppliance('-interactive')
dpManageAppliance
The dpManageAppliance command adds the appliance to a managed set and to start managing the appliance.
Target object
None.
Required parameters
- -managedSetId
- Specifies the ID of the managed set for which the appliance is a member. (String, required)
- -applianceId
- Specifies the 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
The command returns the 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
- Using Jython string:
AdminTask.dpManageAppliance('-managedSetId testMS1 -applianceId "00605 20351"')
- Using Jython list:
AdminTask.dpManageAppliance(['-managedSetId', 'testMS1', '-applianceId', '00605 20351'])
Interactive mode example usage
- Using Jython:
AdminTask.dpManageAppliance('-interactive')
dpRemoveAppliance
The dpRemoveAppliance command removes an appliance from the DataPower appliance manager. Also, the command removes the appliance from a managed set, if it is a member. You cannot remove an appliance that is a master in a managed set. You must select a different appliance as the master before removing a master appliance.
Target object
None.
Required parameters
- -applianceId
- Specifies the 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
- Using Jython string:
AdminTask.dpRemoveAppliance('[-applianceId "00605 20356"]')
- Using Jython list:
AdminTask.dpRemoveAppliance(['-applianceId', '00605 20356'])
Interactive mode example usage
- Using Jython:
AdminTask.dpRemoveAppliance('-interactive')
dpSetAppliance
The dpSetAppliance command modifies the DataPower appliance manager configuration for an appliance.
Target object
None.
Required parameters
- -applianceId
- Specifies the ID of the appliance in the DataPower appliance manager to modify. (String, required)
Optional parameters
- -hostname
- Specifies the host name or IP address of the appliance. (String, optional)
- -hlmPort
- Specifies the port number that the DataPower appliance manager uses to communicate to the appliance. The default value is 5550. (Integer, optional)
- -name
- Specifies the unique name of the appliance in the DataPower appliance manager. Do not specify the following characters within the name parameter: \\/,#$@:;\"*?<>|=+&%' (String, optional)
- -userId
- Specifies the user ID that the DataPower appliance manager uses to access the appliance. (String, optional)
- -password
- Specifies the 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
- Using Jython string:
AdminTask.dpSetAppliance('[-applianceId "00605 20356" -hostname myappliance2.ibm.com -name myappliance2 -hlmPort 4500 -userId admin2 -password myPassword]')
- Using Jython list:
AdminTask.dpSetAppliance(['-applianceId', '00605 20356', '-hostname', 'myappliance2.ibm.com', '-name', 'myappliance2', '-hlmPort', '4500', '-userId', 'admin2', '-password', 'myPassword'])
Interactive mode example usage
- Using Jython:
AdminTask.dpSetAppliance('-interactive')
dpUnmanageAppliance
The dpUnmanageAppliance command removes 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
- Specifies the ID of the managed set for which the appliance is a member. (String, required)
- -applianceId
- Specifies the 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 example usage
- Using Jython string:
AdminTask.dpUnmanageAppliance('[-managedSetId testMS1 -applianceId "00605 20351"]')
- Using Jython list:
AdminTask.dpUnmanageAppliance(['-managedSetId', 'testMS1', '-applianceId "00605 20351"'])
Interactive mode example usage
- Using Jython:
AdminTask.dpUnmanageAppliance('-interactive')
dpAddManagedSet
The dpAddManagedSet command adds a managed set to the DataPower appliance manager.
Target object
None.
Required parameters
- -name
- Specifies the 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
- Using Jython string:
AdminTask.dpAddManagedSet('-name testMS')
- Using Jython list:
AdminTask.dpAddManagedSet(['-name testMS'])
Interactive mode example usage
- Using Jython:
AdminTask.dpAddManagedSet('-interactive')
dpGetAllManagedSetIds
The dpGetAllManagedSetIds command displays the IDs of each DataPower appliance manager managed set.
Target object
None.
Return value
The command returns a string array that contains each managed set ID.
Batch mode example usage
- Using Jython string and list:
AdminTask.dpGetAllManagedSetIds()
dpGetManagedSet
The dpGetManagedSet command displays information for a specific DataPower appliance manager managed set.
Target object
None.
Required parameters
- -managedSetId
- Specifies the ID of the managed set of interest. (String, required)
Return value
Attribute | Description |
---|---|
managedSetId | Displays the ID of the managed set. |
masterApplianceId | Displays the ID of the master appliance of the managed set. |
desiredFirmwareVersionId | Displays the ID of the firmware version to use for the managed set. |
name | Displays the name associated with the managed set. |
rollupOperationalStatus | Displays the operational status of the managed set. |
rollupManagementStatus | Displays the management status of the managed set. |
settingsId | Displays the ID of the settings for the managed set. |
Batch mode example usage
- Using Jython string:
AdminTask.dpGetManagedSet('-managedSetId testMS1')
- Using Jython list:
AdminTask.dpGetManagedSet(['-managedSetId', 'testMS1'])
Interactive mode example usage
- Using Jython:
AdminTask.dpGetManagedSet('-interactive')
dpRemoveManagedSet
The dpRemoveManagedSet command removes a managed set from the DataPower appliance manager.
Target object
None.
Required parameters
- -managedSetId
- Specifies the ID of the managed set to remove. (String, required)
Return value
The command does not return output.
Batch mode example usage
- Using Jython string:
AdminTask.dpRemoveManagedSet('-managedSetId testMS')
- Using Jython list:
AdminTask.dpRemoveManagedSet(['-managedSetId', 'testMS'])
Interactive mode example usage
- Using Jython:
AdminTask.dpRemoveManagedSet('-interactive')
dpSetManagedSet
The dpSetManagedSet command modifies a DataPower appliance manager managed set.
Target object
None.
Required parameters
- -managedSetId
- Specifies the ID of the managed set to modify. (String, required)
Optional parameters
- -masterApplianceId
- Specifies the 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
- Specifies the 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
The command returns the ID of the task that the command creates.
Batch mode example usage
- Using Jython string:
AdminTask.dpSetManagedSet('-managedSetId myManagedSet -masterApplianceId "00605 20356"')
- Using Jython list:
AdminTask.dpSetManagedSet(['-managedSetId', 'myManagedSet', '-masterApplianceId', '"00605 20356"'])
Interactive mode example usage
- Using Jython:
AdminTask.dpSetManagedSet('-interactive')
dpSynchManagedSet
The dpSynchManagedSet command manually synchronizes a DataPower appliance manager managed set. The manager automatically attempts to synchronize the member devices.
Target object
None.
Required parameters
- -managedSetId
- Specifies the ID of the managed set to synchronize. (String, required)
Return value
The command returns the ID of the task that the command creates.
Batch mode example usage
- Using Jython string:
AdminTask.dpSynchManagedSet('-managedSetId myManagedSet')
- Using Jython list:
AdminTask.dpSynchManagedSet(['-managedSetId', 'myManagedSet'])
Interactive mode example usage
- Using Jython:
AdminTask.dpSynchManagedSet('-interactive')
dpAddFirmwareVersion
The dpAddFirmwareVersion command adds a firmware version to the DataPower appliance manager.
Target object
None.
Required parameters
- -file
- Specifies the file in the DataPower appliance manager file system that contains the firmware image to store in the firmware version. (String, required)
Optional parameters
- -userComment
- Specifies the comment to store in the firmware version. (String, optional)
Return value
The command returns the 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
- Using Jython string:
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"]')
- Using Jython list:
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"'])
Interactive mode example usage
- Using Jython:
AdminTask.dpAddFirmwareVersion('-interactive')
dpGetAllFirmwareIds
The dpGetAllFirmwareIds command displays the IDs of each DataPower appliance manager firmware in the configuration.
Target object
None.
Return value
The command returns a string array for each firmware ID in the DataPower appliance manager configuration.
Batch mode example usage
- Using Jython string and list:
AdminTask.dpGetAllFirmwareIds()
dpGetAllFirmwareVersionIds
The dpGetAllFirmwareVersionIds command displays 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
- Specifies the ID of the firmware to query. (String, required)
Return value
The command returns a string array that contains each firmware version in your configuration.
Batch mode example usage
- Using Jython string:
AdminTask.dpGetAllFirmwareVersionIds('-firmwareId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;"')
- Using Jython list:
AdminTask.dpGetAllFirmwareVersionIds(['-firmwareId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;'])
Interactive mode example usage
- Using Jython:
AdminTask.dpGetAllFirmwareVersionIds('-interactive')
dpGetAllMSIdsUsingFirmwareVersion
The dpGetAllMSIdsUsingFirmwareVersion command displays the IDs of the managed sets that use a firmware version.
Target object
None.
Required parameters
- -firmwareVersionId
- Specifies the ID of the firmware version of interest. (String, required)
Return value
The command returns a string array that contains the IDs of the managed sets that use the firmware version of interest.
Batch mode example usage
- Using Jython string:
AdminTask.dpGetAllMSIdsUsingFirmwareVersion('-firmwareVersionId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15"')
- Using Jython list:
AdminTask.dpGetAllMSIdsUsingFirmwareVersion(['-firmwareVersionId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15'])
Interactive mode example usage
- Using Jython:
AdminTask.dpGetAllMSIdsUsingFirmwareVersion('-interactive')
dpGetBestFirmware
The dpGetBestFirmware command displays 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
- Specifies the appliance type of the DataPower appliance for which to display the firmware. (String, required)
- -modelType
- Specifies the model type of the DataPower appliance for which to display the firmware. (String, required)
- -applianceFeatures
- Specifies the appliance features of the DataPower appliance for which to display the firmware. (String, required)
Optional parameters
- -level
- Specifies the level of the firmware version to contain in the returned firmware. (String, optional)
Return value
Attribute | Description |
---|---|
firmwareId | Displays the firmware ID. |
applianceType | Displays the appliance type for which the firmware is used. |
modelType | Displays the model type of the firmware. |
strictFeatures | Displays the strict features for which the firmware is used. |
nonStrictFeatures | Displays the non strict features for which the firmware is used. |
Batch mode example usage
- Using Jython string:
AdminTask.dpGetBestFirmware('-applianceType "XS40" -modelType "9002" -applianceFeatures "JAXP-API" -level "3.6.0.4"')
- Using Jython list:
AdminTask.dpGetBestFirmware(['-applianceType', 'XS40', '-modelType', '9002', '-applianceFeatures', 'JAXP-API', '-level', '3.6.0.4'])
Interactive mode example usage
- Using Jython:
AdminTask.dpGetBestFirmware('-interactive')
dpGetFirmware
The dpGetFirmware command displays attributes for a specific DataPower appliance manager firmware.
Target object
None.
Required parameters
- -firmwareId
- Specifies the ID of the firmware of interest. (String, required)
Return value
Attribute | Description |
---|---|
firmwareId | Displays the firmware ID. |
applianceType | Displays the appliance type for which the firmware is used. |
modelType | Displays the model type of the firmware. |
strictFeatures | Displays the strict features for which the firmware is used. |
nonStrictFeatures | Displays the non strict features for which the firmware is used. |
Batch mode example usage
- Using Jython string:
AdminTask.dpGetFirmware('-firmwareId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;"')
- Using Jython list:
AdminTask.dpGetFirmware(['-firmwareId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;'])
Interactive mode example usage
- Using Jython:
AdminTask.dpGetFirmware('-interactive')
dpGetFirmwareVersion
The dpGetFirmwareVersion command displays a specific DataPower appliance manager firmware version. A firmware version represents a firmware image that you can deploy to a DataPower appliance.
Target object
None.
Required parameters
- -firmwareVersionId
- Specifies the ID of the firmware version of interest. (String, required)
Return value
Attribute | Description |
---|---|
firmwareVersionId | Displays the ID of the firmware version. |
firmareId | Displays the ID of the firmware that contains the firmware version. |
level | Displays the level of the firmware. |
manufactureDate | Displays the date that the firmware was manufactured. |
timestamp | Displays the date that the firmware image was loaded to the DataPower appliance manager. |
userComment | Displays the comment stored with the firmware version. |
isInUse | Displays whether a managed set uses the firmware version. |
Batch mode example usage
- Using Jython string:
AdminTask.dpGetFirmwareVersion('-firmwareVersionId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15"')
- Using Jython list:
AdminTask.dpGetFirmwareVersion(['-firmwareVersionId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15'])
Interactive mode example usage
- Using Jython:
AdminTask.dpGetFirmwareVersion('-interactive')
dpRemoveFirmwareVersion
The dpRemoveFirmwareVersion command removes 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
- Specifies the ID of the firmware version to remove. (String, required)
Return value
The command does not return output.
Batch mode example usage
- Using Jython string:
AdminTask.dpRemoveFirmwareVersion('-firmwareVersionId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15"')
- Using Jython list:
AdminTask.dpRemoveFirmwareVersion(['-firmwareVersionId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15'])
Interactive mode example usage
- Using Jython:
AdminTask.dpRemoveFirmwareVersion('-interactive')
dpSetFirmwareVersion
The dpSetFirmwareVersion command modifies a DataPower appliance manager firmware version.
Target object
None.
Required parameters
- -firmwareVersionId
- Specifies the ID of the firmware version to modify. (String, required)
Optional parameters
- -userComment
- Specifies the comment to store in the firmware version. (String, optional)
Return value
The command does not return output.
Batch mode example usage
- Using Jython string:
AdminTask.dpSetFirmwareVersion('-firmwareVersionId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15" -userComment "new user comment"')
- Using 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
- Using Jython:
AdminTask.dpSetFirmwareVersion('-interactive')
dpCopyMSDomainVersion
The dpCopyMSDomainVersion command copies a DataPower appliance manager managed domain version to a new managed set.
Target object
None.
Required parameters
- -managedSetId
- Specifies the ID of the managed set of interest. (String, required)
- -msDomainVersionId
- Specifies the ID of the managed domain version to copy. (String, required)
Return value
The command returns the ID of the task that the command creates.
Batch mode example usage
- Using Jython string:
AdminTask.dpCopyMSDomainVersion('[-managedSetId myManagedSet -msDomainVersionId "myManagedSet:default:1"]')
- Using Jython list:
AdminTask.dpCopyMSDomainVersion(['-managedSetId', 'myManagedSet', '-msDomainVersionId', 'myManagedSet:default:1'])
Interactive mode example usage
- Using Jython:
AdminTask.dpCopyMSDomainVersion('-interactive')
dpGetAllDomainNames
The dpGetAllDomainNames command display the names of each of the domains on a DataPower appliance.
Target object
None.
Required parameters
- -applianceId
- Specifies the 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 you do not specify the managed or unmanaged parameters, or if you 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 you do not specify the managed or unmanaged parameters, or if you specify both parameters. (String, optional)
Return value
The command returns a string array of the names of the domains in the appliance.
Batch mode example usage
- Using Jython string:
AdminTask.dpGetAllDomainNames('[-applianceId "00605 20356" -managed -unmanaged]')
- Using Jython list:
AdminTask.dpGetAllDomainNames(['-applianceId', '00605 20356', '-managed', '-unmanaged'])
Interactive mode example usage
- Using Jython:
AdminTask.dpGetAllDomainNames('-interactive')
dpGetAllMSDomainIds
The dpGetAllMSDomainIds command displays the IDs of each domain in a DataPower appliance manager managed set.
Target object
None.
Required parameters
- -managedSetId
- Specifies the ID of the managed set of interest. (String, required)
Return value
The command returns a string array that contains the IDs of the domains in the managed set.
Batch mode example usage
- Using Jython string:
AdminTask.dpGetAllMSDomainIds('[-managedSetId myManagedSet]')
- Using Jython list:
AdminTask.dpGetAllMSDomainIds(['-managedSetId', 'myManagedSet'])
Interactive mode example usage
- Using Jython:
AdminTask.dpGetAllMSDomainIds('-interactive')
dpGetAllMSDomainVersionIds
The dpGetAllMSDomainVersionIds command displays the ID of each domain version for a domain in a DataPower appliance manager managed set.
Target object
None.
Required parameters
- -msDomainId
- Specifies the ID of the managed domain to display. (String, required)
Return value
The command returns the ID for each domain version that exists for the managed set domain.
Batch mode example usage
- Using Jython string:
AdminTask.dpGetAllMSDomainVersionIds('[-msDomainId ms1:domain1]')
- Using Jython list:
AdminTask.dpGetAllMSDomainVersionIds(['-msDomainId', 'ms1:domain1'])
Interactive mode example usage
- Using Jython:
AdminTask.dpGetAllMSDomainVersionIds('-interactive')
dpGetMSDomain
The dpGetMSDomain command displays a domain in a DataPower appliance manager managed set.
Target object
None.
Required parameters
- -msDomainId
- Specifies the ID of the managed domain to display. (String, required)
Return value
Attribute | Description |
---|---|
msDomainId | Displays the ID of the domain. |
managedSetId | Displays the ID of the managed set to which the domain belongs. |
name | Displays the name of the domain. |
desiredDomainVersionId | Displays the ID of the domain version that the managed set uses for the domain. |
Batch mode example usage
- Using Jython string:
AdminTask.dpGetMSDomain('[-msDomainId ms1:domain1]')
- Using Jython list:
AdminTask.dpGetMSDomain(['-msDomainId', 'ms1:domain1'])
Interactive mode example usage
- Using Jython:
AdminTask.dpGetMSDomain('-interactive')
dpGetMSDomainVersion
The dpGetMSDomainVersion command displays a DataPower appliance manager managed domain version.
Target object
None.
Required parameters
- -msDomainVersionId
- Specifies the ID of the managed domain version of interest. (String, required)
Return value
Attribute | Description |
---|---|
msDomainVersionId | Displays the ID of the managed domain version. |
msDomainId | Displays the ID of the managed domain. |
versionNumber | Displays the version number. |
timestamp | Displays the date that the system created the copy. |
userComment | Displays the 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 example usage
- Using Jython string:
AdminTask.dpGetMSDomainVersion('[-msDomainVersionId ms1:domain1:1]')
- Using Jython list:
AdminTask.dpGetMSDomainVersion(['-msDomainVersionId', 'ms1:domain1:1'])
Interactive mode example usage
- Using Jython:
AdminTask.dpGetMSDomainVersion('-interactive')
dpManageDomain
The dpManageDomain command adds the domain to a managed set, and starts managing the domain.
Target object
None.
Required parameters
- -managedSetId
- Specifies the ID of the managed set to manage. (String, required)
- -domain
- Specifies the name of the domain on the master appliance to manage. (String, required)
Return value
The command returns 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
- Using Jython string:
AdminTask.dpManageDomain('[-managedSetId testMS1 -domain default]')
- Using Jython list:
AdminTask.dpManageDomain(['-managedSetId', 'testMS1', '-domain', 'default'])
Interactive mode example usage
- Using Jython:
AdminTask.dpManageDomain('-interactive')
dpRemoveMSDomainVersion
The dpRemoveMSDomainVersion command removes a managed domain version from the DataPower appliance manager.
Target object
None.
Required parameters
- -msDomainVersionId
- Specifies the ID of the managed domain version to remove. (String, required)
Return value
The command does not return output.
Batch mode example usage
- Using Jython string:
AdminTask.dpRemoveMSDomainVersion('[-msDomainVersionId ms1:domain1:1]')
- Using Jython list:
AdminTask.dpRemoveMSDomainVersion(['-msDomainVersionId', 'ms1:domain1:1'])
Interactive mode example usage
- Using Jython:
AdminTask.dpRemoveMSDomainVersion('-interactive')
dpSetMSDomain
The dpSetMSDomain command modifies a DataPower appliance manager managed domain.
Target object
None.
Required parameters
- -msDomainId
- Specifies the ID of the managed domain to modify. (String, required)
Optional parameters
- -desiredDomainVersionId
- Specifies the ID of the domain version to synchronize to each appliance in the managed set. (String, optional)
Return value
The command returns the ID of the task that the command creates.
Batch mode example usage
- Using Jython string:
AdminTask.dpSetMSDomain('[-msDomainId ms1:domain1 -desiredDomainVersionId ms1:domain1:1]')
- Using Jython list:
AdminTask.dpSetMSDomain(['-msDomainId', 'ms1:domain1', '-desiredDomainVersionId', 'ms1:domain1:1'])
Interactive mode example usage
- Using Jython:
AdminTask.dpSetMSDomain('-interactive')
dpSetMSDomainVersion
The dpSetMSDomainVersion command modifies a DataPower appliance manager managed domain version.
Target object
None.
Required parameters
- -msDomainVersionId
- Specifies the ID of the managed domain version to modify. (String, required)
Optional parameters
- -userComment
- Specifies the comment to store in the domain version. (String, optional)
Return value
The command does not return output.
Batch mode example usage
- Using Jython string:
AdminTask.dpSetMSDomainVersion('[-msDomainVersionId ms1:domain1:2 -userComment "New Web Service proxy for banking application"]')
- Using Jython list:
AdminTask.dpSetMSDomainVersion(['-msDomainVersionId', 'ms1:domain1:2', '-userComment', 'New web service proxy for banking application'])
Interactive mode example usage
- Using Jython:
AdminTask.dpSetMSDomainVersion('-interactive')
dpUnmanageDomain
The dpUnmanageDomain command removes the domain from a managed set, and stops managing the domain.
Target object
None.
Required parameters
- -msDomainId
- Specifies the 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 you specify the clean parameter, the command returns the ID of the task that the system creates.
Batch mode example usage
- Using Jython string:
AdminTask.dpUnmanageDomain('-msDomainId testMS1:default -clean')
- Using Jython list:
AdminTask.dpUnmanageDomain(['-msDomainId', 'testMS1:default', '-clean'])
Interactive mode example usage
- Using Jython:
AdminTask.dpUnmanageDomain('-interactive')
dpCopyMSSettingsVersion
The dpCopyMSSettingsVersion command copies a DataPower appliance manager managed settings version to a new managed set.
Target object
None.
Required parameters
- -managedSetId
- Specifies the ID of the managed set of interest. (String, required)
- -msSettingsVersionId
- Specifies the ID of the managed settings version to copy. (String, required)
Return value
The command returns the ID of the task that the command creates.
Batch mode example usage
- Using Jython string:
AdminTask.dpCopyMSSettingsVersion('[-managedSetId myManagedSet -msSettingsVersionId "myManagedSet1:1"]')
- Using Jython list:
AdminTask.dpCopyMSSettingsVersion(['-managedSetId', 'myManagedSet', ,-msSettingsVersionId', 'myManagedSet1:1'])
Interactive mode example usage
- Using Jython:
AdminTask.dpCopyMSSettingsVersion('-interactive')
dpGetAllMSSettingsVersionIds
The dpGetAllMSSettingsVersionIds command displays the IDs of each settings version in a DataPower appliance manager managed set.
Target object
None.
Required parameters
- -msSettingsId
- Specifies the ID of the managed settings of interest. (String, required)
Return value
The command returns a string array that contains the IDs of the versions of the managed set settings of interest.
Batch mode example usage
- Using Jython string:
AdminTask.dpGetAllMSSettingsVersionIds('-msSettingsId ms1:2')
- Using Jython list:
AdminTask.dpGetAllMSSettingsVersionIds(['-msSettingsId', 'ms1:2'])
Interactive mode example usage
- Using Jython:
AdminTask.dpGetAllMSSettingsVersionIds('-interactive')
dpGetMSSettings
The dpGetMSSettings command displays the ID of the managed set to which the settings belong.
Target object
None.
Required parameters
- -msSettingsId
- Specifies the ID of the managed settings of interest. (String, required)
Return value
Attribute | Description |
---|---|
msSettingsId | Displays the ID of the settings. |
managedSetId | Displays the ID of the managed ID to which the settings are assigned. |
desiredSettingsVersionId | Displays the ID of the settings version that the managed set uses. |
Batch mode example usage
- Using Jython string:
AdminTask.dpGetMSSettings('-msSettingsId ms1:2')
- Using Jython list:
AdminTask.dpGetMSSettings(['-msSettingsId', 'ms1:2'])
Interactive mode example usage
- Using Jython:
AdminTask.dpGetMSSettings('-interactive')
dpGetMSSettingsVersion
The dpGetMSSettingsVersion command displays a DataPower appliance manager managed settings version.
Target object
None.
Required parameters
- -msSettingsVersionId
- Specifies the ID of the managed settings version of interest. (String, required)
Return value
Attribute | Description |
---|---|
msSetSettingsVersionId | Displays the ID of the managed set settings version. |
msSettingsId | Displays the ID of the managed set settings of interest. |
timestamp | Displays the date that the system created the copy. |
versionNumber | Displays the number of the version. |
userComment | Displays the comment associated with the managed set settings version. |
isInUse | Displays the ID of the settings version that the managed set uses. |
Batch mode example usage
- Using Jython string:
AdminTask.dpGetMSSettingsVersion('-msSettingsVersionId ms1:2')
- Using Jython list:
AdminTask.dpGetMSSettingsVersion(['-msSettingsVersionId', 'ms1:2'])
Interactive mode example usage
- Using Jython:
AdminTask.dpGetMSSettingsVersion('-interactive')
dpRemoveMSSettingsVersion
The dpRemoveMSSettingsVersion command removes a managed settings version from the DataPower appliance manager.
Target object
None.
Required parameters
- -msSettingsVersionId
- Specifies the ID of the managed settings version to remove. (String, required)
Return value
The command does not return output.
Batch mode example usage
- Using Jython string:
AdminTask.dpRemoveMSSettingsVersion('-msSettingsVersionId ms1:2')
- Using Jython list:
AdminTask.dpRemoveMSSettingsVersion(['-msSettingsVersionId', 'ms1:2'])
Interactive mode example usage
- Using Jython:
AdminTask.dpRemoveMSSettingsVersion('-interactive')
dpSetMSSettings
The dpSetMSSettings command modifies the DataPower appliance manager managed settings.
Target object
None.
Required parameters
- -msSettingsId
- Specifies the ID of the managed settings to modify. (String, required)
Optional parameters
- -desiredSettingsVersionId
- Specifies the ID of the settings version to synchronize to each appliance in the managed set. (String, optional)
Return value
The command returns the ID of the task that the command creates.
Batch mode example usage
- Using Jython string:
AdminTask.dpSetMSSettings('-msSettingsId ms1 -desiredSettingsVersionId ms1:1')
- Using Jython list:
AdminTask.dpSetMSSettings(['-msSettingsId', 'ms1', '-desiredSettingsVersionId', 'ms1:1'])
Interactive mode example usage
- Using Jython:
AdminTask.dpSetMSSettings('-interactive')
dpSetMSSettingsVersion
The dpSetMSSettingsVersion command modifies a DataPower appliance manager managed settings version.
Target object
None.
Required parameters
- -msSettingsVersionId
- Specifies the ID of the managed settings version to modify. (String, required)
Optional parameters
- -userComment
- Specifies the comment to store in the settings version. (String, optional)
Return value
The command does not return output.
Batch mode example usage
- Using Jython string:
AdminTask.dpSetMSSettingsVersion('[-msSettingsVersionId ms1:2 -userComment "has new timeserver added"]')
- Using Jython list:
AdminTask.dpSetMSSettingsVersion(['-msSettingsVersionId', 'ms1:2', '-userComment', 'has new timeserver added'])
Interactive mode example usage
- Using Jython:
AdminTask.dpSetMSSettingsVersion('-interactive')
dpGetAllTaskIds
The dpGetAllTaskIds command displays the IDs of each of the DataPower appliance manager tasks.
Target object
None.
Return value
The command returns a list of each asynchronous task ID that currently exists in the DataPower applance manager.
Batch mode example usage
- Using Jython string and list:
AdminTask.dpGetAllTaskIds()
dpGetTask
The dpGetTask command displays information for a specific DataPower appliance manager task.
Target object
None.
Required parameters
- -taskId
- Specifies the ID of the task of interest. (String, required)
Return value
Attribute | Description |
---|---|
taskId | Displays the unique ID of the task. |
taskDescription | Displays a description of the task. |
creationDate | Displays the date and time that the system created the task. |
createdByUser | Displays the user that created the task. |
currentStep | Displays the current step number for the task. |
currentStepDescription | Displays a description of the current step. |
currentStepTimestamp | Displays 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 | Displays the error message of the exception that caused the task to end, if applicable. |
totalSteps | Displays 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 | Displays a value of true if the task is not successfully completed. |
hasUpdate | Displays a value of true if the task is updated. |
isComplete | Displays a value of 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 | Displays the result that the task returns. Refer to the specific command to determine if the command returns output. |
Batch mode example usage
- Using Jython string:
AdminTask.dpGetTask('-taskId 1')
- Using Jython list:
AdminTask.dpGetTask(['-taskId', '1'])
Interactive mode example usage
- Using Jython:
AdminTask.dpGetTask('-interactive')
dpPurgeTask
The dpPurgeTask command purges a specific DataPower appliance manager task. The system automatically deletes tasks after 24 hours.
Target object
None.
Required parameters
- -taskId
- Specifies the 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
- Using Jython string:
AdminTask.dpPurgeTask('-taskId 1')
- Using Jython list:
AdminTask.dpPurgeTask(['-taskId', '1'])
Interactive mode example usage
- Using Jython:
AdminTask.dpPurgeTask('-interactive')