LPARConfigurationScript Specification, Version 10

About the LPARConfigurationScript specification

Following is the specification for LPARConfigurationScript. It defines the tags used for the client to talk to the host and tags used by the host to return information to the client. In order to complete this communication, many sub tags have been defined. These include Info which only gives information about the LPAR configuration, Action which changes the LPAR configuration, and Status, which gives information about actions the client requested to be performed. For an introduction to using XML, see Introduction to using Hardware Configuration Markup Languages.

For the LPARConfigurationScript DTD, see LPARConfigurationScript DTD.


Message IDs

All tags have associated Message IDs that they may generate. A description of these MessageID's can be found at the end of this document. Any subtag may generate any of it's parents MessageID's. That is, if LPARConfigurationScript generates 80, then any subtags may also generate 80.

 
LPARConfigurationScript
 
Tag Format:
<LPARConfigurationScript
     DTDVersion="integer"
     Error="Internal|Validation|Parsing">
  .
  <Info . . . >
  .
  <Action . . . >
  .
  <Status . . . >
  .
  <Message . . . >
  .
</LPARConfigurationScript>
 
Usage:
This is the basic tag for LPAR configuration requests. A client can do the following using LPARConfigurationScript: Request information about the current LPAR configuration using an Info tag, make changes to the LPAR configuration using an Action tag, or request status on the actions which were requested using the Status tag. The server will then return information about the LPAR configuration using the Info tag, tell if an action(s) were successfully submitted using the Action tag, or return the status of an action using the Status tag.
 
Attribute Condition Description
DTDVersion (integer) Required Tells the version of the LPARConfigurationScript being used. This value will be 1 for the first release, and every change to the DTD will cause this version to be incremented. Every version will be upward compatible, so a server running DTDVersion 10 will also be able to process scripts having DTD versions 1-9.

Error (Internal|Parsing|Validation) Optional This attribute is used the tell if there was an internal, validation, or Parsing error of the LPARConfigurationScript. Internal means that a major problem occurred while trying to process the script and a service representative should be contacted. A parsing error means that the script was not correct XML form, such as a new tag was started before the previous one was closed. A validation error means that the script was in correct form, but something about one of the requests was invalid. This is an output only attribute which is only returned if an error occurs.
 
Sub Tag(s) Condition Description
Info Optional, Can Repeat Information about the LPAR configuration. No LPAR changes are made within these tags.

Action Optional, Can Repeat Actions which are performed on the LPAR configuration to change the configuration.

Status Optional, Can Repeat Status about changes made to the LPAR configuration since the last IPL.

Message Optional, Can Repeat This is an output only tag which can be used to return messages, such as whether the system supports LPAR or not.
 
Message IDs (hexadecimal)
70, 71, 78, 79, 80, 81, 88, 89, FF, 100100
 
Info
 
Tag Format:
<Info
     LPARConfigurationID="string">
  .
  <PartitionInfo . . . >
  .
  <SystemInfo . . . >
  .
  <IOResourcesInfo . . . >
  .
  <ProcessorPoolInfo . . . >
  .
  <LPARConfigurationData . . . > (DTDVersion = 10)
  .
  <Message . . . >
  .
</Info>
 
Usage:
This tag is used to get information about the LPAR configuration of a system. It can return information about partition(s), the system, I/O resources, and processor pool(s).
 
Attribute Condition Description
LPARConfigurationID (string) Optional This can be used to tell if the LPAR configuration has changed between requests. If this string differs from a string received previously, then the LPAR configuration has changed.
 
Sub Tag(s) Condition Description
PartitionInfo Optional, Can Repeat Used to request information about one or more partitions on the system.

SystemInfo Optional, Can Repeat Used to request information about the system as a whole.

IOResourcesInfo Optional, Can Repeat Used to request information about the I/O resources on the system or owned by a partition.

ProcessorPoolInfo Optional, Can Repeat Used to request information about the processor pools on the system.

Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
Message IDs (hexadecimal)
No new message IDs that the parent tags cannot also return.
 
Info: PartitionInfo
 
Tag Format:
<PartitionInfo
     Format="All|Basic|General|Communications|
             ProcessorPools|Processors|MainStorage|
             InteractivePerformance|IOResources|
             SRCHistory|GuestEnvironment (DTDVersion = 10)|
             TCPIPAddress">

     SRCHistoryDetailLevel="integer"

     SRCHistoryEntries="integer"
  .
  <Partition . . . >
  .
  <PartitionFilter . . . >
  .
  <Message . . . >
  .
</PartitionInfo>
 
Usage:
This tag is used by the client to request information about one or more partitions and to tell the server how to format this information. The server will return the information using this same tag, but all of the requested information about the partition will be filled in.
 
Attribute(s) Condition Description
Format (enumeration) Optional Specifies what information to return for each partition. If this attribute is not specified, then all information will be returned. Possible values are: All| Basic| General| Communications| ProcessorPools| Processors| MainStorage| InteractivePerformance| IOResources| SRCHistory| GuestEnvironment| TCPIPAddress. To determine what information each format returns, look at the Partition tag. Regardless of which format is specified, the Basic information is always returned. For the format 'All', all information about the partition is returned.

SRCHistoryDetailLevel Optional Specifies how many words to display of an SRC entry. Valid values are 1 through 9, which display up to words 11 through 19 respectively. For example, specifying the SRCHistoryDetailLevel to be 3 will return words 11, 12, and 13 for each SRC entry returned.

SRCHistoryEntries Optional Specifies how many SRC entries to return. Valid values are positive integers. If the value specified for SRCHistoryEntries is larger than the number of entries available, all available entries are returned.
 
Sub Tag(s) Condition Description
Partition Optional, Can Repeat The partition for which information is needed.

PartitionFilter Optional, Can Repeat Used in place of a Partition tag when requesting information. It is used to request information about all partitions which match a certain criteria.

Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
Message IDs (hexadecimal)
No new message IDs that the parent tags cannot also return.
 
Partition
 
Tag Format:
<Partition

  Basic Format Attributes:

     PartitionID="integer"
     PartitionName="string"

  General Format Attributes:

     PartitionType="Primary|Secondary"
     State="On|PoweringOn|Off|PoweringOff|
            Failed|UnitAttention|Error|
            New|Unknown"
     SerialNumber="string"
     LICVRM="string"
     HypervisorDelta="integer"
     IPLSource="A|B|C|D|Unknown"
     IPLMode="Manual|Normal|Automatic|Secure|Unknown"
     SystemIPLAction="IPL|Hold"
     IPLChanges="Pending|None"
     FunctionalConfiguration="Yes|No"
     PointerTagsInactive="Yes|No"

  Communications Format Attributes:

     HighSpeedLinkPool="integer"
     VirtualOptiConnectPool="integer"
     VirtualLANField="bitfield"

  ProcessorPools Format Attributes:

     ProcessorPoolID="integer"
     ProcessorPoolIDPending="integer"

  Processors Format Attributes:

     ProcessorType="Physical|Virtual"
     ProcessorTypePending="Physical|Virtual"
     PhysicalProcessors="integer"
     PhysicalProcessorsPending="integer"
     PhysicalProcessorsMin="integer"
     PhysicalProcessorsMinFunctional="integer"
     PhysicalProcessorsMinPending="integer"
     PhysicalProcessorsMax="integer"
     PhysicalProcessorsMaxPending="integer"
     VirtualProcessors="integer"
     VirtualProcessorsPending="integer"
     VirtualProcessorsMin="integer"
     VirtualProcessorsMinFunctional="integer"
     VirtualProcessorsMinPending="integer"
     VirtualProcessorsMax="integer"
     VirtualProcessorsMaxPending="integer"
     ProcessingUnits="float"
     ProcessingUnitsPending="float"
     ProcessingUnitsMin="float"
     ProcessingUnitsMinFunctional="float"
     ProcessingUnitsMinPending="float"
     ProcessingUnitsMax="float"
     ProcessingUnitsMaxPending="float"

  MainStorage Format Attributes:

     MainStorage="integer"
     MainStoragePending="integer"
     MainStorageMin="integer"
     MainStorageMinFunctional="integer"
     MainStorageMinPending="integer"
     MainStorageMinRuntime="integer"
     MainStorageMax="integer"
     MainStorageMaxPending="integer"
     MainStorageReserved="integer"
     MainStorageReservedPending="integer"

  InteractivePerformance Format Attributes:

     InteractivePerformance="integer"
     InteractivePerformancePending="integer"
     InteractivePerformanceMin="integer"
     InteractivePerformanceMinFunctional="integer"
     InteractivePerformanceMinPending="integer"
     InteractivePerformanceMax="integer"
     InteractivePerformanceMaxPending="integer"

  IOResources Format Attributes:

     LoadSourceIOP="integer"
     AlternateIPLSourceIOP="integer"
     WorkstationConsoleIOP="integer"
     AlternateWorkstationConsoleIOP="integer"
     ElectronicCustomerSupportIOP="integer"

  SRCHistory Format Attributes:

     SRCHistoryEntriesTotal="integer"

  GuestEnvironment Format Attributes: (DTDVersion = 10)

     HostPartitionID="integer"
     IPLSourceAParameters="hexadecimal"
     IPLSourceBParameters="hexadecimal"
     IPLSourceCParameters="hexadecimal"
     IPLSourceDParameters="hexadecimal">
  .

 SRCHistory Format Sub Tags:

  <SRC . . . >
  .

 TCPIPAddress Format Sub Tags:

  <TCPIPAddress . . . >
  .

  <Message . . . >
  .

</Partition>
 
Usage:
This tag and its sub tags are used to return information about a partition.
 
Attribute Condition Description
PartitionID (integer) Required Number assigned to the partition. This value can range from 0 to 31, if the hardware supports 32 partitions.

PartitionName (string) Optional Name assigned to the partition. This value can range from 1 to 8 characters in length, and must be different than the name of any other partition on the system.

PartitionType (Primary|Secondary) Optional The type of partition, whether it is a primary or secondary partition.

State (enumeration) Optional State that the partition is in. Possible values: On| PoweringOn| Off| PoweringOff| Failed| UnitAttention| Error| New| Unknown. See table below for more information about these states.

SerialNumber (string) Optional The serial number of the partition.

LICVRM (string) Optional The version, release, and modification of the Licensed Internal Code of the partition. The string is in the form of VvRrMm where the v is the version, r is the release, and m is the modification.

HypervisorDelta (integer) Optional Tells how much the PLIC of the partition differs from the PLIC of the primary partition.

IPLSource (A|B|C|D|Unknown) Optional Tells the source which will be used the next time the partition is IPLed.

IPLMode (Manual|Normal|Automatic|Secure|Unknown) Optional Tells the IPL mode that the partition is in.

SystemIPLAction (IPL|Hold) Optional This is used to signify if the partition will IPL when the system IPLs or not. The primary is always set to IPL, all other partitions can either IPL with the system or wait to be manually IPLed.

IPLChanges (Pending|None) Optional Tells if there are partition configuration changes that will take effect on the next time the partition or the system is IPLed.

FunctionalConfiguration (Yes|No) Optional Yes if the partition has enough resources to be functional, No otherwise.

PointerTagsInactive (Yes|No) Optional State of the pointer tags bit on the processors. "No" partition is running an operating system which honors the pointer tag bit (such as i5/OS), "Yes" if the partition is running an operating system which ignores this bit.

HighSpeedLinkPool (integer) Optional The high speed link pool which the partition is in. The valid values are 0 which means that it isn't using high speed link, and 1 which means it is using high speed link.

