HMC Web Services APIIBM
IBM
Note: Before you use this information and the product it supports, read the information in “Safety” on page xxix, Appendix E, “Notices,” on page 1405, and IBM Systems Environmental Notices and User Guide, Z125–5823.
This edition, SC27-2636-04, applies to the IBM Z and IBM LinuxONE servers. This edition replaces SC27-2636-03.
There might be a newer version of this document in a PDF file available on Resource Link. Go to http://www.ibm.com/servers/resourcelink and click Library on the navigation bar.
© Copyright IBM Corporation 2017, 2018. US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
Level 04a
World trade safety information . . . . . . xxix Laser safety information . . . . . . . . . xxix
Laser compliance . . . . . . . . . . . xxix
About this publication . . . . . . . xxxi Related publications . . . . . . . . . . . xxxi Related HMC and SE console information . . . xxxi Extending zBX connectivity options to Layer-2 xxxi Revisions . . . . . . . . . . . . . . xxxi Accessibility . . . . . . . . . . . . . xxxii
Accessibility features . . . . . . . . . xxxii Keyboard navigation . . . . . . . . . xxxii Consult assistive technologies . . . . . . xxxii IBM and accessibility . . . . . . . . . xxxii
How to send your comments . . . . . . . xxxii
Part 1. Web Services API fundamentals. . . . . . . . . . . . 1
Chapter 1. Introduction . . . . . . . . 3 Overview . . . . . . . . . . . . . . . 3
Components of the API . . . . . . . . . . 3 Enabling and accessing the API . . . . . . . . 4
Authentication and access control . . . . . . 5 Alternate HMC considerations . . . . . . . 5
Compatibility . . . . . . . . . . . . . . 6 API versioning . . . . . . . . . . . . 6 Allowable changes within a major version . . . 6 Requirements on client applications. . . . . . 7
Summary of API version updates . . . . . . . 7
Chapter 2. Base definitions . . . . . . 31 Data types. . . . . . . . . . . . . . . 31 Input and output representation . . . . . . . 32
Representing API data types in JSON. . . . . 32
Chapter 3. Invoking API operations . . 35 HTTP protocol standard . . . . . . . . . . 35 Connecting to the API HTTP server . . . . . . 35 HTTP header field usage . . . . . . . . . . 35
Required request header fields . . . . . . . 36 Optional request headers . . . . . . . . . 36 Standard response headers . . . . . . . . 37 Additional response headers. . . . . . . . 38
Media types . . . . . . . . . . . . . . 38 HTTP status codes . . . . . . . . . . . . 39 Error response bodies . . . . . . . . . . . 40
Common request validation reason codes . . . 41 Common request processing reason codes . . . 45
Use of chunked response encoding . . . . . . 45 Filter query parameters . . . . . . . . . . 45
Regular expression syntax . . . . . . . . 46
Chapter 4. Asynchronous notification 47 JMS basics . . . . . . . . . . . . . . . 47 Connecting to the API message broker . . . . . 47 Per-session notification topics . . . . . . . . 48 Notification message formats . . . . . . . . 49
Common message characteristics . . . . . . 49 Status change notification. . . . . . . . . 51 Property change notification . . . . . . . . 52 Inventory change notification . . . . . . . 53 Job completion notification . . . . . . . . 54 Log entry notification . . . . . . . . . . 54 Operating system message notification . . . . 55
Chapter 5. Data model definitions . . . 57 Data model concepts . . . . . . . . . . . 57
Objects in the data model. . . . . . . . . 57 Properties in the data model. . . . . . . . 58
Shared data model schema elements . . . . . . 60 Base managed object properties schema . . . . 60
Chapter 6. Firmware features . . . . . 63 Firmware feature concepts . . . . . . . . . 63
dpm-storage-management . . . . . . . . 63
Part 2. General services . . . . . . 65
Chapter 7. General API services . . . . 67 General API services operations summary . . . . 67 Session management services . . . . . . . . 67
Query API Version . . . . . . . . . . . 68 Logon . . . . . . . . . . . . . . . 70 Establish Shared Secret Key . . . . . . . . 75 Logoff . . . . . . . . . . . . . . . 76 Get Notification Topics . . . . . . . . . 77
Asynchronous job processing . . . . . . . . 80 Query Job Status . . . . . . . . . . . 80 Delete Completed Job Status. . . . . . . . 83 Cancel Job . . . . . . . . . . . . . . 84
Chapter 8. Inventory and metrics services . . . . . . . . . . . . . . 87 Inventory services operations summary . . . . . 87 Metrics service operations summary . . . . . . 87 Inventory service . . . . . . . . . . . . 88
Get Inventory . . . . . . . . . . . . 88 Metrics service . . . . . . . . . . . . . 94
Create Metrics Context . . . . . . . . . 94 Get Metrics . . . . . . . . . . . . . 97
© Copyright IBM Corp. 2017, 2018 iii
|| || ||
Chapter 9. Metric groups . . . . . . 103 Monitors dashboard metric groups . . . . . . 103
BladeCenter temperature and power metric group . . . . . . . . . . . . . . . 103 Blade power. . . . . . . . . . . . . 104 Channels . . . . . . . . . . . . . . 104 CPC overview . . . . . . . . . . . . 104 zBX (Node) overview. . . . . . . . . . 106 DPM system overview . . . . . . . . . 106 Logical partitions . . . . . . . . . . . 107 Partitions . . . . . . . . . . . . . . 108 zCPC environmentals and power . . . . . . 108 zCPC processors . . . . . . . . . . . 109 Blade CPU and memory metric group . . . . 109 Cryptos . . . . . . . . . . . . . . 110 Adapters . . . . . . . . . . . . . . 110 Flash memory adapters . . . . . . . . . 111 RoCE adapters . . . . . . . . . . . . 111 Ensemble power . . . . . . . . . . . 111
Performance management metrics groups . . . . 112 Virtual server CPU and memory metrics group 112 Virtualization host CPU and memory metrics group . . . . . . . . . . . . . . . 113 Workload service class data metrics group. . . 115
Network management metrics . . . . . . . . 115 Virtualization host and virtual server metrics 116 Optimizer network metrics . . . . . . . . 123 Network adapter port metric group . . . . . 126 Network interface metric group . . . . . . 128
Physical switches . . . . . . . . . . . . 130 Top-of-rack switch ports metrics . . . . . . 131 ESM switch port metrics . . . . . . . . 132
Part 3. CPC management . . . . . 135
Chapter 10. Dynamic Partition Manager (DPM) . . . . . . . . . . 137 FICON storage configuration . . . . . . . . 137 Operations summary . . . . . . . . . . . 139
Partition operations summary . . . . . . . 139 Adapter operations summary . . . . . . . 140 Virtual Switch operations summary . . . . . 141 Capacity Group operations summary . . . . 142 Storage Site operations summary . . . . . . 142 Storage Fabric operations summary . . . . . 142 Storage Switch operations summary . . . . . 143 Storage Subsystem operations summary . . . 143 Storage Control Unit operations summary . . . 144 Storage Group operations summary . . . . . 145
Partition object . . . . . . . . . . . . . 146 Data model . . . . . . . . . . . . . 146 List Partitions of a CPC . . . . . . . . . 164 List Permitted Partitions. . . . . . . . . 167 Create Partition. . . . . . . . . . . . 170 Delete Partition. . . . . . . . . . . . 175 Delete Partition Asynchronously . . . . . . 177 Get Partition Properties . . . . . . . . . 179 Update Partition Properties. . . . . . . . 182
Update Partition Properties Asynchronously . . 186 Start Partition . . . . . . . . . . . . 190 Stop Partition . . . . . . . . . . . . 193 Dump Partition. . . . . . . . . . . . 195 Start Dump Program . . . . . . . . . . 199 Perform PSW Restart . . . . . . . . . . 203 Create Virtual Function . . . . . . . . . 205 Delete Virtual Function . . . . . . . . . 208 Get Virtual Function Properties . . . . . . 209 Update Virtual Function Properties . . . . . 211 Create NIC . . . . . . . . . . . . . 213 Delete NIC . . . . . . . . . . . . . 217 Get NIC Properties . . . . . . . . . . 218 Update NIC Properties . . . . . . . . . 220 Increase Crypto Configuration. . . . . . . 223 Change Crypto Domain Configuration . . . . 226 Decrease Crypto Configuration . . . . . . 228 Mount ISO Image . . . . . . . . . . . 231 Unmount ISO Image . . . . . . . . . . 233 Attach Storage Group to Partition . . . . . 234 Detach Storage Group from Partition . . . . 237 Create HBA . . . . . . . . . . . . . 239 Delete HBA . . . . . . . . . . . . . 241 Update HBA Properties . . . . . . . . . 243 Get HBA Properties . . . . . . . . . . 245 Reassign Storage Adapter Port . . . . . . 247 Send OS Command . . . . . . . . . . 249 Open OS Message Channel . . . . . . . . 251 List OS Messages of a Partition . . . . . . 253 Get ASCII Console WebSocket URI . . . . . 256 Inventory service data . . . . . . . . . 259
Adapter object . . . . . . . . . . . . . 262 Data model . . . . . . . . . . . . . 262 List Adapters of a CPC . . . . . . . . . 273 Get Adapter Properties . . . . . . . . . 275 Update Adapter Properties . . . . . . . . 277 Change Crypto Type . . . . . . . . . . 279 Create Hipersocket . . . . . . . . . . 282 Delete Hipersocket . . . . . . . . . . 284 Get Partitions Assigned to Adapter . . . . . 285 Get Network Port Properties . . . . . . . 287 Update Network Port Properties . . . . . . 289 Get Storage Port Properties . . . . . . . . 291 Update Storage Port Properties . . . . . . 292 Change Adapter Type . . . . . . . . . 294 Inventory service data . . . . . . . . . 296
Virtual Switch object . . . . . . . . . . . 298 Data model . . . . . . . . . . . . . 298 List Virtual Switches of a CPC. . . . . . . 299 Get Virtual Switch Properties . . . . . . . 301 Get Connected VNICs of a Virtual Switch . . . 303 Update Virtual Switch Properties . . . . . . 304 Inventory service data . . . . . . . . . 306
Capacity Group element object . . . . . . . 307 Data model . . . . . . . . . . . . . 307 List Capacity Groups of a CPC . . . . . . 308 Create Capacity Group . . . . . . . . . 310 Delete Capacity Group . . . . . . . . . 313 Get Capacity Group Properties . . . . . . 315 Add Partition to Capacity Group . . . . . . 316 Remove Partition from Capacity Group . . . 319
iv HMC Web Services API
||
|| || || || || ||
||
|| ||
||
Update Capacity Group Properties . . . . . 321 Inventory service data . . . . . . . . . 323
Storage Site object . . . . . . . . . . . . 323 Data model . . . . . . . . . . . . . 323 List Storage Sites . . . . . . . . . . . 324 Create Storage Site . . . . . . . . . . 327 Delete Storage Site . . . . . . . . . . 330 Get Storage Site Properties . . . . . . . . 331 Update Storage Site Properties . . . . . . 333 Inventory service data . . . . . . . . . 335
Storage Fabric object . . . . . . . . . . . 336 Data model . . . . . . . . . . . . . 336 List Storage Fabrics . . . . . . . . . . 337 Create Storage Fabric . . . . . . . . . . 339 Delete Storage Fabric . . . . . . . . . . 342 Get Storage Fabric Properties . . . . . . . 343 Update Storage Fabric Properties . . . . . . 344 Inventory service data . . . . . . . . . 346
Storage Switch object . . . . . . . . . . . 347 Data model . . . . . . . . . . . . . 347 List Storage Switches of a Storage Site . . . . 348 List Storage Switches of a Storage Fabric . . . 351 Define Storage Switch . . . . . . . . . 353 Undefine Storage Switch . . . . . . . . 355 Get Storage Switch Properties . . . . . . . 357 Update Storage Switch Properties . . . . . 358 Move Storage Switch to Storage Site. . . . . 360 Move Storage Switch to Storage Fabric . . . . 362 Inventory service data . . . . . . . . . 364
Storage Subsystem object . . . . . . . . . 365 Data model . . . . . . . . . . . . . 365 List Storage Subsystems of a Storage Site . . . 366 Define Storage Subsystem . . . . . . . . 369 Undefine Storage Subsystem . . . . . . . 371 Get Storage Subsystem Properties . . . . . 372 Update Storage Subsystem Properties . . . . 374 Move Storage Subsystem to Storage Site . . . 376 Add Connection Endpoint . . . . . . . . 378 Remove Connection Endpoint . . . . . . . 380 Inventory service data . . . . . . . . . 382
Storage Control Unit object . . . . . . . . . 383 Data model . . . . . . . . . . . . . 383 List Storage Control Units of a Storage Subsystem . . . . . . . . . . . . . 386 Define Storage Control Unit . . . . . . . 388 Undefine Storage Control Unit . . . . . . 390 Get Storage Control Unit Properties . . . . . 392 Update Storage Control Unit Properties . . . 394 Add Volume Range . . . . . . . . . . 396 Remove Volume Range . . . . . . . . . 398 Create Storage Path . . . . . . . . . . 400 Delete Storage Path . . . . . . . . . . 402 Get Storage Path Properties . . . . . . . 404 Update Storage Path Properties . . . . . . 405 Inventory service data . . . . . . . . . 408
Storage Group object . . . . . . . . . . . 409 Data model . . . . . . . . . . . . . 411 List Storage Groups . . . . . . . . . . 424 Create Storage Group. . . . . . . . . . 426 Delete Storage Group. . . . . . . . . . 430 Get Storage Group Properties . . . . . . . 433
Modify Storage Group Properties. . . . . . 435 Add Candidate Adapter Ports to an FCP Storage Group . . . . . . . . . . . . 443 Remove Candidate Adapter Ports from an FCP Storage Group . . . . . . . . . . . . 446 List Storage Volumes of a Storage Group . . . 448 Get Storage Volume Properties . . . . . . 451 Fulfill FICON Storage Volume . . . . . . . 453 Fulfill FCP Storage Volume . . . . . . . . 456 List Virtual Storage Resources of a Storage Group . . . . . . . . . . . . . . . 459 Get Virtual Storage Resource Properties . . . 461 Update Virtual Storage Resource Properties . . 463 Get Partitions for a Storage Group . . . . . 465 Validate LUN Path . . . . . . . . . . 467 Inventory service data . . . . . . . . . 469
Chapter 11. Core IBM Z resources . . 473 Operations Summary . . . . . . . . . . . 473
Console operations summary . . . . . . . 473 User operations summary . . . . . . . . 474 User Role operations summary . . . . . . 475 Task operations summary . . . . . . . . 475 User Pattern operations summary . . . . . 476 Password Rule operations summary . . . . . 476 LDAP Server Definition operations summary 476 Group operations summary . . . . . . . 477 CPC operations summary . . . . . . . . 478 Logical partition operation summary . . . . 479 Activation profile operations summary . . . . 480 Capacity record operations summary . . . . 481
Shared nested objects . . . . . . . . . . . 482 Console object . . . . . . . . . . . . . 485
Data model . . . . . . . . . . . . . 485 Get Console Properties . . . . . . . . . 488 Restart Console. . . . . . . . . . . . 492 Make Console Primary . . . . . . . . . 494 Shutdown Console . . . . . . . . . . 495 Reorder User Patterns . . . . . . . . . 496 Get Console Audit Log . . . . . . . . . 498 Get Console Security Log . . . . . . . . 501 List Console Hardware Messages . . . . . . 505 Get Console Hardware Message Properties . . 507 Delete Console Hardware Message . . . . . 509 List Unmanaged CPCs . . . . . . . . . 510 List Unmanaged zBX Nodes . . . . . . . 512 Get Mobile App Preferences . . . . . . . 514 Set Mobile App Preferences . . . . . . . 516 Get CPC Notification Preferences for Device . . 517 Update CPC Notification Preferences for Device 521 Inventory service data . . . . . . . . . 525
User-related-access permission. . . . . . . . 529 User object . . . . . . . . . . . . . . 530
Data model . . . . . . . . . . . . . 530 List Users . . . . . . . . . . . . . 535 Get User Properties . . . . . . . . . . 537 Update User Properties . . . . . . . . . 539 Add User Role to User . . . . . . . . . 542 Remove User Role from User . . . . . . . 544 Create User . . . . . . . . . . . . . 546 Delete User . . . . . . . . . . . . . 549
Contents v
Inventory service data . . . . . . . . . 551 User Role object . . . . . . . . . . . . 552
Data model . . . . . . . . . . . . . 553 List User Roles . . . . . . . . . . . . 555 Get User Role Properties . . . . . . . . 558 Update User Role Properties . . . . . . . 560 Add Permission to User Role . . . . . . . 562 Remove Permission from User Role . . . . . 565 Create User Role . . . . . . . . . . . 567 Delete User Role . . . . . . . . . . . 569 Inventory service data . . . . . . . . . 571
Task object . . . . . . . . . . . . . . 572 Data model . . . . . . . . . . . . . 572 List Tasks. . . . . . . . . . . . . . 573 Get Task Properties . . . . . . . . . . 574 Inventory service data . . . . . . . . . 576
User Pattern object . . . . . . . . . . . 576 Data model . . . . . . . . . . . . . 577 List User Patterns . . . . . . . . . . . 578 Get User Pattern Properties. . . . . . . . 580 Update User Pattern Properties . . . . . . 582 Create User Pattern . . . . . . . . . . 584 Delete User Pattern . . . . . . . . . . 586 Inventory service data . . . . . . . . . 588
Password Rule object . . . . . . . . . . . 588 Data model . . . . . . . . . . . . . 589 List Password Rules . . . . . . . . . . 591 Get Password Rule Properties . . . . . . . 593 Update Password Rule Properties . . . . . 595 Create Password Rule . . . . . . . . . 597 Delete Password Rule . . . . . . . . . 599 Inventory service data . . . . . . . . . 600
LDAP Server Definition object. . . . . . . . 602 Data model . . . . . . . . . . . . . 603 List LDAP Server Definitions . . . . . . . 605 Get LDAP Server Definition Properties . . . . 607 Update LDAP Server Definition Properties . . 609 Create LDAP Server Definition . . . . . . 611 Delete LDAP Server Definition . . . . . . 613 Inventory service data . . . . . . . . . 614
Group Object . . . . . . . . . . . . . 615 Data model . . . . . . . . . . . . . 616 List Custom Groups . . . . . . . . . . 617 Get Custom Group Properties . . . . . . . 619 Create Custom Group . . . . . . . . . 620 Delete Custom Group . . . . . . . . . 622 Add Member to Custom Group . . . . . . 623 Remove Member from Custom Group . . . . 625 List Custom Group Members . . . . . . . 627 Inventory service data . . . . . . . . . 628
CPC object . . . . . . . . . . . . . . 629 Data model . . . . . . . . . . . . . 629 List CPC Objects . . . . . . . . . . . 644 List Ensemble CPC Objects . . . . . . . . 646 Get CPC Properties . . . . . . . . . . 648 Update CPC Properties . . . . . . . . . 656 Start CPC . . . . . . . . . . . . . 657 Stop CPC. . . . . . . . . . . . . . 660 Activate CPC . . . . . . . . . . . . 662 Deactivate CPC. . . . . . . . . . . . 664 Import Profiles . . . . . . . . . . . . 666
Export Profiles . . . . . . . . . . . . 668 Set Auto-Start List . . . . . . . . . . . 669 Add Temporary Capacity . . . . . . . . 671 Remove Temporary Capacity . . . . . . . 673 Swap Current Time Server . . . . . . . . 675 Set STP Configuration . . . . . . . . . 676 Change STP-only Coordinated Timing Network 678 Join STP-only Coordinated Timing Network . . 680 Leave STP-only Coordinated Timing Network 681 Get CPC Audit Log . . . . . . . . . . 682 Get CPC Security Log . . . . . . . . . 684 List CPC Hardware Messages . . . . . . . 687 Get CPC Hardware Message Properties . . . 689 Delete CPC Hardware Message . . . . . . 691 Export WWPN List . . . . . . . . . . 693 Import DPM Configuration. . . . . . . . 695 Inventory service data . . . . . . . . . 703
Logical Partition object . . . . . . . . . . 703 Data model . . . . . . . . . . . . . 703 List Logical Partitions of CPC . . . . . . . 720 List Permitted Logical Partitions . . . . . . 722 Get Logical Partition Properties . . . . . . 725 Update Logical Partition Properties . . . . . 730 Activate Logical Partition . . . . . . . . 731 Deactivate Logical Partition . . . . . . . 733 Reset Normal . . . . . . . . . . . . 735 Reset Clear . . . . . . . . . . . . . 737 Load Logical Partition . . . . . . . . . 738 PSW Restart . . . . . . . . . . . . . 741 Start Logical Partition . . . . . . . . . 742 Stop Logical Partition . . . . . . . . . 744 Send OS Command . . . . . . . . . . 746 Open OS Message Channel . . . . . . . . 747 List OS Messages of a Logical Partition. . . . 749 SCSI Load . . . . . . . . . . . . . 752 SCSI Dump . . . . . . . . . . . . . 755 List Managed Virtual Machines of a Logical Partition . . . . . . . . . . . . . . 757 Inventory service data . . . . . . . . . 760
Reset activation profile . . . . . . . . . . 760 Data model . . . . . . . . . . . . . 760 List Reset Activation Profiles . . . . . . . 761 Get Reset Activation Profile Properties . . . . 763 Update Reset Activation Profile Properties. . . 765 Inventory service data . . . . . . . . . 767
Image activation profile . . . . . . . . . . 767 Data model . . . . . . . . . . . . . 767 List Image Activation Profiles . . . . . . . 786 Get Image Activation Profile Properties. . . . 788 Update Image Activation Profile Properties . . 792 Inventory service data . . . . . . . . . 794
Load activation profile . . . . . . . . . . 794 Data model . . . . . . . . . . . . . 795 List Load Activation Profiles . . . . . . . 796 Get Load Activation Profile Properties . . . . 798 Update Load Activation Profile Properties . . . 800 Inventory service data . . . . . . . . . 802
Group profile . . . . . . . . . . . . . 802 Data model . . . . . . . . . . . . . 803 List Group Profiles . . . . . . . . . . 804 Get Group Profile Properties . . . . . . . 806
vi HMC Web Services API
||
Update Group Profile Properties . . . . . . 808 Inventory service data . . . . . . . . . 809
Capacity records . . . . . . . . . . . . 810 Data model . . . . . . . . . . . . . 810 List Capacity Records . . . . . . . . . 812 Get Capacity Record Properties . . . . . . 813 Inventory service data . . . . . . . . . 814
Chapter 12. Energy management . . . 817 Groups . . . . . . . . . . . . . . . 818 Special states . . . . . . . . . . . . . 819 Power saving . . . . . . . . . . . . . 820
Group power saving . . . . . . . . . . 820 Power capping . . . . . . . . . . . . . 820
Group capping . . . . . . . . . . . . 820 Energy management operations summary . . . . 821 Energy Management for zBX (Node) object . . . 822
Data model . . . . . . . . . . . . . 822 Operations . . . . . . . . . . . . . 822 Set zBX (Node) Power Save . . . . . . . 822 Set zBX (Node) Power Capping . . . . . . 824
Energy Management for CPC object . . . . . . 827 Data model . . . . . . . . . . . . . 827 Operations . . . . . . . . . . . . . 827 Set CPC Power Save . . . . . . . . . . 827 Set CPC Power Capping. . . . . . . . . 829 Set zCPC Power Save . . . . . . . . . 832 Set zCPC Power Capping . . . . . . . . 834 Get CPC Energy Management Data . . . . . 836 Get Energy Optimization Advice Summary . . 837 Get Energy Optimization Advice Details . . . 843
Energy Management for BladeCenter object . . . 848 Data model . . . . . . . . . . . . . 848 Operations . . . . . . . . . . . . . 848 Set BladeCenter Power Save . . . . . . . 848 Set BladeCenter Power Capping . . . . . . 851
Energy Management for Blade object . . . . . 853 Data model . . . . . . . . . . . . . 853 Operations . . . . . . . . . . . . . 853 Set Blade Power Save. . . . . . . . . . 853 Set Blade Power Capping . . . . . . . . 855
Part 4. Ensemble and zBX management . . . . . . . . . . . 859
Chapter 13. Ensemble composition 861 Ensemble composition operations summary . . . 861 Ensemble object . . . . . . . . . . . . 862
Data model . . . . . . . . . . . . . 862 Operations . . . . . . . . . . . . . 865 List Ensembles . . . . . . . . . . . . 865 Get Ensemble Properties. . . . . . . . . 867 Update Ensemble Properties . . . . . . . 869 List Ensemble Nodes . . . . . . . . . . 871 Get Node Properties . . . . . . . . . . 873 Add Node to Ensemble . . . . . . . . . 875 Remove Node from Ensemble . . . . . . . 878 Inventory service data . . . . . . . . . 879 Usage notes . . . . . . . . . . . . . 880
Chapter 14. zBX infrastructure elements . . . . . . . . . . . . . 881 zBX physical network overview . . . . . . . 881 zBX infrastructure operations summary . . . . 882 zBX object . . . . . . . . . . . . . . 883
Data model . . . . . . . . . . . . . 884 Operations . . . . . . . . . . . . . 891 List zBXs of a CPC . . . . . . . . . . 891 List zBXs of an Ensemble . . . . . . . . 894 Get zBX Properties . . . . . . . . . . 896 Get EC/MCL Description of zBX (Node) . . . 899 Activate zBX (Node) . . . . . . . . . . 902 Deactivate zBX (Node) . . . . . . . . . 905 Get zBX (Node) Audit Log . . . . . . . . 907 Get zBX (Node) Security Log . . . . . . . 909 List zBX (Node) Hardware Messages . . . . 912 Get zBX (Node) Hardware Message Properties 915 Delete zBX (Node) Hardware Message . . . . 917 Inventory service data . . . . . . . . . 918
zBX Top-of-Rack switches . . . . . . . . . 919 Data model . . . . . . . . . . . . . 919 Operations . . . . . . . . . . . . . 921 List Top-of-Rack Switches of a zBX . . . . . 921 Get Top-of-Rack Switch Properties . . . . . 924 Get Top-of-Rack Switch Port Details . . . . . 926 Update Top-of-Rack Switch Port Properties . . 928 Add MAC Filters to Top-of-Rack Switch Port 930 Remove MAC Filters from Top-of-Rack Switch Port . . . . . . . . . . . . . . . 932 Add Top-of-Rack Switch Port to Virtual Networks. . . . . . . . . . . . . . 934 Remove Top-of-Rack Switch Port from the Virtual Networks . . . . . . . . . . . 936
Rack object . . . . . . . . . . . . . . 938 Data model . . . . . . . . . . . . . 939 Operations . . . . . . . . . . . . . 939 List Racks of a zBX . . . . . . . . . . 939 Get Rack Properties . . . . . . . . . . 941 Inventory service data . . . . . . . . . 943
BladeCenter object. . . . . . . . . . . . 944 Data model . . . . . . . . . . . . . 944 Operations . . . . . . . . . . . . . 947 List BladeCenters in a Rack. . . . . . . . 947 List BladeCenters in a zBX . . . . . . . . 949 Get BladeCenter Properties . . . . . . . . 951 Activate BladeCenter . . . . . . . . . . 953 Deactivate BladeCenter . . . . . . . . . 956 Inventory service data . . . . . . . . . 958
Blade object . . . . . . . . . . . . . . 959 Data model . . . . . . . . . . . . . 959 Operations . . . . . . . . . . . . . 964 List Blades in a BladeCenter . . . . . . . 964 List Blades in a zBX . . . . . . . . . . 966 Get Blade Properties . . . . . . . . . . 969 Activate a Blade . . . . . . . . . . . 973 Deactivate a Blade. . . . . . . . . . . 975 Create IEDN Interface for a DataPower XI50z Blade . . . . . . . . . . . . . . . 977 Delete IEDN Interface for a DataPower XI50z Blade . . . . . . . . . . . . . . . 980 Inventory service data . . . . . . . . . 981
Contents vii
Level 04a
Chapter 15. Virtualization management. . . . . . . . . . . . 985 Virtualization host operations summary . . . . 985 Virtual server operations summary . . . . . . 986 Virtualization Host object . . . . . . . . . 987
Data model . . . . . . . . . . . . . 987 Operations . . . . . . . . . . . . . 998 List Virtualization Hosts of a zBX (Node) . . . 998 List Virtualization Hosts of a Node. . . . . 1000 List Virtualization Hosts of an Ensemble . . . 1003 List Virtualization Hosts of a CPC . . . . . 1005 Get Virtualization Host Properties . . . . . 1008 Update Virtualization Host Properties . . . . 1013 List Virtual Switches . . . . . . . . . 1015 Get Virtual Switch Properties. . . . . . . 1016 Create IEDN Virtual Switch . . . . . . . 1019 Create QDIO Virtual Switch . . . . . . . 1022 Get Switch Controllers . . . . . . . . . 1025 Update Virtual Switch . . . . . . . . . 1027 Delete Virtual Switch . . . . . . . . . 1031 Activating a Virtualization Host . . . . . . 1032 Deactivating a Virtualization Host . . . . . 1033 SMAPI Error Response Body . . . . . . . 1033 Inventory service data . . . . . . . . . 1034
Virtual Server Object . . . . . . . . . . 1036 Data model. . . . . . . . . . . . . 1037 Operations . . . . . . . . . . . . . 1062 List Virtual Servers of a zBX (Node) . . . . 1063 List Virtual Servers of a Node . . . . . . 1065 List Virtual Servers of an Ensemble. . . . . 1067 List Virtual Servers of a CPC . . . . . . . 1070 List Virtual Servers of a Virtualization Host 1073 Create Virtual Server . . . . . . . . . 1075 Delete Virtual Server . . . . . . . . . 1080 Get Virtual Server Properties . . . . . . . 1082 Update Virtual Server Properties . . . . . 1090 Create Network Adapter . . . . . . . . 1095 Delete Network Adapter . . . . . . . . 1098 Get Network Adapter Properties . . . . . 1099 Update Network Adapter . . . . . . . . 1101 Reorder Network Adapter . . . . . . . . 1104 Create Virtual Disk . . . . . . . . . . 1106 Delete Virtual Disk . . . . . . . . . . 1110 Get Virtual Disk Properties . . . . . . . 1112 Update Virtual Disk Properties . . . . . . 1114 Reorder Virtual Disks . . . . . . . . . 1117 Activate Virtual Server . . . . . . . . . 1119 Deactivate Virtual Server . . . . . . . . 1121 Mount Virtual Media . . . . . . . . . 1124 Mount Virtual Media Image . . . . . . . 1126 Unmount Virtual Media . . . . . . . . 1128 Migrate Virtual Server . . . . . . . . . 1130 Initiate Virtual Server Dump . . . . . . . 1132 Inventory service data . . . . . . . . . 1133
Chapter 16. Storage management 1139 Terms . . . . . . . . . . . . . . . 1139 Object model overview . . . . . . . . . . 1140 Storage management operations summary . . . 1140 Storage Resource object. . . . . . . . . . 1142
Data model. . . . . . . . . . . . . 1142 Operations . . . . . . . . . . . . . 1143 List Storage Resources . . . . . . . . . 1143 Get Storage Resource Properties . . . . . . 1146 Create Storage Resource . . . . . . . . 1147 Update Storage Resource Properties . . . . 1149 Delete Storage Resource . . . . . . . . 1151 Export World Wide Port Names List . . . . 1153 Import Storage Access List . . . . . . . 1155 List Virtualization Host Storage Resources of a Storage Resource . . . . . . . . . . . 1157 Inventory service data . . . . . . . . . 1159
Virtualization Host Storage Resource object . . . 1160 Data model. . . . . . . . . . . . . 1160 Operations . . . . . . . . . . . . . 1162 List Virtualization Host HBA Ports . . . . . 1162 List Virtualization Host Storage Resources . . 1164 Get Virtualization Host Storage Resource Properties . . . . . . . . . . . . . 1167 Create Virtualization Host Storage Resource 1171 Delete Virtualization Host Storage Resource 1174 Add Virtualization Host Storage Resource Paths . . . . . . . . . . . . . . . 1176 Remove Virtualization Host Storage Resource Paths . . . . . . . . . . . . . . . 1179 Discover Virtualization Host Storage Resources 1182 List Virtual Disks of a Virtualization Host Storage Resource . . . . . . . . . . . 1184 Notifications . . . . . . . . . . . . 1186 Inventory service data . . . . . . . . . 1186
Virtualization Host Storage Group object . . . . 1187 Data model. . . . . . . . . . . . . 1187 Operations . . . . . . . . . . . . . 1188 List Virtualization Host Storage Groups . . . 1188 Get Virtualization Host Storage Group Properties . . . . . . . . . . . . . 1190 List Virtualization Host Storage Resources in a Virtualization Host Storage Group . . . . . 1192 Add Virtualization Host Storage Resource to Virtualization Host Storage Group . . . . . 1194 Remove Virtualization Host Storage Resource from Virtualization Host Storage Group . . . 1196 Notifications . . . . . . . . . . . . 1197 Inventory service data . . . . . . . . . 1198 Usage notes . . . . . . . . . . . . 1198
Chapter 17. Virtual network management . . . . . . . . . . . 1199 Virtual network management operations summary 1199 Virtual Network object . . . . . . . . . . 1199
Data model. . . . . . . . . . . . . 1200 List Virtual Networks . . . . . . . . . 1200 Get Virtual Network Properties . . . . . . 1202 Update Virtual Network Properties. . . . . 1203 Create Virtual Network. . . . . . . . . 1206 Delete Virtual Network. . . . . . . . . 1208 List Members of a Virtual Network. . . . . 1210 Inventory service data . . . . . . . . . 1212
viii HMC Web Services API
Level 04a
Workload resource group operations summary 1216 Workload Resource Group object . . . . . . 1219
Data model. . . . . . . . . . . . . 1219 List Workload Resource Groups of an Ensemble . . . . . . . . . . . . . 1224 Get Workload Resource Group Properties . . 1226 Create Workload Resource Group . . . . . 1228 Delete Workload Resource Group . . . . . 1231 Update Workload Resource Group . . . . . 1232 List Virtual Servers of a Workload Resource Group . . . . . . . . . . . . . . 1234 Add Virtual Server to a Workload Resource Group . . . . . . . . . . . . . . 1237 Remove Virtual Server from a Workload Resource Group . . . . . . . . . . . 1239 List Groups of Virtual Servers of a Workload Resource Group . . . . . . . . . . . 1241 Add Group of Virtual Servers to a Workload Resource Group . . . . . . . . . . . 1243 Remove Group of Virtual Servers from a Workload Resource Group . . . . . . . 1245 List Workload Element Groups of a Workload Resource Group . . . . . . . . . . . 1247 Add Workload Element Group to a Workload Resource Group . . . . . . . . . . . 1248 Remove Workload Element Group from a Workload Resource Group . . . . . . . 1250
Performance Policy object . . . . . . . . . 1252 Data model. . . . . . . . . . . . . 1252 Notifications of property changes to performance policies . . . . . . . . . 1256 List Performance Policies . . . . . . . . 1257 Get Performance Policy Properties . . . . . 1259 Create Performance Policy. . . . . . . . 1262 Delete Performance Policy. . . . . . . . 1264 Update Performance Policy . . . . . . . 1266 Activate Performance Policy . . . . . . . 1269 Import Performance Policy . . . . . . . 1270 Export Performance Policy . . . . . . . 1272
Performance management reports . . . . . . 1275 Generate Workload Resource Groups Report (Performance Management) . . . . . . . 1276 Generate Workload Resource Group Performance Index Report. . . . . . . . 1280 Generate Workload Resource Group Resource Adjustments Report . . . . . . . . . . 1283 Generate Virtual Servers Report . . . . . . 1287 Generate Virtual Server CPU Utilization Report 1291 Generate Virtual Server Resource Adjustments Report . . . . . . . . . . . . . . 1294 Generate Hypervisor Report . . . . . . . 1299 Generate Hypervisor Resource Adjustments Report . . . . . . . . . . . . . . 1307 Generate Service Classes Report . . . . . . 1311 Generate Service Class Resource Adjustments Report . . . . . . . . . . . . . . 1314 Generate Service Class Hops Report . . . . 1319
Generate Service Class Virtual Server Topology Report . . . . . . . . . . . . . . 1324 Generate Load Balancing Report . . . . . 1332
Workload Element Group object . . . . . . . 1334 Data model. . . . . . . . . . . . . 1334 List Workload Element Groups of an Ensemble 1337 Get Workload Element Group Properties . . . 1338 Create Workload Element Group . . . . . 1339 Delete Workload Element Group . . . . . 1342 Update Workload Element Group . . . . . 1343 List Virtual Servers of a Workload Element Group . . . . . . . . . . . . . . 1344 Add Virtual Server to a Workload Element Group . . . . . . . . . . . . . . 1345 Remove Virtual Server from a Workload Element Group . . . . . . . . . . . 1347
Availability Policy object . . . . . . . . . 1348 Data model. . . . . . . . . . . . . 1349 List Availability Policies . . . . . . . . 1351 Get Availability Policy Properties . . . . . 1353 Create Availability Policy . . . . . . . . 1354 Delete Availability Policy . . . . . . . . 1356 Update Availability Policy . . . . . . . . 1357 Activate Availability Policy . . . . . . . 1359
Ensemble Availability Management reports . . . 1360 Generate Workload Resource Groups Report (Ensemble Availability Management) . . . . 1362 Generate Workload Resource Group Availability Status Report . . . . . . . . 1365 Generate Virtual Servers Report (Ensemble Availability Management) . . . . . . . . 1370 Generate Availability Status Report. . . . . 1373
Get Performance Management Velocity Level Range Mappings . . . . . . . . . . . . 1375 Inventory service data . . . . . . . . . . 1377
Part 5. Appendixes . . . . . . . 1383
Appendix A. XML document structure of a performance policy . . 1385 XML structure of a ServiceClasses element . . . 1385 Sample XML document for a performance policy 1389
Appendix B. Enum values for a type of managed objects within User Roles . . . . . . . . . . . . . . 1393
Appendix C. Enum values for the User Role object . . . . . . . . . 1395
Appendix D. Enum values for the Task object . . . . . . . . . . . . 1397
Appendix E. Notices . . . . . . . . 1405 Trademarks . . . . . . . . . . . . . 1406 Class A Notices . . . . . . . . . . . . 1407
Index . . . . . . . . . . . . . . 1411
Contents ix
Level 04a
Level 04a
Figures
1. Logon: Request . . . . . . . . . . . 74 2. Logon: Response . . . . . . . . . . . 74 3. Establish Shared Secret Key: Request . . . . 76 4. Establish Shared Secret Key: Response . . . 76 5. Logoff: Request . . . . . . . . . . . 77 6. Logoff: Response . . . . . . . . . . . 77 7. Get Notification Topics: Request . . . . . 79 8. Get Notification Topics: Response . . . . . 79 9. Query Job Status: Request. . . . . . . . 83
10. Query Job Status: Response . . . . . . . 83 11. Delete Completed Job Status: Request . . . . 84 12. Delete Completed Job Status: Response 84 13. Cancel Job: Request . . . . . . . . . . 86 14. Cancel Job: Response . . . . . . . . . 86 15. Get Inventory: Request. . . . . . . . . 93 16. Get Inventory: Response . . . . . . . . 93 17. Create Metrics Context: Request. . . . . . 96 18. Create Metrics Context: Response . . . . . 97 19. Get Metrics: Request . . . . . . . . . 100 20. Get Metrics: Response . . . . . . . . 101 21. Delete Metrics Context: Request . . . . . 102 22. Delete Metrics Context: Response . . . . . 102 23. List Partitions of a CPC: Request . . . . . 166 24. List Partitions of a CPC: Response . . . . 167 25. List Permitted Partitions: Request . . . . . 169 26. List Permitted Partitions: Response . . . . 170 27. Create Partition: Request . . . . . . . . 175 28. Create Partition: Response . . . . . . . 175 29. Delete Partition: Request . . . . . . . . 176 30. Delete Partition: Response . . . . . . . 177 31. Delete Partition Asynchronously: Request 179 32. Delete Partition Asynchronously: Response 179 33. Get Partition Properties: Request . . . . . 180 34. Get Partition Properties: Response (Part 1) 181 35. Get Partition Properties: Response (Part 2) 182 36. Update Partition Properties: Request 186 37. Update Partition Properties: Response 186 38. Update Partition Properties Asynchronously:
Request . . . . . . . . . . . . . 190 39. Update Partition Properties Asynchronously:
Response . . . . . . . . . . . . . 190 40. Start Partition: Request . . . . . . . . 193 41. Start Partition: Response . . . . . . . . 193 42. Stop Partition: Request . . . . . . . . 195 43. Stop Partition: Response . . . . . . . . 195 44. Dump Partition: Request . . . . . . . . 198 45. Dump Partition: Response . . . . . . . 199 46. Start Dump Program: Request . . . . . . 203 47. Start Dump Program: Response . . . . . 203 48. Perform PSW Restart: Request . . . . . . 205 49. Perform PSW Restart: Response . . . . . 205 50. Create Virtual Function: Request . . . . . 207 51. Create Virtual Function: Response . . . . 208 52. Delete Virtual Function: Request . . . . . 209 53. Delete Virtual Function: Response. . . . . 209 54. Get Virtual Function Properties: Request 211
55. Get Virtual Function Properties: Response 211 56. Update Virtual Function Properties: Request 213 57. Update Virtual Function Properties: Response 213 58. Create NIC: Request . . . . . . . . . 216 59. Create NIC: Response. . . . . . . . . 217 60. Delete NIC: Request . . . . . . . . . 218 61. Delete NIC: Response . . . . . . . . . 218 62. Get NIC Properties: Request . . . . . . 220 63. Get NIC Properties: Response . . . . . . 220 64. Update NIC Properties: Request . . . . . 223 65. Update NIC Properties: Response . . . . . 223 66. Increase Crypto Configuration: Request 226 67. Increase Crypto Configurations: Response 226 68. Change Crypto Domain Configuration:
Request . . . . . . . . . . . . . 228 69. Change Crypto Domain Configuration:
Response . . . . . . . . . . . . . 228 70. Decrease Crypto Configuration: Request 230 71. Decrease Crypto Configuration: Response 231 72. Mount ISO Image: Request . . . . . . . 232 73. Mount ISO Image: Response . . . . . . 232 74. Unmount ISO Image: Request . . . . . . 234 75. Unmount ISO Image: Response . . . . . 234 76. Attach Storage Group to Partition: Request 236 77. Attach Storage Group to Partition: Response 236 78. Detach Storage Group from Partition: Request 238 79. Detach Storage Group from Partition:
Response . . . . . . . . . . . . . 239 80. Create HBA: Request . . . . . . . . . 241 81. Create HBA: Response . . . . . . . . 241 82. Delete HBA: Request . . . . . . . . . 243 83. Delete HBA: Response . . . . . . . . 243 84. Update HBA Properties: Request . . . . . 245 85. Update HBA Properties: Response . . . . 245 86. Get HBA Properties: Request . . . . . . 246 87. Get HBA Properties: Response . . . . . . 247 88. Reassign Storage Adapter Port: Request 249 89. Reassign Storage Adapter Port: Response 249 90. Send OS Command: Request . . . . . . 250 91. Send OS Command: Response . . . . . . 251 92. Open OS Message Channel: Request . . . . 252 93. Open OS Message Channel: Response 253 94. List OS Messages of a Partition: Request 255 95. List OS Messages of a Partition: Response 256 96. Get ASCII Console WebSocket URI: Request 258 97. Get ASCII Console WebSocket URI: Response 259 98. Partition object: Sample inventory data -
Response (Part 1) . . . . . . . . . . 260 99. Partition object: Sample inventory data -
Response (Part 2) . . . . . . . . . . 261 100. Partition object: Sample inventory data -
Response (Part 3) . . . . . . . . . . 261 101. List Adapters of a CPC: Request . . . . . 275 102. List Adapters of a CPC: Response. . . . . 275 103. Get Adapter Properties: Request . . . . . 276 104. Get Adapter Properties: Response . . . . . 277
© Copyright IBM Corp. 2017, 2018 xi
|| ||
|| || || | ||
Level 04a
105. Update Adapter Properties: Request . . . . 279 106. Update Adapter Properties: Response 279 107. Change Crypto Type: Request . . . . . . 281 108. Change Crypto Type: Response . . . . . 281 109. Create Hipersocket: Request . . . . . . 283 110. Create Hipersocket: Response . . . . . . 284 111. Delete Hipersocket: Request . . . . . . 285 112. Delete Hipersocket: Response . . . . . . 285 113. Get Partitions Assigned to Adapter: Request 287 114. Get Partitions Assigned to Adapter: Response 287 115. Get Network Port Properties: Request 289 116. Get Network Port Properties: Response 289 117. Update Network Port Properties: Request 291 118. Update Network Port Properties: Response 291 119. Get Storage Port Properties: Request . . . . 292 120. Get Storage Port Properties: Response 292 121. Update Storage Port Properties: Request 294 122. Update Storage Port Properties: Response 294 123. Change Adapter Type: Request . . . . . 296 124. Change Adapter Type: Response . . . . . 296 125. Adapter object: Sample inventory data 297 126. List Virtual Switches of a CPC: Request 301 127. List Virtual Switches of a CPC: Response 301 128. Get Virtual Switch Properties: Request 302 129. Get Virtual Switch Properties: Response 303 130. Get Connected VNICs of a Virtual Switch:
Request . . . . . . . . . . . . . 304 131. Get Connected VNICs of a Virtual Switch:
Response . . . . . . . . . . . . . 304 132. Update Virtual Switch Properties: Request 306 133. Update Virtual Switch Properties: Response 306 134. Virtual Switch object: Sample inventory data -
Response . . . . . . . . . . . . . 307 135. List Capacity Groups of a CPC: Request 310 136. List Capacity Groups of a CPC: Response 310 137. Create Capacity Group: Request . . . . . 313 138. Create Capacity Group: Response . . . . . 313 139. Delete Capacity Group: Request . . . . . 314 140. Delete Capacity Group: Response . . . . . 315 141. Get Capacity Group Properties: Request 316 142. Get Capacity Group Properties: Response 316 143. Add Partition to Capacity Group: Request 318 144. Add Partition to Capacity Group: Response 319 145. Remove Partition from Capacity Group:
Request . . . . . . . . . . . . . 320 146. Remove Partition from Capacity Group:
Response . . . . . . . . . . . . . 321 147. Update Capacity Group Properties: Request 322 148. Update Capacity Group Properties: Response 323 149. List Storage Sites: Request . . . . . . . 326 150. List Storage Sites: Response . . . . . . . 327 151. Create Storage Site: Request. . . . . . . 329 152. Create Storage Site: Response . . . . . . 329 153. Delete Storage Site: Request. . . . . . . 331 154. Delete Storage Site: Response . . . . . . 331 155. Get Storage Site Properties: Request . . . . 332 156. Get Storage Site Properties: Response 333 157. Update Storage Site Properties: Request 335 158. Update Storage Site Properties: Response 335 159. Storage Site object: Sample inventory data -
Response . . . . . . . . . . . . . 336
160. List Storage Fabrics: Request . . . . . . 339 161. List Storage Fabrics: Response . . . . . . 339 162. Create Storage Fabric: Request . . . . . . 341 163. Create Storage Fabric: Response . . . . . 341 164. Delete Storage Fabric: Request . . . . . . 343 165. Delete Storage Fabric: Response . . . . . 343 166. Get Storage Fabric Properties: Request 344 167. Get Storage Fabric Properties: Response 344 168. Update Storage Fabric Properties: Request 346 169. Update Storage Fabric Properties: Response 346 170. Storage Fabric object: Sample inventory data -
Response . . . . . . . . . . . . . 347 171. List Storage Switches of a Storage Site:
Request . . . . . . . . . . . . . 350 172. List Storage Switches of a Storage Site:
Response . . . . . . . . . . . . . 350 173. List Storage Switches of a Storage Fabric:
Request . . . . . . . . . . . . . 352 174. List Storage Switches of a Storage Fabric:
Response . . . . . . . . . . . . . 353 175. Define Storage Switch: Request . . . . . 355 176. Define Storage Switch: Response . . . . . 355 177. Undefine Storage Switch: Request. . . . . 357 178. Undefine Storage Switch: Response . . . . 357 179. Get Storage Switch Properties: Request 358 180. Get Storage Switch Properties: Response 358 181. Update Storage Switch Properties: Request 360 182. Update Storage Switch Properties: Response 360 183. Move Storage Switch to Storage Site: Request 362 184. Move Storage Switch to Storage Site:
Response . . . . . . . . . . . . . 362 185. Move Storage Switch to Storage Fabric:
Request . . . . . . . . . . . . . 364 186. Move Storage Switch to Storage Fabric:
Response . . . . . . . . . . . . . 364 187. Storage Switch object: Sample inventory data
- Response . . . . . . . . . . . . 365 188. List Storage Subsystems of a Storage Site:
Request . . . . . . . . . . . . . 368 189. List Storage Subsystems of a Storage Site:
Response . . . . . . . . . . . . . 368 190. Define Storage Subsystem: Request . . . . 370 191. Define Storage Subsystem: Response 370 192. Undefine Storage Subsystem: Request 372 193. Undefine Storage Subsystem: Response 372 194. Get Storage Subsystem Properties: Request 373 195. Get Storage Subsystem Properties: Response 374 196. Update Storage Subsystem Properties:
Request . . . . . . . . . . . . . 376 197. Update Storage Subsystem Properties:
Response . . . . . . . . . . . . . 376 198. Move Storage Subsystem to Storage Site:
Request . . . . . . . . . . . . . 378 199. Move Storage Subsystem to Storage Site:
Response . . . . . . . . . . . . . 378 200. Add Connection Endpoint: Request . . . . 380 201. Add Connection Endpoint: Response 380 202. Remove Connection Endpoint: Request 382 203. Remove Connection Endpoint: Response 382 204. Storage Subsystem object: Sample inventory
data - Response . . . . . . . . . . . 383
|| ||
|| || || || || || || || || || | ||
|| || || || || || || || || || | || | || | || | || | || || || || || || || || || || | || | || | || | || | || | || || || || || || || | || | || | || | || || || || || | ||
Level 04a
205. List Storage Control Units of a Storage Subsystem: Request . . . . . . . . . 388
206. List Storage Control Units of a Storage Subsystem: Response . . . . . . . . . 388
207. Define Storage Control Unit: Request 390 208. Define Storage Control Unit: Response 390 209. Undefine Storage Control Unit: Request 392 210. Undefine Storage Control Unit: Response 392 211. Get Storage Control Unit Properties: Request 393 212. Get Storage Control Unit Properties: Response 394 213. Update Storage Control Unit Properties:
Request . . . . . . . . . . . . . 396 214. Update Storage Control Unit Properties:
Response . . . . . . . . . . . . . 396 215. Add Volume Range: Request . . . . . . 398 216. Add Volume Range: Response . . . . . . 398 217. Remove Volume Range: Request . . . . . 399 218. Remove Volume Range: Response. . . . . 400 219. Create Storage Path: Request . . . . . . 402 220. Create Storage Path: Response . . . . . . 402 221. Delete Storage Path: Request . . . . . . 404 222. Delete Storage Path: Response . . . . . . 404 223. Get Storage Path Properties: Request 405 224. Get Storage Path Properties: Response 405 225. Update Storage Path Properties: Request 407 226. Update Storage Path Properties: Response 408 227. Storage Control Unit object: Sample inventory
data - Response . . . . . . . . . . . 409 228. List Storage Groups: Request . . . . . . 425 229. List Storage Groups: Response . . . . . . 426 230. Create Storage Group: Request . . . . . . 430 231. Create Storage Group: Response . . . . . 430 232. Delete Storage Group: Request . . . . . . 433 233. Delete Storage Group: Response . . . . . 433 234. Get Storage Group Properties: Request 434 235. Get Storage Group Properties: Response 435 236. Modify Storage Group Properties: Request 443 237. Modify Storage Group Properties: Response 443 238. Add Candidate Adapter Ports to an FCP
Storage Group: Request . . . . . . . . 445 239. Add Candidate Adapter Ports to an FCP
Storage Group: Response . . . . . . . 446 240. Remove Candidate Adapter Ports from an
FCP Storage Group: Request . . . . . . 448 241. Remove Candidate Adapter Ports from an
FCP Storage Group: Response . . . . . . 448 242. List Storage Volumes of a Storage Group:
Request . . . . . . . . . . . . . 450 243. List Storage Volumes of a Storage Group:
Response . . . . . . . . . . . . . 451 244. Get Storage Volume Properties: Request 453 245. Get Storage Volume Properties: Response 453 246. Fulfill FICON Storage Volume: Request 456 247. Fulfill FICON Storage Volume: Response 456 248. Fulfill FCP Storage Volume: Request . . . . 458 249. Fulfill FCP Storage Volume: Response 458 250. List Virtual Storage Resources of a Storage
Group: Request . . . . . . . . . . . 461 251. List Virtual Storage Resources of a Storage
Group: Response . . . . . . . . . . 461
252. Get Virtual Storage Resource Properties: Request . . . . . . . . . . . . . 462
253. Get Virtual Storage Resource Properties: Response . . . . . . . . . . . . . 463
254. Update Virtual Storage Resource Properties: Request . . . . . . . . . . . . . 465
255. Update Virtual Storage Resource Properties: Response . . . . . . . . . . . . . 465
256. Get Partitions for a Storage Group: Request 467 257. Get Partitions for a Storage Group: Response 467 258. Validate LUN Path: Request . . . . . . 469 259. Validate LUN Path: Response . . . . . . 469 260. Storage Group object: Sample inventory data
- Response (Part 1) . . . . . . . . . . 471 261. Storage Group object: Sample inventory data
- Response (Part 2) . . . . . . . . . . 473 262. Get Console Properties: Request . . . . . 489 263. Get Console Properties: Response (Part 1) 490 264. Get Console Properties: Response (Part 2) 491 265. Get Console Properties: Response (Part 3) 492 266. Shutdown Console: Request. . . . . . . 496 267. Shutdown Console: Response . . . . . . 496 268. Reorder User Patterns: Request . . . . . 498 269. Reorder User Patterns: Response . . . . . 498 270. Get Console Audit Log: Request . . . . . 500 271. Get Console Audit Log: Response. . . . . 501 272. Get Console Security Log: Request . . . . 503 273. Get Console Security Log: Response (Part 1) 504 274. Get Console Security Log: Response (Part 2) 505 275. List Console Hardware Messages: Request 507 276. List Console Hardware Messages: Response 507 277. Get Console Hardware Message Properties:
Request . . . . . . . . . . . . . 508 278. Get Console Hardware Message Properties:
Response . . . . . . . . . . . . . 509 279. Delete Console Hardware Message: Request 510 280. Delete Console Hardware Message: Response 510 281. List Unmanaged CPCs: Request . . . . . 512 282. List Unmanaged CPCs: Response . . . . . 512 283. List Unmanaged zBX Nodes: Request 514 284. List Unmanaged zBX Nodes: Response 514 285. Get Mobile App Preferences: Request 515 286. Get Mobile App Preferences: Response 515 287. Set Mobile App Preferences: Request 517 288. Set Mobile App Preferences: Response 517 289. Get CPC Notification Preferences for Device:
Request . . . . . . . . . . . . . 520 290. Get CPC Notification Preferences for Device:
Response . . . . . . . . . . . . . 521 291. Update CPC Notification Preferences for
Device: Request . . . . . . . . . . . 524 292. Update CPC Notification Preferences for
Device: Response . . . . . . . . . . 525 293. Console object: Sample inventory data (Part
1) . . . . . . . . . . . . . . . 526 294. Console object: Sample inventory data (Part
2) . . . . . . . . . . . . . . . 527 295. Console object: Sample inventory data (Part
3) . . . . . . . . . . . . . . . 528 296. Console object: Sample inventory data (Part
4) . . . . . . . . . . . . . . . 529
Figures xiii
Level 04a
297. List Users: Request. . . . . . . . . . 536 298. List Users: Response . . . . . . . . . 537 299. Get User Properties: Request . . . . . . 538 300. Get User Properties: Response . . . . . . 539 301. Update User Properties: Request . . . . . 542 302. Update User Properties: Response . . . . 542 303. Add User Role to User: Request . . . . . 544 304. Add User Role to User: Response . . . . . 544 305. Remove User Role from User: Request 546 306. Remove User Role from User: Response 546 307. Create User: Request . . . . . . . . . 549 308. Create User: Response . . . . . . . . 549 309. Delete User: Request . . . . . . . . . 550 310. Delete User: Response . . . . . . . . 551 311. User object: Sample inventory data . . . . 552 312. List User Roles: Request . . . . . . . . 557 313. List User Roles: Response . . . . . . . 558 314. Get User Role Properties: Request. . . . . 559 315. Get User Role Properties: Response . . . . 560 316. Update User Role Properties: Request 562 317. Update User Role Properties: Response 562 318. Add Permission to User Role: Request 564 319. Add Permission to User Role: Response 565 320. Remove Permission from User Role: Request 567 321. Remove Permission from User Role: Response 567 322. Create User Role: Request . . . . . . . 569 323. Create User Role: Response . . . . . . . 569 324. Delete User Role: Request . . . . . . . 570 325. Delete User Role: Response . . . . . . . 571 326. User Role object: Sample inventory data 572 327. List Tasks: Request . . . . . . . . . . 574 328. List Tasks: Response . . . . . . . . . 574 329. Get Task Properties: Request . . . . . . 575 330. Get Task Properties: Response . . . . . . 576 331. Task object: Sample inventory data . . . . 576 332. List User Patterns: Request . . . . . . . 580 333. List User Patterns: Response . . . . . . 580 334. Get User Pattern Properties: Request 581 335. Get User Pattern Properties: Response 582 336. Update User Pattern Properties: Request 584 337. Update User Pattern Properties: Response 584 338. Create User Pattern: Request . . . . . . 586 339. Create User Pattern: Response . . . . . . 586 340. Delete User Pattern: Request . . . . . . 587 341. Delete User Pattern: Response . . . . . . 587 342. User Pattern object: Sample inventory data 588 343. List Password Rules: Request . . . . . . 593 344. List Password Rules: Response. . . . . . 593 345. Get Password Rule Properties: Request 595 346. Get Password Rule Properties: Response 595 347. Update Password Rule Properties: Request 597 348. Update Password Rule Properties: Response 597 349. Create Password Rule: Request . . . . . 599 350. Create Password Rule: Response . . . . . 599 351. Delete Password Rule: Request . . . . . 600 352. Delete Password Rule: Response . . . . . 600 353. Password Rule object: Sample inventory data 602 354. List LDAP Server Definitions: Request 606 355. List LDAP Server Definitions: Response 607 356. Get LDAP Server Definition Properties:
Request . . . . . . . . . . . . . 608
357. Get LDAP Server Definition Properties: Response . . . . . . . . . . . . . 609
358. Update LDAP Server Definition Properties: Request . . . . . . . . . . . . . 610
359. Update LDAP Server Definition Properties: Response . . . . . . . . . . . . . 611
360. Create LDAP Server Definition: Request 613 361. Create LDAP Server Definition: Response 613 362. Delete LDAP Server Definition: Request 614 363. Delete LDAP Server Definition: Response 614 364. LDAP Server Definition object: Sample
inventory data . . . . . . . . . . . 615 365. List Custom Groups: Request . . . . . . 619 366. List Custom Groups: Response. . . . . . 619 367. Get Custom Group Properties: Request 620 368. Get Custom Group Properties: Response 620 369. Create Custom Group: Request . . . . . 622 370. Create Custom Group: Response . . . . . 622 371. Delete Custom Group: Request . . . . . 623 372. Delete Custom Group: Response . . . . . 623 373. Add Member to Custom Group: Request 625 374. Add Member to Custom Group: Response 625 375. Remove Member from Custom Group:
Request . . . . . . . . . . . . . 626 376. Remove Member from Custom Group:
Response . . . . . . . . . . . . . 627 377. List Custom Group Members: Request 628 378. List Custom Group Members: Response 628 379. List CPC Objects: Request . . . . . . . 645 380. List CPC Objects: Response . . . . . . . 646 381. List Ensemble CPC Objects: Request . . . . 648 382. List Ensemble CPC Objects: Response 648 383. Get CPC Properties: Request . . . . . . 650 384. Get CPC Properties: Response (Part 1) 651 385. Get CPC Properties: Response (Part 2) 652 386. Get CPC Properties: Response (Part 3) 653 387. Get CPC Properties: Response (Part 4) 654 388. Get CPC Properties: Response (Part 5) 655 389. Get CPC Properties: Response (Part 6) 656 390. Set Auto-Start List: Request . . . . . . . 671 391. Set Auto-Start List: Response . . . . . . 671 392. Get CPC Audit Log: Request . . . . . . 684 393. Get CPC Audit Log: Response . . . . . . 684 394. Get CPC Security Log: Request . . . . . 686 395. Get CPC Security Log: Response . . . . . 687 396. List CPC Hardware Messages: Request 689 397. List CPC Hardware Messages: Response 689 398. Get CPC Hardware Message Properties:
Request . . . . . . . . . . . . . 691 399. Get CPC Hardware Message Properties:
Response . . . . . . . . . . . . . 691 400. Delete CPC Hardware Message: Request 693 401. Delete CPC Hardware Message: Response 693 402. Export WWPN List: Request . . . . . . 695 403. Export WWPN List: Response . . . . . . 695 404. Import DPM Configuration: Request (Part 1) 698 405. Import DPM Configuration: Request (Part 2) 699 406. Import DPM Configuration: Request (Part 3) 700 407. Import DPM Configuration: Request (Part 4) 701 408. Import DPM Configuration: Request (Part 5) 702 409. Import DPM Configuration: Response 703
xiv HMC Web Services API
|| || || || || ||
Level 04a
410. List Logical Partitions of CPC: Request 721 411. List Logical Partitions of CPC: Response 722 412. List Permitted Logical Partitions: Request 724 413. List Permitted Logical Partitions: Response 725 414. Get Logical Partition Properties: Request 727 415. Get Logical Partition Properties: Response
(Part 1) . . . . . . . . . . . . . 728 416. Get Logical Partition Properties: Response
(Part 2) . . . . . . . . . . . . . 729 417. Send OS Command: Request . . . . . . 747 418. Send OS Command: Response . . . . . . 747 419. Open OS Message Channel: Request . . . . 749 420. Open OS Message Channel: Response 749 421. List OS Messages of a Logical Partition:
Request . . . . . . . . . . . . . 752 422. List OS Messages of a Logical Partition:
Response . . . . . . . . . . . . . 752 423. List Managed Virtual Machines of a Logical
Partition: Request . . . . . . . . . . 759 424. List Managed Virtual Machines of a Logical
Partition: Response . . . . . . . . . 760 425. List Reset Activation Profiles: Request 763 426. List Reset Activation Profiles: Response 763 427. Get Reset Activation Profile Properties:
Request . . . . . . . . . . . . . 765 428. Get Reset Activation Profile Properties:
Response . . . . . . . . . . . . . 765 429. List Image Activation Profiles: Request 787 430. List Image Activation Profiles: Response 788 431. Get Image Activation Profile Properties:
Request . . . . . . . . . . . . . 790 432. Get Image Activation Profile Properties:
Response (Part 1) . . . . . . . . . . 791 433. Get Image Activation Profile Properties:
Response (Part 2) . . . . . . . . . . 792 434. List Load Activation Profiles: Request 798 435. List Load Activation Profiles: Response 798 436. Get Load Activation Profile Properties:
Request . . . . . . . . . . . . . 800 437. Get Load Activation Profile Properties:
Response . . . . . . . . . . . . . 800 438. List Group Profiles: Request . . . . . . 805 439. List Group Profiles: Response . . . . . . 806 440. Get Group Profile Properties: Request 807 441. Get Group Profile Properties: Response 808 442. Energy management as applied throughout
layers of enterprise management . . . . . 817 443. Example of a zBX node group that contains a
BladeCenter with blades . . . . . . . . 818 444. Example of a CPC group that contains a
zCPC . . . . . . . . . . . . . . 818 445. Example of a CPC (Ensemble) group that
contains a zCPC and a BladeCenter . . . . 819 446. Example of a CPC (Ensemble) group that
contains a zCPC . . . . . . . . . . 819 447. Get Energy Optimization Advice Summary:
Request . . . . . . . . . . . . . 839 448. Get Energy Optimization Advice Summary:
Response (Part 1) . . . . . . . . . . 840 449. Get Energy Optimization Advice Summary:
Response (Part 2) . . . . . . . . . . 841
450. Get Energy Optimization Advice Summary: Response (Part 3) . . . . . . . . . . 842
451. Get Energy Optimization Advice Summary: Response (Part 4) . . . . . . . . . . 843
452. Get Energy Optimization Advice Details: Request . . . . . . . . . . . . . 848
453. Get Energy Optimization Advice Details: Response . . . . . . . . . . . . . 848
454. List Ensembles: Request . . . . . . . . 867 455. List Ensembles: Response . . . . . . . 867 456. Get Ensemble Properties: Request . . . . . 868 457. Get Ensemble Properties: Response . . . . 869 458. Update Ensemble Properties: Request 871 459. Update Ensemble Properties: Response 871 460. List Ensemble Nodes: Request . . . . . . 873 461. List Ensemble Nodes: Response . . . . . 873 462. Get Node Properties: Request . . . . . . 875 463. Get Node Properties: Response . . . . . 875 464. Ensemble object: Sample inventory data 880 465. List zBXs of a CPC: Request . . . . . . 893 466. List zBXs of a CPC: Response . . . . . . 893 467. List zBXs of an Ensemble: Request . . . . 895 468. List zBXs of an Ensemble: Response . . . . 896 469. Get zBX Properties: Request . . . . . . 897 470. Get zBX Properties: Response (Part 1) 898 471. Get zBX Properties: Response (Part 2) 899 472. Get EC/MCL Description of zBX (Node):
Request . . . . . . . . . . . . . 900 473. Get EC/MCL Description of zBX (Node):
Response (Part 1) . . . . . . . . . . 901 474. Get EC/MCL Description of zBX (Node):
Response (Part 2) . . . . . . . . . . 902 475. Activate zBX (Node): Request . . . . . . 904 476. Activate zBX (Node): Response . . . . . 904 477. Deactivate zBX (Node): Request . . . . . 906 478. Deactivate zBX (Node): Response . . . . . 907 479. Get zBX (Node) Audit Log: Request . . . . 909 480. Get zBX (Node) Audit Log: Response 909 481. Get zBX (Node) Security Log: Request 911 482. Get zBX (Node) Security Log: Response 912 483. List zBX (Node) Hardware Messages: Request 914 484. List zBX (Node) Hardware Messages:
Response . . . . . . . . . . . . . 915 485. Get zBX (Node) Hardware Message
Properties: Request . . . . . . . . . 916 486. Get zBX (Node) Hardware Message
Properties: Response . . . . . . . . . 917 487. Delete zBX (Node) Hardware Message:
Request . . . . . . . . . . . . . 918 488. Delete zBX (Node) Hardware Message:
Response . . . . . . . . . . . . . 918 489. zBX object: Sample inventory data . . . . 919 490. List Top-of-Rack Switches: Request . . . . 923 491. List Top-of-Rack Switches: Response . . . . 923 492. Get Top-of-Rack Switch Properties: Request 925 493. Get Top-of-Rack Switch Properties: Response 926 494. Get Top-of-Rack Switch Port Details: Request 928 495. Get Top-of-Rack Switch Port Details:
Response . . . . . . . . . . . . . 928 496. Update Top-of-Rack Switch Port Properties:
Request . . . . . . . . . . . . . 930
Figures xv
Level 04a
498. Add MAC Filters to Top-of-Rack Switch Port: Request . . . . . . . . . . . . . 932
499. Add MAC Filters to Top-of-Rack Switch Port: Response . . . . . . . . . . . . . 932
500. Remove MAC Filters from Top-of-Rack Switch Port: Request . . . . . . . . . 934
501. Remove Mac Filters from Top-of-Rack Switch Port: Response . . . . . . . . . . . 934
502. Add Top-of-Rack Switch Port to Virtual Networks: Request . . . . . . . . . . 936
503. Add Top-of-Rack Switch Port to Virtual Networks: Response . . . . . . . . . 936
504. Remove Top-of-Rack Switch Port from the Virtual Networks: Request . . . . . . . 938
505. Remove Top-of-Rack Switch Port from the Virtual Networks: Response. . . . . . . 938
506. List Racks of a zBX: Request . . . . . . 941 507. List Racks of a zBX: Response . . . . . . 941 508. Get Rack Properties: Request . . . . . . 942 509. Get Rack Properties: Response . . . . . . 943 510. Rack object: Sample inventory data . . . . 943 511. List BladeCenters in a Rack: Request 948 512. List BladeCenters in a Rack: Response 949 513. List BladeCenters in a zBX: Request . . . . 951 514. List BladeCenters in a zBX: Response 951 515. Get BladeCenter Properties: Request . . . . 952 516. Get BladeCenter Properties: Response 953 517. Activate BladeCenter: Request . . . . . . 955 518. Activate BladeCenter: Response . . . . . 955 519. Deactivate BladeCenter: Request . . . . . 957 520. Deactivate BladeCenter: Response. . . . . 958 521. BladeCenter object: Sample inventory data 959 522. List Blades in a BladeCenter: Request 966 523. List Blades in a BladeCenter: Response 966 524. List Blades in a zBX: Request . . . . . . 968 525. List Blades in a zBX: Response . . . . . . 969 526. Get Blade Properties: Request . . . . . . 970 527. Get Blade Properties: Response for blade of
type "system-x" (similar for type "power") . . 971 528. Get Blade Properties: Response for blade of
type "dpx150z": . . . . . . . . . . . 972 529. Get Blade Properties: Response for blade of
type "isaopt": . . . . . . . . . . . 973 530. Activate a Blade: Request . . . . . . . 975 531. Activate a Blade: Response . . . . . . . 975 532. Deactivate a Blade: Request . . . . . . . 977 533. Deactivate a Blade: Response . . . . . . 977 534. Sample inventory data for a blade of type
"power" . . . . . . . . . . . . . 982 535. Sample inventory data for a blade of type
"system-x" . . . . . . . . . . . . 983 536. List Virtualization Hosts of a zBX (Node):
Request . . . . . . . . . . . . . 1000 537. List Virtualization Hosts of a zBX (Node):
Response . . . . . . . . . . . . 1000 538. List Virtualization Hosts of a Node: Request 1002 539. List Virtualization Hosts of a Node:
Response . . . . . . . . . . . . 1002
540. List Virtualization Hosts of an Ensemble: Request . . . . . . . . . . . . . 1004
541. List Virtualization Hosts of an Ensemble: Response . . . . . . . . . . . . 1005
542. List Virtualization Hosts of a CPC: Request 1007 543. List Virtualization Hosts of a CPC: Response 1008 544. Get Virtualization Host Properties: Request 1009 545. Get Virtualization Host Properties: Response
for virtualization host of type "prsm" . . . 1010 546. Get Virtualization Host Properties: Response
for virtualization host of type "power-vm" . 1011 547. Get Virtualization Host Properties: Response
for virtualization host of type "x-hyp" . . . 1012 548. Get Virtualization Host Properties: Response
for virtualization host of type "zvm" . . . 1013 549. List Virtual Switches: Request. . . . . . 1016 550. List Virtual Switches: Response . . . . . 1016 551. Get Virtual Switch Properties: Request 1018 552. Get Virtual Switch Properties: Response for
virtual switch of type "iedn" . . . . . . 1018 553. Get Virtual Switch Properties: Response for
virtual switch of type "qdio" . . . . . . 1019 554. Get Switch Controllers: Request . . . . . 1026 555. Get Switch Controllers: Response . . . . 1027 556. Virtualization Host object: Sample inventory
data for a virtualization host of type "power-vm". . . . . . . . . . . . 1035
557. Virtualization Host object: Sample inventory data for a virtualization host of type "prsm" . 1036
558. Virtualization Host object: Sample inventory data for a virtualization host of type "x-hyp". 1036
559. List Virtual Servers of a zBX (Node): Request 1064 560. List Virtual Servers of a zBX (Node):
Response . . . . . . . . . . . . 1065 561. List Virtual Servers of a Node: Request 1067 562. List Virtual Servers of a Node: Response 1067 563. List Virtual Servers of an Ensemble: Request 1069 564. List Virtual Servers of an Ensemble:
Response . . . . . . . . . . . . 1070 565. List Virtual Servers of a CPC: Request 1072 566. List Virtual Servers of a CPC: Response 1073 567. List Virtual Servers of a Virtualization Host:
Request . . . . . . . . . . . . . 1075 568. List Virtual Servers of a Virtualization Host:
Response . . . . . . . . . . . . 1075 569. Create Virtual Server: Request for a virtual
server of type "power-vm" . . . . . . . 1080 570. Create Virtual Server: Response for a virtual
server of type "power-vm" . . . . . . . 1080 571. Delete Virtual Server: Request . . . . . 1082 572. Delete Virtual Server: Response . . . . . 1082 573. Get Virtual Server Properties: Request 1084 574. Get Virtual Server Properties: Response for
virtual servers of "power-vm" (Part 1) . . . 1085 575. Get Virtual Server Properties: Response for
virtual servers of "power-vm" (part 2) . . . 1086 576. Get Virtual Server Properties: Response for
virtual servers of type "prsm" . . . . . . 1087 577. Get Virtual Server Properties: Response for
virtual servers of type "x-hyp" (Part 1) . . . 1088
xvi HMC Web Services API
Level 04a
578. Get Virtual Server Properties: Response for virtual servers of type "x-hyp" (Part 2) . . . 1089
579. Get Virtual Server Properties: Response for virtual servers of type "zvm" . . . . . . 1090
580. Update Virtual Server Properties: Request for a virtual server of type "x-hyp" . . . . 1095
581. Update Virtual Server Properties: Response for a virtual server of type "x-hyp" . . . . 1095
582. Create Network Adapter: Request for a virtual server of type "x-hyp" . . . . . . 1097
583. Create Network Adapter: Response for a virtual server of type "x-hyp" . . . . . . 1098
584. Delete Network Adapter: Request . . . . 1099 585. Delete Network Adapter: Response 1099 586. Get Network Adapter Properties: Request 1101 587. Get Network Adapter Properties: Response 1101 588. Update Network Adapter: Request for a
virtual server of type "x-hyp" . . . . . . 1104 589. Update Network Adapter: Response for a
virtual server of type "x-hyp" . . . . . . 1104 590. Reorder Network Adapter: Request 1106 591. Reorder Network Adapter: Response 1106 592. Create Virtual Disk: Request for a virtual
server of type "power-vm" . . . . . . . 1109 593. Create Virtual Disk: Response for a virtual
server of type "power-vm" . . . . . . . 1109 594. Create Virtual Disk: Request for a virtual
server of type "x-hyp" . . . . . . . . 1109 595. Create Virtual Disk: Response for a virtual
server of type "x-hyp" . . . . . . . . 1110 596. Delete Virtual Disk: Request . . . . . . 1111 597. Delete Virtual Disk: Response . . . . . . 1112 598. Get Virtual Disk Properties: Request for a
virtual server of type "power-vm" . . . . 1113 599. Get Virtual Disk Properties: Response for a
virtual server of type "power-vm" . . . . 1114 600. Get Virtual Disk Properties: Request for a
virtual server of type "x-hyp" . . . . . . 1114 601. Get Virtual Disk Properties: Response for a
virtual server of type "x-hyp" . . . . . . 1114 602. Update Virtual Disk Properties: Request for a
virtual server of type "x-hyp" . . . . . . 1117 603. Update Virtual Disk Properties: Response for
a virtual server of type "x-hyp" . . . . . 1117 604. Reorder Virtual Disks: Request . . . . . 1119 605. Reorder Virtual Disks: Response . . . . . 1119 606. Activate Virtual Server: Request . . . . . 1121 607. Activate Virtual Server: Response . . . . 1121 608. Deactivate Virtual Server: Request . . . . 1123 609. Deactivate Virtual Server: Response 1124 610. Mount Virtual Media: Request . . . . . 1126 611. Mount Virtual Media: Response . . . . . 1126 612. Unmount Virtual Media: Request . . . . 1129 613. Unmount Virtual Media: Response 1130 614. Initiate Virtual Server Dump: Request 1133 615. Initiate Virtual Server Dump: Response 1133 616. Virtual Server object: Sample inventory data
for a virtual server of type "power-vm" (Part 1) . . . . . . . . . . . . . . . 1135
617. Virtual Server object: Sample inventory data for a virtual server of type "power-vm" (Part 2) . . . . . . . . . . . . . . . 1136
618. Virtual Server object: Sample inventory data for a virtual server of type "prsm" . . . . 1137
619. Virtual Server object: Sample inventory data for a virtual server of type "x-hyp" . . . . 1138
620. Object model . . . . . . . . . . . 1140 621. List Storage Resources: Request . . . . . 1145 622. List Storage Resources: Response . . . . 1145 623. Get Storage Resource Properties: Request 1147 624. Get Storage Resource Properties: Response 1147 625. Create Storage Resource: Request . . . . 1149 626. Create Storage Resource: Response 1149 627. Update Storage Resource Properties: Request 1151 628. Update Storage Resource Properties:
Response . . . . . . . . . . . . 1151 629. Delete Storage Resource: Request . . . . 1152 630. Delete Storage Resource: Response 1153 631. Export World Wide Port Names List: WWPN
list: Request. . . . . . . . . . . . 1155 632. Export World Wide Port Names List: WWPN
list: Response . . . . . . . . . . . 1155 633. List Virtualization Host Storage Resources of
a Storage Resource: Request . . . . . . 1158 634. List Virtualization Host Storage Resources of
a Storage Resource: Response . . . . . . 1159 635. Storage Resource object: Sample inventory
data . . . . . . . . . . . . . . 1160 636. List Virtualization Host HBA Ports: Request 1163 637. List Virtualization Host HBA Ports:
Response . . . . . . . . . . . . 1164 638. List Virtualization Host Storage Resources:
Request . . . . . . . . . . . . . 1167 639. List Virtualization Host Storage Resources:
Response . . . . . . . . . . . . 1167 640. Get Virtualization Host Storage Resource
Properties: Request . . . . . . . . . 1169 641. Get Virtualization Host Storage Resource
Properties: Response for Virtualization Host of type "power-vm" or "x-hyp" . . . . . 1170
642. Get Virtualization Host Storage Resource Properties: Response for Virtualization Host of type "zvm" . . . . . . . . . . . 1171
643. Create Virtualization Host Storage Resource: Request . . . . . . . . . . . . . 1174
644. Create Virtualization Host Storage Resource: Response . . . . . . . . . . . . 1174
645. Delete Virtualization Host Storage Resource: Request . . . . . . . . . . . . . 1176
646. Delete Virtualization Host Storage Resource: Response . . . . . . . . . . . . 1176
647. Add Virtualization Host Storage Resource Paths: Request . . . . . . . . . . . 1179
648. Add Virtualization Host Storage Resource Paths: Response . . . . . . . . . . 1179
649. List Virtual Disks of a Virtualization Host Storage Resource: Request . . . . . . . 1186
650. List Virtual Disks of a Virtualization Host Storage Resource: Response . . . . . . 1186
Figures xvii
Level 04a
653. Get Virtualization Host Storage Group Properties: Request . . . . . . . . . 1192
654. Get Virtualization Host Storage Group Properties: Response . . . . . . . . . 1192
655. List Virtual Networks: Request . . . . . 1202 656. List Virtual Networks: Response . . . . . 1202 657. Get Virtual Network Properties: Request 1203 658. Get Virtual Network Properties: Response 1203 659. Update Virtual Network Properties: Request 1206 660. Update Virtual Network Properties:
Response . . . . . . . . . . . . 1206 661. Create Virtual Network: Request . . . . . 1208 662. Create Virtual Network: Response . . . . 1208 663. Delete Virtual Network: Request . . . . . 1210 664. Delete Virtual Network: Response . . . . 1210 665. List Members of a Virtual Network: Request 1212 666. List Members of a Virtual Network:
Response . . . . . . . . . . . . 1212 667. Virtual Network object: Sample inventory
data . . . . . . . . . . . . . . 1213 668. List Workload Resource Groups of an
Ensemble: Request . . . . . . . . . 1225 669. List Workload Resource Groups of an
Ensemble: Response . . . . . . . . . 1226 670. Get Workload Resource Group Properties:
Request . . . . . . . . . . . . . 1227 671. Get Workload Resource Group Properties:
Response . . . . . . . . . . . . 1228 672. Create Workload Resource Group: Request 1230 673. Create Workload Resource Group: Response 1231 674. Delete Workload Resource Group: Request 1232 675. Delete Workload Resource Group: Response 1232 676. Update Workload Resource Group: Request 1234 677. Update Workload Resource Group: Response 1234 678. List Virtual Servers of a Workload Resource
Group: Request . . . . . . . . . . 1236 679. List Virtual Servers of a Workload Resource
Group: Response . . . . . . . . . . 1237 680. Add Virtual Server to a Workload Resource
Group: Request . . . . . . . . . . 1239 681. Add Virtual Server to a Workload Resource
Group: Response . . . . . . . . . . 1239 682. Remove Virtual Server from a Workload
Resource Group: Request . . . . . . . 1241 683. Remove Virtual Server from a Workload
Resource Group: Response . . . . . . . 1241 684. List Groups of Virtual Servers of a Workload
Resource Group: Request . . . . . . . 1243 685. List Groups of Virtual Servers of a Workload
Resource Group: Response . . . . . . . 1243 686. Add Group of Virtual Servers to a Workload
Resource Group: Request . . . . . . . 1245 687. Add Group of Virtual Servers to a Workload
Resource Group: Response . . . . . . . 1245 688. Remove Group of Virtual Servers from a
Workload Resource Group: Request. . . . 1247
689. Remove Group of Virtual Servers from a Workload Resource Group: Response . . . 1247
690. List Performance Policies: Request . . . . 1258 691. List Performance Policies: Response 1259 692. Get Performance Policy Properties: Request 1260 693. Get Performance Policy Properties: Response
(Part 1) . . . . . . . . . . . . . 1261 694. Get Performance Policy Properties: Response
(Part 2) . . . . . . . . . . . . . 1262 695. Create Performance Policy: Request 1264 696. Create Performance Policy: Response 1264 697. Delete Performance Policy: Request 1266 698. Delete Performance Policy: Response 1266 699. Update Performance Policy: Request 1268 700. Update Performance Policy: Response 1269 701. Activate Performance Policy: Request 1270 702. Activate Performance Policy: Response 1270 703. Export Performance Policy: Request 1273 704. Export Performance Policy: Response 1274 705. Relationship between reports and the
properties used . . . . . . . . . . 1276 706. Generate Workload Resource Groups Report:
Request . . . . . . . . . . . . . 1280 707. Generate Workload Resource Group
Performance Index Report: Request . . . . 1282 708. Generate Workload Resource Group
Resource Adjustments Report: Request. . . 1287 709. Generate Virtual Servers Report: Request 1291 710. Generate Virtual Server CPU Utilization
Report: Request . . . . . . . . . . 1294 711. Generate Virtual Server Resource
Adjustments Report: Request . . . . . . 1298 712. Generate Hypervisor Report: Request 1307 713. Generate Hypervisor Resource Adjustments
Report: Request . . . . . . . . . . 1311 714. Generate Service Classes Report: Request 1314 715. Generate Service Class Resource
Adjustments Report: Request . . . . . . 1319 716. Generate Service Class Hops Report:
Request . . . . . . . . . . . . . 1324 717. Generate Service Class Virtual Server
Topology Report: Request . . . . . . . 1332 718. Generate Load Balancing Report: Request 1334 719. Relationship between reports and the
properties used . . . . . . . . . . 1361 720. Generate Workload Resource Groups Report
(Ensemble Availability Management): Request . . . . . . . . . . . . . 1365
721. Generate Workload Resource Group Availability Status Report: Request . . . . 1370
722. Generate Virtual Servers Report: Request 1372 723. Generate Virtual Servers Report: Request 1375 724. Get Performance Management Velocity Level
Range Mappings: Request . . . . . . . 1377 725. Workload Resource Group: Sample
inventory data (Part 1) . . . . . . . . 1378 726. Workload Resource Group: Sample
inventory data (Part 2) . . . . . . . . 1379 727. Workload Resource Group: Sample
inventory data (Part 3) . . . . . . . . 1380
xviii HMC Web Services API
Level 04a
728. Workload Resource Group: Sample inventory data (Part 4) . . . . . . . . 1381
729. Policy XML example, Part 1 . . . . . . 1390 730. Policy XML example, Part 2 . . . . . . 1391
Figures xix
Level 04a
Level 04a
Tables
1. Summary of updates for API version 1.1 (HMC/SE Version 2.11.1) . . . . . . . . 8
2. Summary of updates for API version 1.2 (HMC/SE Version 2.11.1) . . . . . . . . 8
3. Summary of updates for API version 1.3 (HMC/SE Version 2.12.0) . . . . . . . . 9
4. Summary of updates for API version 1.4 (HMC/SE Version 2.12.1) . . . . . . . . 11
5. Summary of updates for API version 1.5 (HMC/SE Version 2.12.1) . . . . . . . . 13
6. Summary of updates for API version 1.6 (HMC/SE Version 2.13.0) . . . . . . . . 14
7. Summary of updates for API version 1.7 (HMC/SE Version 2.13.1) . . . . . . . . 16
8. Summary of updates for API version 2.1 (HMC/SE Version 2.13.1) . . . . . . . . 21
9. Summary of updates for API version 2.2 (HMC/SE Version 2.13.1) . . . . . . . . 22
10. Summary of updates for API version 2.20 (HMC/SE Version 2.14.0) . . . . . . . . 23
11. Summary of updates for API version 2.21 (HMC/SE Version 2.14.0) . . . . . . . . 26
12. Summary of updates for API version 2.22 (HMC/SE Version 2.14.0) . . . . . . . . 26
13. Summary of updates for API version 2.23 (HMC/SE Version 2.14.0) . . . . . . . . 27
14. Summary of updates for API version 2.24 (HMC/SE Version 2.14.0) . . . . . . . . 30
15. Primitive data types. . . . . . . . . . 31 16. Compound data types . . . . . . . . . 32 17. Primitive data types in JSON notation . . . 32 18. Compound data types in JSON notation 33 19. error-feature-info object properties . . . . . 44 20. General API services: operations summary 67 21. General API services: URI variables . . . . 67 22. topic-info object . . . . . . . . . . . 78 23. Inventory service: operations summary 87 24. Metrics service: operations summary . . . . 87 25. Metrics service: URI variables . . . . . . 87 26. BladeCenter temperature and power metric
group . . . . . . . . . . . . . . 103 27. Blade power metric group . . . . . . . 104 28. Channels metric group . . . . . . . . 104 29. CPC overview metric group . . . . . . 105 30. zBX node overview metric group . . . . . 106 31. DPM system overview metric group . . . . 106 32. Logical partitions metric group . . . . . 107 33. Partitions metric group . . . . . . . . 108 34. zCPC environmentals and power metric
group . . . . . . . . . . . . . . 108 35. zCPC processors metric group . . . . . . 109 36. Blade CPU and memory metric group 110 37. Crypto metric group . . . . . . . . . 110 38. Adapters metric group . . . . . . . . 110 39. Flash memory adapters metric group 111 40. RoCE adapters metric group . . . . . . 111
41. Ensemble power metric group . . . . . . 112 42. Virtual server CPU and memory metric group 112 43. Virtualization host CPU and memory metric
group . . . . . . . . . . . . . . 114 44. Workload metrics group - service class data
metric group . . . . . . . . . . . . 115 45. Virtualization host (vSwitch) uplink metric
group . . . . . . . . . . . . . . 117 46. Virtualization host (vSwitch) by virtual
network metric group . . . . . . . . . 119 47. Attached virtual server network adapters
metric group . . . . . . . . . . . . 122 48. Optimizer IEDN virtual network interface
metric group . . . . . . . . . . . . 124 49. Optimizer IEDN physical network adapter
metric group . . . . . . . . . . . . 125 50. Network adapter port metric group . . . . 127 51. Network interface metric group . . . . . 129 52. Top-of-rack switch port metrics group 131 53. Optimizer IEDN physical network adapter
metric group . . . . . . . . . . . . 133 54. DPM - Partition: operations summary 139 55. DPM - Partition: URI variables. . . . . . 140 56. DPM - Adapter: operations summary 140 57. DPM - Adapter: URI variables . . . . . . 141 58. DPM - Virtual Switch: operations summary 141 59. DPM - Virtual Switch: URI variables . . . . 141 60. DPM - Capacity Group: operations summary 142 61. DPM - Capacity Group: URI variables 142 62. DPM - Storage Site: operations summary 142 63. DPM - Storage Site: URI variables. . . . . 142 64. DPM - Storage Fabric: operations summary 142 65. DPM - Storage Fabric: URI variables . . . . 143 66. DPM - Storage Switch: operations summary 143 67. DPM - Storage Switch: URI variables 143 68. DPM - Storage Subsystem: operations
summary . . . . . . . . . . . . . 143 69. DPM - Storage Subsystem: URI variables 144 70. DPM - Storage Control Unit: operations
summary . . . . . . . . . . . . . 144 71. DPM - Storage Control Unit: URI variables 145 72. DPM - Storage Group: operations summary 145 73. DPM - Storage Group: URI variables 145 74. Partition object: base managed object
properties specializations . . . . . . . 146 75. Partition object: class specific properties 148 76. partition-feature-info object properties 159 77. crypto-configuration nested object properties 160 78. crypto-domain-configuration nested object
properties . . . . . . . . . . . . . 160 79. Partition object - Virtual Function element
properties . . . . . . . . . . . . . 161 80. Partition object - NIC element object
properties . . . . . . . . . . . . . 161 81. Partition object - HBA element object
properties . . . . . . . . . . . . . 163
| || | ||
||
|| || || || || || | || || | || || || ||
||
84. Delete Partition Asynchronously: HTTP status and reason codes . . . . . . . . . . 178
85. Delete Partition Asynchronously: Job status and reason codes . . . . . . . . . . 179
86. Update Partition Properties: HTTP status and reason codes . . . . . . . . . . . . 184
87. Update Partition Properties Asynchronously: HTTP status and reason codes . . . . . . 188
88. Update Partition Properties Asynchronously: Job status and reason codes . . . . . . . 188
89. Start Partition: Job status and reason codes 192 90. Stop Partition: Job status and reason codes 195 91. Dump Partition: HTTP status and reason
codes . . . . . . . . . . . . . . 197 92. Dump Partition: Job status