Use the wsadmin tool to update firmware for appliances within a
managed set. Firmware version files from the manufacturer are specific to
device types, model types, and libraries for features.
Before you begin
Before you begin, set up the DataPower® appliance manager by adding
and configuring appliances and managed sets.
About this task
This topic provides an example for updating the firmware for multiple
appliances that the DataPower appliance manager administers within
a managed set. The appliances of interest are members of the testSet managed
set. When updating the firmware on a managed set that manages multiple appliances,
the system deploys the firmware version to the master appliance and then sequentially
to each appliance in the managed set.
To view additional information
and examples for the commands in this topic, refer to the documentation for
the dpManagerCommands command group for the AdminTask object.
Procedure
- wsadmin 스크립트 도구를 시작하십시오.
- Determine the IDs of the managed sets.
Use the dpGetAllManagedSetIDs
command to display the IDs of each managed set in the DataPower appliance manager configuration,
as the following command demonstrates:
AdminTask.dpGetAllManagedSetIds()
You
can optionally use the dpGetManagedSet command to display attributes for a
given specific managed set ID, as the following example demonstrates:
AdminTask.dpGetManagedSet('-managedSetId testSet')
- Determine the firmware version to deploy to each managed set.
You can use the DataPower appliance manager to deploy a new firmware
version in your configuration or to revert to a previous firmware version
that exist in your configuration.
- Verify that the system added the new firmware version to the DataPower appliance
manager.
Use the getTask command to determine if the task is
complete, as the following example demonstrates:
AdminTask.dpGetTask('-taskId '+addFirmwareTask)
The command returns information about
the asynchronous task of interest. The isComplete attribute displays
a value of true if the task is complete. If it is not complete, note
the value for the taskStatus attribute. 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.
- Deploy the firmware version
After the system adds
the firmware version to the DataPower appliance manager, use the dpSetManagedSet
command to assign the firmware version to the managed set. The following example
assigns the newly downloaded firmware version to the test environment managed
set:
FVTask=AdminTask.dpSetManagedSet('-managedSetId testSet -desiredFirmwareVersionId '+testFirmwareVersionID)
The command submits the tasks to the DataPower appliance
manager and assigns the task identifiers to the corresponding variables. Deploying
a firmware can take several minutes and will result in the appliance being
restarted to run the new firmware version.
- Verify that the system successfully assigned the new firmware versions
to the managed sets.
Use the getTask command to determine if
the task is complete, as the following example demonstrates:
AdminTask.dpGetTask('-taskId '+FVTask)
The command returns information about
the asynchronous task of interest. The isComplete attribute displays
a value of true if the task is complete. If it is not complete, note
the value for the taskStatus attribute. 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.
- Optional: Remove the firmware version that the system
replaced from the DataPower appliance manager.
If you
do not want to keep a copy of the previous firmware version on the DataPower appliance
manager, remove the firmware version from your configuration. You might want
to keep the previous two firmware versions in case you need to revert to the
previous version.
Use the dpRemoveFirmwareVersion command to remove
the firmware version that the managed set no longer uses. You can not remove
firmware versions that are assigned to managed sets. The following example
removes the firmware version from the DataPower appliance manager:
AdminTask.dpRemoveFirmwareVersion('-firmwareVersionId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.13"')
Results
The managed set uses the new firmware version.
What to do next
You can use the wsadmin tool to manage appliances, firmware, domains,
managed sets, and appliance-specific settings. Additionally, the system creates
versions of domains, firmware, and appliance-specific settings. You can use
the wsadmin tool to modify the current version, or to revert to previous versions
of domains, firmware, and appliance-specific settings.