VirtualOptiConnectPool (integer) Optional The virtual opticonnect pool which the partition is in. The valid values are 0 which means that it isn't using virtual opticonnect, and 1 which means it is using virtual opticonnect.

VirtualLANField (bitfield) Optional The virtual LAN field tells which LAN connections the partition supports. This bit field is made up of four hex digits, such as 8F2B. Each bit represents a different LAN ID, with 0 being the left most bit. In the case listed above, this partition would be communicating on the following LAN IDs: 0, 4, 5, 6, 7, 10, 12, 14, and 15.

ProcessorPoolID (integer) Optional Processor pool that the partition is currently using. This will not be returned if the partition is not using a processor pool. The only valid processor pool ID is 0 in V5R1.

ProcessorPoolIDPending (integer) Optional Processor pool that the partition will be using after the next IPL. This will not be returned if the partition is not using a processor pool. The only valid processor pool ID is 0 in V5R1.

ProcessorType (Physical|Virtual) Optional Type of processors the partition has.

ProcessorTypePending (Physical|Virtual) Optional Type of processors the partition will have after next IPL.

PhysicalProcessors (integer) Optional Current number of physical processors.

PhysicalProcessorsPending (integer) Optional Number of physical processors after next IPL.

PhysicalProcessorsMin (integer) Optional Minimum number of physical processors.

PhysicalProcessorsMinFunctional (integer) Optional Minimum number of physical processors needed for the partition to be functional.

PhysicalProcessorsMinPending (integer) Optional Minimum number of physical processors after the next IPL.

PhysicalProcessorsMax (integer) Optional Maximum number of physical processors.

PhysicalProcessorsMaxPending (integer) Optional Maximum number of physical processors after next IPL.

VirtualProcessors (integer) Optional Current number of virtual processors.

VirtualProcessorsPending (integer) Optional Number of virtual processors after next IPL.

VirtualProcessorsMin (integer) Optional Minimum number of virtual processors.

VirtualProcessorsMinFunctional (integer) Optional Minimum number of virtual processors needed for the partition to be functional.

VirtualProcessorsMinPending (integer) Optional Minimum number of virtual processors after the next IPL.

VirtualProcessorsMax (integer) Optional Maximum number of virtual processors.

VirtualProcessorsMaxPending (integer) Optional Maximum number of virtual processors after next IPL.

ProcessingUnits (float) Optional Current number of processing units. This value has a precision of 2 decimal places.

ProcessingUnitsPending (float) Optional Number of processing units after next IPL. This value has a precision of 2 decimal places.

ProcessingUnitsMin (float) Optional Minimum number of processing units. This value has a precision of 2 decimal places.

ProcessingUnitsMinFunctional (float) Optional Minimum number of processing units needed for this partition to be functional. This value has a precision of 2 decimal places.

ProcessingUnitsMinPending (float) Optional Minimum number of processing units after the next IPL. This value has a precision of 2 decimal places.

ProcessingUnitsMax (float) Optional Maximum number of processing units. This value has a precision of 2 decimal places.

ProcessingUnitsMaxPending (float) Optional Maximum number of processing units after next IPL. This value has a precision of 2 decimal places.

MainStorage (integer) Optional Current amount of main storage(MB).

MainStoragePending (integer) Optional Amount of main storage(MB) after next IPL.

MainStorageMin (integer) Optional Minimum amount of main storage(MB).

MainStorageMinFunctional (integer) Optional Minimum amount of main storage(MB) needed for this partition to be functional.

MainStorageMinPending (integer) Optional Minimum amount of main storage(MB) after next IPL.

MainStorageMinRuntime (integer) Optional Minimum amount of main storage(MB) that doesn't require an IPL.

MainStorageMax (integer) Optional Maximum amount of main storage(MB).

MainStorageMaxPending (integer) Optional Maximum amount of main storage(MB) after the next IPL.

MainStorageReserved (integer) Optional Amount of main storage which is reserved because the current main storage is less than the maximum main storage.

MainStorageReservedPending (integer) Optional Amount of main storage which will be reserved next IPL because the current main storage is less than the maximum main storage.

InteractivePerformance (integer) Optional Current amount of interactive performance(% of system).

InteractivePerformancePending (integer) Optional Amount of interactive performance(% of system) after next IPL.

InteractivePerformanceMin (integer) Optional Minimum amount of interactive performance(% of system).

InteractivePerformanceMinFunctional (integer) Optional Minimum amount of interactive performance(% of system) needed for the partition to be functional.

InteractivePerformanceMinPending (integer) Optional Minimum amount of interactive performance(% of system) after next IPL.

InteractivePerformanceMax (integer) Optional Maximum amount of interactive performance(% of system).

InteractivePerformanceMaxPending (integer) Optional Maximum amount of interactive performance(% of system) after the next IPL.

LoadSourceIOP (integer) Optional System resource ID of the IOP which contains the load source of the partition. The system resource ID is used by LPAR to uniquely identify an I/O resource on the system.

AlternateIPLSourceIOP (integer) Optional System resource ID of the IOP which contains the alternate IPL source of the partition. The system resource ID is used by LPAR to uniquely identify an I/O resource on the system.

WorkstationConsoleIOP (integer) Optional System resource ID of the IOP which contains the workstation console of the partition. The system resource ID is used by LPAR to uniquely identify an I/O resource on the system.

AlternateWorkstationConsoleIOP (integer) Optional System resource ID of the IOP which contains the alternate workstation console of the partition. The system resource ID is used by LPAR to uniquely identify an I/O resource on the system.

ElectronicCustomerSupportIOP (integer) Optional System resource ID of the IOP which contains the default electronic customer support device of the partition. The system resource ID is used by LPAR to uniquely identify an I/O resource on the system.

SRCHistoryEntriesTotal (integer) Optional Number of SRCs which have been kept in the SRC history for this partition.

HostPartitionID (integer) Optional Partition ID of the hosting i5/OS partition for this guest partition. (DTDVersion = 10)

IPLSourceAParameters (hexadecimal) Optional The guest partition command line parameters for an A side IPL. (DTDVersion = 10)

IPLSourceBParameters (hexadecimal) Optional The guest partition command line parameters for a B side IPL. (DTDVersion = 10)

IPLSourceCParameters (hexadecimal) Optional The guest partition command line parameters for a C side IPL. (DTDVersion = 10)

IPLSourceDParameters (hexadecimal) Optional The guest partition command line parameters for a D side IPL. (DTDVersion = 10)
 
Sub Tag(s) Condition Description
SRC Optional, Can Repeat SRC which has been logged for this partition.

TCPIPAddress Optional, Can Repeat TCP/IP address which the partition has configured. This field is only supported when called from the Primary partition.

Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
101000
 
Info: PartitionFilter
 
tag format:
<PartitionFilter
     Value="All|This|Primary|Secondary">
</PartitionFilter>
 
usage:
This tag allows the client to request information about partitions which fit in the category specified by the Value attribute.
 
Attribute(s) Condition Description
Value (All|This|Primary|Secondary) Optional Value to filter on. 'All' is the default. 'All' means all partitions will be returned, 'This' means that only information about the partition which the client is connected to will be returned, 'Primary' means that only information about the primary will be returned, and 'Secondary' means that information about all of the secondaries will be returned.
 
Sub Tag(s) Condition Description
None
 
message ids (hexadecimal)
D000
 
SRC
 
tag format:
<SRC
     Word1="string"
     Word2="string"
     Word3="string"
     Word4="string"
     Word5="string"
     Word6="string"
     Word7="string"
     Word8="string"
     Word9="string"
     Year="integer"
     Month="integer"
     Day="integer"
     Hour="integer"
     Minute="integer"
     Second="integer"/>
 
usage:
This tag returns an SRC which was displayed for the partition.
 
Attribute(s) Condition Description
Word1 (string) Optional First word of the SRC.

Word2 (string) Optional Second word of the SRC.

Word3 (string) Optional Third word of the SRC.

Word4 (string) Optional Fourth word of the SRC.

Word5 (string) Optional Fifth word of the SRC.

Word6 (string) Optional Sixth word of the SRC.

Word7 (string) Optional Seventh word of the SRC.

Word8 (string) Optional Eighth word of the SRC.

Word9 (string) Optional Ninth word of the SRC.

Year (integer) Optional The year in which the SRC was posted.

Month (integer) Optional The month on which the SRC was posted.

Day (integer) Optional The day on which the SRC was posted.

Hour (integer) Optional The hour on which the SRC was posted.

Minute (integer) Optional The minute on which the SRC was posted.

Second (integer) Optional The second on which the SRC was posted.
 
Sub Tag(s) Condition Description
None
 
message ids (hexadecimal)
No new message IDs that the parent tags cannot also return.
 
TCPIPAddress
 
tag format:
<TCPIPAddress
     IPAddress="string"
     AddressType="Service|XPF"/>
 
usage:
This tag returns a TCP/IP address which is configured on this partition.
 
Attribute(s) Condition Description
IPAddress (string) Optional String specifying an IP address on the partition, such as "255.255.255.255".

AddressType (Service|XPF) Optional Type of IP address. Service address is available when IPLed to DST or beyond, but an i5/OS address is only available when IPLed to i5/OS and TCP has been started.
 
Sub Tag(s) Condition Description
None
 
message ids (hexadecimal)
No new message IDs that the parent tags cannot also return.
 
Info: SystemInfo
 
tag format:
<SystemInfo
     Format="All|General|
             Communications|
             Partitions|
             ProcessorPools|
             Processors|
             MainStorage|
             InteractivePerformance">
  .
  <System . . . >
  .
  <Message . . . >
  .
</SystemInfo>
 
usage:
This tag is used by the client to request information about the system resources and to tell the server how to format this information. The server will return the information using this same tag, but all of the requested information about the system will be filled in.
 
Attribute(s) Condition Description
Format (enumeration) Optional Specifies what information to return for each partition. If this attribute is not specified, then all information will be returned. Possible values are: All| General| Communications| InteractivePerformance| MainStorage| Partitions| ProcessorPools| Processors. To determine what information each format returns, look at the System tag. For the format 'All', all information about the system is returned.
 
Sub Tag(s) Condition Description
System Optional, Cannot Repeat The information about the system resources.

Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
No new message IDs that the parent tags cannot also return.
 
System
 
tag format:
<System

  General Format Attributes:

     TypeModel="string"
     FeatureCode="string"
     SerialNumber="string"
     PointerTagsInactiveCapable="Yes|No"
     CommercialProcessingWorkloadTotal="integer"
     CommercialProcessingWorkloadInteractive="integer"

  Communications Format Attributes:

     HighSpeedLinkCapable="Yes|No"
     HighSpeedLinkPoolMaximum="integer"
     VirtualOptiConnectCapable="Yes|No"
     VirtualOptiConnectPoolMaximum="integer"

  Partitions Format Attributes:

     PartitionsConfigured="integer"
     PartitionsMaximum="integer"

  ProcessorPools Format Attributes:

     ProcessorPoolCapable="Yes|No"
     ProcessorPoolsConfigured="integer"
     ProcessorPoolsMaximum="integer"
     GuestProcessorPoolCapable="Yes|No" (DTDVersion = 10)

  Processors Format Attributes:

     PhysicalProcessors="integer"
     PhysicalProcessorsAvail="integer"
     PhysicalProcessorsAvailPending="integer"
     ProcessingUnits="float"
     ProcessingUnitsPending="float"
     ProcessingUnitsAvail="float"
     ProcessingUnitsAvailPending="float"

  MainStorage Format Attributes:

     MainStorage="integer"
     MainStorageAvail="integer"
     MainStorageAvailPending="integer"

  InteractivePerformance Format Attributes:

     InteractivePerformance="integer"
     InteractivePerformanceAvail="integer"
     InteractivePerformanceAvailPending="integer">
  .


  <Message . . . >
  .

</System>
 
usage:
This tag is used to return the information about the system and its resources.
 
Attribute Condition Description
TypeModel (string) Optional Type and model of the system. The format for this string is TTTT-MMM, where TTTT is the type and MMM is the model.

FeatureCode (string) Optional Feature code of the system.

SerialNumber (string) Optional Serial number of the system.

PointerTagsInactiveCapable (Yes|No) Optional Yes if the system supports partitions with pointer tags inactive, No otherwise.

CommercialProcessingWorkloadTotal (integer) Optional Total amount of commercial processing workload the system has. This is used as a performance benchmark when comparing systems.

CommercialProcessingWorkloadInteractive (integer) Optional Total amount of interactive commercial processing workload the system has. This is used as a performance benchmark when comparing systems.

HighSpeedLinkCapable (Yes|No) Optional Tells if the system hardware supports high speed link.

HighSpeedLinkPoolMaximum (integer) Optional Maximum number of high speed link pools allowed on the system.

VirtualOptiConnectCapable (Yes|No) Optional Tells if the system hardware supports virtual opticonnect.

VirtualOptiConnectPoolMaximum (integer) Optional Maximum number of virtual opticonnect pools allowed on the system.

PartitionsConfigured (integer) Optional Number of configured partitions on the system.

PartitionsMaximum (integer) Optional The maximum number of partitions allowed on the system.

ProcessorPoolCapable (Yes|No) Optional Tells if the system supports processor pools or not.

ProcessorPoolsConfigured (integer) Optional Number of processor pools configured on the system.

ProcessorPoolsMaximum (integer) Optional Maximum number of processor pools which the system supports.

GuestProcessorPoolCapable (Yes|No) Optional Tells if the system supports guest partitions using processor pools. (DTDVersion = 10)

PhysicalProcessors (integer) Optional Number of physical processors the system has.

PhysicalProcessorsAvail (integer) Optional Number of physical processors available.

PhysicalProcessorsAvailPending (integer) Optional Number of physical processors available next IPL.

ProcessingUnits (float) Optional Number of processing units in all processor pools on the system. This value has a precision of 2 decimal places.

ProcessingUnitsPending (float) Optional Number of processing units in all processor pools on the system after the next IPL. This value has a precision of 2 decimal places.

ProcessingUnitsAvail (float) Optional Number of processing units in all processor pools which are available. This value has a precision of 2 decimal places.

ProcessingUnitsAvailPending (float) Optional Number of processing units in all processor pools which will be available after the next IPL. This value has a precision of 2 decimal places.

MainStorage (integer) Optional Amount of main storage(MB) the system has.

MainStorageAvail (integer) Optional Amount of main storage(MB) available.

MainStorageAvailPending (integer) Optional Amount of main storage(MB) available next IPL.

InteractivePerformance (integer) Optional Amount of interactive performance(% of system) the system has.

InteractivePerformanceAvail (integer) Optional Amount of interactive performance(% of system) available.

InteractivePerformanceAvailPending (integer) Optional Amount of interactive performance(% of system) available next IPL.
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
No new message IDs that the parent tags cannot also return.
 
Info: IOResourcesInfo
 
tag format:
<IOResourcesInfo
     Format="All|Basic|General|Partitions|Address"
     DetailLevel="integer"
     CapabilityFilter="All|LoadSource|AlternateIPLSource|
                       ElectronicCustomerSupport|
                       AnyConsole|TwinaxialConsole|
                       OperationsConsole|LANAttachedConsole">
  .
  <PartitionIOResources . . . >
  .
  <PartitionIOResourcesFilter . . . >
  .
  <SystemIOResources . . . >
  .
  <Message . . . >
  .
 
usage:
This tag is used to return information about the I/O resources on the system by partition or the system as a whole.
 
Attribute Condition Description
Format (enumeration) Optional Specifies what information to return for I/O resource. If this attribute is not specified, then all information will be returned. Possible values are: All| Basic| General| Partitions| Address. To determine what information each format returns, look at the IOResource tag. For the format 'All', all information about each I/O resource is returned.

DetailLevel (integer) Optional The level of detail to include in the information returned. The default value of 1 returns only one level below that of the resource specified, while a value greater than one returns that many more levels of resources below the current. Example: if a bus was specified, then a level of detail of 1 returns all IOPs under the bus, while a detail level of 3 returns all IOPs, IOAs, and Devices under the bus.

CapabilityFilter (enumeration) Optional This specifies the capabilities the IOPs should have which are returned. For example if LoadSource was specified, only IOPs capable of supporting a load source device would be returned, along with the resources attached to the IOP if that information was asked for. All other IOPs are filtered out. The default value is All which returns all resources. Possible values are: All| LoadSource| AlternateIPLSource| ElectronicCustomerSupport| AnyConsole| TwinaxialConsole| OperationsConsole| LANAttachedConsole. Any console returns an IOP capable of supporting a console, while TwinaxialConsole, OperationsConsole, and LANAttachedConsole return only IOPs capable of supporting that particular console.
 
Sub Tag(s) Condition Description
PartitionIOResources Optional, Can Repeat. I/O resources belonging to a partition.

PartitionIOResourcesFilter Optional, Can Repeat. I/O resources for partitions which fit in a particular category.

SystemIOResources Optional, Can Repeat. I/O resources attached to the system as a whole.

Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
No new message IDs that the parent tags cannot also return.
 
PartitionIOResources
 
tag format:
<PartitionIOResources
     PartitionID="integer">
  .
  <IOResource . . . >
  .
  <Message . . . >
  .
</PartitionIOResources>
 
usage:
This tag is used to return information about the I/O resources belonging to a particular partition.
 
Attribute Condition Description
PartitionID (integer) Required Number assigned to the partition. This value can range from 0 to 31, if the hardware supports 32 partitions.
 
Sub Tag(s) Condition Description
IOResource Optional, Can Repeat. This tag is used to give information about an I/O resource.

Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
101000, 101500, 101501, 101510, 101511, 101520, 101521, 101530, 101531, D000
 
PartitionIOResourcesFilter
 
tag format:
<PartitionIOResourcesFilter
     Value="All|This|Primary|Secondary">
  .
  <IOResource . . . >
  .
  <Message . . . >
  .
</PartitionIOResourcesFilter>
 
usage:
This tag allows the client to request information about the I/O resources for partitions which fit in the category specified by the Value attribute.
 
Attribute(s) Condition Description
Value (All|This|Primary|Secondary) Optional Value to filter on. 'All' is the default. 'All' means all partitions will be returned, 'This' means that only information about the partition which the client is connected to will be returned, 'Primary' means that only information about the primary will be returned, and 'Secondary' means that information about all of the secondaries will be returned.
 
Sub Tag(s) Condition Description
IOResource Optional, Can Repeat. This tag is used to give information about an I/O resource.

Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
101500, 101501, D000
 
SystemIOResources
 
tag format:
<SystemIOResources
     Value="All|Available">
  .
  <IOResource . . . >
  .
  <Message . . . >
  .
</SystemIOResources>
 
usage:
This tag is used to return information about the I/O resources belonging to the system. All resources can be returned or only those resources which are available.
 
Attribute Condition Description
Value (All|Available) Optional Value to filter on. 'All' is the default. 'All' means all I/O resources will be returned, and 'Available' means that only available I/O resources will be returned. The list returned will meet the requirements specified by the IOResourcesInfo tag.
 
Sub Tag(s) Condition Description
IOResource Optional, Can Repeat. This tag is used to give information about an I/O resource.

Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
101500, 101501, D000
 
IOResource
 
tag format:
<IOResource

  Basic Format Attributes:

     LPARSRID="integer"

  General Format Attributes:

     ResourceType="Bus|IOP|IOA|Device|Slot|Unknown"
     DescriptionID="integer"
     StatusID="integer"
     TypeModel="string"
     SerialNumber="string"
     PartNumber="string"
     Sharable="Yes|No"
     Configurable="Yes|No"
     ResourcesAttached="integer"
     OwnershipType="Dedicated|Shared|Available|Unknown"
     OwningPartitionID="integer"
     OwningPartitionName="string"
     TowerNumber="integer"
     CardPosition="string"
     DevicePosition="string"
     VendorID="integer"
     DeviceID="integer"
     RevisionID="integer"
     SubSystemType="integer"
     SubSystemVendorID="integer"
     LoadSource="Yes|No"
     LoadSourceAbility="DeviceAttached|Capable|Incapable"
     AlternateIPLSource="Yes|No"
     RecentAlternateIPLSource="Yes|No"
     AlternateIPLSourceAbility="DeviceAttached|Capable|Incapable"
     WorkstationConsole="Yes|No"
     AlternateWorkstationConsole="Yes|No"
     WorkstationConsoleAbility="Capable|Incapable"
     TwinaxialConsoleAbility="DeviceAttached|Capable|Incapable"
     OperationsConsoleAbility="Capable|Incapable"
     LANAttachedConsoleAbility="Capable|Incapable"
     ElectronicCustomerSupport="Yes|No"
     ElectronicCustomerSupportAbility="DeviceAttached|Capable|Incapable"

  Address Format Attributes:

     LogicalAddress="string"
     BusTransportType="SPD|PCI"
     SystemBusAddress="integer"
     SystemBoardAddress="integer"
     SystemCardAddress="integer"
     UnitAddressType="Communications|Storage|
                      WorkStation|Library|
                      AuxiliaryProcessor|
                      Cryptography"
     IOAdapterAddress="integer"
     IOBusAddress="integer"
     AuxiliaryProcessorAddress="integer"
     LibraryAddress="integer"
     ControllerAddress="integer"
     AdapterAddress="integer"
     PortAddress="integer"
     ChannelAddress="integer"
     DeviceAddress="integer"
     SessionAddress="integer">
  .
  <IOResource . . . >
  .
  <Message . . . >
  .

 Partitions Format Sub Tags:

  <UsingPartition . . . >
  .
</IOResource>
 
usage:
This tag is used to return or specify information about an I/O resource on the system.
 
Attribute Condition Description
LPARSRID (integer) Required System resource ID of the I/O resource. This is used by LPAR to uniquely identify an I/O resource on the system.

DescriptionID (integer) Optional A number which corresponds to a description of the resource. See table below for a description of the values.

StatusID (integer) Optional A number which corresponds to the status of the resource. See table below for a description of the values.

TypeModel (string) Optional Type and model of the resource. The format for this string is TTTT-MMM, where TTTT is the type and MMM is the model.

SerialNumber (string) Optional The serial number of the resource.

PartNumber (string) Optional The part number of the resource.

Sharable (Yes|No) Optional Yes if the resource can be shared by multiple partitions at the same time, No otherwise.

Configurable (Yes|No) Optional Yes if the resource can have configuration actions done on it directly using the ConfigureIOResource action, No if it cannot be configured independent from one of its parent resources.

ResourcesAttached (integer) Optional Number of Devices attached to this Device.

OwnershipType (enumeration) Optional This tells if the resource is owned by one or more partitions. Possible values: Dedicated| Shared| Available| Unknown. Dedicated means that the resource and all resources attached to it are owned by one partition. Shared means that the resource is shared by more than one partition. Available means that no partition owns the resource, so it can be added to any partition. Unknown means that the ownership of the resource is unknown.

OwningPartitionID (integer) Optional ID of the partition which owns the resource. This value can range from 0 to 31, if the hardware supports 32 partitions. If the ownership type is Available, this attribute will not be returned.

OwningPartitionName (string) Optional Name of the partition which owns the resource. This value can range from 1 to 8 characters in length, and must be different than the name of any other partition on the system. If the ownership type is Available, this attribute will not be returned.

TowerNumber (integer) Optional The number of the tower in which this resource resides.

CardPosition (integer) Optional The location within the tower that the resource resides.

DevicePosition (integer) Optional The location within the tower that the resource resides.

VendorID (integer) Optional Details about resource. Only available on PCI hardware.

DeviceID (integer) Optional Details about resource. Only available on PCI hardware.

RevisionID (integer) Optional Details about resource. Only available on PCI hardware.

SubSystemType (integer) Optional Details about resource. Only available on PCI hardware.

SubSystemVendorID (integer) Optional Details about resource. Only available on PCI hardware.

LoadSource (Yes|No) Optional Yes if this resource is a load source IOP for a partition, No otherwise.

LoadSourceAbility (enumeration) Optional The ability this resource has of supporting a load source device. Possible values are: DeviceAttached| Capable| Incapable. DeviceAttached means that a device is attached and ready to use. Capable means that this IOP can support a load source device if it is attached. Incapable means that the feature is not supported by this IOP.

AlternateIPLSource (Yes|No) Optional Yes if this resource is a alternate IPL source IOP for a partition, No otherwise.

RecentAlternateIPLSource (Yes|No) Optional Yes if this resource was the most recently used alternate IPL source used to IPL the partition, No otherwise.

AlternateIPLSourceAbility (enumeration) Optional The ability this resource has of supporting an alternate IPL device. Possible values are: DeviceAttached| Capable| Incapable. DeviceAttached means that a device is attached and ready to use. Capable means that this IOP can support an alternate IPL device if it is attached. Incapable means that the feature is not supported by this IOP.

WorkstationConsole (Yes|No) Optional Yes if this resource is the workstation console IOP for a partition, No otherwise.

AlternateWorkstationConsole (Yes|No) Optional Yes if this resource is the alternate workstation console IOP for a partition, No otherwise.

WorkstationConsoleAbility (enumeration) Optional The ability this resource has of supporting a workstation console. Possible values are: Capable| Incapable. Capable means that this IOP can support a workstation console device if it is attached. Incapable means that the feature is not supported by this IOP.

TwinaxialConsoleAbility (enumeration) Optional The ability this resource has of supporting twinaxial console. Possible values are: DeviceAttached| Capable| Incapable. DeviceAttached means that a device is attached and ready to use. Capable means that this IOP can support a twinaxial console device if it is attached. Incapable means that the feature is not supported by this IOP.

OperationsConsoleAbility (enumeration) Optional The ability this resource has of supporting operations console. Possible values are: Capable| Incapable. Capable means that this IOP can support an operations console device if it is attached. Incapable means that the feature is not supported by this IOP.

LANAttachedConsoleAbility (enumeration) Optional The ability this resource has of supporting LAN attached console. Possible values are: Capable| Incapable. Capable means that this IOP can support a LAN attached console device if it is attached. Incapable means that the feature is not supported by this IOP.

ElectronicCustomerSupport (Yes|No) Optional Yes if this IOP is the default electronic customer support IOP for a partition, No otherwise.

ElectronicCustomerSupportAbility (enumeration) Optional The ability this resource has of supporting electronic customer support device. Possible values are: DeviceAttached| Capable| Incapable. DeviceAttached means that a device is attached and ready to use. Capable means that this IOP can support an electronic customer support device if it is attached. Incapable means that the feature is not supported by this IOP.

LogicalAddress (string) Optional Logical address of the resource.

BusTransportType (SPD|PCI) Optional Bus transport type part of the resource's address.

SystemBusAddress (integer) Optional System bus part of the resource's address.

SystemBoardAddress (integer) Optional System board part of the resource's address.

SystemCardAddress (integer) Optional System card part of the resource's address.

UnitAddressType (enumeration) Optional Unit address part of the resource's address. Possible values: Communications| Storage| WorkStation| Library| AuxiliaryProcessor| Cryptography

IOAdapterAddress (integer) Optional I/O adapter part of the resource's address.

IOBusAddress (integer) Optional I/O bus part of the resource's address.

AuxiliaryProcessorAddress (integer) Optional Auxiliary processor part of the resource's address.

LibraryAddress (integer) Optional Library part of the resource's address.

ControllerAddress (integer) Optional Controller part of the resource's address.

AdapterAddress (integer) Optional Adapter part of the resource's address.

PortAddress (integer) Optional Port part of the resource's address.

ChannelAddress (integer) Optional Channel part of the resource's address.

DeviceAddress (integer) Optional Device part of the resource's address.

SessionAddress (integer) Optional Session part of the resource's address.
 
Sub Tag(s) Condition Description
IOResource Optional, Can Repeat. This tag is used to give information about an I/O resource.

Message Optional, Can Repeat This is an output only tag which can be used to return messages.

UsingPartition Optional, Can Repeat Tells which partitions are using the resource.
 
message ids (hexadecimal)
No new message IDs that the parent tags cannot also return.
 
Info: ProcessorPoolInfo
 
tag format:
<ProcessorPoolInfo
     Format=All|Basic|Partitions|Processors">
  .
  <ProcessorPool . . . >
  .
  <ProcessorPoolFilter . . . >
  .
  <Message . . . >
  .
</ProcessorPoolInfo>
 
usage:
This tag is used to return information about the processor pools on the system.
 
Attribute Condition Description
Format (enumeration) Optional Specifies what information to return for processor pools. If this attribute is not specified, then all information will be returned. Possible values are: All| Basic| Partitions| Processors. To determine what information each format returns, look at the ProcessorPool tag. For the format 'All', all information about each processor pool is returned.
 
Sub Tag(s) Condition Description
ProcessorPool Optional, Can Repeat. This tag is used to request information about a single processor pool.

ProcessorPoolFilter Optional, Can Repeat. This tag is used to request information about processor pools which fit in a particular category.

Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
No new message IDs that the parent tags cannot also return.
 
ProcessorPool
 
tag format:
<ProcessorPool

  Basic Format Attributes:

     ProcessorPoolID="integer"

  Processors Format Attributes:

     PhysicalProcessors="integer"
     PhysicalProcessorsPending="integer"
     PhysicalProcessorsMinRequired="integer"
     PhysicalProcessorsMinRequiredPending="integer"
     ProcessingUnits="float"
     ProcessingUnitsPending="float">
     ProcessingUnitsAvail="float"
     ProcessingUnitsAvailPending="float">
  .
  <Message . . . >
  .

 Partitions Format Sub Tags:

  <UsingPartition . . . >
  .
</ProcessorPool>
 
usage:
This tag is used to get the information about a processor pool.
 
Attribute Condition Description
ProcessorPoolID (integer) Required Number assigned to the processor pool. The only valid processor pool ID is 0 in V5R1.

PhysicalProcessors (integer) Optional Number of physical processors the processor pool has.

PhysicalProcessorsPending (integer) Optional Number of physical processors the processor pool will have next IPL.

PhysicalProcessorsMinRequired (integer) Optional Minimum number of physical processors which have to be in the processor pool to fulfill the number of processing units needed by each partition using the processor pool.

PhysicalProcessorsMinRequiredPending (integer) Optional Minimum number of physical processors after the next IPL which have to be in the processor pool to fulfill the number of processing units needed by each partition using the processor pool.

ProcessingUnits (float) Optional Number of processing units the processor pool has. This value has a precision of 2 decimal places.

ProcessingUnitsPending (float) Optional Number of processing units the processor pool will have after the next IPL. This value has a precision of 2 decimal places.

ProcessingUnitsAvail (float) Optional Number of processing units available. This value has a precision of 2 decimal places.

ProcessingUnitsAvailPending (float) Optional Number of processing units available next IPL. This value has a precision of 2 decimal places.
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat This is an output only tag which can be used to return messages.

UsingPartition Optional, Can Repeat Tells which partitions are using the processor pool.
 
message ids (hexadecimal)
101010
 
ProcessorPoolFilter
 
tag format:
<ProcessorPoolFilter
     Value="All|Available"
  .
  <Message . . . >
  .
</ProcessorPoolFilter>
 
usage:
This tag is used to get information about the processor pools on the system.
 
Attribute Condition Description
Value (All|Available) Optional Value to filter on. 'All' is the default. 'All' means that all processor pools will be returned. 'Available' means that only processor pools having available processing units will be returned.
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
D000
 
Info: LPARConfigurationData (DTDVersion = 10)
 
tag format:
<LPARConfigurationData
     ConfigurationData="hexadecimal">
  .
  <Message . . . >
  .
</LPARConfigurationData>
 
usage:
This tag is used to backup the LPAR configuration data from the server.
 
Attribute Condition Description
ConfigurationData (hexadecimal) Optional This returns the binary data as a hexadecimal string.
 
Sub Tag(s) Condition Description
None
 
message ids (hexadecimal)
101010, 11000D, 110064, 110065, 110068, 1103E8, 1203E9, 12000A, 12000B, 12000C, 12000D, 12000E, 12000F, 120012, 120013
 
UsingPartition
 
tag format:
<UsingPartition
     PartitionID="integer"
     PartitionName="string"/>
 
usage:
This tag is used to tell which partitions are using a particular resource.
 
Attribute Condition Description
PartitionID (integer) Required Number assigned to the partition. This value can range from 0 to 31, if the hardware supports 32 partitions.

PartitionName (string) Optional Name for the new partition. This value can range from 1 to 8 characters in length, and must be different than the name of any other partition on the system.
 
Sub Tag(s) Condition Description
None
 
message ids (hexadecimal)
No new message IDs that the parent tags cannot also return.
 
Action
 
tag format:
<Action
     Handle="string"
     ActionStatus="Successful|Failed"
     LPARConfigurationID="string">
  <OpenSession . . . >
  .
  <CloseSession . . . >
  .
  <CancelAction . . . >
  .
  <CommitActions . . . >
  .
  <AcceptLPARConfigurationData . . . >
  .
  <ClearLPARConfigurationData . . . >
  .
  <ClearNonReportingLPARResources . . . >
  .
  <ConfigureIOResource . . . >
  .
  <ConfigurePartition . . . >
  .
  <ConfigureProcessorPool . . . >
  .
  <CopyConfigurationDataToServer . . . > (DTDVersion = 10)
  .
  <CreatePartition . . . >
  .
  <CreateProcessorPool . . . >
  .
  <DeletePartition . . . >
  .
  <DeleteProcessorPool . . . >
  .
  <RestartSystem . . . >
  .
  <SaveLPARConfigurationData . . . >
  .
  <SynchronizeLPARConfigurationData . . . >
  .
  <UnclearLPARConfigurationData . . . >
  .
  <ActionProfile . . . >
  .
  <Message . . . >
  .
</Action>
 
usage:
This tag is used to request that a specified action(s) be performed on the LPAR configuration. The user and the partition must have the appropriate authorities to make the request. Most actions do not actually take effect until a CommitActions tag is put into the script. This means that if a CloseSession tag is done without doing a CommitActions tag, then all of the configuration changes done in the script will be lost. A CommitActions tag can be specified after every tag if each action should be committed before attempting the next action. If an action doesn't need to be committed, this will be listed in the usage section of the tag.
 
Attribute Condition Description
Handle (string) Optional Handle to the currently opened session. If this attribute is specified, an OpenSession tag is not needed. This also updates the timeout value which is used to automatically close the session if the server hasn't gotten a response from the client for 5 minutes.

ActionStatus (Successful|Failed) Optional Tells if all of the actions have been successfully submitted.

LPARConfigurationID (string) Optional This can be used to tell if the LPAR configuration has changed between requests. If this string differs from a string received previously, then the LPAR configuration has changed.
 
Sub Tag(s) Condition Description
OpenSession Optional, Cannot Repeat Opens a new session to make LPAR configuration changes.

CloseSession Optional, Cannot Repeat Closes the currently open LPAR configuration change session.

CancelAction Optional, Can Repeat Cancels actions which are running or are pending.

CommitActions Optional, Can Repeat Commit all pending configuration actions. Configuration changes will be lost unless they are committed.

AcceptLPARConfigurationData Optional, Can Repeat Accept a load source disk which was added to the system. This action does not require a CommitActions tag for changes to occur.

ClearLPARConfigurationData Optional, Can Repeat Clear all of the LPAR configuration data on the system. This action does not require a CommitActions tag for changes to occur.

ClearNonReportingLPARResources Optional, Can Repeat Clear non-reporting resources from the logical partitioning configuration lists. This action does not require a CommitActions tag for changes to occur.

ConfigureIOResource Optional, Can Repeat Configure an existing I/O resource on the system. This is used to change the owning partition and the type of ownership of the resource.

ConfigurePartition Optional, Can Repeat Configure an existing partition on the system. This allows the resources of a partition to be changed except for I/O resources.

ConfigureProcessorPool Optional, Can Repeat Configure an existing processor pool on the system. This allows the number of processors in the pool to be changed.

CreatePartition Optional, Can Repeat Create a new partition on the system.

CreateProcessorPool Optional, Can Repeat Create a new processor pool on the system.

DeletePartition Optional, Can Repeat Delete an existing partition on the system.

DeleteProcessorPool Optional, Can Repeat Delete an existing processor pool on the system.

RestartSystem Optional Restart the system in order to make configuration changes take effect.

SaveLPARConfigurationData Optional, Can Repeat Save the primary partition's LPAR configuration data on the active secondary partitions. This action does not require a CommitActions tag for changes to occur.

SynchronizeLPARConfigurationData Optional, Can Repeat Synchronize the LPAR configuration data on the other side of the load source with the configuration data on this side of the load source. This action does not require a CommitActions tag for changes to occur.

UnclearLPARConfigurationData Optional, Can Repeat Unclear the LPAR configuration data of the system. This action does not require a CommitActions tag for changes to occur.

ActionProfile Optional, Can Repeat This is an output only tag which is used to tell if the actions were successfully submitted or not.

Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
1, 2, 3, 4, 6, 7, 8, 9, C, D, 110001
 
Action: OpenSession
 
tag format:
<OpenSession>
  .
  <Message . . . >
  .
</OpenSession>
 
usage:
This action opens a new session. A handle to the session will be passed back using the Action tag's Handle attribute.
 
Attribute Condition Description
None
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
2, C
 
Action: CloseSession
 
tag format:
<CloseSession>
  .
  <Message . . . >
  .
</CloseSession>
 
usage:
This action closes the currently opened session. The session handle is obtained from the call to OpenSession previously in the script or by specifying the handle directly by using the Handle attribute of the Action tag. Any uncommitted LPAR configuration changes are lost when the session is closed.
 
Attribute(s) Condition Description
None
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
2, C
 
Action: CancelAction
 
tag format:
<CancelAction
     Type="All|Current">
  .
  <Message . . . >
  .
</CancelAction>
 
usage:
This action cancels the Type of action specified (All or Current). The current running action may, or may not be able to be cancelled. All remaining non-running actions are eligible to be cancelled. A CancelAction with a type of "All" cancels all pending uncommitted actions, the current action, and all actions which have not been run.
 
Attribute(s) Condition Description
Type Optional Specifies the Type of action to be cancelled. Possible values are: All | Current.
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
B
 
Action: CommitActions
 
tag format:
<CommitActions>
  .
  <Message . . . >
  .
</CommitActions>
 
usage:
This action commits all pending configuration changes that the user has requested. This tag is required for actions in the script to be committed to the configuration. Most of the recovery type actions do not need to be committed, but actions used to set up and maintain the LPAR configuration need to be committed.
 
Attribute(s) Condition Description
None
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
No new message IDs that the parent tags cannot also return.
 
Action: AcceptLPARConfigurationData
 
tag format:
<AcceptLPARConfigurationData>
  .
  <Message . . . >
  .
</AcceptLPARConfigurationData>
 
usage:
This action forces changes made to the logical partitioning configuration data to the load source disk unit. Use this action if the load source disk unit currently contains logical partitioning configuration data that originated on another partition or system. The user must be an LPAR Administrator to perform this action.
 
Attribute Condition Description
None
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
101010, 11000D, 110064, 110065, 110068, 1103E8, 1203E9, 12000A, 12000B, 12000C, 12000D, 12000E, 12000F, 120012, 120013
 
Action: ClearLPARConfigurationData
 
tag format:
<ClearLPARConfigurationData>
  .
  <Message . . . >
  .
</ClearLPARConfigurationData>
 
usage:
This action clears the logical partitioning configuration data stored on the load source disk unit. On the next system IPL, all resources will be owned by the primary partition and no secondary partitions will exist. The system will no longer be partitioned. All secondary partitions defined must be powered off before the clear can proceed. A system IPL is required to activate the change. It may be required to perform a ClearLPARConfigurationDataOnDisk action on the first system IPL after executing this action. The user must be an LPAR Administrator to perform this action. This action occurs whether it is committed or not.
 
Attribute Condition Description
None
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
101010, 11000D, 110064, 110065, 110068, 1103E8, 1203E9, 12000A, 12000B, 12000C, 12000D, 12000E, 12000F, 120012, 120013
 
Action: ClearNonReportingLPARResources
 
tag format:
<ClearNonReportingLPARResources>
  .
  <Message . . . >
  .
</ClearNonReportingLPARResources>
 
usage:
This action clears non-reporting resources from the logical partitioning configuration lists. This is useful if hardware resources have been moved and old entries still exist in the configuration data. The user must be an LPAR Administrator to perform this action. This action occurs whether it is committed or not.
 
Attribute Condition Description
None
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
101010, 11000D, 110064, 110065, 110068, 1103E8, 1203E9, 12000A, 12000B, 12000C, 12000D, 12000E, 12000F, 120012, 120013
 
Action: ConfigureIOResource
 
tag format:
<ConfigureIOResource
     LPARSRID="integer"
     OwnershipType="Dedicated|Shared|Use|Available">
     PartitionID="integer">
     ClearHardwareInfo="Yes|No">
     IgnoreInuseWarnings="Yes|No">
     IgnoreConfigurationWarnings="Yes|No">
  .
  <Message . . . >
  .
</ConfigureIOResource>
 
usage:
This action changes the configuration of an I/O resource. Things such as changing which partition owns the resource and what type of ownership the partition has of the resource can be changed using this tag.
 
Attribute Condition Description
LPARSRID (integer) Required Specifies the I/O resource to configure.

OwnershipType (Dedicated|Shared|Use|Available) Required Specifies how the I/O resource should be owned. Dedicated means that the resource and all resources attached to it are owned by a single partition and cannot be used by any other partition. Shared means that the resource and resources attached to it can be used by other partitions. Use means that the resource is owned by another partition, but that this partition should be allowed to use it as well. Available means that the resource is not owned by any partition.

PartitionID (integer) Optional Specifies the partition on which this action is being performed. For ownership type of "Dedicated", "Shared", or "Use", it specifies which partition should own the resource dedicated, shared, or use the resource, respectively. For ownership type of "Available" it specifies which partition will no longer be using the resource. This parameter is required for all ownership types except "Available". If it is not specified in the ownership type of "Available", it is assumed that the resource should be removed from all partitions currently owning/using it.

ClearHardwareInfo (Yes|No) Optional Specifies whether the information about this hardware should be kept by the partition the I/O resource came from. "No" is the default. "No" means that the information about the resource will be kept by the partition it came from, "Yes" means that the hardware information will be deleted. This should not be set to yes if the resource will be moved back to this partition in the future.

IgnoreInuseWarnings (Yes|No) Optional Specifies whether the resource should be moved even if the resource is currently in use by the partition it is in before the move. "No" is the default. "No" means that the resource will not be moved if it is in use, "Yes" means that it will be moved even if the other partition is using it. It can cause failure or data corruption if the resource is moved while in use. For this reason, only an LPAR Administrator is allowed to set this attribute to "Yes".

IgnoreConfigurationWarnings (Yes|No) Optional Specifies whether warnings encountered by moving the partition should be returned to the user or if the warnings should be ignored the action should be performed anyway. The default is "No". No means that the action will not be performed if these warnings occur, and the warnings will be returned to the user. "Yes" means that these warnings will be ignored and the action will be attempted anyway.
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
101500, 101501, 101502, 110032, 110033, 110034, 110035, 110036, 110037, 110038, 110039, 11003A, 11003B, 11003C, 11003D, 11003F, 110040, 110044, 131200, 132100, 132101, 132105, 132201, 134102, 134103, 134104, 134106, 134200
 
Action: ConfigurePartition
 
tag format:
<ConfigurePartition
     PartitionID="integer"
     PartitionName="string"

     SystemIPLAction="IPL|Hold"
     PointerTagsInactive="Yes|No"

     HighSpeedLinkPool="integer"
     VirtualOptiConnectPool="integer"
     VirtualLANField="bitfield"

     ProcessorType="Physical|Virtual"
     PhysicalProcessors="integer"
     PhysicalProcessorsMin="integer"
     PhysicalProcessorsMax="integer"
     VirtualProcessors="integer"
     VirtualProcessorsMin="integer"
     VirtualProcessorsMax="integer"
     ProcessingUnits="float"
     ProcessingUnitsMin="float"
     ProcessingUnitsMax="float"
     ProcessorPoolID="integer"

     MainStorage="integer"
     MainStorageMin="integer"
     MainStorageMax="integer"

     InteractivePerformance="integer"
     InteractivePerformanceMin="integer"
     InteractivePerformanceMax="integer"

     LoadSourceIOP="integer"
     AlternateIPLSourceIOP="integer"
     WorkstationConsoleIOP="integer"
     AlternateWorkstationConsoleIOP="integer"
     ElectronicCustomerSupportIOP="integer"

     HostPartitionID="integer" (DTDVersion = 10)

     IPLSourceAParameters="hexadecimal" (DTDVersion = 10)
     IPLSourceBParameters="hexadecimal" (DTDVersion = 10)
     IPLSourceCParameters="hexadecimal" (DTDVersion = 10)
     IPLSourceDParameters="hexadecimal" (DTDVersion = 10)

     IgnoreCommunicationsInuseWarnings="Yes|No"
     IgnoreIOResourceCapabilities="Yes|No">
  .
  <Message . . . >
  .
</ConfigurePartition>
 
usage:
This action is used to change the configuration of a partition. The user must be an LPAR Administrator to be able to change any Min or Max type attributes on this tag. If an attribute requires LPAR Administrator authority to change, then that is listed in the description of the attribute.

The ConfigurePartition attributes correspond to their equivalent Pending attributes in the Partition tag. For example, setting the MainStorage attribute in ConfigurePartition would update the MainStoragePending value in the Partition tag.

 
Attribute(s) Condition Description
PartitionID (integer) Required Specifies which partition to apply the action to. This value can range from 0 to 31, if the hardware supports 32 partitions.

PartitionName (string) Optional New name assigned to the partition. This value can range from 1 to 8 characters in length, and must be different than the name of any other partition on the system.

SystemIPLAction (IPL|Hold) Optional New system IPL action for the partition. "IPL" means that the partition will be IPLed when the system IPLs, "Hold" means that the partition will stay turned off when the system IPLs and have to be turned on manually. This parameter can only be set to "IPL" for the primary partition. This parameter does not require a CommitActions tag for changes to occur.

PointerTagsInactive (Yes|No) Optional New state of the pointer tags bit on the processors. "No" partition is running an operating system which honors the pointer tag bit (such as i5/OS), "Yes" if the partition is running an operating system which ignores this bit.

HighSpeedLinkPool (integer) Optional New high speed link pool which the partition is in. The valid values are 0 which means that it isn't using high speed link, and 1 which means it is using high speed link.

VirtualOptiConnectPool (integer) Optional New virtual opticonnect link pool which the partition is in. The valid values are 0 which means that it isn't using virtual opticonnect, and 1 which means it is using virtual opticonnect.

VirtualLANField (bitfield) Optional New virtual LAN connections for this partition. This bit field is made up of four hex digits, such as 8F2B. Each bit represents a different LAN ID, with 0 being the left most bit. In the case listed above, this partition would be communicating on the following LAN IDs: 0, 4, 5, 6, 7, 10, 12, 14, and 15.

ProcessorType (Physical|Virtual) Optional New type of processors for the partition.

PhysicalProcessors (integer) Optional New number of physical processors for the partition.

PhysicalProcessorsMin (integer) Optional New physical processor minimum for the partition. The user must be an LPAR Administrator to change this value.

PhysicalProcessorsMax (integer) Optional New physical processor maximum for the partition. The user must be an LPAR Administrator to change this value.

VirtualProcessors (integer) Optional New number of virtual processors for the partition.

VirtualProcessorsMin (integer) Optional New virtual processor minimum for the partition. The user must be an LPAR Administrator to change this value.

VirtualProcessorsMax (integer) Optional New virtual processor maximum for the partition. The user must be an LPAR Administrator to change this value.

ProcessingUnits (float) Optional New number of processing units for the partition. This value will be truncated to 2 decimal places.

ProcessingUnitsMin (float) Optional New processing units minimum for the partition. The user must be an LPAR Administrator to change this value. This value will be truncated to 2 decimal places.

ProcessingUnitsMax (float) Optional New processing units maximum for the partition. The user must be an LPAR Administrator to change this value. This value will be truncated to 2 decimal places.

ProcessorPoolID (integer) Optional Number assigned to the processor pool which the partition will be in. The only valid processor pool ID is 0 in V5R1.

MainStorage (integer) Optional New amount of main storage(MB) for the partition.

MainStorageMin (integer) Optional New main storage minimum(MB) for the partition. The user must be an LPAR Administrator to change this value.

MainStorageMax (integer) Optional New main storage maximum(MB) for the partition. The user must be an LPAR Administrator to change this value.

InteractivePerformance (integer) Optional New interactive performance(% of system) for the partition.

InteractivePerformanceMin (integer) Optional New interactive performance(% of system) minimum for the partition. The user must be an LPAR Administrator to change this value.

InteractivePerformanceMax (integer) Optional New interactive performance(% of system) maximum for the partition. The user must be an LPAR Administrator to change this value.

LoadSourceIOP (integer) Optional System resource ID of the new load source IOP of the partition. The partition must already own this IOP. The system resource ID is used by LPAR to uniquely identify an I/O resource on the system.

AlternateIPLSourceIOP (integer) Optional System resource ID of the new alternate IPL source IOP of the partition. The partition must already own this IOP. The system resource ID is used by LPAR to uniquely identify an I/O resource on the system.

WorkstationConsoleIOP (integer) Optional System resource ID of the new workstation console IOP of the partition. The partition must already own this IOP. The system resource ID is used by LPAR to uniquely identify an I/O resource on the system.

AlternateWorkstationConsoleIOP (integer) Optional System resource ID of the new alternate workstation console IOP of the partition. The partition must already own this IOP. The system resource ID is used by LPAR to uniquely identify an I/O resource on the system.

ElectronicCustomerSupportIOP (integer) Optional System resource ID of the new default electronic customer support IOP of the partition. The partition must already own this IOP. The system resource ID is used by LPAR to uniquely identify an I/O resource on the system.

HostPartitionID (integer) Optional Sets the partition ID of the hosting i5/OS partition for this guest partition. (DTDVersion = 10)

IPLSourceAParameters (hexadecimal) Optional The guest partition command line parameters for an A side IPL. This parameter does not require a CommitActions tag for changes to occur. (DTDVersion = 10)

IPLSourceBParameters (hexadecimal) Optional The guest partition command line parameters for a B side IPL. This parameter does not require a CommitActions tag for changes to occur. (DTDVersion = 10)

IPLSourceCParameters (hexadecimal) Optional The guest partition command line parameters for a C side IPL. This parameter does not require a CommitActions tag for changes to occur. (DTDVersion = 10)

IPLSourceDParameters (hexadecimal) Optional The guest partition command line parameters for a D side IPL. This parameter does not require a CommitActions tag for changes to occur. (DTDVersion = 10)

IgnoreCommunicationsInuseWarnings (Yes|No) Optional Tells whether a communications type(High Speed Link, Virtual OptiConnect, or Virtual LAN) should be disconnected if it is in use. "Yes" if this communication should be disconnected, "No" if it should not. The default is "No".

IgnoreIOResourceCapabilities (Yes|No) Optional Tells whether an I/O resource should be check to see if it is capable of performing the requested function. Example, if an IOP is marked to be the load source, should it be checked to make sure it can function as a load source. "Yes" if the resource should not be checked and marked as requested, "No" if it should be checked and not marked if it is not capable of performing the requested function. The default is "No".
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
101000, 101010, 101200, 101201, 101210, 101211, 101212, 101220, 101221, 101222, 101230, 101231, 101232, 101240, 101241, 101242, 101250, 101251, 101252, 101253, 101260, 101270, 101280, 101290, 101500, 101501, 101600, 102100, 11000B, 11000C, 11000E, 110022, 11003E, 11004F, 110050, 110051, 110052, 110053, 110054, 120014, 120028, 120029, 12002A, 12002B, 12002C, 120032, 120033, 120034, 120035
 
Action: ConfigureProcessorPool
 
tag format:
<ConfigureProcessorPool
     ProcessorPoolID="integer"
     PhysicalProcessors="integer">
  .
  <Message . . . >
  .
</ConfigureProcessorPool>
 
usage:
This action is used to change the configuration of a processor pool. Only values which are specified will be changed.
 
Attribute(s) Condition Description
ProcessorPoolID (integer) Required Number assigned to the processor pool to be configured. The only valid processor pool ID is 0 in V5R1.

PhysicalProcessors (integer) Optional New number of physical processors for the processor pool.
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
101010, 101210, 101211, 110049, 11004A
 
Action: CopyConfigurationDataToServer (DTDVersion = 10)
 
tag format:
<CopyConfigurationDataToServer
     ConfigurationData="hexadecimal"/>
  .
  <Message . . . >
  .
</CopyConfigurationDataToServer>
 
usage:
This action is used to restore the LPAR configuration data of a system which has previously been backed up using the LPARConfigurationData info tag. This completely destroys the existing configuration on the server. An IPL is required. The user must be an LPAR Administrator to perform this action.
 
Attribute(s) Condition Description
ConfigurationData (hexadecimal) Optional The configuration data to send to the server. The user must be an LPAR Administrator to change this value.
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
101010, 11000D, 110064, 110065, 110068, 1103E8, 1203E9, 12000B, 12000C, 12000D, 12000E, 12000F, 120012, 120013
 
Action: CreatePartition
 
tag format:
<CreatePartition
     PartitionID="integer"
     PartitionName="string"

     PointerTagsInactive="Yes|No"

     HighSpeedLinkPool="integer"
     VirtualOptiConnectPool="integer"
     VirtualLANField="bitfield"

     ProcessorType="Physical|Virtual"
     PhysicalProcessors="integer"
     PhysicalProcessorsMin="integer"
     PhysicalProcessorsMax="integer"
     VirtualProcessors="integer"
     VirtualProcessorsMin="integer"
     VirtualProcessorsMax="integer"
     ProcessingUnits="float"
     ProcessingUnitsMin="float"
     ProcessingUnitsMax="float"
     ProcessorPoolID="integer"

     MainStorage="integer"
     MainStorageMin="integer"
     MainStorageMax="integer"

     InteractivePerformance="integer"
     InteractivePerformanceMin="integer"
     InteractivePerformanceMax="integer"

     HostPartitionID="integer" (DTDVersion = 10)

     IgnoreCommunicationsInuseWarnings="Yes|No">
  .
  <Message . . . >
  .
</CreatePartition>
 
usage:
This action is used to create a new partition. The user must be an LPAR Administrator to perform this action.

The CreatePartition attributes correspond to their equivalent Pending attributes in the Partition tag. For example, setting the MainStorage attribute in CreatePartition would update the MainStoragePending value in the Partition tag.

 
Attribute(s) Condition Description
PartitionID (integer) Optional Specifies which partition to create. If no number is specified, then a valid available number will be chosen. This value can range from 0 to 31, if the hardware supports 32 partitions.

PartitionName (string) Required Name for the new partition. This value can range from 1 to 8 characters in length, and must be different than the name of any other partition on the system.

PointerTagsInactive (Yes|No) Optional New state of the pointer tags bit on the processors. "No" partition is running an operating system which honors the pointer tag bit (such as i5/OS), "Yes" if the partition is running an operating system which ignores this bit.

HighSpeedLinkPool (integer) Optional The high speed link pool which the partition will be in. The valid values are 0 which means that it isn't using high speed link, and 1 which means it is using high speed link.

VirtualOptiConnectPool (integer) Optional The virtual opticonnect link pool which the partition will be in. The valid values are 0 which means that it isn't using virtual opticonnect, and 1 which means it is using virtual opticonnect.

VirtualLANField (bitfield) Optional New virtual LAN connections for this partition. This bit field is made up of four hex digits, such as 8F2B. Each bit represents a different LAN ID, with 0 being the left most bit. In the case listed above, this partition would be communicating on the following LAN IDs: 0, 4, 5, 6, 7, 10, 12, 14, and 15.

ProcessorType (Physical|Virtual) Optional Type of processors the new partition will have.

PhysicalProcessors (integer) Optional Number of physical processors for the new partition.

PhysicalProcessorsMin (integer) Optional Physical processor minimum for the new partition.

PhysicalProcessorsMax (integer) Optional Physical processor maximum for the new partition.

VirtualProcessors (integer) Optional Number of virtual processors for the new partition.

VirtualProcessorsMin (integer) Optional Virtual processor minimum for the new partition.

VirtualProcessorsMax (integer) Optional Virtual processor maximum for the new partition.

ProcessingUnits (float) Optional Number of processing units for the new partition. This value will be truncated to 2 decimal places.

ProcessingUnitsMin (float) Optional Processing units minimum for the new partition. This value will be truncated to 2 decimal places.

ProcessingUnitsMax (float) Optional Processing units maximum for the new partition. This value will be truncated to 2 decimal places.

ProcessorPoolID (integer) Optional Number assigned to the processor pool which the new partition will be in. The only valid processor pool ID is 0 in V5R1.

MainStorage (integer) Optional Amount of main storage(MB) for the new partition.

MainStorageMin (integer) Optional Main storage(MB) minimum for the new partition.

MainStorageMax (integer) Required Main storage(MB) maximum for the new partition.

InteractivePerformance (integer) Optional Interactive performance(% of system) for the new partition.

InteractivePerformanceMin (integer) Optional Interactive performance(% of system) minimum for the new partition.

InteractivePerformanceMax (integer) Optional Interactive performance(% of system) maximum for the new partition.

HostPartitionID (integer) Optional Sets the partition ID of the hosting i5/OS partition for this guest partition. (DTDVersion = 10)

IgnoreCommunicationsInuseWarnings (Yes|No) Optional Tells whether a communications type(High Speed Link, Virtual OptiConnect, or Virtual LAN) should be disconnected if it is in use. "Yes" if this communication should be disconnected, "No" if it should not. The default is "No".
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
101000, 101001, 101010, 101200, 101201, 101210, 101211, 101212, 101220, 101221, 101222, 101230, 101231, 101232, 101240, 101241, 101242, 101250, 101251, 101252, 101253, 101260, 101270, 101280, 101290, 101500, 101501, 101600, 102100, 10D000, 11000B, 11000C, 11000E, 110022, 11003E, 11004F, 110050, 110051, 110052, 110053, 110054, 120014, 120028, 120029, 12002A, 12002B, 12002C, 120032, 120033, 120034, 120035
 
Action: CreateProcessorPool
 
tag format:
<CreateProcessorPool
     ProcessorPoolID="integer"
     PhysicalProcessors="integer">
  .
  <Message . . . >
  .
</CreateProcessorPool>
 
usage:
This action is used to create a new processor pool. The user must be an LPAR Administrator to perform this action.
 
Attribute(s) Condition Description
ProcessorPoolID (integer) Required Number assigned to the processor pool to be configured. The only valid processor pool ID is 0 in V5R1.

PhysicalProcessors (integer) Optional Number of physical processors for the new processor pool.
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
101010, 101011, 101210, 101211, 110046, 110048, 11004A, 110078
 
Action: DeletePartition
 
tag format:
<DeletePartition
     PartitionID="integer">
  .
  <Message . . . >
  .
</DeletePartition>
 
usage:
This action is used to delete a secondary partition. Resources owned by the partition will be made available for other partitions to use. The partition must be in the off state to be deleted. The user must be an LPAR Administrator to perform this action.
 
Attribute(s) Condition Description
PartitionID (integer) Required Specifies which partition to apply the action to. This value can range from 0 to 31, if the hardware supports 32 partitions.
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
101000, 102000, 11000D
 
Action: DeleteProcessorPool
 
tag format:
<DeleteProcessorPool
     ProcessorPoolID="integer">
  .
  <Message . . . >
  .
</DeleteProcessorPool>
 
usage:
This action deletes a processor pool. No partitions can be using the pool when it is deleted. The processors in the pool will be made available to be reallocated. The user must be an LPAR Administrator to perform this action.
 
Attribute(s) Condition Description
ProcessorPoolID (integer) Required Number assigned to the processor pool which should be deleted. The only valid processor pool ID is 0 in V5R1.
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
101010, 110049
 
Action: RestartSystem
 
tag format:
<RestartSystem
     IgnorePrimaryAtXPFWarning="Yes|No"
     IgnoreSecondaryPartitionsActiveWarning="Yes|No"
  .
  <Message . . . >
  .
</RestartSystem>
 
usage:
This action is used to restart the system for configuration changes to take effect. The user must be an LPAR Administrator to perform this action. This action does not require a CommitActions tag for changes to occur.
 
Attribute(s) Condition Description
IgnorePrimaryAtXPFWarning (Yes|No) Optional Tells whether the system should be restarted if the primary partition is up at XPF. "Yes" if the system should be restarted regardless of the state of the primary, "No" if it should only be restarted if the primary is at DST. The default is "No".

IgnoreSecondaryPartitionsActiveWarning (Yes|No) Optional Tells whether the system should be restarted if any secondary partitions are running. "Yes" if the system should be restarted regardless of whether any secondaries are active, "No" if the system should only be restarted if all secondary partitions are off. The default is "No".
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
102101, 102110
 
Action: SaveLPARConfigurationData
 
tag format:
<SaveLPARConfigurationData>
  .
  <Message . . . >
  .
</SaveLPARConfigurationData>
 
usage:
This action updates the logical partitioning configuration data stored on all active secondary partition load source disk units with the logical partitioning configuration data on the primary partition load source. The user must be an LPAR Administrator to perform this action. This action occurs whether it is committed or not.
 
Attribute Condition Description
None
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
101010, 11000D, 110064, 110065, 110068, 1103E8, 1203E9, 12000A, 12000B, 12000C, 12000D, 12000E, 12000F, 120012, 120013
 
Action: SynchronizeLPARConfigurationData
 
tag format:
<SynchronizeLPARConfigurationData>
  .
  <Message . . . >
  .
</SynchronizeLPARConfigurationData>
 
usage:
This action writes the logical partitioning configuration data stored on this side of the load source disk unit to the other side (from source A LIC to source B LIC, or from source B LIC to source A LIC). The user must be an LPAR Administrator to perform this action. This action occurs whether it is committed or not.
 
Attribute Condition Description
None
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
101010, 11000D, 110064, 110065, 110068, 1103E8, 1203E9, 12000A, 12000B, 12000C, 12000D, 12000E, 12000F, 120012, 120013
 
Action: UnclearLPARConfigurationData
 
tag format:
<UnclearLPARConfigurationData>
  .
  <Message . . . >
  .
</UnclearLPARConfigurationData>
 
usage:
This action is used to unclear the logical partitioning configuration data stored on the primary partition load source disk unit. The system will attempt to recover from a previous clear. If any logical partitioning configuration actions were performed after the previous clear operation, then the original logical configuration data saved before the clear would have been changed and the unclear will not recover the original configuration. This action should only be performed if advised to do so by a service representative. The user must be an LPAR Administrator to perform this action. This action occurs whether it is committed or not.
 
Attribute Condition Description
None
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
101010, 11000D, 110064, 110065, 110068, 1103E8, 1203E9, 12000A, 12000B, 12000C, 12000D, 12000E, 12000F, 120012, 120013
 
Status
 
tag format:
<Status
     Handle="string">
  .
  <ActionProfile . . . >
  .
  <Message . . . >
  .
</Status>
 
usage:
This tag is used to request status about an LPAR action which has been requested.
 
Attribute Condition Description
Handle (string) Optional Handle to the currently opened session, which was obtained from an OpenSession tag. This also updates the timeout value which is used to automatically close the session if the server hasn't gotten a response from the client for 5 minutes.
 
Sub Tag(s) Condition Description
ActionProfile Optional, Can Repeat Returns information about an action which was requested.

Message Optional, Can Repeat This is an output only tag which can be used to return messages.
 
message ids (hexadecimal)
No new message IDs that the parent tags cannot also return.
 
ActionProfile
 
tag format:
<ActionProfile
     ActionID="integer"
     ActionType="string"
     PercentDone="integer"
     Stage="integer"
     ActionState="Successful|Failed|Running|
                  Waiting|Canceled|Purged">
  .
  <Message . . . >
  .
</ActionProfile>
 
usage:
This tag is used to return the status of an action which is pending, running or has already run.
 
Attribute Condition Description
ActionID (integer) Required Number associated with the action. This number can range from 0 to 511. If more than 512 actions are requested for the system or the system is IPLed, then the number wraps back around to 0. This number is only known by the partition which requested the action, and all entries are cleared if the partition is IPLed.

ActionType (string) Optional Name of the action. This name matches the name of the tag which was used to request the action. For example, if the user requests a ConfigurePartition action, this attribute would be set to ConfigurePartition.

PercentDone (integer) Optional Percentage of the action which has been completed.

Stage (integer) Optional The stage that the action is in, if the action has multiple stages. This is currently not used for any LPAR configuration actions.

ActionState (enumeration) Optional State of the action. Possible values: Successful| Failed| Running| Waiting| Canceled| Purged. See table below for a description of the values.
 
Sub Tag(s) Condition Description
Message Optional, Can Repeat Returns error/warning code(s) encountered from trying to perform the requested actions.
 
Message
 
tag format:
<Message
         MessageID="integer"
         MessageType="Error|Warning|Info">
  .
  <MessageData . . . >
  .
</Message>
 
usage:
This tag is used to return any messages (Errors, Warnings, or Info) that occur.
 
Attribute Condition Description
MessageID (integer) Required Identifier representing a message which can be returned by the system. See table below for a description of the values.

MessageType (enumeration) Optional Type of message. Possible values are: Error| Warning| Info. The default is Error. Error means that an error occurred which caused the request to fail. Warning means that the configuration change may cause unexpected problems to occur, but the user can override the warnings and the configuration changes will go through. Info means that the request was successful, but there is information about the request that the user should be aware of.
 
Sub Tag(s) Condition Description
MessageData Optional, Can Repeat Data associated with the message.
 
MessageData
 
tag format:
<MessageData
     Type="string"
     Value="string"/>
 
usage:
This tag specifies any data that is associated with the message.
 
Attribute Condition Description
Type (string) Required The type of data that is included in the tag, such as PartitionID.

Value (string) Optional The actual value of the data.
 
Sub Tag(s) Condition Description
None
Type Value Description
Attribute Name of attribute (String) There was a problem with this attribute. Either it is an illegal attribute or its value was invalid.

AttributeValue Value of attribute (String) There was a problem with this value for the attribute. This shows errors like an attribute should have been an integer and was not, or an attribute is an enumerated type and the value given was not one of the valid options.

PartitionID Identifier of the partition. (Integer) The partition the message is about.

SessionType GUI, GreenScreen (String) Unable to open a new session because a session is already open. GUI means that another XML client already has a session open, GreenSreen means that a green screen client already has a session open.

SubTag Name of Sub Tag (String) There was a problem with this XML Sub Tag. The subtag is either not valid or it was missing.

Tag Name of Tag (String) There was a problem with this XML Tag. The tag is either not valid or it was missing.
 
States that an action can be in.
 
State Description
Successful The action has completed successfully.

Failed The action was attempted but has failed. A message should be associated with the action to tell what caused the action to fail.

Running The action is currently running. The PercentDone attribute will specify how close the action is to completing.

Waiting The action is waiting for another action ahead of it in the queue to complete before it can be run.

Canceled The action was not run because the user canceled it using the cancel action tag.

Purged The action was not run because an action ahead of it in the queue failed to complete successfully.
 
DescriptionID values for I/O Resources
 
Resource Description DescriptionID
Uninitialized Description 1

Bus Expansion Adapter 1000

SI Controller 1001

Bus Control Card 1005

Multi-adapter Bridge 1006

SI I/O Adapter 1007

SI System Adapter 1008

Remote HSL I/O Bridge 1009

Bus Expansion Unit 1010

Remote Bus Expansion Adapter 1011

Bus Extension Driver 1015

Bus Extension Receiver 1020

Bus Extension Unit 1021

Control Panel 1025

Deleted Resource 1028

Disk Expansion Unit 1030

System Bus 1035

Virtual System Bus 1036

SI Ring 1037

Remote SI Network Bus 1038

Main Storage 1040

Main Storage Riser 1041

Main Storage L3 Cache 1042

Power Controller 1045

Rack Enclosure 1050

Device Enclosure 1051

Bus Adapter 1052

Virtual Bus Adapter 1053

Shared Bus Adapter 1055

Shared Bus Unit 1056

System 1060

Active Backplane 1061

Backplane Extender 1062

System Clock 1065

System Expansion Unit 1070

System Processor 1075

System Unit 1080

Voltage Regulator 1085

SPCN Card 1086

Processor Capacity 1087

Interactive Card 1088

Capacitor Card 1089

Service Processor 1090

Unknown Resource 1095

Remote System 1096

Remote System Unit 1097

Remote Expansion Unit 1098

Communications IOP 2000

Connectivity IOP 2005

Cryptographic IOP 2010

Facsimile IOP 2015

File Server IOP 2020

Storage IOP 2025

Multiple Function IOP 2030

Workstation IOP 2035

Multiple Function Planar 2040

Combined Function IOP 2050

Remote SI Network IOP 2060

Virtual IOP 2061

Communications IOA 3000

Disk Controller 3005

Diskette Controller 3010

Multiple Function IOA 3015

Virtual Storage IOA 3016

Optical Library 3017

Optical Controller 3018

Tape Controller 3020

Tape Library 3022

Virtual Controller 3024

Workstation IOA 3025

Virtual Adapter 3030

Cryptography Adapter 3031

Virtual Communication IOA 3032

Generic Adapter 3033

Storage IOA 3034

CD-ROM Storage Unit 4000

Communications Port 4005

Disk Unit 4010

Diskette Unit 4015

Display Station 4020

Optical Storage Unit 4025

Plotter 4030

Printer 4035

Tape Unit 4040

Library Picker Arm 4042

Virtual Port 4045

Cryptography Device 4046

Read Cache 4047

Device Services 4048

Backplane 4049

Virtual Communication Port 4050

Communications Channel 5000

Empty Position 6000

Inaccessible Position 6001

Occupied Position 6002
 
States that the partition can be in.
 
State Description
On Partition is powered on.

PoweringOn Partition is in the process of powering on. Panel functions may not be allowed or may be ignored while the partition is in this state.

Off Partition is powered off.

PoweringOff Partition is in the process of powering off. Panel functions may not be allowed or may be ignored while the partition is in this state.

Failed Partition encountered a pre-IPL type failure, so there may be a problem with the configuration that is preventing a successful IPL. Check the Product Activity Log under the primary partition and service documentation for the system reference code shown. The following reference codes are common:

B2xx 1210 - The system password has not been verified yet on the primary partition, secondary partitions cannot be IPLed until this is done.

B2xx 1230 - The partition manager has detected a configuration that is not functionally valid for the partition (minimum requirements for processors, main storage, or interactive feature percentage not met).


UnitAttention Partition encountered a run time failure. Check the reference code for the partition and take the appropriate action.

Error An internal error has caused the control panel task to fail for the partition. No panel functions will be available. See the Licensed Internal Code (LIC) log and service documentation.

New Partition was created on this IPL and the system has not yet been IPLed to activate the partition.

Unknown The state of the partition is unknown.
 
StatusID values for I/O Resources
 
Status StatusID Status Description
Available 0 The resource is in a normal functioning state.

Unavailable 518 The resource is in a state where requests cannot be processed at this time, including the status request just issued by the system.

Failed 2 or 4613 The resource is in a state where the system request for status failed, or the resource is otherwise not operational.

Unknown 11 The resource does not support the status request issued by the system so the operational state is not known.
 
MessageID
 
message codes:
There are errors, warnings, and informational messages which can be returned while attempting to perform LPAR actions. The following is a list of the messages which can be returned. The message tag will tell if the message is an error, warning(which can be ignored), or informational.
 
Description MessageID
(hexadecimal)
Handle not valid. Either the handle was not used within the specified timeout (LPAR interface is in closed status), or the handle is not the one provided by the open command. 1

Action interface is already open. Another client is currently using the LPAR function.

Message data associated with this message:
  • SessionType - Type of session that has the interface open: Possible values: GUI / GreenScreen / DST / SST
  • UserID - ID of the user who has the session open.
  • TCPIPAddress - TCP/IP address of the user if the user is a GUI user
2

Action failed. 4

Action in progress, new action cannot be started. 6

Open session request failed. 7

Unknown Error 8

User is not authorized to perform the action. 9

Unable to override a warning. A

Cannot cancel action. B

Cannot open a new session. C

Cannot close the currently open session. D

Parsing error occurred in the XML stream.

Message data associated with this message:
  • Line - line number the error was found on (starting with 1)
  • Position - position on the line where the error was found (starting with 1)
60

Tag is not valid.

Message data associated with this message:
  • Tag - name of invalid tag
70

Tag is missing that was expected.

Message data associated with this message:
  • Tag - name of missing tag
71

Tag is missing that was expected.

Message data associated with this message:
  • SubTag - name of invalid sub tag
78

Sub tag is missing that was expected.

Message data associated with this message:
  • SubTag - name of invalid sub tag
79

Attribute is not valid.

Message data associated with this message:
  • Attribute - attribute which is invalid
80

Attribute is missing which was expected.

Message data associated with this message:
  • Attribute - attribute which is missing
81

Attribute value is not valid.

Message data associated with this message:
  • Attribute - attribute with invalid value
  • AttributeValue - value of attribute which is not valid
88

Attribute value is missing.

Message data associated with this message:
  • Attribute - attribute with invalid value
89

An internally unrecognized LPAR error occurred, causing the action to fail. FE

General LPAR Error. Some internal error has caused the LPAR action to fail. FF

Nothing to return which matches the request. D000

The system does not support LPAR. 100100

Partition ID is not valid. 101000

Partition ID already exists. 101001

Processor pool ID is not valid. 101010

Processor pool ID already exists. 101011

Partition name is not valid. 101200

Partition name already exists. 101201

Number of physical processors requested is not valid. Verify that the requested dedicated processor value is between the minimum and maximum. Verify that the requested processor pool size is valid. 101210

Physical processors minimum is greater than the maximum. 101211

Physical processors requested is greater than that available. 101212

Number of virtual processors is not valid. Verify that the amount requested is between the minimum and maximum. 101220

Virtual processors minimum is greater than the maximum. 101221

Virtual processors requested is greater than that available. 101222

Number of processing units requested is not valid. Verify that the amount requested is between the minimum and maximum. 101230

Processing units minimum is greater than the maximum. 101231

Processing units requested is greater than that available. 101232

Amount of main storage requested is not valid. Verify that the amount requested is between the minimum and maximum. 101240

Main storage minimum is greater than the maximum. 101241

Main storage requested is greater than that available. 101242

Amount of interactive performance requested is not valid. Verify that the amount requested is between the minimum and maximum. 101250

Interactive performance minimum is greater than the maximum. 101251

Interactive performance requested is greater than that available. 101252

Interactive performance needs to be adjusted.

Message data associated with this message:
  • InteractivePerformanceLowerLimit - lowest allowable interactive performance based on the number of processors
  • InteractivePerformanceUpperLimit - highest allowable interactive performance based on the number of processors
101253

High speed link pool is not valid. 101260

Virtual OptiConnect pool is not valid. 101270

Virtual LAN field is not valid. 101280

Physical processors not valid for processor pool. 101290

I/O resource LPAR SRID not valid. 101500

I/O resource is not owned by the specified partition. 101501

I/O resource not changed or configured. 101502

IPL source kernel parameters are not valid. (DTDVersion = 10) 101600

LPAR configuration data is not valid. (DTDVersion = 10) 101610

Request is not valid for the primary partition. 102000

Request is not valid for the secondary partition. 102001

Action not valid, primary was IPLed to DST. 102100

Action not valid, primary was IPLed past DST. 102101

Secondary partitions are active. 102110

Partition created successfully.

Message data associated with this message:
  • PartitionID - ID of the partition created
10D000

Processor pool created successfully.

Message data associated with this message:
  • ProcessorPoolID - ID of the processor pool created
10D010

Internal LPAR configuration failure. 110001

LPAR does not support this function because of its release. 110003

Maximum number of partitions have already been configured. 11000A

Change successful, but partition is not functional. 11000B

Resources requested greater than is allocated to the partition. 11000C

Partition is in an invalid power state. 11000D

Partition is not available. 11000E

Minimum memory not big enough to support maximum.

Message data associated with this message:
  • MainStorageMin - Minimum main storage needed to support maximum
110022

Bus is not available. 110032

Bus has already been allocated. 110033

Bus does not have an owner. 110034

Bus is not shared. 110035

Bus is in use by another partition so it cannot be configured. 110036

Bus has not been allocated. 110037

Bus not changable. 110038

Bus not in use. 110039

Bus not dedicated. 11003A

Bus is in a switchable tower. (DTDVersion = 10) 11003B

IOP has already been allocated. 11003C

IOP is not available. 11003D

IOP selected lacks capabilities to support requested function. 11003E

IOP has not been allocated. 11003F

IOP cannot be added or removed due to IOP type. 110040

IOA has not been allocated. (DTDVersion = 10) 110044

Processor pool already exists. 110046

No available processor pools. 110048

Processor pool in use. 110049

Processor pool allocation exceeded. 11004A

Shared processor pool units greater than processors can support. 11004F

Number of shared processor units not within minimum and maximum range. Not enough processing units available in the shared processor pool to satisfy the request. 110050

Minimum processor pool units below what minimum virtual processors can support. 110051

Maximum processor pool units above what maximum virtual processors can support. 110052

Shared processor pool units above maximum processor capacity. 110053

Shared processor pool units below minimum processor capacity. 110054

Logical partitioning configuration data is not valid. 110064

Logical partitioning configuration data error detected. 110065

Configuration data changed during request, try again. 110068
IOP must be on a shared bus. 11006E

Hardware does not support processor pools. 110078

Hardware does not support HSL OptiConnect. 110079

Logical partitioning configuration data is not protected. 1103E8

Logical partitioning configuration data is protected. 1103E9

No LPAR configuration data was found 12000A

LPAR configuration data does not match the current configuration. 12000B

LPAR configuration data is from a different system. 12000C

LPAR configuration data is from a different partition. 12000D

LPAR configuration data is newer than the current configuration. 12000E

LPAR configuration data is older than the current configuration. 12000F

LPAR configuration data has a VRM mismatch. 120012

LPAR configuration data has a source and target hardware mismatch. 120013

Partition does not support virtual processors because of its VRM. 120014

Electronic customer support IOP for the partition doesn't support ASYNC. 120028

Electronic customer support IOP for the partition doesn't support SDLC. 120029

Alternate IPL source IOP for the partition doesn't support a valid Tape device. 12002A

Alternate IPL source IOP for the partition doesn't support a valid CD-ROM device. 12002B

Primary console hasn't been selected yet for the partition. 12002C

Minimum interactive performance adjusted.

Message data associated with this message:
  • InteractivePerformanceMin - new interactive performance minimum
120032

Maximum interactive performance adjusted.

Message data associated with this message:
  • InteractivePerformanceMax - new interactive performance maximum
120033

Minimum processing units adjusted.

Message data associated with this message:
  • ProcessingUnitsMin - new processing units minimum
120034

Maximum processing units adjusted.

Message data associated with this message:
  • ProcessingUnitsMax - new processing units maximum
120035

Communication resource is in use. 12003C

Informational error. 131200

I/O resource is in use. 132100

State of IOP is unknown. 132101

IOA required to be powered on. (DTDVersion = 10) 132105

Bus ownership type change failed. 132201

Bus was not removed. 134102

IOP was not removed. 134103

I/O resource was not updated. 134104

Slot is powered off. (DTDVersion = 10) 134106

IOP requires allocation. 134200