CIM Management Interface

z Systems

Common Information Model (CIM) Management InterfaceSB10-7165-01

IBM

Note:Before you use this information and the product it supports, read the information in “Safety” onpage vii, Appendix B, “Notices,” on page 239, and IBM Systems Environmental Notices and UserGuide, Z125–5823.

This edition, SB10-7165-01, applies to the IBM z Systems and IBM LinuxONE servers. This edition replacesSB10-7165-00.

There may be a newer version of this document in a PDF file available on Resource Link. Go tohttp://www.ibm.com/servers/resourcelink and click on Library on the navigation bar. A newer version is indicatedby a lowercase, alphabetic letter following the form number suffix (for example: 00a, 00b, 01a, 01b).

© Copyright IBM Corporation 2015, 2016.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

http://www.ibm.com/servers/resourcelink

Contents

Figures . . . . . . . . . . . . . . . v

Safety . . . . . . . . . . . . . . . viiSafety notices . . . . . . . . . . . . . vii

World trade safety information . . . . . . . viiLaser safety information . . . . . . . . . . vii

Laser compliance . . . . . . . . . . . vii

About this publication . . . . . . . . ixHow this book is organized . . . . . . . . . ixAccessibility . . . . . . . . . . . . . . ix

Accessibility features . . . . . . . . . . xKeyboard navigation . . . . . . . . . . xIBM and accessibility . . . . . . . . . . x

Revisions . . . . . . . . . . . . . . . xHow to send your comments . . . . . . . . . x

Chapter 1. General information . . . . . 1General . . . . . . . . . . . . . . . . 1CIM objects. . . . . . . . . . . . . . . 1

CIM schema version . . . . . . . . . . . 1CIM profiles . . . . . . . . . . . . . 1Managed Object Format . . . . . . . . . 2

CIM server configuration . . . . . . . . . . 2Enabling the CIM server prior to HMC version2.11.1 . . . . . . . . . . . . . . . . 2Enabling the CIM server on HMC versions 2.11.1 -2.12.1 . . . . . . . . . . . . . . . . 3Enabling the CIM server on HMC version 2.13.0and later. . . . . . . . . . . . . . . 3Enabling temporary capacity changes . . . . . 4HMC user configuration . . . . . . . . . 4Authorization . . . . . . . . . . . . . 8

CIM client configuration . . . . . . . . . . 13Protocol . . . . . . . . . . . . . . 13TCP/IP address . . . . . . . . . . . . 13Port number . . . . . . . . . . . . . 13User and password . . . . . . . . . . . 13CIM namespaces . . . . . . . . . . . 13

Indications . . . . . . . . . . . . . . 13Registering for indications . . . . . . . . 14

Chapter 2. CIM model descriptions . . 15Class hierarchy . . . . . . . . . . . . . 15

Computer system related classes . . . . . . 15Service related classes . . . . . . . . . . 24Setting data related classes . . . . . . . . 26Logical device related classes . . . . . . . 30Association classes . . . . . . . . . . . 30

Class relationships . . . . . . . . . . . . 31CPC relationships . . . . . . . . . . . 31Image relationships . . . . . . . . . . . 33Support Element and Hardware ManagementConsole relationships . . . . . . . . . . 34

Service and capabilities relationships . . . . . 36Setting data relationships . . . . . . . . . 37Resource pool relationships . . . . . . . . 39

Chapter 3. Class definitions. . . . . . 41Computer systems . . . . . . . . . . . . 43

CPC . . . . . . . . . . . . . . . . 43Image . . . . . . . . . . . . . . . 60Support Element. . . . . . . . . . . . 70HMC . . . . . . . . . . . . . . . 82

Services . . . . . . . . . . . . . . . 95Boot control . . . . . . . . . . . . . 95Image operations . . . . . . . . . . . 101Processor operations . . . . . . . . . . 110Resource pool configuration . . . . . . . 113Virtual system management . . . . . . . 118

Setting data . . . . . . . . . . . . . . 123Boot control . . . . . . . . . . . . . 124Virtual system management . . . . . . . 132Temporary capacity . . . . . . . . . . 164

Logical devices . . . . . . . . . . . . . 172Fibre channel . . . . . . . . . . . . 172Processors . . . . . . . . . . . . . 182

Indications . . . . . . . . . . . . . . 189Lifecycle indications . . . . . . . . . . 189Modification indications . . . . . . . . . 191Alert indications . . . . . . . . . . . 191

Chapter 4. z specific classes inManaged Object Format . . . . . . . 195Classes . . . . . . . . . . . . . . . 195

IBMZ_AuditLog . . . . . . . . . . . 195IBMZ_ComputerSystem . . . . . . . . . 195IBMZ_CoordinatedTimingNetwork . . . . . 196IBMZ_CPC . . . . . . . . . . . . . 198IBMZ_CPCBootSettingData . . . . . . . . 200IBMZ_FCPortSettingData . . . . . . . . 201IBMZ_GroupSettingData . . . . . . . . 202IBMZ_HardwareManagementConsole . . . . 203IBMZ_HardwareMessageLog . . . . . . . 203IBMZ_Image . . . . . . . . . . . . 203IBMZ_ImageBootSettingData . . . . . . . 204IBMZ_ImageBootSourceSetting . . . . . . 205IBMZ_ImageOperationsService . . . . . . 206IBMZ_ImageSettingData. . . . . . . . . 214IBMZ_InstCreation . . . . . . . . . . 216IBMZ_InstDeletion . . . . . . . . . . 216IBMZ_InstModification . . . . . . . . . 217IBMZ_MemorySettingData . . . . . . . . 217IBMZ_OperatingSystem . . . . . . . . . 218IBMZ_OSMessage . . . . . . . . . . . 218IBMZ_ProcessorOperationsService . . . . . 219IBMZ_ProcessorSettingData . . . . . . . 219IBMZ_SecurityLog. . . . . . . . . . . 222IBMZ_SupportElement . . . . . . . . . 222

© Copyright IBM Corp. 2015, 2016 iii

IBMZ_TemporaryCapacityProcessor . . . . . 223IBMZ_TemporaryCapacityProcessorRecord . . 224IBMZ_TemporaryCapacityRecord. . . . . . 225IBMZ_TemporaryCapacityTarget . . . . . . 229

Association classes . . . . . . . . . . . 231IBMZ_CoordinatedTimingNetworkComponent 231IBMZ_ElementSoftwareIdentity . . . . . . 232IBMZ_ManagedSE. . . . . . . . . . . 233

Appendix A. z Systems or LinuxONEto CIM status mappings . . . . . . . 235IBMZ_CPC z Systems or LinuxONE to CIM statusmappings . . . . . . . . . . . . . . 235

IBMZ_Image z Systems or LinuxONE to CIMstatus mappings . . . . . . . . . . . . 236

Appendix B. Notices . . . . . . . . 239Trademarks . . . . . . . . . . . . . . 240Class A Notices. . . . . . . . . . . . . 240

Glossary . . . . . . . . . . . . . 245

Index . . . . . . . . . . . . . . . 253

iv CIM Management Interface

|

|

Figures

1. Customize Console Services task . . . . . . 22. Customize API Settings . . . . . . . . . 33. Customize API Settings task on HMC version

2.13.0 . . . . . . . . . . . . . . . 34. Customize API Settings task . . . . . . . 45. User Profiles . . . . . . . . . . . . 56. Modify User . . . . . . . . . . . . 57. User Properties. . . . . . . . . . . . 68. User Management. . . . . . . . . . . 79. User Details . . . . . . . . . . . . . 8

10. Inheritance diagram for computer systemrelated objects. . . . . . . . . . . . 16

11. Inheritance diagram for operating systemrelated objects. . . . . . . . . . . . 17

12. Inheritance diagram for licensed internal coderelated objects. . . . . . . . . . . . 18

13. Inheritance diagram for log related objects. 1914. Inheritance diagram for coordinated timing

network related objects. . . . . . . . . 2115. Inheritance diagram for miscellaneous

computer system related objects. . . . . . 2216. Inheritance diagram for physical packaging

related objects. . . . . . . . . . . . 24

17. Inheritance diagram for service related objects 2518. Inheritance diagram for capabilities related

objects . . . . . . . . . . . . . . 2619. Inheritance diagram for boot setting data

related objects. . . . . . . . . . . . 2720. Inheritance diagram for virtual system setting

data related objects . . . . . . . . . . 2821. Inheritance diagram for temporary capacity

setting data related objects . . . . . . . 2922. Inheritance diagram for logical device related

classes . . . . . . . . . . . . . . 3023. Inheritance diagram for associations . . . . 3124. CPC relationship diagram. . . . . . . . 3225. Image relationship diagram . . . . . . . 3326. Support Element and Hardware Management

Console relationship diagram . . . . . . 3527. Service and capabilities relationship diagram 3628. Boot setting data relationship diagram . . . 3729. Image setting data relationship diagram 3830. Temporary capacity setting data relationship

diagram. . . . . . . . . . . . . . 3931. Resource pool relationship diagram . . . . 40

© Copyright IBM Corp. 2015, 2016 v

||

vi CIM Management Interface

Safety

Safety noticesSafety notices may be printed throughout this guide. DANGER notices warn you of conditions orprocedures that can result in death or severe personal injury. CAUTION notices warn you of conditionsor procedures that can cause personal injury that is neither lethal nor extremely hazardous. Attentionnotices warn you of conditions or procedures that can cause damage to machines, equipment, orprograms.

There are no DANGER notices in this guide.

World trade safety informationSeveral countries require the safety information contained in product publications to be presented in theirtranslation. If this requirement applies to your country, a safety information booklet is included in thepublications package shipped with the product. The booklet contains the translated safety informationwith references to the US English source. Before using a US English publication to install, operate, orservice this IBM® product, you must first become familiar with the related safety information in theSystems Safety Notices, G229-9054. You should also refer to the booklet any time you do not clearlyunderstand any safety information in the US English publications.

Laser safety informationAll IBM z Systems™ (z SystemsTM) and IBM LinuxONETM (LinuxONE) models can use I/O cards such asFICON®, Open Systems Adapter (OSA), InterSystem Channel-3 (ISC-3), or other I/O features which arefiber optic based and utilize lasers (short wavelength or long wavelength lasers).

Laser complianceAll lasers are certified in the US to conform to the requirements of DHHS 21 CFR Subchapter J for Class1 or Class 1M laser products. Outside the US, they are certified to be in compliance with IEC 60825 as aClass 1 or Class 1M laser product. Consult the label on each part for laser certification numbers andapproval information.

CAUTION: Data processing environments can contain equipment transmitting on system links withlaser modules that operate at greater than Class 1 power levels. For this reason, never look into theend of an optical fiber cable or open receptacle. (C027)

CAUTION: This product contains a Class 1M laser. Do not view directly with optical instruments.(C028)

© Copyright IBM Corp. 2015, 2016 vii

viii CIM Management Interface

About this publication

The Common Information Model (CIM) is a system management architecture controlled by theDistributed Management Task Force (DMTF), a collaborative industry standards organization. The DMTFprovides a number of CIM-related specifications, including those that describe:v An object-oriented representation of manageable objects and inter-object associations. This

representation is normally expressed in Managed Object Format (MOF), a C++ class-like representation,but there is an equivalent XML representation as well.

v An object-oriented framework that includes objects, with properties and methods, which defines thecommon functionality of all systems. Management applications written against this framework can beused to manage systems in a platform independent way. Vendors can extend this framework withplatform-specific functionality.

v An API that allows a management client to manipulate CIM objects (create, modify, call methods, etc.).v The transmission of CIM requests in XML format over HTTP.

The Hardware Management Console (HMC) supports a CIM interface in System z10®™ and later zSystems™ and LinuxONE servers that focuses on representing CPCs, Images, and the various types ofActivation Profiles.

How this book is organizedHere is a brief description of the parts of this book:v Chapter 1 provides general information about the CIM management interface.v Chapter 2 identifies the classes that are used in the HMC CIM model: their general purpose, where

each fits into the class hierarchy, and how they are interrelated.v Chapter 3 gives a detailed description of each class, the properties and methods defined by that class

and each of its parent classes, and each association in which the class participates.v Chapter 4 shows the definitions of each of the IBMZ classes in Managed Object Format.

Figures included in this document illustrate concepts and are not necessarily accurate in content,appearance, or specific behavior.

AccessibilityIBM strives to provide products with usable access for everyone, regardless of age or ability.

Accessible publications for this product are offered in HTML format and can be downloaded fromResource Link® at http://www.ibm.com/servers/resourcelink.

If you experience any difficulty with the accessibility of any z Systems and IBM LinuxONE information,go to Resource Link at http://www.ibm.com/servers/resourcelink and click Feedback from thenavigation bar on the left. In the Comments input area, state your question or comment, the publicationtitle and number, choose General comment as the category and click Submit. You can also send an emailto [email protected] providing the same information.

When you send information to IBM, you grant IBM a nonexclusive right to use or distribute theinformation in any way it believes appropriate without incurring any obligation to you.

© Copyright IBM Corp. 2015, 2016 ix

|



Accessibility features

The following list includes the major accessibility features in z Systems and IBM LinuxONEdocumentation:v Keyboard-only operationv Interfaces that are commonly used by screen readersv Customizable display attributes such as color, contrast, and font sizev Communication of information independent of colorv Interfaces commonly used by screen magnifiersv Interfaces that are free of flashing lights that could induce seizures due to photo-sensitivity.

Keyboard navigationThis product uses standard Microsoft Windows navigation keys.

IBM and accessibilitySee http://www.ibm.com/able for more information about the commitment that IBM has to accessibility.

RevisionsA technical change from the previous edition of this document is indicated by a vertical line (|) to the leftof the change.

How to send your commentsYour feedback is important in helping to provide the most accurate and high-quality information. Sendyour comments by using Resource Link at http://www.ibm.com/servers/resourcelink. Click Feedbackon the navigation bar on the left. You can also send an email to [email protected]. Be sure to includethe name of the book, the form number of the book, the version of the book, if applicable, and thespecific location of the text you are commenting on (for example, a page number, table number, or aheading).

x CIM Management Interface

http://www.ibm.com/able


Chapter 1. General information

This chapter provides general information about the Common Information Model (CIM) ManagementInterface.

GeneralThe HMC allows external clients a limited ability to remotely manage system objects using the CommonInformation Model (CIM) management architecture. CIM is defined and controlled by the DistributedManagement Task Force (DMTF), an industry consortium. The DMTF publishes many white papers andspecification documents that describe the many aspects of CIM. These documents, which include severalreferenced later in this book, can be freely accessed at the DMTF Web site: http://www.dmtf.org.

CIM objectsManageable objects are represented in CIM by instances of object-oriented classes. The DMTF defines anextensive class hierarchy, more commonly known as a schema, to describe platform independent featuresof a computer system. Client management scripts that conform to the base schema can expect to manageany computer system that implements the schema in a platform independent manner.

Consistent with object-oriented principles, CIM classes can contain attributes of the object being described(properties) and actions that can be performed on the object (methods).

CIM also defines object references, however their use is limited to special CIM classes known asassociations. Instances of CIM classes are not aware of their relationships to other instances. In otherwords, they do not directly reference another instance. Instead, connections between instances are madeusing instances of association classes. An association instance always contains two references to theobjects that it connects. Associations can, but typically do not, contain other properties.

The HMC extends parts of the schema to provide z Systems and LinuxONE specific functionality. A clientis not likely to be able to make use of the added z Systems and LinuxONE functionality without addingplatform-dependent code to its client management scripts.

The HMC CIM model is described in Chapter 2. Detailed descriptions of the z Systems and LinuxONEspecific classes are found in Chapter 3.

CIM schema versionThe DMTF schema changes over time as functionality is added or removed. The HMC CIM model isbased on the DMTF schema version 2.18.

CIM profilesThe DMTF also defines specification documents known as profiles. A profile generally focuses on arelatively small number of classes and describes additional requirements on the behavior of those classesand how they relate to other classes. An implementation advertises its conformance to a profilespecification through the existence of an instance of class CIM_RegisteredProfile andCIM_ElementConformsToProfile associations from this instance to instances of the class that is central tothe profile.

The HMC implementation is conformant to the following profile specifications:

© Copyright IBM Corp. 2015, 2016 1

||

|

Profile Name Profile Version DMTF Profile Document

Boot Control 1.0 DSP1012: Boot Control Profile

Base Server 1.0 DSP1004: Base Server Profile

Physical Asset 1.0 DSP1011: Physical Asset Profile

Service Processor 1.0 DSP1018: Service Processor Profile

Software Inventory 1.0 DSP1023: Software Inventory Profile

System Virtualization 1.0 DSP1042: System Virtualization Profile

Virtual System 1.0 DSP1057: Virtual System Profile

Managed Object FormatA special Managed Object Format (MOF) syntax is used to represent a class definition. A MOF classdefinition looks like a C++ class definition with the exception that each element in the definition (class,property, method, method parameter, etc.) can be preceded by a set of zero or more attributes calledqualifiers contained in square brackets. There are a few dozen defined qualifiers. Common ones includedescriptions, units, minimum or maximum values, enumerated values and whether a property iswritable.

Class instances can also be described in MOF. A MOF instance is identical to its MOF class, except theproperties have values. There is also an XML format that can be used to represent CIM classes andinstances.

The z Systems and LinuxONE specific MOF class definitions appear in Chapter 4, “z specific classes inManaged Object Format,” on page 195.

CIM server configurationCIM is implemented in a traditional client-server design. The HMC contains a server that is dedicated toprocessing CIM requests. A CIM client queries or manipulates the CIM objects exposed by the server,thereby managing the z Systems and LinuxONE entities that these CIM objects represent.

Enabling the CIM server prior to HMC version 2.11.1By default, the CIM server is disabled on an HMC. To enable the CIM server, log on to an HMC and startthe Customize Console Services task. The Customize Console Services task is located within theHardware Management Console Settings. By default, this task is available to ACSADMIN and SYSPROGusers. Figure 1 shows the Customize Console Services task window when the CIM server is disabled.

Figure 1. Customize Console Services task

2 CIM Management Interface

|

|

To enable the CIM server, change the CIM management interface value from Disabled to Enabled andclick OK. The CIM server is now enabled. The first time the CIM server is enabled, the server might notbe available for up to a minute. The CIM server remains enabled until it is disabled using theCustomized Console Services task. The CIM server enablement setting is remembered across HMCreboots.

Enabling the CIM server on HMC versions 2.11.1 - 2.12.1By default, the CIM server is disabled on an HMC. To enable the CIM server, log on to an HMC and startthe Console Actions task. The Customize API Settings task is located within the Hardware ManagementConsole Settings task. By default, this task is available to ACSADMIN and SYSPROG users. Figure 2shows the CIM page of the Customize API Settings task, when the CIM server is disabled.

To enable the CIM server, select Enable and click OK. The CIM server is now enabled. The first time theCIM server is enabled, the server might not be available for up to a minute. The CIM server remainsenabled until it is disabled using the Customize API Settings task. The CIM server enablement setting isremembered across HMC reboots.

Enabling the CIM server on HMC version 2.13.0 and laterBy default, the CIM server is disabled on an HMC. To enable the CIM server, log on to an HMC and startthe Customize API Settings task. By default, this task is available to ACSADMIN and SYSPROG users.Figure 3 shows the CIM page of the Customize API Settings task, when the CIM server is disabled.

To enable the CIM server, select Enable and click OK. The CIM server is now enabled. The first time theCIM server is enabled, the server might not be available for up to a minute. The CIM server remainsenabled until it is disabled using the Customize API Settings task. The CIM server enablement setting isremembered across HMC reboots.

Figure 2. Customize API Settings

Figure 3. Customize API Settings task on HMC version 2.13.0

Chapter 1. General information 3

Enabling temporary capacity changesBy default, activation or deactivation of temporary capacity records using the CIM interface is disabled. Ifthis capability is wanted, it must be enabled on the Support Element associated with each CPC that willbe a target of CIM temporary capacity activation or deactivation requests. On each SE, start theCustomize API Settings task. The Customize API Settings task is located within Support ElementSettings. By default, this task is available to ACSADMIN and SYSPROG users. Figure 4 shows theCustomize API Settings task when temporary capacity change requests are disabled.

To enable temporary capacity change requests, check the Allow capacity change API requests field andclick OK.

HMC user configurationAll CIM client requests are authenticated against one of the defined HMC users. In addition to validatinga client's user ID and password, the CIM server fails to authenticate a client request if any of thefollowing conditions are true:v The user ID has been disabled.v The password has expired.v Remote connections are not allowed for the user.

An authentication failure results in an entry in the system message log, a pacing response delay and anincrement in the failed logon count for the user, just as with an authentication failure when logging on tothe HMC itself. Each CIM request is authenticated by the CIM server, so ill-behaved clients could resultin high failure counts.

For HMC version 2.12.1 or earlier:

By default, remote connections are not allowed for an HMC user. To enable remote connections, use theUser Profiles or Manage Users Wizard task. By default, these tasks are available only to the ACSADMINuser.

Figure 4. Customize API Settings task


Select the user, for example SYSPROG, that will be used by CIM clients, and then select Modify from theUser list. The Modify User window appears:

From the Modify User window, click User Properties.

Figure 5. User Profiles

Figure 6. Modify User


Check Allow remote access via the web and click OK. Then click OK on the main Modify User window.You can repeat the process for any other user profiles that will be used by CIM clients.

For HMC version 2.13.0 and later:

By default, remote connections are not allowed for an HMC user. To enable remote connections, use theUser Management task. By default, this task is available only to the ACSADMIN user.

Figure 7. User Properties


Select the user, for example SYSPROG, that will be used by CIM clients, and then select the Details icon(the one with the paper and pencil). The User Details window appears:

Figure 8. User Management


Under General, click Allow remote access to the console, click Apply, to apply the changes, and clickOK. You can repeat the process for any other user profiles that will be used by CIM clients.

AuthorizationIn addition to authenticating the user and password, the HMC ensures that the user is authorized toperform each CIM operation. There are two levels of authorization: all requests are checked to ensure thatthe user is authorized to access the target of the request and, for InvokeMethod requests, the user mustalso be authorized to perform the specific task. Target and task authorization is controlled by theauthorities granted to the user in their assigned user roles.

Note: The HMC CIM model is not compatible with CPCs operating in IBM Dynamic Partition Manager(DPM) mode. DPM CPCs, including their CPC Images and other related CIM instances are alwayshidden, regardless of the user authorization.

Information about user roles for HMC Version 2.12.1 and newer can be found on the console help system,or on the IBM Knowledge Center at https://www.ibm.com/support/knowledgecenter. (Select z Systemson the navigation bar, and then select your server).

For user role information from earlier versions of the HMC, see the Hardware Management ConsoleOperations Guide. User roles are managed through the Customize User Controls HMC task. Roles areassigned to users through the User Profiles or Manage Users Wizard HMC tasks.

Target authorizationTarget authorization is performed based on the presence of Defined CPC and CPC Image objects in theManaged Objects roles assigned to the user. A user is authorized to access a target based on three criteria:

Figure 9. User Details


|||

https://www.ibm.com/support/knowledgecenter

CPC The target is a CPC, or is associated with a specific CPC. The target is authorized if the CPC ispresent in the role.

Image The target is an Image, or is associated with a specific Image. The target is authorized if theImage is present in the role.

Any ImageThe target can be associated with multiple Images. It is authorized if at least one Image is presentin the role.

Some targets are either not associated with a CPC or Image, or can be associated with multiple CPCs. Allusers are authorized to access these targets.

The following table lists all of the CIM classes supported by the HMC, and for each, the criteria that areused to authorize targets of that type. If a class has multiple criteria, a user is authorized if any singlecriterion is met. For example, a CIM request that targets a specific IBMZ_ImageSettingData instance willbe authorized if the user is authorized to access the Image associated with the setting data or isauthorized to access the CPC that hosts that Image.

Table 1. CIM classes supported by the HMC

CIM Class All Users CPC Image Any Image

CIM_AllocationCapabilities (Processor) v v

CIM_AllocationCapabilities (ResourcePool) v

CIM_BootConfigSetting (CPC) v

CIM_BootConfigSetting (Image) v v

CIM_BootConfigSetting (Load) v v

CIM_BootService v v

CIM_BootServiceCapabilities v

CIM_EnabledLogicalElementCapabilites v

CIM_FCPort (Host) v

CIM_FCPort (Virtual) v

CIM_IPProtocolEndpoint v v

CIM_LogEntry (HMC) v

CIM_LogEntry (SE) v

CIM_Processor (Host) v

CIM_Processor (Virtual) v

CIM_RedundancySet v

CIM_RegisteredProfile v

CIM_ResourcePool v

CIM_ResourcePoolConfigurationCapabilities v

CIM_ResourcePoolConfigurationService v

CIM_SoftwareIdentity (HMC) v

CIM_SoftwareIdentity (SE) v v

CIM_SystemSpecificCollection (HMC) v

CIM_SystemSpecificCollection (SE) v v

CIM_VirtualSystemManagementCapabilities v

CIM_VirtualSystemManagementService v v

IBMZ_CoordinatedTimingNetwork v


Table 1. CIM classes supported by the HMC (continued)

CIM Class All Users CPC Image Any Image

IBMZ_CPC v

IBMZ_CPCBootSettingData v

IBMZ_FCPortSettingData v

IBMZ_GroupSettingData v

IBMZ_HardwareManagementConsole v

IBMZ_HardwareMessageLog (HMC) v

IBMZ_HardwareMessageLog (SE) v

IBMZ_Image v

IBMZ_ImageBootSettingData (Image) v v

IBMZ_ImageBootSettingData (Load) v v

IBMZ_ImageBootSourceSetting (Image) v v

IBMZ_ImageBootSourceSetting (Load) v v

IBMZ_ImageOperationsService v

IBMZ_ImageSettingData v v

IBMZ_MemorySettingData v v

IBMZ_OperatingSystem v

IBMZ_OSCommandService v

IBMZ_ProcessorOperationsService v v

IBMZ_ProcessorSettingData v v

IBMZ_Rack v

IBMZ_SettingDataStagingService v v

IBMZ_SupportElement v v

IBMZ_TemporaryCapacityProcessorRecord v

IBMZ_TemporaryCapacityRecord v

IBMZ_TemporaryCapacityService v

IBMZ_TemporaryCapacityTarget v

Association instance targets are authorized if both objects referenced by the association are authorized.The results of enumeration requests are filtered using the same criteria as is used for target authorization.

All the system defined users for an HMC are, by default, authorized to access all CPCs and Images. ForHMC version 2.12.1, you can use the Customize User Controls HMC task to create your own roles thatlimit access to a certain set of CPCs and Images. The User Profiles or Manage Users Wizard HMC taskscan then be used to replace the more general CPC and Image role(s) with the custom role for an existinguser, or to create a new user with the new role. For HMC version 2.13.0, you can use the UserManagement HMC task to accomplish these same tasks.

Task authorization (HMC version 2.12.1 or earlier)In addition to authorizing the target, InvokeMethod CIM requests are further checked to ensure that theuser is authorized to execute the specified method. There is not a one-to-one correspondence betweenCIM methods and HMC console tasks, so CIM method authorization is accomplished using a specialCIM Actions system defined Task role containing all the method names supported by the HMC. All thesystem defined users for an HMC are, by default, authorized to execute all CIM methods. You can usethe Customize User Controls HMC task to create your own roles that limit access to a subset of the


supported methods. The User Profiles or Manage Users Wizard HMC tasks can then be used to replacethe CIM Actions Task role with the custom role for an existing user, or to create a new user with the newrole.

Example: Assume one wants to define a user that is dedicated to processing CIM requests. That user isto have access to a single Image called TEST hosted by a CPC named CPC1. The user is further limited inthat the only method that can be invoked on this Image is RequestStateChange. The following stepswould be required:v Start the Customize User Controls HMC task.

– Ensure the Managed Resource Roles radio button is clicked.– Select Add... from the Edit list.– Give your new role a name, for example CPC1:TEST.– From the Based on field, select the existing role on which the new role is based (for example

Limited Managed Objects).– In the Available Objects pane, open the list of managed objects by clicking the plus sign beside

Managed Objects.– Select CPC1:TEST.– Click the Add button. A Managed Objects entry containing CPC1:Test appears in the Current

Objects pane on the right.– Click the OK button.– Click the Task Roles radio button.– Select Add... from the Edit list.– Give your new role a name, for example CIM System Enablement.– Select CIM Actions from the Based on field.– In the Available Objects pane, open the list of tasks by clicking the plus sign beside CIM.– Select RequestStateChange.– Click the Add button. A CIM entry containing RequestStateChange appears in the Current Objects

pane on the right.– Click the OK button.

v Start the User Profiles HMC task (the Manage Users Wizard task can also be used to accomplish thispart).– Select Add... from the User list.– Fill out the User Information, Authentication and Details blocks.– In the Managed Resource Roles list, select the check box to the left of the Managed Object role

created in the previous section (for example, CPC1:TEST).– In the Task Roles list, select the check box to the left of the Task role created in the previous section

(for example, CIM System Enablement).– Click the User Properties... button.– Select the Allow remote access via the web check box.– Click the OK button to return to the main User Profiles panel.– Click the OK button.

Note: By default, the Customize User Controls, User Profiles and Manage Users Wizard are availableonly to the ACSADMIN user.

Referencing Table 1 on page 9, the user created in this example would have access to:v Any instance of a class marked with a bullet in the All Users or Any Image column.v Any instance of a class marked with a bullet in the Image column that is associated with Image

CPC1:TEST.


In addition, the user would be allowed to invoke the RequestStateChange method on the IBMZ_Imageinstance associated with CPC1:TEST.

Task authorization (HMC version 2.13.0)In addition to authorizing the target, InvokeMethod CIM requests are further checked to ensure that theuser is authorized to execute the specified method. There is not a one-to-one correspondence betweenCIM methods and HMC console tasks, so CIM method authorization is accomplished using a specialCIM Actions system defined Task role containing all the method names supported by the HMC. All thesystem defined users for an HMC are, by default, authorized to execute all CIM methods. You can usethe User Management task to create your own roles that limit access to a subset of the supportedmethods. This task can then be used to replace the CIM Actions Task role with the custom role for anexisting user, or to create a new user with the new role.

Example: Assume one wants to define a user that is dedicated to processing CIM requests. That user isto have access to a single Image called TEST hosted by a CPC named CPC1. The user is further limited inthat the only method that can be invoked on this Image is RequestStateChange. The following stepswould be required:v Start the User Management HMC task.

– Click the Roles icon.– Click the New icon. The New Role wizard opens.– Click Next to advance to the Role Name page.– From the Based on field, select an existing role on which the new role is based, for example CIM

Actions.– Give your new role a name, for example CPC1-TEST. Click Next.– On the Select Tasks page, select only RequestStateChange (CIM). Click Next.– Click Next to advance to the Select Specific Objects page.– On the Select Specific Objects page, select only LPAR Image TEST. Click Next.– Continue clicking Next, until you can click Finish to create the new user role.

v On the main page of the User Management HMC task:– Select the User icon.– Click the New icon. The New User wizard opens.– Click Next to advance to the Name User page– Enter a name, such as SpecialCimUser, and click Next.– Enter the password authentication information on the Authentication page, and click Next.– On the Select Roles page, select the check box for the user role you created earlier in this example

(CPC1-TEST). Click Next.– Click Next until you get to the final page, and click Finish to create the new user.

Note: By default, these actions in the User Management task are available only to the ACSADMIN user.

Referencing Table 1 on page 9, the user created in this example would have access to:v Any instance of a class marked with a bullet in the All Users or Any Image column.v Any instance of a class marked with a bullet in the Image column that is associated with Image

CPC1-TEST.

In addition, the user would be allowed to invoke the RequestStateChange method on the IBMZ_Imageinstance associated with CPC1-TEST.


CIM client configurationA CIM client communicates with the CIM server on the HMC via a TCP/IP connection. The CIM serversupports both IPv4 and IPv6 sockets. There are several pieces of information that a CIM client needs toknow in order to connect to the CIM server.

ProtocolThe CIM server on the HMC only accepts SSL (HTTPS) client connections.

TCP/IP addressYou need to know the TCP/IP address of your HMC.

Port numberThe CIM server listens for requests on port 5989.

User and passwordAll CIM client requests are authenticated by the CIM server. They must contain the user name andpassword for one of the users that is defined to the HMC. See “HMC user configuration” on page 4 foradditional information about how HMC users relate to CIM.

CIM namespacesThe CIM classes managed by a CIM server are organized into discreet namespaces. A namespace servesto isolate CIM implementations. Instances of a class need to be unique only within their namespace.

The HMC uses two namespaces within the CIM server. Most classes in the z Systems and LinuxONEimplementation reside in namespace "root/ibmz". The following exist in the CIM server's interoperabilitynamespace, "root/PG_InterOp": CIM_RegisteredProfile, IBMZ_InstCreation, IBMZ_InstDeletion,IBMZ_InstModification, and IBMZ_OSMessage.

IndicationsCIM indications are instances of specialized CIM classes that are asynchronously broadcast to registeredlisteners. They describe an event that occurred. Indication instances do not persist for any amount of timein the CIM server, a fact which has a number of implications, including:v Indications do not have key properties.v Indications do not participate in associations.v There are no methods, intrinsic, or extrinsic, that can be invoked on an indication. For example, one

cannot ask the CIM server to enumerate members of an indication class.

Indications fall into three broad categories:

Lifecycle indications are broadcast when instances of certain classes are created or deleted. Each classdescription in Chapter 3, “Class definitions,” on page 41 contains an Indications section that describes thelifecycle indications, if any, that result when instances of that class are created or deleted.

Modification indications are broadcast when certain properties of certain classes are updated. The tables inthe Class Properties and Methods section of each class description in Chapter 3, “Class definitions,” onpage 41 indicate which class properties, if any, result in modification indications when their values areupdated.

Alert indications are broadcast when some other event occurs. The Indications section of each classdescription describes the alert indications, if any, that are related to that class.


|

Registering for indicationsA client must register with the CIM server to receive indications. Registration is defined by the existenceof instances of three classes in the CIM server’s interoperability namespace (root/PG_InterOp):

CIM_ListenerDestinationCIMXMLDefines a single client listener. Each client wanting to receive indications can create an instance ofCIM_ListenerDestinationCIMXML to describe the I/P information for its listener application. Theimportant property in this instance is Destination, which must be in the form:Protocol+”://”+Hostname+”:”+Port

Where:Protocol is protocol of the listener application ("http"or "https")Hostname is the hostname or I/P address of the listener applicationPort is the port number on which the application is listening

CIM_IndicationFilterDefines a particular indication or set of indications. The following indication filters arepredefined:

Table 2. Predefined indication filters

Filter Name Description

IBM:Z:Alert All alert events.

IBM:Z:All All events.

IBM:Z:Creation All lifecycle creation events.

IBM:Z:Deletion All lifecycle deletion events.

IBM:Z:Instance All lifecycle and modification events.

IBM:Z:Modification All property modification events.

IBM:Z:OSMessage All OS messages events.

The predefined filters should be used if they define the intended set of indications. If not, a clientcan create instances of CIM_IndicationFilter with different filter specifications.

CIM_IndicationSubscriptionCreates an indication subscription by linking a listener (an instance ofCIM_ListenerDestinationCIMXML) to a filter (an instance of CIM_IndicationFilter). If a clientwants to subscribe to more than one filter, there must be an instance ofCIM_IndicationSubscription associating the client’s CIM_ListenerDestinationCIMXML instanceand each CIM_IndicationFilter instance.


Chapter 2. CIM model descriptions

This chapter identifies all the classes that will be used in the HMC CIM model. It describes the generalpurpose for each class, where it fits in the class hierarchy, and how it relates to other classes.

In the figures contained in this chapter, the blue (or darker) shaded classes, with names beginning with"CIM_", represent those defined as part of the base CIM schema. The yellow (or lighter) shaded classes,with names beginning with "IBMZ_", represent the HMC-specific class extensions.

Also, in the figures, certain important CIM property qualifiers might appear after the property name incurly brackets. They are encoded as follows:

d The property has been deprecated.

k The property is a key property for the class.

o The property overrides the definition of the same property defined higher in the class hierarchy.

Class hierarchyThis section introduces the classes in the HMC CIM model and describes how they are linked together inthe class hierarchy. The relationships between these classes are described in “Class relationships” on page31.

Computer system related classesIn CIM, a computer system object is primarily the aggregation point for all the things that make up acomputer system. Some things that one might normally expect to be included in a computer systemobject definition are represented elsewhere. For example, the current trend in CIM class design is todissociate the methods that operate on an object from the object itself. They are instead organized intointerface-like Service objects. See “Service related classes” on page 24.

The diagram in Figure 10 on page 16 describes the class hierarchy for the computer systems in the HMCmodel.


Class IBMZ_CPC represents a CPC. In CIM nomenclature, a CPC IMLed in LPAR mode performs the roleof a host computer system.

Class IBMZ_Image represent an Image, either an LPAR or a Coupling Facility. It performs the CIM role ofa virtual computer system.

Figure 10. Inheritance diagram for computer system related objects


Class IBMZ_SupportElement represents the Support Element associated to a CPC. It performs the CIMrole of a service processor. SE objects are included in the model because they more accurately portray theowner of system setting data (Activation Profiles) and the provider of services. It is not intended that aCIM client can directly manage an SE.

Class IBMZ_HardwareManagementConsole represents an HMC. In CIM terms, the HMC is amanagement client. Since CIM is focused on representing managed objects rather than clients, an HMCdoes not have a defined logical role. However one can view the hardware on which the HMC applicationis running as a manageable object, so the HMC is represented at that level.

The diagram in Figure 11 describes the class hierarchy for operating system related classes.

Class IBMZ_OperatingSystem provides a limited view of an operating system. Instances of this class existonly for operating systems that have been loaded on an Image.

The class diagram in Figure 12 on page 18 describes the class hierarchy for licensed internal code relatedclasses.

Figure 11. Inheritance diagram for operating system related objects.

Chapter 2. CIM model descriptions 17

Licensed internal code bundles are represented in the HMC model as instances of classCIM_SoftwareIdentity. Fixes that can be applied to an internal code bundle are also represented byinstances of CIM_SoftwareIdentity. Only important fix levels (retrieved, installable concurrent, activated,removable concurrent and accepted) are represented. Fix levels that have not yet been installed (retrieved,installable concurrent) are grouped by an instance of class CIM_SystemSpecificCollection.

The class diagram in Figure 13 on page 19 describes the class hierarchy for log related classes.

Figure 12. Inheritance diagram for licensed internal code related objects


CPC hardware messages are represented by instances of class CIM_LogEntry. They are grouped in a logrepresented by an instance of class IBMZ_HardwareMessageLog. An HMC similarly has a hardware

CIM_ManagedElement

Caption : string

Description : string

ElementName : string

CIM_ManagedSystemElement

CommunicationStatus : uint16

DetailedStatus : uint16

HealthState : uint16

InstallDate : datetime

Name : string

OperatingStatus : uint16

OperationalStatus[] : uint16

PrimaryStatus : uint16

Status : string {d}

StatusDescriptions[] : string

CIM_LogicalElement

CIM_EnabledLogicalElement

AvailableRequestedStates[] : uint16

EnabledDefault : uint16

EnabledState : uint16

OtherEnabledState : string

RequestedState : uint16

TimeOfLastStateChange : datetime

TransitioningToState [] : uint16

RequestStateChange()

CIM_LogEntry

CreationTimestamp : datetime

InstanceID : string {k}

LogInstanceID : string

LogName : string

Message : string

MessageArguments[] : string

MessageID : string

OwningEntity : string

RecordID : string

CIM_RecordLog


CIM_Log

CurrentNumberOfRecords : uint64

LogState : uint16

MaxNumberOfRecords : uint64

OverwritePolicy : uint16

ClearLog()

IBMZ_HardwareMessageLog

CIM_RecordForLog

Locale : string {d}

RecordData : string

RecordFormat : string

IBMZ_SecurityLogIBMZ_AuditLog

Figure 13. Inheritance diagram for log related objects.


message log. HMC audit and security log entries are also represented by instances of classCIM_LogEntry. They are associated to an instance of IBMZ_AuditLog and IBMZ_SecurityLog respectively.

The class diagram in Figure 14 on page 21 describes the class hierarchy for coordinated timing networkrelated classes.


A coordinated timing network is a collection of CPCs that have a common time-of-day source. If such anetwork has been configured, it is represented by an instance of class IBMZ_CoordinatedTimingNetwork.Class CIM_RedundancySet groups the current and spare time servers in the network.

Figure 14. Inheritance diagram for coordinated timing network related objects


The diagram in Figure 15 describes the class hierarchy for miscellaneous classes that are related tocomputer systems.

Requirements and behaviors for subcomponents of CIM implementations are defined by the DMTFspecification documents known as profiles. This can be confusing, as the same term is used in commonsystem nomenclature to denote collections of setting data that are used when activating a system. Inorder to avoid confusion, in this document the word "Profile" is capitalized when it refers to anActivation Profile and uncapitalized when it refers to a DMTF specification.

Class CIM_RegisteredProfile defines a version of a specific CIM profile. When an instance of this class isassociated via CIM_ElementConformsToProfile to another element, known as the central instance of theprofile, it is a guarantee to a management client that the element and other related elements conform tothe specifications described in the profile. The following profiles are supported by the HMC model:

Base ServerDescribes a physical computer system.

Boot ControlDescribes the control of the boot process of a computer system.

Figure 15. Inheritance diagram for miscellaneous computer system related objects


Physical AssetDescribes a physical element of a computer system.

Service ProcessorDescribes a computer system that supports a larger computer system.

Software InventoryDescribes software components.

System VirtualizationDescribes the relationship between host and virtual computer systems and how virtual computersystems are defined and managed.

Virtual SystemDescribes a virtual computer system.

Profiles can be autonomous, meaning that they can stand on their own, or component, meaning that theydefine a specific component referenced by a scoping autonomous profile. The Base Server, ServiceProcessor, System Virtualization, and Virtual System profiles are autonomous profiles. The Physical Assetprofile is a component profile of the Base Server profile. The Boot Control and Software Inventoryprofiles are component profiles of the Base Server, Service Processor, and Virtual System profiles.Component profiles are not directly associated to their central instances. Instead, compliance is inferredby the fact the component profiles are associated to their referencing autonomous profile viaCIM_ReferencedProfile associations.

Class CIM_ResourcePool represents the pool of resources provided by a host FC port from which virtualFC ports are drawn.

Class CIM_IPProtocolEndpoint represents an I/P address.

The diagram in Figure 16 on page 24 describes the class hierarchy for classes that represent physicalpackaging.


Class CIM_Rack represents the highest level enclosure of the physical computer system. Except for thisclass, the HMC model does not attempt to model the physical elements of any computer system. TheCIM_Rack class is included because it is the architected place to expose the machine type, model, andserial number information.

Service related classesIn CIM, a Service class represents a set of one or more related methods, and sometimes properties, thatperform a service to or on behalf of a related object. By dissociating the functionality from the object, onecreates the possibility of reusing the service definition in an interface-like manner for multiple classes ofobjects.

The diagram in Figure 17 on page 25 describes the class hierarchy for the service related classes.

Figure 16. Inheritance diagram for physical packaging related objects


Class IBMZ_ImageOperationsService defines the methods that affect the operations of an Image. It can bethought of as an extension to the IBMZ_Image class.

Class CIM_BootService controls the boot process. For CPCs, the boot process is an IML. For Images, theboot process is a Load.

Class CIM_VirtualSystemManagementService provides methods that allow a client to modify virtualsystem configurations (Image Activation Profiles).

Class IBMZ_ProcessorOperationsService defines the methods that affect the operations of a processor. Itcan be thought of as an extension to the CIM_Processor class.

Class CIM_ResourcePoolConfigurationService defines the methods that manage resource pools.

CIM uses separate capabilities classes to indicate to a management client which optional features aresupported by a service and its related classes.

The diagram in Figure 18 on page 26 describes the class hierarchy for the capabilities related classes.

Figure 17. Inheritance diagram for service related objects


Class CIM_EnabledLogicalElementCapabilities is used to describe which, if any, of the defined statechanges (for example, enable, disable, reset) are supported by theCIM_EnabledLogicalElement.RequestStateChange() method.

Class CIM_BootServiceCapabilities is used to define the operations supported by the CIM_BootServiceclass and other boot related aspects.

Class CIM_VirtualSystemMangementCapabilities defines the capabilities of the virtual systemmanagement service and other aspects of system virtualization.

Class CIM_AllocationCapabilities is used for two purposes. The first is to define the allocation capabilitiesof a resource pool. The second is to attach limits, specifically, minimum and maximum processor weights,to processor configurations.

Class CIM_ResourcePoolConfigurationCapabilities defines the capabilities of the resource poolconfiguration service.

Setting data related classesSetting data is the generic CIM concept used to describe collections of configuration-like data. They areused in the HMC model in various ways to describe Activation Profiles and temporary capacity records.

The diagram in Figure 19 on page 27 describes the class hierarchy for the boot setting data related classes.

Figure 18. Inheritance diagram for capabilities related objects


A Reset Activation Profile controls a CPC’s IML process. A Load Activation Profile controls the loading ofan operating system into an Image. In CIM terms, both of these are boot processes, and therefore fallunder the specifications outlined in the Boot Control profile. The profile splits boot related setting datainto three classes: CIM_BootConfigSetting, which serves as an anchor for instances of the other classes,CIM_BootSourceSetting, which defines a device that can be used as the source for the boot configuration,and CIM_BootSettingData, which defines any other boot parameters.

The Reset Activation Profile is represented by class IBMZ_CPCBootSettingData. The boot source isimplied, so there is no explicit CIM_BootSourceSetting present in a CPC boot configuration. There willalso be a single instance of CIM_BootConfigSetting to anchor the full boot configuration.

The Load Activation Profile is split between classes IBMZ_ImageBootSettingData andIBMZ_ImageBootSourceSetting.

The diagram in Figure 20 on page 28 describes the class hierarchy for the virtual setting data relatedclasses.

Figure 19. Inheritance diagram for boot setting data related objects


The Image Activation Profile is split into a number of CIM classes. The parts of the Image Profile thatdeal with the specification of logical devices, for example, processors, memory, and fibre channel ports,are defined in subclasses of CIM_ResourceAllocationSettingData: IBMZ_ProcessorSettingData,

CIM_ResourceAllocationSettingData

Address : string

AllocationUnits : string

AutomaticAllocation : boolean

AutomaticDeallocation : boolean

Connection[] : string

ConsumerVisibility : uint16

HostResource[] : CIM_LogicalDevice inst

Limit : uint64

MappingBehavior : uint16

OtherResourceType : string

Parent : string

PoolID : string

Reservation : uint64

ResourceSubType : string

ResourceType : uint16

VirtualQuantity : uint64

Weight : uint32

CIM_VirtualSystemSettingData

AutomaticRecoveryAction : uint16

AutomaticShutdownAction : uint16

AutomaticStartupAction : uint16

AutomaticStartupActionDelay : datetime

AutomaticStartupActionSequenceNumber : uint16

ConfigurationDataRoot : string

ConfigurationFile : string

ConfigurationID : string

CreationTime : datetime

LogDataRoot : string

Notes[] : string

RecoveryFile : string

SnapshotDataRoot : string

SuspendDataRoot : string

SwapFileDataRoot : string

VirtualSystemIdentifier : string

VirtualSystemType : string

IBMZ_ProcessorSettingData

AbsoluteCappingProcessors: real32Capped : booleanReservedVirtualQuantity : uint64ResourceSubType : string {o}VirtualQuantity : uint64 {o}Weight : uint32 {o}

IBMZ_MemorySettingData

ReservedVirtualQuantity : uint64

ResourceSubType : string {o}

VirtualQuantity : uint64 {o}

IBMZ_FCPortSettingData

ChannelPathID : uint32

ChannelSubsystemID : uint32

DeviceNumber : uint32

ImageID : uint32

SubchannelSetID : uint32

WorldWidePortName : uint64

IBMZ_ImageSettingData

AESKeyImportFunctionsPermitted : boolean

BasicCounterAuthorized : boolean

BasicSampleAuthorized : boolean

CoprocessorGroupCounterAuthorized : boolean

CryptoActivityCounterAuthorized : boolean

DEAKeyImportFunctionsPermitted : boolean

DefinedCapacity : uint32

DiagnosticSampleAuthorized : boolean

ExtendedCounterAuthorized : boolean

ProblemStateCounterAuthorized

VirtualSystemType : string {o}

WorkLoadManaged : boolean

CIM_ManagedElement

Caption : string

Description : string

ElementName : string

CIM_SettingData

ChangeableType : uint16

ConfigurationName : string

ElementName : string {o}


IBMZ_GroupSettingData

Capacity : uint64

Figure 20. Inheritance diagram for virtual system setting data related objects


IBMZ_MemorySettingData and IBMZ_FCPortSettingData respectively. The Image Profile properties thatrelate to loading an operating system are represented by a boot configuration. The remaining propertiesend up in class IBMZ_ImageSettingData, which anchors the entire configuration.

Class IBMZ_ProcessorSettingData defines the quantity of a particular type of processor that is to beassigned to an Image. There are up to 10 separate instances of this class that define the processor quantityof (potentially) every combination of the two processor attributes: (dedicated or shared), and fiveprocessor types (CP, zAAP, IFL, ICA, or ZIIP). If Work Load Management is enabled, for each sharedIBMZ_ProcessorSettingData instance, there will be a CIM_AllocationCapabilities instance with twoadditional IBMZ_ProcessorSettingData instances to define the minimum and maximum processingweights.

Class IBMZ_MemorySettingData defines the amount of assigned and reserved memory for an Image.There can be up to two instances of this class to represent memory allocation from the two types ofmemory: central storage and expanded storage.

Class IBMZ_FCPortSettingData represents the Fibre Channel port data. For each virtual FC port definedin an Input/Output Configuration Data Set, there is an instance of IBMZ_FCPortSettingData representingthe configuration parameters that define the virtual port.

Class IBMZ_GroupSettingData defines an Image group processing weight.

The diagram in Figure 21 describes the class hierarchy for the temporary capacity setting data relatedclasses.

Class IBMZ_TemporaryCapacityRecord is the aggregation point for the representation of a temporarycapacity record. Instances of IBMZ_TemporaryCapacityTarget represent an allowed target CPconfiguration when activating or deactivating the record. Instances ofIBMZ_TemporaryCapacityProcessorRecord represent the capacity information for processor of a specifictype within the record. Instances of its parent class, IBMZ_TemporaryCapacityProcessor, are supplied asparameters when activating or deactivating a temporary capacity record to specify specialty processorquantities.

Figure 21. Inheritance diagram for temporary capacity setting data related objects


Logical device related classesThe diagram in Figure 22 describes the class hierarchy for the logical device related classes.

Class CIM_FCPort represents a Fibre Channel port. In the HMC model, instances of this class are used torepresent both the host (PCHID) and virtual (CHPID) devices.

Class CIM_Processor represents a processor. In the HMC model, instances of this class are used torepresent both the host (PU) and virtual (CP) processors.

Association classesThe diagram in Figure 23 on page 31 describes the association classes that are defined in the HMC model.

Figure 22. Inheritance diagram for logical device related classes


Association IBMZ_ManagedSE links a Hardware Management Console to the Support Elements that itmanages.

Association IBMZ_CoordinatedTimingNetworkComponent links the CPC members to their coordinatedtiming network.

Association IBMZ_ElementSoftwareIdentity links a licensed internal code bundle or licensed internal codefix level to the Support Element or Hardware Management Console to which it applies. Only significantcode levels (retrieved, installable concurrent, removable concurrent, activated, and accepted) arerepresented. The significance of the code level is indicated by the contents of the ElementSoftwareStatusproperty.

Class relationshipsThis section describes how instances of the classes are related to each other. For clarity in the diagrams inthis section, the "CIM_" and "IBMZ_" prefixes have been left off the class names. Classes with namesbeginning with "CIM_" can be identified by the blue (or darker) shading. "IBMZ_" classes have yellow (orlighter) shading.

CPC relationshipsFigure 24 on page 32 shows the classes that are related to the IBMZ_CPC class.

Figure 23. Inheritance diagram for associations


The physical enclosure is modeled using an instance of CIM_Rack, associated viaCIM_ComputerSystemPackage to its CPC.

The enablement capabilities of a CPC are described by an instance ofCIM_EnabledLogicalElementCapabilities associated to each CPC via CIM_ElementCapabilities.

The Fibre Channel port allocation capabilities of a CPC are described by an instance ofCIM_AllocationCapabilities associated to each CPC via CIM_ElementCapabilities. See “Resource poolrelationships” on page 39 for additional CIM_AllocationCapabilities relationship information.

One or more boot configurations (Reset Activation Profiles) are rooted in CIM_BootConfigSettinginstances associated to the CPC via CIM_ElementSettingData. See “Setting data relationships” on page 37for additional CIM_BootConfigSetting relationship information.

One of the boot configurations associated with a CPC will have the CIM_ElementSettingData.IsNextproperty set to 1 "Is Next". This indicates the configuration that will be automatically used when the CPCis next enabled (powered-on). One of the configurations will have the CIM_ElementSettingData.IsDefaultproperty set to 1 "Is Default", identifying the system defined default boot configuration. If the CPC hasbeen booted at least once, one of the associated configurations will have theCIM_ElementSettingData.IsCurrent property set to 1 "Is Current", indicating the last used bootconfiguration. A single CIM_ElementSettingData instance might have more than one of these attributespresent, indicating that the referenced boot configuration plays multiple roles.

Zero or more virtual computer system (Image) instances are associated via CIM_HostedDependency tothe hosting CPC. See “Image relationships” on page 33 for additional IBMZ_Image relationshipinformation.

Zero or more real-time state Image group settings are associated via CIM_SettingsDefineState to thehosting CPC. See “Setting data relationships” on page 37 for additional IBMZ_GroupSettingDatarelationship information.

Figure 24. CPC relationship diagram


A CPC contains zero or more host CIM_FCPort instances (Fibre Channel PCHIDs) as indicated byCIM_SystemDevice associations. Each FC port is aggregated into a CIM_ResourcePool, as indicated by aCIM_ConcreteComponent association. The resource pool is hosted by a CPC, as indicated by theCIM_HostedResourcePool association.

A CPC contains one or more CIM_Processor instances (PU’s) as indicated by CIM_SystemDeviceassociations. See “Service and capabilities relationships” on page 36 for additional CIM_Processorrelationship information.

Zero or more temporary capacity records are associated via CIM_ElementSettingData to a CPC. See“Setting data relationships” on page 37 for additional IBMZ_TemporaryCapacityRecord relationshipinformation.

The members of an IBMZ_CoordinatedTimingNetwork are identified byIBMZ_CoordinatedTimingNetworkComponent associations to instances of IBMZ_CPC. If a backup timeserver has been configured, two of these members will also be associated to an instance ofCIM_RedundancySet via CIM_MemberOfCollection. One of these will additionally be associated to theCIM_RedundancySet via CIM_IsSpare, identifying the spare time server. The current time server will bethe other member of the redundancy set.

The CPC’s hardware message log is represented by an instance of IBMZ_HardwareMessageLog,associated to the CPC via CIM_UseOfLog. See “Support Element and Hardware Management Consolerelationships” on page 34 for additional CIM_AllocationCapabilities relationship information.

A CPC is related to its IBMZ_SupportElement via a CIM_SystemComponent association. See “SupportElement and Hardware Management Console relationships” on page 34 for additionalIBMZ_SupportElement relationship information.

A CPC is affected by two services: CIM_BootService and CIM_VirtualSystemManagementService, eachassociated to the CPC via CIM_ServiceAffectsElement. A Support Element hosts the CIM_BootService andCIM_VirtualSystemManagementService instances as indicated by the CIM_HostedService associations. See“Service and capabilities relationships” on page 36 for additional service class relationship information.

Image relationshipsFigure 25 shows the classes that are related to the IBMZ_Image class.

An Image with an active operating system represents that OS by an instance of IBMZ_OperatingSystemassociated via CIM_RunningOS.

Figure 25. Image relationship diagram


The enablement capabilities of an Image are described by an instance ofCIM_EnabledLogicalElementCapabilities associated to the Image via CIM_ElementCapabilities.

The hosting CPC is associated to an Image via CIM_HostedDependency. See “CPC relationships” on page31 for additional IBMZ_CPC relationship information.

One or more boot configurations (Load Activation Profiles) are rooted in CIM_BootConfigSettinginstances associated to the Image via CIM_ElementSettingData. See “Setting data relationships” on page37 for additional CIM_BootConfigSetting relationship information.

One of the boot configurations associated with an Image will have the CIM_ElementSettingData.IsNextproperty set to 1 "Is Next". This indicates the configuration that will be automatically used when theImage is next enabled (activated). One of the configurations will have theCIM_ElementSettingData.IsDefault property set to 1 "Is Default", identifying the system defined defaultboot configuration. If the Image has been booted at least once, one of the associated configurations willhave the CIM_ElementSettingData.IsCurrent property set to 1 "Is Current", indicating the last used bootconfiguration. A single CIM_ElementSettingData instance might have more than one of these attributespresent, indicating that the referenced boot configuration plays multiple roles.

A single virtual system configuration, representing the real-time state of the system, is rooted in anIBMZ_ImageSettingData instance associated to the Image via CIM_SettingsDefineState. Recorded and lastused IBMZ_ImageSettingData instances might be associated to the state instance. See “Setting datarelationships” on page 37 for additional IBMZ_ImageSettingData relationship information.

An Image contains zero or more CIM_FCPort (Fibre Channel port) and one or more CIM_Processor (CP)instances, as indicated by CIM_SystemDevice associations.

An Image contains zero or more CIM_Processor instances (CP’s) as indicated by CIM_SystemDeviceassociations. See “Service and capabilities relationships” on page 36 for additional CIM_FCPort andCIM_Processor relationship information.

An Image is affected by two services, each associated to the Image via CIM_ServiceAffectsElement:CIM_BootService and IBMZ_ImageOperationsService.

Support Element and Hardware Management Console relationshipsFigure 26 on page 35 shows the classes that are related to the IBMZ_SupportElement andIBMZ_HardwareManagementConsole classes.


A Support Element is associated via IBMZ_ManagedSE to one or more Hardware Management Consolesthat manage it.

A Support Element is associated via CIM_SystemComponent to its CPC. See “CPC relationships” on page31 for additional IBMZ_CPC relationship information.

An SE’s I/P addresses are exposed through one or more instances of CIM_IPProtocolEndpoint associatedto the Support Element via CIM_HostedAccessPoint.

The licensed internal code bundles that pertain to an SE are modeled by CIM_SoftwareIdentity instancesassociated to the SE via IBMZ_ElementSoftwareIdentity. Significant code levels (retrieved, installableconcurrent, removable concurrent, activated, and accepted) within each bundle are also represented byinstances of CIM_SoftwareIdentity, which are associated to the CIM_SoftwareIdentity representing thecode bundle via IBMZ_OrderedComponent. The significance of the code level is indicated by the contentsof the IBMZ_ElementSoftwareIdentity.ElementSoftwareStatus property. Activated (including removableconcurrent and accepted) code levels are linked to the SE via CIM_InstalledSoftwareIdentity. Retrievedand installable concurrent levels are grouped via CIM_MemberOfCollection associations to an instance ofCIM_SystemSpecificCollection, which is in turn associated to the SE via CIM_HostedCollection.

The CIM_SoftwareIdentity and CIM_SystemSpecificCollections classes are used to represent the licensedinternal code bundles and levels for an HMC in the same manner as for an SE.

The HMC’s hardware message log is represented by an instance of IBMZ_HardwareMessageLog,associated to the HMC via CIM_UseOfLog. Each entry in the log is an instance of CIM_LogEntry,associated to the log via CIM_LogManagesRecord.

Similarly, the HMC's audit and security logs are represented by instances of IBMZ_AuditLog andIBMZ_SecurityLog, respectively. Each is associated to the HMC via CIM_UseOfLog and to theirCIM_LogEntry instances via CIM_LogManagesRecord.

Figure 26. Support Element and Hardware Management Console relationship diagram


An SE is also associated to every configuration via CIM_ConcreteComponent. These relationships areshown in Figure 28 on page 37, Figure 29 on page 38 and Figure 30 on page 39 but not explicitly in thisdiagram. An SE hosts all services via CIM_HostedService. These relationships are shown in Figure 27below, but not explicitly in this diagram.

Service and capabilities relationshipsFigure 27 shows how the service and capabilities classes are related to the computer system and devicerelated classes.

The relationship to the computer system classes (IBMZ_CPC and IBMZ_Image) have already beencovered in “CPC relationships” on page 31 and “Image relationships” on page 33, and will therefore notbe described here again.

A single instance of CIM_BootServiceCapabilities is associated to each CIM_BootService instance viaCIM_ElementCapabilties to indicate the supported CIM_BootService methods.

The capabilities of the CIM_VirtualSystemManagementService instances are defined by an instance ofCIM_VirtualSystemMangementCapabilities associated via CIM_ElementCapabilities.

Each virtual FC port (CHPID) is related to its host port (PCHID) via CIM_HostedDependency.

The resources of each host FC port are aggregated into an instance of CIM_ResourcePool, as indicated bya CIM_ConcreteComponent association between them. Virtual FC ports are allocated from a pool, asindicated by CIM_ElementAllocatedFromPool associations.

The CIM_ResourcePool instance is managed by an instance of CIM_ResourcePoolConfigurationService asindicated by the CIM_ServiceAffectsElement association. The capabilities of the service are defined in aninstance of CIM_ResourcePoolConfigurationCapabilities associated via CIM_ElementCapabilities. See“Resource pool relationships” on page 39 for additional CIM_ResourcePool relationship information.

An instance of IBMZ_ProcessorOperationsService is associated to the CIM_Processor instances that itmanages via CIM_ServiceAffectsElement.

Figure 27. Service and capabilities relationship diagram


An instance of IBMZ_SupportElement hosts all services, as indicated by the CIM_HostedServiceassociations to CIM_BootService, IBMZ_ImageOperationsService, IBMZ_ProcessorOperationsService,CIM_ResourcePoolConfigurationService, and CIM_VirtualSystemManagementService.

Setting data relationshipsFigure 28 shows how the boot setting data classes are related to the computer system classes and to eachother.

The relationship to the computer system classes (IBMZ_CPC and IBMZ_Image) have already beencovered in “CPC relationships” on page 31 and “Image relationships” on page 33, and will therefore notbe described here again.

CIM_BootConfigSetting is the aggregation point for a representation of a boot configuration. Each ResetActivation Profile is represented by an instance of IBMZ_CPCBootSettingData, associated to aCIM_BootConfigSetting via CIM_ConcreteComponent. The settings associated with a Load ActivationProfile are split between an instance of IBMZ_ImageBootSettingData (associated viaCIM_ConcreteComponent) and an instance of IBMZ_ImageBootSourceSettting (associated viaCIM_OrderedComponent).

An instance of IBMZ_SupportElement hosts all boot configurations, as indicated by theCIM_ConcreteComponent associations to the CIM_BootConfigSetting instances.

Figure 29 on page 38 shows how the Image setting data classes are related to the computer system classesand to each other.

Figure 28. Boot setting data relationship diagram


IBMZ_ImageSettingData is the aggregation point for the representation of a virtual system configuration(Image Activation Profile). Each instance is associated via CIM_VirtualSystemSettingDataComponent tomultiple instances of IBMZ_ProcessorSettingData, IBMZ_MemorySettingData, andIBMZ_FCPortSettingData. The instance of IBMZ_ImageSettingData that defines an Image's real-time stateis associated to its related Image via CIM_SettingsDefineState. A second IBMZ_ImageSettingData instance,representing the recorded settings (Image Activation Profile) is associated to each state instance via aCIM_ElementSettingData association with its IsDefault and IsNext properties set to 1 "Is Default" and 1"Is Next", respectively. This indicates that the configuration is the system defined default and will beautomatically used when the Image is next enabled (activated). When the Image is active, a thirdinstance, representing the last applied configuration, is also associated to the instance viaCIM_ElementSettingData with its IsCurrent property value set to 1 "Is Current". When the system is notactive, the recorded instance is also the last used instance.

If Work Load Management is enabled and an instance of IBMZ_ProcessorSettingData defines sharedprocessors, it will be associated to an instance of CIM_AllocationCapabilities viaCIM_ElementCapabilities. The CIM_AllocationCapabilities instance is in turn associated viaCIM_SettingsDefineCapabilities to two special instances of IBMZ_ProcessorSettingData, one defining theminimum and one defining the maximum processing weight for the processor configuration.

Each recorded IBMZ_ImageSettingData instance will be associated to a recordedIBMZ_ProcessorSettingData instance. If processors are shared, the recorded instance will be associated toa recorded CIM_AllocationCapabilities instance, which is then associated to minimum and maximumrecorded IBMZ_ProcessorSettingData instances. If the Image is active, the state and currentIBMZ_ImageSettingData instances will be associated to state and current instances ofIBMZ_ProcessorSettingData representing the real-time state and last used processor configurations. Ifprocessors are shared, both instances will be associated to a state CIM_AllocationCapabilities instance,which is then associated to state minimum and maximum IBMZ_ProcessorSettingData instances. Whenthe Image is not active, state and current IBMZ_ProcessorSettingData instances do not exist. When itexists, the state IBMZ_ProcessorSettingData instance is associated to both the recorded and currentinstances via CIM_ElementSettingData.

Each recorded IBMZ_ImageSettingData instance will be associated viaCIM_VirtualSystemSettingDataComponent to one or two recorded instances ofIBMZ_MemorySettingData, representing the defined central and expanded memory. If the Image is active,real-time state versions of these classes will exist and be associated to the state and current

Figure 29. Image setting data relationship diagram


|

|||

IBMZ_ImageSettingData instances. When it exists, a state IBMZ_MemorySettingData instance isassociated to its recorded instance via IBMZ_ElementSettingData.

Each recorded IBMZ_ImageSettingData instance will be associated viaCIM_VirtualSystemSettingDataComponent to zero or more instances of IBMZ_FCPortSettingData,representing the defined Fibre Channel ports. If the Image is active, these instances will also be associatedto the state and current IBMZ_ImageSettingData instances. When an Image is active, eachIBMZ_FCPortSettingData references itself via a CIM_ElementSettingData association to indicate that eachinstance is simultaneously performing the state and recorded roles.

Zero or more IBMZ_ImageSettingData instances can be associated into an Image group viaCIM_ConcreteComponent. State instances of IBMZ_GroupSettingData are associated to their related CPCsvia CIM_SettingsDefineState. A recorded instance (Image Group Profile) is associated to each stateinstance via CIM_ElementSettingData.

For CPCs starting with z13s, instances of IBMZ_ProcessorSettingData are associated to each state andrecorded IBMZ_GroupSettingData to define settings for processor types within the group.

An instance of IBMZ_SupportElement hosts all Image and group configurations, as indicated by theCIM_ConcreteComponent associations to the recorded IBMZ_ImageSettingData andIBMZ_GroupSettingData instances.

Figure 30 shows how the temporary capacity setting data classes are related to the computer systemclasses and to each other.

IBMZ_TemporaryCapacityRecord is the aggregation point for the data that defines a temporary capacityrecord. Instances of this class are associated to a CPC via CIM_ElementSettingData. Each instance isassociated to one or more instances of IBMZ_TemporaryCapacityProcessorRecord andIBMZ_TemporaryCapacityTarget via CIM_ConcreteComponent.

An instance of IBMZ_SupportElement hosts all temporary capacity configurations, as indicated by theCIM_ConcreteComponent association to instances of IBMZ_TemporaryCapacityRecord.

Resource pool relationshipsFigure 31 on page 40 shows the classes that are related to an FC port resource pool.

Figure 30. Temporary capacity setting data relationship diagram


||

Class CIM_ResourcePool represents an aggregation of system resources. Each resource pool is backed bya single host CIM_FCPort instance, as indicated by the CIM_ConcreteComponent association. VirtualCIM_FCPort instances are allocated from a pool as indicated by the CIM_ElementAllocatedFromPoolassociation. Each virtual port is associated to its hosting port via CIM_HostedDependency.

The real-time state attributes for each virtual port are described by an instance ofIBMZ_FCPortSettingData associated to a virtual FC port via CIM_SettingsDefineState. FC port stateattributes cannot be dynamically updated, so the same instance of IBMZ_FCPortSettingData alsorepresents the recorded and current (last-used) settings as indicated by a self-referencing instance ofCIM_ElementSettingData. When the virtual ports are active, each IBMZ_FCPortSettingData is alsoassociated to the resource pool from which its defined port is allocated viaCIM_ResourceAllocationFromPool.

A resource pool is hosted by a CPC, as indicated by the CIM_HostedResourcePool association.

The allocation capabilities of a resource pool are defined by an instance if CIM_AllocationCapabilities,associated to the pool via CIM_ElementCapabilities. The same CIM_AllocationCapabilites instance is alsoassociated to the CPC via CIM_ElementCapabilites to define the allocation capabilities for the entire hostsystem.

Figure 31. Resource pool relationship diagram


Chapter 3. Class definitions

This chapter describes all the classes that will be used in the HMC CIM model. For each class, theproperties and methods defined by that class and each of its parent classes, and each association in whichthe class participates are enumerated. Any indications generated by the class are also described.

Some classes are used in multiple contexts. In this case, a class will be listed multiple times, one for eachcontext in which it is used.

AssociationsAssociations are defined in tables with the following three columns:

AssociationThe association class name.

Role The name of the association property that references instances of this class and thecardinality of this class in the association.

To The name of the class to which this class is associated and the cardinality of theassociated class.

PropertiesThe properties are defined in tables that are segmented by the (parent) class in which they aredefined. Each property table contains the following three columns:

PropertyThe property name. Certain important CIM property qualifiers might appear after theproperty name in curly brackets. They are encoded as follows:

d The property has been deprecated.

i Modifications of this property will result in an IBMZ_InstModification indication.

k The property is a key property for the class.

o The property overrides the definition of the same property defined higher in theclass hierarchy.

w The property is writable. In these tables, writable also implies that the propertycan be updated using the intrinsic ModifyInstance() method. The same propertymight be listed a writable in one context, but not in another.

Value Some property values are represented by symbols in angle brackets:

<null>The property has no defined value.

<string:n>The value is a string. ":n" is optionally present and indicates the maximum valuelength. Further constraints on the content might be described in the Commentcolumn.

<uintn>Where n is 8, 16, 32 or 64. The value represents an n-bit unsigned integer.

<sintn>Where n is 8, 16, 32 or 64. The value represents an n-bit signed integer.

<true> The Boolean TRUE value.

<false>The Boolean FALSE value.


<boolean><true> or <false>.

<datetime>The value represents a date and time.

<datetime:i>The value represents an interval.

<overridden>The value is redefined lower in the class hierarchy by a property that overridesthis one.

<empty>The value is an array with no elements.

Any text in quotes will appear as is in the property value.

Values of the form n..m indicate a numeric range between ‘n’ and ‘m’.

References of the form PropertyName or ClassName.PropertyName (for example,CPC.Name) indicate that property value contains the value of the referenced classproperty. ClassName is present only when the reference is defined in a different class.Otherwise the reference is to the property of that name in the current class.

Square brackets are used to indicate the set of values for array properties.

Values for properties defined as a value map are indicated by the numeric value followedby the text value in quotes (for example, 2 "Enabled").

Any other text is a description of the data that appears in the property value.

CommentAdditional information regarding the property value. Many times the Comment field willdescribe the property in z Systems or LinuxONE terms.

MethodsThe methods are defined in tables that are segmented by the (parent) class in which they aredefined. Each method table contains the following two columns:

MethodThe method name. If the method is supported, its parameters (if any) are listed on thelines that follow. Certain important CIM method or parameter qualifiers might appearafter the method or parameter name in curly brackets. They are encoded as follows:

d The method or parameter has been deprecated.

r The parameter is required (not <null>)

i The parameter is defined as an input parameter.

o The parameter is defined as an output parameter.

CommentAdditional information regarding the method. If the method is supported and hasparameters, their values are described here.

Method detailsAdditional details about the supported intrinsic and extrinsic methods will appear after the classmethod and property tables.

IndicationsIf any lifecycle or modification indications are associated with the class, they are described in atable with the following two columns:


|

IndicationThe indication class name.

TriggerA description of the event that triggers the indication.

Classes that have an implementation-specific meaning have names that start with the prefix "IBMZ_".Classes that are not extended with z specific functionality start with the base schema prefix of "CIM_".

Computer systemsThis section describes the classes that are related to computer systems.

CPCThis section describes the classes that are related to Central Processing Complex (CPC) objects. It coversclasses that are described in the Base Server, System Virtualization and Physical Asset profiles.

IBMZ_CPCThe IBMZ_CPC class represents a Central Processing Complex (CPC). This is the aggregation point for allaspects of a physical computer system. The IBMZ_CPC implementation is conformant to the Base Serverand System Virtualization profiles.

A CPC can be enabled or disabled using the IBMZ_CPC.RequestStateChange() method.

Class hierarchy:

IBMZ_CPCIBMZ_ComputerSystem

CIM_ComputerSystemCIM_System

CIM_EnabledLogicalElementCIM_LogicalElement

CIM_ManagedSystemElementCIM_ManagedElement

Associations: Each instance of IBMZ_CPC participates in the associations defined in the following table.

Association Role To

CIM_ComputerSystemPackage DependentCardinality: 1

CIM_RackCardinality: 1

CIM_ElementCapabilities ManagedElementCardinality: *

CIM_EnabledLogicalElementCapabilitiesCardinality: 1


CIM_AllocationCapabilities(FC Port Pool)Cardinality: 1

CIM_ElementConformsToProfile ManagedElementCardinality: *

CIM_RegisteredProfile(System Virtualization)Cardinality: 1


CIM_RegisteredProfile(Base Server)Cardinality: 1

CIM_ElementSettingData ManagedElementCardinality: 1

CIM_BootConfigSetting(CPC)Cardinality: 1..*

Chapter 3. Class definitions 43

Association Role To


IBMZ_TemporaryCapacityRecordCardinality: *

CIM_HostedDependency AntecedentCardinality: 1

IBMZ_ImageCardinality: *

CIM_HostedResourcePool GroupComponentCardinality: 1

CIM_ResourcePoolCardinality: *

CIM_IsSpare AntecedentCardinality: 1

CIM_RedundancySetCardinality: 0..1

CIM_MemberOfCollection CollectionCardinality: 2

CIM_RedundancySetCardinality: 0..1

CIM_ServiceAffectsElement AffectedElementCardinality: 1

CIM_VirtualSystemManagementServiceCardinality: 1

CIM_ServiceAffectsElement AffectedElementCardinality: 1

CIM_BootServiceCardinality: 1

CIM_SettingsDefineState ManagedElementCardinality: 0..1

IBMZ_GroupSettingDataCardinality: *

CIM_SystemComponent GroupComponentCardinality: 1

IBMZ_SupportElementCardinality: 1

CIM_SystemDevice GroupComponentCardinality: 1

CIM_FCPort (Host)Cardinality: *


CIM_Processor (Host)Cardinality: *

CIM_UseOfLog AntecedentCardinality: 1

IBMZ_HardwareMessageLogCardinality: 1

IBMZ_CoordinatedTimingNetworkComponent

PartComponentCardinality: *

IBMZ_CoordinatedTiming NetworkCardinality: 1

Class properties and methods: The properties and methods of the IBMZ_CPC class are defined in thefollowing tables, grouped by the class in which they are defined.

CIM_ManagedElement

Property Value Comment

Caption "CPC"

Description <string>

ElementName {i} <string> The user-defined name



CommunicationStatus {i} 2 "Communication OK" or3 "Lost Communication"

DetailedStatus {i} 1 "No Additional Information"

IBMZ_CPC



HealthState {i} 0 "Unknown",5 "OK",10 "Degraded/Warning",20 "Major Failure" or25 "Critical Failure"

InstallDate <null>

Name <overridden>

OperationalStatus[] <overridden>

OperatingStatus {i} 0 "Unknown",2 "Servicing",5 "Stopped" or16 "In Service"

PrimaryStatus {i} 0 "Unknown",1 "OK",2 "Degraded" or3 "Error"

Status {i,d} "OK","Error","Degraded","Service","Lost Comm" or"Stopped"

The mapping between Statusproperty values and the z SystemsCPC Status is described in Table 60on page 235.

StatusDescriptions[] {i} [ "Operating normally","Operating, but with degradation","Operating, but with exceptions","Not operating","In service","Not communicating","No power","Status check","Service required" and/or"Power save" ]

The description order matches thestate values defined inOperationalStatus.

CIM_LogicalElement




AvailableRequestedStates[] <null>

EnabledDefault 7 "No Default"

EnabledState {i} 0 "Unknown",2 "Enabled" or3 "Disabled"

The mapping between EnabledStateproperty values and the z SystemsCPC Status is described in Table 58on page 235.

OtherEnabledState <null>

RequestedState 5 "No Change"

TimeOfLastStateChange <null>

IBMZ_CPC



TransitioningToState 12 "Not Applicable"

Method Comment

RequestStateChange(RequestedState {i},TimeoutPeriod {i},Job {o})

Enables or disables a CPC.2 "Enabled", 3 "Disabled" or 11 "Reset"<null> or 0<null>

CIM_System


CreationClassName {k} "IBMZ_CPC"

IdentifyingDescriptions[] [ "CIM:Model:SerialNumber" ]

Name {k,o} <string>

NameFormat <overridden>

OtherIdentifyingInfo[] [ "IBM:Z:"+Rack.Model+":"+Rack.SerialNumber ]

PrimaryOwnerContact <null>

PrimaryOwnerName <null>

Roles[] <null>

CIM_ComputerSystem


Dedicated[] [ 0 "Not Dedicated" or2 "Other" ]

0=Native Mode2=LPAR Mode

NameFormat {o} "HID"

OtherDedicatedDescriptions[] <null> or[ "System Virtualizer" ]

PowerManagementCapabilities [] {d} <null>

ResetCapability 4 "Enabled"

Method Comment

SetPowerState {d} Not supported

IBMZ_ComputerSystem


AcceptableStatus[] <overridden>

HasMessages <boolean>

HasUnacceptableStatus <boolean>

IBMZ_CPC

IBMZ_CPC



AcceptableStatus[] {i,o,w} [ 2 "OK",3 "Degraded",6 "Error",10 "Stopped",11 "In Service",13 "Lost Communication",18 "Power Mode",0x8000 "Status Check",0x8001 "Service Required"

and/or0x8002 "Power Save" ]

Array of the status values defined inOperationalStatus that are considered"Acceptable".

DegradedSubsystem[] <empty> or[ 1 "Memory",2 "MBA",3 "Node",4 "Ring",5 "CBU",6 "MRU",7 "Ambient" or8 "MRU IML" ]

This array will be empty if thesystem is not currently in a degradedstate.

ID <string>

ModelCapacityID <string>

ModelPermanentCapacityID <string>

ModelTemporaryCapacityID <string>

MSU <uint32>

OperationalStatus[] {i,o} [ 2 "OK",3 "Degraded",6 "Error",10 "Stopped",11 "In Service",13 "Lost Communication",18 "Power Mode",0x8000 "Status Check",0x8001 "Service Required"

and/or0x8002 "Power Save" ]

The mapping betweenOperationalStatus property valuesand the z Systems CPC Status isdescribed in Table 59 on page 235. Insome cases, multiple CIM statuses areused to indicate a single CPC status.

PendingProcessors <uint32>

PermanentMSU <uint32>

TemporaryMSU <uint32>

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_CPC class.

Intrinsic methods: The IBMZ_CPC class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_CPC instance.

Associators Returns the set of instances that are associated to a specific IBMZ_CPCinstance.

EnumerateInstanceNames Returns the complete set of IBMZ_CPC references to instances.

IBMZ_CPC


Operation Comment

EnumerateInstances Returns the complete set of IBMZ_CPC instances.

GetInstance Returns a specific IBMZ_CPC instance.

InvokeMethod Invokes an extrinsic method on a specific IBMZ_CPC instance.

ModifyInstance Updates the value of one or more properties of a specific IBMZ_CPCinstance. Only properties marked as writable in the previous tables can beupdated. If new values are specified for non-writable properties, they will beignored.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_CPC instance.

References Returns the set of the association instances that reference a specificIBMZ_CPC instance.

Extrinsic methods: The IBMZ_CPC class supports the following extrinsic CIM operations:


This method is used to enable or disable a host computer system (CPC). In system terminology,these operations are known as Activating and Deactivating the CPC.

A RequestedState parameter value of "Enabled" will enable the CPC if it is not already enabled.CPC enablement can include: powering on the CPC, booting (IMLing) the CPC and enabling(activating) and booting (loading) one or more virtual computer systems (Images) to run in thehost CPC. If the CPC is already enabled, the request will be ignored.

A RequestedState parameter value of "Disabled" reverses the enablement process, ending with aCPC that is powered off. If the CPC is already disabled, the request will be ignored.

A RequestedState parameter value of "Reset" is the equivalent of issuing a "Disabled" followed byan "Enabled" request.

The return code values and parameters for the RequestStateChange() method are specified inTable 3 and Table 4 respectively.

Table 3. RequestStateChange() Method Return Code Values

Value Description

0 Completed with no error

2 Error occurred

Table 4. RequestStateChange() Method Parameters

Qualifiers Name Type Description/Values

IN RequestedState <uint16> The requested state.Must be one of: 2 "Enabled", 3"Disabled" or 11 "Reset"

IN TimeoutPeriod <datetime:i> Must be zero or <null>, indicatingthat the timeout period cannot becontrolled.

OUT Job <CIM_ConcreteJob ref> Will always return <null>

Indications: The following indications are associated with the IBMZ_CPC class:

Indication Trigger

IBMZ_InstCreation A new IBMZ_CPC instance is created.

IBMZ_CPC


Indication Trigger

IBMZ_InstDeletion An IBMZ_CPC instance is deleted.

IBMZ_InstModification One of the properties marked above changes.

In addition, if the next boot configuration (next Reset Activation Profile) for a CPC changes, twoIBMZ_InstModification indications will occur. One will show the IsNext property of theCIM_ElementSettingData association that connects the CPC to the original next configuration changingfrom 1 "Is Next" to 2 "Is Not Next". The second will show the IsNext property of theCIM_ElementSettingData association that connects the CPC to the new next configuration changing from2 "Is Not Next" to 1 "Is Next".

CIM_EnabledLogicalElementCapabilities (CPC)An instance of the CIM_EnabledLogicalElementCapabilities class defines the allowed state transitions thatcan be affected on a CPC using the RequestStateChange() method. The allowed state changes are"Enabled", "Disabled" and "Reset", which correspond to the z Systems and LinuxONE functions ofActivate (if not already activated), Deactivate and Activate. The CIM_EnabledLogicalElementimplementation is conformant to the Base Server Profile.

Class hierarchy:

CIM_EnabledLogicalElementCapabilitiesCIM_Capabilities

CIM_ManagedElement

Associations: Each instance of CIM_EnabledLogicalElementCapabilities participates in the associationsdefined in the following table.

Association Role To

CIM_ElementCapabilities CapabilitiesCardinality: 1

IBMZ_CPCCardinality: *

Class properties and methods: The properties and methods of theCIM_EnabledLogicalElementCapabilities class are defined in the following tables, grouped by the class inwhich they are defined.

CIM_ManagedElement


Caption "CPC Enablement Capabilities"


ElementName <overridden>

CIM_Capabilities


ElementName {o} Caption

InstanceID {k} <string>

Method Comment

CreateGoalSetting Not supported

IBMZ_CPC


|

CIM_EnabledLogicalElementCapabilities


ElementNameEdit Supported <false>

ElementNameMask <null>

MaxElementNameLength <null>

RequestedStates Supported[] [ 2 "Enabled",3 "Disabled" and11 "Reset" ]

Activate (if not activated)DeactivateActivate

StateAwareness[] <empty>

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theCIM_EnabledLogicalElementCapabilities class.

Intrinsic methods: The CIM_EnabledLogicalElementCapabilities class supports the following intrinsic CIMoperations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificCIM_EnabledLogicalElementCapabilities instance.

Associators Returns the set of instances that are associated to a specificCIM_EnabledLogicalElementCapabilities instance.

EnumerateInstanceNames Returns the complete set of CIM_EnabledLogicalElementCapabilitiesreferences to instances.

EnumerateInstances Returns the complete set of CIM_EnabledLogicalElementCapabilitiesinstances.

GetInstance Returns a specific CIM_EnabledLogicalElementCapabilities instance.

ReferenceNames Returns the set of association references to instances that reference a specificCIM_EnabledLogicalElementCapabilities instance.

References Returns the set of the association instances that reference a specificCIM_EnabledLogicalElementCapabilities instance.

Extrinsic methods: The CIM_EnabledLogicalElementCapabilities class does not support any extrinsic CIMoperations.

Indications: There are no indications associated with the CIM_EnabledLogicalElementCapabilities (CPC)class.

CIM_RackAn instance of CIM_Rack is associated with each CPC instance. Its primary purpose is to expose theManufacturer, Machine Model (and Type) and Serial Number. The CIM_Rack implementation isconformant to the Base Server and Physical Asset profiles.

Class hierarchy:

CIM_RackCIM_PhysicalFrame

CIM_PhysicalPackageCIM_PhysicalElement


CIM_EnabledLogicalElementCapabilities (CPC)


Associations: Each instance of CIM_Rack participates in the associations defined in the following table.

Association Role To

CIM_ComputerSystemPackage AntecedentCardinality: 1

IBMZ_CPCCardinality: 1

Class properties and methods: The properties and methods of the CIM_Rack class are defined in thefollowing tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "CPC Package"

Description <overridden>




CommunicationStatus 2 "Communication OK"

DetailedStatus 1 "No Additional Information"

HealthState 5 "OK"

InstallDate <null>

Name <string>

OperatingStatus 16 "In Service"

OperationalStatus[] [ 2 "OK" ]

PrimaryStatus 1 "OK"

Status {d} "OK"

StatusDescriptions[] [ "Operating normally" ]

CIM_PhysicalElement


CanBeFRUed <null>

CreationClassName {k} "CIM_Rack"

Description {o} <string>

ElementName {o} CPC.ElementName

ManufactureDate <null>

Manufacturer "IBM"

Model <string> Machine type+ Machine model

OtherIdentifyingInfo <null>

PartNumber <null>

PoweredOn <null>

SerialNumber <string> Machine serial number

SKU <null>

CIM_Rack



Tag {k} CPC.Name

UserTracking <null>

VendorEquipmentType <null>

Version <null>

CIM_PhysicalPackage


Depth <null>

Height <overridden>

HotSwappable <null>

OtherPackageType <null>

PackageType 3 "Chassis/Frame"

Removable {d} <null>

RemovalConditions 2 "Not Applicable"

Replaceable {d} <null>

VendorCompatibilityStrings[] <null>

Weight <null>

Width <null>

Method Comment

IsCompatible {d} Not supported

CIM_PhysicalFrame


AudibleAlarm <null>

BreachDescription <null>

CableManagementStrategy <null>

IsLocked <null>

LockPresent <null>

SecurityBreach <null>

ServiceDescriptions[] <null>

ServicePhilosophy[] <null>

VisableAlarm <null>

CIM_Rack


CountryDesignation <null>

Height {o} <null>

TypeOfRack <null>

CIM_Rack


Method details: This section describes in detail the intrinsic and extrinsic methods supported by theCIM_Rack class.

Intrinsic methods: The CIM_Rack class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificCIM_Rack instance.

Associators Returns the set of instances that are associated to a specific CIM_Rackinstance.

EnumerateInstanceNames Returns the complete set of CIM_Rack references to instances.

EnumerateInstances Returns the complete set of CIM_Rack instances.

GetInstance Returns a specific CIM_Rack instance.

ReferenceNames Returns the set of association references to instances that reference a specificCIM_Rack instance.

References Returns the set of the association instances that reference a specificCIM_Rack instance.

Extrinsic methods: The CIM_Rack class does not support any extrinsic CIM operations.

Indications: There are no indications associated with the CIM_Rack class.

IBMZ_CoordinatedTimingNetworkEach instance of IBMZ_CoordinatedTimingNetwork represents a network of CPCs where one of theCPCs, known as the current time server, is supplying the time-of-day clock for all CPCs in the network.There can be up to three CPCs in a CTN with special roles. There should always be one CPC that isdesignated as the preferred time server. Optionally, a second CPC can be designated as the backup timeserver. Either the preferred or backup CPC will be the current time server. The other server is the spare.Optionally, a third CPC can be designated as the arbiter. The arbiter is used by the spare time server ifand when it loses communications with the current time server. An automatic failover will occur only ifthe spare can communicate with the arbiter and both the spare and arbiter systems are unable to talk tothe current time server. The preferred, backup and arbiter systems must all be unique CPCs. The role thata CPC is playing in a CTN is identified by the Role property value of theIBMZ_CoordinatedTimingNetworkComponent association instance that links the CPC to its CTN. CPCsin a network that are not explicitly designated as preferred, backup or arbiter are simply clients of thecurrent time server.

If a backup time server has not been defined, the current time server will be the preferred time server. Ifa backup time server has been defined, the preferred and backup time servers form a redundancy set andthe current time server can be determined by the member of the set that is not marked as being a spare.See “CIM_RedundancySet” on page 58 for more details.

CPCs are designated as preferred, backup or arbiter using the extrinsicIBMZ_CoordinatedTimingNetwork.ConfigureTimeServers() method. CPCs can be added or removed froma CTN using the AddMember() or RemoveMember() methods of this class.

Class hierarchy:

IBMZ_CoordinatedTimingNetworkCIM_AdminDomain

CIM_SystemCIM_EnabledLogicalElement

CIM_Rack


CIM_LogicalElementCIM_ManagedSystemElement

CIM_ManagedElement

Associations: Each instance of IBMZ_CoordinatedTimingNetwork participates in the associationsdefined in the following table.

Association Role To


GroupComponentCardinality: 1


Class properties and methods: The properties and methods of the IBMZ_CoordinatedTimingNetworkclass are defined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Coordinated Timing Network"


ElementName <string> CTN Name





HealthState 5 "OK"

InstallDate <null>

Name <overridden>




Status {d} "OK"


CIM_LogicalElement

No properties are defined for this class.




EnabledDefault 2 "Enabled"

EnabledState 2 "Enabled"


RequestedState 12 "Not Applicable"

IBMZ_CoordinatedTimingNetwork





Method Comment

Method Comment

RequestStateChange Not supported.

CIM_System


CreationClassName {k} "IBMZ CoordinatedTiming Network"

IdentifyingDescriptions[] <null>

Name {k,o} ElementName

NameFormat <overridden:>

OtherIdentifyingInfo[] <null>

PrimaryOwnerContact <null.


Roles[] <null>

CIM_AdminDomain


NameFormat {o} "Other"



Method Comment

AddMember(Member {i.r},Job {o})

ConfigureTimeServers(PreferredTimeServer {i,r},BackupTimeServer {i},Arbiter {i},CurrentTimeServer {i},Force {i},Job {o})

RemoveMember(Member {i,r},Job {o})

Adds a CPC to a Coordinated Timing Network<IBMZ_CPC ref<null>

Configures the time servers in a CTN.<IBMZ_CPC ref><null> or <IBMZ_CPC ref><null> or <IBMZ_CPC ref<null>, 2 "Preferred" or 3 "Backup"<null> or <boolean><null>

Removes a CPC from a Coordinated Timing Network<IBMZ_CPC ref><null>

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_CoordinatedTimingNetwork class.

Intrinsic methods: The IBMZ_CoordinatedTimingNetwork class supports the following intrinsic CIMoperations:



Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_CoordinatedTimingNetwork instance.

Associators Returns the set of instances that are associated to a specificIBMZ_CoordinatedTimingNetwork instance.

EnumerateInstanceNames Returns the complete set of IBMZ_CoordinatedTimingNetwork references toinstances.

EnumerateInstances Returns the complete set of IBMZ_CoordinatedTimingNetwork instances.

GetInstance Returns a specific IBMZ_CoordinatedTimingNetwork instance.

InvokeMethod Invokes an extrinsic method on a specific IBMZ_CoordinatedTimingNetworkinstance.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_CoordinatedTimingNetwork instance.

References Returns the set of the association instances that reference a specificIBMZ_CoordinatedTimingNetwork instance.

Extrinsic methods: The IBMZ_CoordinatedTimingNetwork class supports the following extrinsic CIMoperations:

ConfigureTimeServers()

This method is used to configure the time servers in a Coordinated Timing Network or to createa new CTN. The method assigns the CPC that will be the preferred time server and, optionally,the backup time server and arbiter. If a backup time server is specified, the method alsodesignates whether the preferred or backup time server will become the current time server. Thereturn code values and parameters for the ConfigureTimeServers() method are specified in Table 5and Table 6, respectively.

Table 5. ConfigureTimeServers() Method Return Code Values

Value Description


2 Error occurred

Table 6. ConfigureTimeServers() Method Parameters


IN, REQ PreferredTimeServer <IBMZ_CPC ref> The CPC that is designated as thepreferred time server. IfBackupTimeServer is not specified,this CPC will become the currenttime server. If BackupTimeServer isspecified, this CPC will become thecurrent time server if so designatedby CurrentTimeServer.

IN BackupTimeServer <null> or<IBMZ_CPC ref>

The CPC that is designated as thebackup time server. This CPC willbecome the current time server ifso designated byCurrentTimeServer. If <null>, therewill be no backup time server. Thisparameter is required if Arbiter isnot <null>.



Table 6. ConfigureTimeServers() Method Parameters (continued)


IN Arbiter <null> or<IBMZ_CPC ref>

The CPC that is designated as thearbiter. If <null>, there will be noarbiter.

IN CurrentTimeServer <null>,2 "Preferred" or3 "Backup"

Designates which CPC will becomethe current time server. If <null>,or if BackupTimeServer is <null>,the PreferredTimeServer willbecome the current time server.

IN Force <null> or<boolean>

If <true> the configuration updatewill occur even if the requestedconfiguration cannot be fullyvalidated. If <false> or <null> therequest will fail if the configurationcannot be validated.

OUT Job <CIM_ConcreteJob ref> Will always return <null>.

AddMember()

This method is used to add a CPC to a coordinated timing network. The target CPC cannot bethe current time server in any existing CTN. The return code values and parameters for theAddMember() method are specified in Table 7 and Table 8, respectively.

Table 7. AddMember() Method Return Code Values

Value Description


2 Error occurred

Table 8. AddMember() Method Parameters


IN, REQ Member <IBMZ_CPC ref> The CPC that is to join the CTN.

OUT Job <CIM ConcreteJob ref> Will always return <null>

RemoveMember()

This method is used to remove a CPC from a coordinated timing network. The target CPC cannotbe the current time server in the CTN. The return code values and parameters for theRemoveMember() method are specified in Table 9 and Table 10, respectively.

Table 9. RemoveMember() Method Return Code Values

Value Description


2 Error occurred

Table 10. RemoveMember() Method Parameters


IN, REQ Member <IBMZ_CPC ref> The CPC that is to leave the CTN.

OUT Job <CIM ConcreteJob ref> Will always return <null>



Indications: There are no indications associated with the IBMZ_CoordinatedTimingNetwork class.

CIM_RedundancySetIf a coordinated timing network (see “IBMZ_CoordinatedTimingNetwork” on page 53) contains a backuptime server, the preferred and backup time servers form a redundancy set. The redundancy set isrepresented by an instance of the CIM_RedundancySet class and its two members are identified byinstances of the CIM_MemberOfSet association linking the CIM_Redundancy set instance to the instancesof IBMZ_CPC that have been designated as the preferred and backup servers. One of these two servers(the spare time server) will also be linked to the redundancy set via an instance of the CIM_IsSpareassociation. The CPC that is not a spare is the current time server.

If a backup time server is not defined for a CTN, the preferred time server will always be the currenttime server and there will be no redundancy set associated with the CTN.

A CIM_RedundancySet instance is indirectly associated to a single instance ofIBMZ_CoordinatedTimingServer through its member CPCs.

A failover from the current time server to the spare time server can occur automatically, if an arbiter isdefined and both the spare time server and arbiter lose communication with the current time server, ormanually using the CIM_RedundancySet.Failover() method.

Class hierarchy:

CIM_RedundancySetCIM_SystemSpecificCollection

CIM_CollectionCIM_ManagedElement

Associations: Each instance of CIM_RedundancySet participates in the associations defined in thefollowing table.

Association Role To

CIM_IsSpare DependentCardinality: 0..1


CIM_MemberOfCollection CollectionCardinality: 0..1


Class properties and methods: The properties and methods of the CIM_RedundancySet class aredefined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "CTN Redundancy"


ElementName <string> CoordinatedTimingNetwork.ElementName

CIM_Collection


CIM_RedundancySet


CIM_SystemSpecificCollection



CIM_RedundancySet


LoadBalanceAlgorithm 2 "No Load Balancing"

MaxNumberSupported 2

MinNumberNeeded 2

OtherLoadBalanceAlgorithm <null>

OtherTypeOfSet[] <null>

RedundancyStatus 2 "Fully Redundant"

TypeOfSet[] [ 4 "Sparing" ]

VendorIdentifyingInfo <null>

Method Comment

Failover(FailoverFrom {i},FailoverTo {i})

Swaps the active and spare time servers.<null><null>

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theCIM_RedundancySet class.

Intrinsic methods: The CIM_RedundancySet class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificCIM_RedundancySet instance.

Associators Returns the set of instances that are associated to a specificCIM_RedundancySet instance.

EnumerateInstanceNames Returns the complete set of CIM_RedundancySet references to instances.

EnumerateInstances Returns the complete set of CIM_RedundancySet instances.

GetInstance Returns a specific CIM_RedundancySet instance.

InvokeMethod Invokes an extrinsic method on a specific CIM_RedundancySet instance.

ReferenceNames Returns the set of association references to instances that reference a specificCIM_RedundancySet instance.

References Returns the set of the association instances that reference a specificCIM_RedundancySet instance.

Extrinsic methods: The CIM_RedundancySet class supports the following extrinsic CIM operations:

Failover()

This method makes the spare time server, as indicated by the IBMZ_CPC instance associated tothis CIM_Redundancy instance via CIM_IsSpare, the current time server. The time server thatwas originally current will be made the spare. Because the current and spare time servers areimplicitly known, the FailoverFrom and FailoverTo parameters are redundant and are therefore

CIM_RedundancySet


ignored. The return code values and parameters for the Failover() method are specified inTable 11 and Table 12 respectively.

Table 11. Failover() Method Return Code Values

Value Description


2 Error occurred

Table 12. Failover() Method Parameters


IN FailoverFrom <IBMZ_CPC ref> This parameter is ignored

IN FailoverTo <IBMZ_CPC ref> This parameter is ignored

Indications: There are no indications associated with the CIM_RedundancySet class.

ImageThis section describes the classes that are related to Image objects.

IBMZ_ImageThe IBMZ_Image class represents a logically partitioned system image. It can either be an LPAR or aCoupling Facility. This is the aggregation point for all aspects of a virtual computer system.

An Image can be enabled or disabled using the IBMZ_Image.RequestStateChange() method. See“IBMZ_ImageOperationsService” on page 101 for other methods that apply to Images.

Class hierarchy:

IBMZ_ImageIBMZ_ComputerSystem

CIM_ComputerSystemCIM_System



Associations: Each instance of IBMZ_Image participates in the associations defined in the followingtable.

Association Role To


CIM_RegisteredProfile(Virtual System)Cardinality: 1


CIM_EnabledLogicalElementCapabilitiesCardinality: 1

CIM_ElementSettingData ManagedElementCardinality: *

CIM_BootConfigSettingImage)Cardinality: 1..*

CIM_HostedDependency DependentCardinality: *


CIM_RedundancySet


Association Role To

CIM_RunningOS ComputerSystemCardinality: 1

IBMZ_OperatingSystemCardinality: 0..1

CIM_ServiceAffectsElement AffectedElementCardinality: *



IBMZ_ImageOperationsServiceCardinality: 1


IBMZ_ImageSettingDataCardinality: 1


CIM_FCPort (Virtual)Cardinality: *


CIM_Processor (Virtual)Cardinality: *

Class properties and methods: The properties and methods of the IBMZ_Image class are defined in thefollowing tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "LPAR Image"


ElementName {i} <string> CPC.Name+":"+The user-definedImage name



CommunicationStatus {i} 2 "Communication OK" or3 "Lost Communication"


HealthState {i} 0 "Unknown",5 "OK",10 "Degraded/Warning",20 "Major Failure" or25 "Critical Failure"

InstallDate <null>

Name <overridden>

OperatingStatus {i} 0 "Unknown",2 "Servicing",5 "Stopped",7 "Dormant" or16 "In Service"


PrimaryStatus {i} 0 "Unknown",1 "OK",2 "Degraded" or3 "Error"

IBMZ_Image



Status {i,d} "OK","Error","Degraded","Service","Lost Comm" or"Stopped"

The mapping between Statusproperty values and the z SystemsImage Status is described in Table 63on page 236.

StatusDescriptions[] {i} [ "Operating normally","Operating, but with exceptions","Not operating","In service", "Not communicating","No power","Status Check","Power Save" and/or"Not activated" ]

The description order matches thestate values defined inOperationalStatus.

CIM_LogicalElement






EnabledState 0 "Unknown",2 "Enabled" or3 "Disabled"

The mapping between EnabledStateproperty values and the z SystemsImage Status is described in Table 61on page 236.





Method Comment

Method Comment


Enables or disables an Image.2 "Enabled", 3 "Disabled" or 11 "Reset"<null> or 0<null>

CIM_System


CreationClassName {k} "IBMZ_Image"


Name {k,o} <string>



IBMZ_Image





Roles[] <null>

CIM_ComputerSystem


Dedicated[] [ 0 "Not Dedicated" ]

NameFormat {o} "Other"

OtherDedicatedDescriptions[] <null>

PowerManagementCapabilities[] {d} <null>

ResetCapability 5 "Not Implemented"

Method Comment


IBMZ_ComputerSystem


AcceptableStatus[] <overridden>

HasMessages <boolean>

HasUnacceptableStatus <boolean>

IBMZ_Image


AcceptableStatus[] {i,o,w} [ 2 "OK",6 "Error",10 "Stopped",0x8000 "Status Check",0x8002 "Power Save" and/or0x8003 "Not Activated" ]

Array of the status values defined inOperationalStatus that are considered"Acceptable".

OperationalStatus[] {i,o} [ 2 "OK",3 "Degraded",6 "Error",10 "Stopped",11 "In Service",13 "Lost Communication",18 "Power Mode",0x8000 "Status Check",0x8002 "Power Save" and/or0x8003 "Not Activated" ]

The mapping betweenOperationalStatus property valuesand the z Systems Image Status isdescribed in Table 62 on page 236. Insome cases, multiple CIM statuses areused to indicate a single Imagestatus.

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_Image class.

Intrinsic methods: The IBMZ_Image class supports the following intrinsic CIM operations:

IBMZ_Image


Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_Image instance.

Associators Returns the set of instances that are associated to a specific IBMZ_Imageinstance.

EnumerateInstanceNames Returns the complete set of IBMZ_Image instance references.

EnumerateInstances Returns the complete set of IBMZ_Image instances.

GetInstance Returns a specific IBMZ_Image instance.

InvokeMethod Invokes an extrinsic method on a specific IBMZ_Image instance.

ModifyInstance Updates the value of one or more properties of a specific IBMZ_Imageinstance. Only properties marked as writable in the previous tables can beupdated. If new values are specified for non-writable properties, they will beignored.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_Image instance.

References Returns the set of the association instances that reference a specificIBMZ_Image instance.

Extrinsic methods: The IBMZ_Image class supports the following extrinsic CIM operations:


This method is used to enable, disable, or reset a virtual computer system (Image). In systemterminology, these operations are known as Activating and Deactivating the Image.

A RequestedState parameter value of "Enabled" will enable the Image. Image enablement caninclude: enabling (activating) and booting (loading) the Image. If the Image is already enabled,the request will be ignored.

A RequestedState parameter value of "Disabled"reverses the enablement process, ending with anImage that is disabled (deactivated). If the Image is already disabled, the request will be ignored.

A RequestedState parameter value of "Reset" is the equivalent of issuing a "Disabled" followed byan "Enabled" request.

The return code values and parameters for the RequestStateChange() method are specified inTable 13 and Table 14, respectively.


Value Description


2 Error occurred



IN RequestedState <uint16> The requested state.Must be one of:2 "Enabled",3 "Disabled" or11 "Reset"


IBMZ_Image


Table 14. RequestStateChange() Method Parameters (continued)



Indications: The following indications are associated with the IBMZ_Image class:

Indication Trigger

IBMZ_InstCreation A new IBMZ_Image instance is created.

IBMZ_InstDeletion An IBMZ_Image instance is deleted.


In addition, if the next Image configuration (next Image Activation Profile) for an Image changes, twoIBMZ_InstModification indications will occur. One will show the IsNext property of theCIM_ElementSettingData association that connects the Image to the original next configuration changingfrom 1 "Is Next" to 2 "Is Not Next". The second will show the IsNext property of theCIM_ElementSettingData association that connects the Image to the new next configuration changingfrom 2 "Is Not Next" to 1 "Is Next".

IBMZ_OperatingSystemThe IBMZ_OperatingSystem class represents the hardware view of the operating system currentlyrunning in an Image. Much of the information traditionally associated with an operating system is notknown to the hardware, so this is a very lightweight representation.

Messages can be sent to an operating system using the IBMZ_OperatingSystem.SendOSCommand()method.

Class hierarchy:

IBMZ_OperatingSystemCIM_OperatingSystem



Associations: Each instance of IBMZ_OperatingSystem participates in the associations defined in thefollowing table.

Association Role To

CIM_RunningOS DependentCardinality: 0..1

IBMZ_ImageCardinality: 1

Class properties and methods: The properties and methods of the CIM_OperatingSystem class aredefined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Image OS"


ElementName <string> OS Name

IBMZ_Image






HealthState 5 "OK"

InstallDate <null>

Name <overridden>




Status {d} "OK"


CIM_LogicalElement











Method Comment

RequestStateChange Not supported

CIM_OperatingSystem


CreationClassName {k} IBMZ_OperatingSystem

CSCreationClassName {k} Image.CreationClassName

CSName {k} Image.Name

CurrentTimeZone <null>

Distributed <null>

FreePhysicalMemory <null>

FreeSpaceInPagingFiles <null>

FreeVirtualMemory <null>

IBMZ_OperatingSystem



LastBootUpTime <null>

LocalDateTime <null>

MaxNumberOfProcesses <null>

MaxProcessesPerUser <null>

MaxProcessMemorySize <null>

Name {k,o} ElementName

NumberOfLicensedUsers <null>

NumberOfProcesses <null>

NumberOfUsers <null>

OSType 1 "Other"10 "MVS™",39 "VM",59 "Dedicated",60 "OS/390®",61 "VSE" or68 "zOS"

OtherMVSz/VMCoupling FacilityOS/390z/VSEzOS

OtherTypeDescription <null> or other OS type

SizeStoredInPagingFiles <null>

TotalSwapSpaceSize <null>

TotalVirtualMemorySize <null>

TotalVisibleMemorySize <null>

Version <null> or <string> OS Version+"."+OS Release+"."OSRevision. <null> ifOSType=59

Method Comment

Reboot Not supported

Shutdown Not supported



SysplexName <string> Sysplex Name

Method Comment

SendOSCommand(IsPriority {i},Command, {i,r},Job {o})

Sends a command or response to the active OS<boolean><string><null>

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theCIM_OperatingSystem class.

Intrinsic methods: The CIM_OperatingSystem class supports the following intrinsic CIM operations:



Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificCIM_OperatingSystem instance.

Associators Returns the set of instances that are associated to a specificCIM_OperatingSystem instance.

EnumerateInstanceNames Returns the complete set of CIM_OperatingSystem references to instances.

EnumerateInstances Returns the complete set of CIM_OperatingSystem instances.

GetInstance Returns a specific CIM_OperatingSystem instance.

InvokeMethod Invokes an extrinsic method on a specific CIM_OperatingSystem instance.

ReferenceNames Returns the set of association references to instances that reference a specificCIM_OperatingSystem instance.

References Returns the set of the association instances that reference a specificCIM_OperatingSystem instance.

Extrinsic methods: The IBMZ_OperatingSystem class supports the following extrinsic CIM operations:

SendOSCommand()This method is used to send a command or message response to an active operating system. Thereturn code values and parameters for the SendOSCommand() method are specified in Table 15and Table 16, respectively.

Table 15. SendOSCommand() Method Return Code Values

Value Description


2 Error occurred

Table 16. SendOSCommand() Method Parameters


IN IsPriority <null> or <boolean> If <true> the command is markedas a priority request. If <false> ornot present, the command hasnormal priority.

IN, REQ Command <string> The OS command string.


Indications: The following indications are associated with the IBMZ_OperatingSystem class:

Indication Type Comment

OSMessage Alert OS Console Messages

CIM_EnabledLogicalElementCapabilities (Image)An instance of the CIM_EnabledLogicalElementCapabilities class defines the allowed state transitions thatcan be affected on an Image using the RequestStateChange() method. The allowed state changes are"Enabled", "Disabled" and "Reset", which correspond to Activate (if the Image is not already activated),Deactivate and Activate respectively.

Class hierarchy:



CIM_EnabledLogicalElementCapabilitiesCIM_Capabilities

CIM_ManagedElement

Associations: Each instance of CIM_EnabledLogicalElementCapabilities participates in the associationsdefined in the following table.

Association Role To



Class properties and methods: The properties and methods of theCIM_EnabledLogicalElementCapabilities class are defined in the following tables, grouped by the class inwhich they are defined.

CIM_ManagedElement


Caption "Image Enablement Capabilities"



CIM_Capabilities




Method Comment




ElementNameEditSupported<false>



RequestedStatesSupported[] [ 2 "Enabled",3 "Disabled" and11 "Reset" ]

Activate (if not activated)DeactivateActivate

StateAwareness[] <empty>

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theCIM_EnabledLogicalElementCapabilities class.

Intrinsic methods: The CIM_EnabledLogicalElementCapabilities class supports the following intrinsic CIMoperations:

CIM_EnabledLogicalElementCapabilities (Image)


Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificCIM_EnabledLogicalElementCapabilities instance.

Associators Returns the set of instances that are associated to a specificCIM_EnabledLogicalElementCapabilities instance.

EnumerateInstanceNames Returns the complete set of CIM_EnabledLogicalElementCapabilitiesreferences to instances.

EnumerateInstances Returns the complete set of CIM_EnabledLogicalElementCapabilitiesinstances.

GetInstance Returns a specific CIM_EnabledLogicalElementCapabilities instance.

ReferenceNames Returns the set of association references to instances that reference a specificCIM_EnabledLogicalElementCapabilities instance.

References Returns the set of the association instances that reference a specificCIM_EnabledLogicalElementCapabilities instance.

Extrinsic methods: The CIM_EnabledLogicalElementCapabilities class does not support any extrinsic CIMoperations.

Indications: There are no indications associated with the CIM_EnabledLogicalElementCapabilities class.

Support ElementThis section describes the classes that are related to Support Element (SE) objects. It covers classes thatare described in the Service Processor profile.

The boot and virtual system configurations owned by an SE can be saved and restored using theIBMZ_SupportElement.Export() and IBMZ_SupportElement.Import() methods.

IBMZ_SupportElementInstances of class IBMZ_SupportElement represent the Support Element (SE) that manages a CPC.

Class hierarchy:

IBMZ_SupportElementCIM_ComputerSystem



CIM_ManagedElement

Associations: Each instance of IBMZ_SupportElement participates in the following associations:

Association Role To

CIM_ConcreteComponent GroupComponentCardinality: 1

CIM_BootConfigSetting (Image)Cardinality: *


CIM_BootConfigSetting (CPC)Cardinality: *


IBMZ_TemporaryCapacityRecordCardinality: *


IBMZ_GroupSettingDataCardinality: *

CIM_EnabledLogicalElementCapabilities (Image)


Association Role To


IBMZ_ImageSettingDataCardinality: *


CIM_RegisteredProfile(Service Processor)Cardinality: 1

CIM_HostedAccessPoint AntecedentCardinality: 1

CIM_IPProtocolEndpointCardinality: 1..*

CIM_HostedCollection AntecedentCardinality: 0..1

CIM_SystemSpecificCollectionCardinality: 1

CIM_HostedService AntecedentCardinality: 1



CIM_ResourcePoolConfigurationServiceCardinality: 1


CIM_VirtualSystemManagementServiceCardinality: 1


IBMZ_ImageOperationsServiceCardinality: 1


IBMZ_ProcessorOperationsServiceCardinality: 1

CIM_InstalledSoftwareIdentity SystemCardinality: 0..1

CIM_SoftwareIdentityCardinality: *

CIM_SystemComponent PartComponentCardinality: 1


IBMZ_ElementSoftwareIdentity AntecedentCardinality: 1


IBMZ_ManagedSE ManagedConsoleCardinality: *

IBMZ_HardwareManagementConsoleCardinality: 1..*

Class properties and methods: The properties and methods of the IBMZ_SupportElement class aredefined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Support Element"


ElementName CPC.ElementName



CommunicationStatus 2 "Communication OK" or3 "Lost Communication"


IBMZ_SupportElement



HealthState 0 "Unknown" or5 "OK"

InstallDate <null>

Name <overridden>

OperatingStatus 0 "Unknown" or16 "In Service"

OperationalStatus[] [ 2 "OK" or13 "Lost Communication" ]

PrimaryStatus 0 "Unknown" or1 "OK"

Status {d} "OK" or"Lost Comm"

StatusDescriptions[] [ "Operating normally" or"Not communicating" ]

CIM_LogicalElement






EnabledState 0 "Unknown" or2 "Enabled"





Method Comment

RequestStateChange Not Supported

CIM_System


CreationClassName {k} "IBMZ_SupportElement"

IdentifyingDescriptions[] CPC.IdentifyingDescriptions

Name {k,o} CPC.Name


OtherIdentifyingInfo[] CPC.OtherIdentifyingInfo



Roles[] <null>

IBMZ_SupportElement


CIM_ComputerSystem


Dedicated[] [ 14 "Management" ]





Method Comment


IBMZ_SupportElement


Method Comment

Export(StagingArea {i,r},Job {o})

Exports the current setting data to a staging area.<uint8:1-4><null>

Import(StagingArea {i,r},Job {o})

Imports the setting data from a staging area.<uint8:1-4><null>

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_SupportElement class.

Intrinsic methods: The IBMZ_SupportElement class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_SupportElement instance.

Associators Returns the set of instances that are associated to a specificIBMZ_SupportElement instance.

EnumerateInstanceNames Returns the complete set of IBMZ_SupportElement references to instances.

EnumerateInstances Returns the complete set of IBMZ_SupportElement instances.

GetInstance Returns a specific IBMZ_SupportElement instance.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_SupportElement instance.

References Returns the set of the association instances that reference a specificIBMZ_SupportElement instance.

Extrinsic methods: The IBMZ_SupportElement class supports the following extrinsic CIM operations:

Export()This method is used to copy the current collection of boot and virtual system setting data that is

IBMZ_SupportElement


owned by an SE into one of four staging areas. The current setting data is not affected. The returncode values and parameters for the Export() method are specified in Table 17 and Table 18respectively.

Table 17. Export() Method Return Code Values

Value Description


2 Error occurred

Table 18. Export() Method Parameters


IN, REQ StagingAreaID <uint8> The staging area identifier. Thismust be a number between 1 and4.


Import()This method is used to replace the current collection of boot and virtual system setting data thatis owned by an SE with a collection that has been previously exported into one of four stagingareas. The return code values and parameters for the Import() method are specified in Table 19and Table 20 respectively.

Table 19. Import() Method Return Code Values

Value Description


2 Error occurred

Table 20. Import() Method Parameters


IN, REQ StagingAreaID <uint8> The staging area identifier. Thismust be a number between 1 and 4.


Indications: There are no indications associated with the IBMZ_SupportElement class.

CIM_IPProtocolEndpointThe CIM_IPProtocolEndpoint class represents an I/P communications endpoint for an SE. Its primarypurpose is to expose the SE’s I/P addresses.

Class hierarchy:

CIM_IPProtocolEndpointCIM_ProtocolEndpoint

CIM_ServiceAccessPointCIM_EnabledLogicalElement


CIM_ManagedElement

Associations: Each instance of CIM_IPProtocolEndpoint participates in the associations defined in thefollowing table.

IBMZ_SupportElement


Association Role To

CIM_HostedAccessPoint DependentCardinality: 1..*


Class properties and methods: The properties and methods of the CIM_IPProtocolEndpoint class aredefined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "I/P Endpoint"

Description <overridden>

ElementName IPv4Address or IPv6Address



CommunicationStatus 2 "Communication OK" or3 "Lost Communication"


HealthState 0 "Unknown" or5 "OK"

InstallDate <null>

Name <overridden>

OperatingStatus 0 "Unknown" or16 "In Service"


PrimaryStatus 0 "Unknown" or1 "OK"

Status {d} "OK" or"Lost Comm"

StatusDescriptions[] [ "Operating normally" or"Not communicating" ]

CIM_LogicalElement






EnabledState <overridden>



TimeOfLastStateChange <overridden>

CIM_IPProtocolEndpoint




Method Comment

RequestStateChange Not Supported

CIM_ServiceAccessPoint


CreationClassName {k} "CIM_IPProtocol Endpoint"

Name {k,o} <overridden>

SystemCreationClassName {k} SupportElement.Creation ClassName

SystemName {k} SupportElement.Name

CIM_ProtocolEndpoint


BroadcastResetSupported {e} <false>

Description {o} <string>

EnabledState {o} 0 "Unknown" or2 "Enabled"

Name {k,o} <string>

NameFormat "Host address"

OperationalStatus {o} [ 2 "OK" or13 "Lost Communication" ]

OtherTypeDescription <null>

ProtocolIFType <overridden>

ProtocolType {d} <null>

TimeOfLastStatusChange {o} <null>



Address {d} <null>

AddressOrigin 0 "Unknown"

AddressType {d} <null>

IPv4Address <null> or <string> IPv4 address.One or the other ofIPv4Address or IPV6Addresswill be specified.

IPv6Address <null> or <string> IPv6 address

IPVersionsSupported {d} <null>

PrefixLength <null>

ProtocolIFType {o} 4096 "IPv4" or 4097 "IPv6"

SubnetMask <null>



Method details: This section describes in detail the intrinsic and extrinsic methods supported by theCIM_IPProtocolEndpoint class.

Intrinsic methods: The CIM_IPProtocolEndpoint class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificCIM_IPProtocolEndpoint instance.

Associators Returns the set of instances that are associated to a specificCIM_IPProtocolEndpoint instance.

EnumerateInstanceNames Returns the complete set of CIM_IPProtocolEndpoint references to instances.

EnumerateInstances Returns the complete set of CIM_IPProtocolEndpoint instances.

GetInstance Returns a specific CIM_IPProtocolEndpoint instance.

ReferenceNames Returns the set of association references to instances that reference a specificCIM_IPProtocolEndpoint instance.

References Returns the set of the association instances that reference a specificCIM_IPProtocolEndpoint instance.

Extrinsic methods: The CIM_IPProtocolEndpoint class does not support any extrinsic CIM operations.

Indications: There are no indications associated with the CIM_IPProtocolEndpoint class.

CIM_SoftwareIdentityThe CIM_SoftwareIdentity class represents a part of the licensed internal code that is installed oravailable to be installed on an HMC or SE. Licensed internal code is segmented by subsystem intodiscrete bundles. Service updates are applied to bundles incrementally with delta fix packages known aslicensed internal code change levels. An instance of the CIM_SoftwareIdentity class represents either abundle or an internal code change level.

Because internal code change levels are always installed sequentially, only significant levels arerepresented. The significance of the level is denoted by the ElementSoftwareStatus property of theIBMZ_ElementSoftwareIdentity association connecting an instance of CIM_SoftwareIdentity to its scopingcomputer system.

The following table describes the possible ElementSoftwareStatus value combinations. In the thirdcolumn, the states are also mapped to their z Systems and LinuxONE terms.

ElementSoftwareStatus Description z Systems and LinuxONE Term

[6 "Installed",2 "Current",32768 "Concurrent"]

The lowest level that can be removedwithout disrupting the CPC.

Removable Concurrent

[6 "Installed",2 "Current",32769 "Accepted"]

The lowest level that can beremoved. Levels at or below thisvalue have been permanentlyapplied.

Accepted

[6 "Installed",2 "Current",5 "Default"]

The base internal code bundle.

[6 "Installed",2 "Current"]

The highest level that has beeninstalled and activated.

Activated



|

|

ElementSoftwareStatus Description z Systems and LinuxONE Term

[8 "Available",32768 "Concurrent"]

The highest level that has beenretrieved to the system that can beinstalled and activated withoutdisrupting the CPC.

Installable Concurrent

[8 "Available"] The highest level that has beenretrieved to the system, but has notbeen installed and activated.

Retrieved

Class hierarchy:

CIM_SoftwareIdentityCIM_LogicalElement


Associations: Each instance of CIM_SoftwareIdentity participates in the associations defined in thefollowing table.

Association Role To

CIM_InstalledSoftware Identity InstalledSoftwareCardinality: *

IBMZ_SupportElement orIBMZ_HardwareManagementConsoleCardinality: 0..1

CIM_MemberOfCollection MemberCardinality: *

CIM_SystemSpecificCollectionCardinality: 0..1

CIM_OrderedComponent GroupComponentCardinality: 0..1


CIM_OrderedComponent PartComponentCardinality: *

CIM_SoftwareIdentityCardinality: 0..1

IBMZ_ElementSoftware Identity AntecedentCardinality: *

IBMZ_SupportElement orIBMZ_HardwareManagementConsoleCardinality: 1

Class properties and methods: The properties and methods of the CIM_SoftwareIdentity class aredefined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Internal Code"


ElementName <string>





CIM_SoftwareIdentity


|


HealthState 5 "OK"

InstallDate <null>

Name <null>


OperationalStatus[] [2 "OK" ]


Status {d} "OK"


CIM_LogicalElement




BuildNumber <null> or <uint16> Licensed internal code change level

ClassificationDescriptions[] <null>

Classifications[] [ 10 "Firmware",12 "Support/Service Pack" ] or[ 10 "Firmware",13 "Software Bundle" ]

"Support/Service Pack" represents alicensed internal code change level."Software Bundle" represents alicensed internal code change bundle

ExtendedResourceType <null>

IdentifyingInfoType[] <null>

IdentifyingInfoValue[] <null>


IsEntity <true>

Languages[] <null>

MajorVersion <null> or <uint16> <null> if the version is not available

Manufacturer "IBM"

MinExtendedResourceTypeBuildNumber

<null>

MinExtendedResourceTypeMajorVersion

<null>

MinExtendedResourceTypeMinorVersion

<null>

MinExtendedResourceTypeRevisionNumber

<null>

MinorVersion <null> or <uint16> <null> if the version is not available

OtherExtendedResourceTypeDescription

<null>

ReleaseDate <null> or <datetime> <null> for internal code bundles

RevisionNumber <null> or <uint16> <null> if the version is not available

SerialNumber <null>

TargetOperatingSystems[] <null>




TargetOSTypes[] <null>

TargetTypes[] [ <string> ] Licensed internal code number

VersionString <null> or <string> MajorVersion+"."+MinorVersion+"."+ReleaseLevel<null> if the version is not available

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theCIM_SoftwareIdentity class.

Intrinsic methods: The CIM_SoftwareIdentity class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificCIM_SoftwareIdentity instance.

Associators Returns the set of instances that are associated to a specificCIM_SoftwareIdentity instance.

EnumerateInstanceNames Returns the complete set of CIM_SoftwareIdentity references to instances.

EnumerateInstances Returns the complete set of CIM_SoftwareIdentity instances.

GetInstance Returns a specific CIM_SoftwareIdentity instance.

InvokeMethod Invokes an extrinsic method on a specific CIM_SoftwareIdentity instance.

ReferenceNames Returns the set of association references to instances that reference a specificCIM_SoftwareIdentity instance.

References Returns the set of the association instances that reference a specificCIM_SoftwareIdentity instance.

Extrinsic methods: The CIM_SoftwareIdentity class does not support any extrinsic CIM operations.

Indications: There are no indications associated with the CIM_SoftwareIdentity class.

CIM_SystemSpecificCollectionThe CIM_SystemSpecificCollection class represents the collection of licensed internal code levels managedby a Support Element or Hardware Management Console that are in the "Available" ("Retrieved" orInstallable Concurrent) state.

Class hierarchy:

CIM_SystemSpecificCollectionCIM_Collection

CIM_ManagedElement

Associations: Each instance of CIM_SystemSpecificCollection participates in the associations defined inthe following table.

Association Role To

CIM_HostedCollection DependentCardinality: 1

IBMZ_SupportElement orIBMZ_HardwareManagementConsoleCardinality: 1



Association Role To

CIM_MemberOfCollection CollectionCardinality: 0..1


Class properties and methods: The properties and methods of the CIM_SystemSpecificCollection classare defined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Available Software"


ElementName Caption

CIM_Collection





Method details: This section describes in detail the intrinsic and extrinsic methods supported by theCIM_SystemSpecificCollection class.

Intrinsic methods: The CIM_SystemSpecificCollection class supports the following intrinsic CIMoperations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificCIM_SystemSpecificCollection instance.

Associators Returns the set of instances that are associated to a specificCIM_SystemSpecificCollection instance.

EnumerateInstanceNames Returns the complete set of CIM_SystemSpecificCollection references toinstances.

EnumerateInstances Returns the complete set of CIM_SystemSpecificCollection instances.

GetInstance Returns a specific CIM_SystemSpecificCollection instance.

InvokeMethod Invokes an extrinsic method on a specific CIM_SystemSpecificCollectioninstance.

ReferenceNames Returns the set of association references to instances that reference a specificCIM_SystemSpecificCollection instance.

References Returns the set of the association instances that reference a specificCIM_SystemSpecificCollection instance.

Extrinsic methods: The CIM_SystemSpecificCollection class does not support any extrinsic CIMoperations.

Indications: There are no indications associated with the CIM_SystemSpecificCollection class.



HMCThis section describes the classes that are related to Hardware Management Console (HMC) objects.

IBMZ_HardwareManagementConsoleInstances of class IBMZ_HardwareManagementConsole represent a Hardware Management Console thatprovides a consolidated management view of CPCs and Images. An HMC hosts a CIM server.

An HMC can be enabled or disabled using theIBMZ_HardwareManagementConsole.RequestStateChange() method.

Class hierarchy:

IBMZ_HardwareManagementConsoleCIM_ComputerSystem



CIM_ManagedElement

Associations: Each instance of IBMZ_HardwareManagementConsole participates in the followingassociations:

Association Role To

CIM_HostedCollection AntecedentCardinality: 0..1

CIM_SystemSpecific CollectionCardinality: 1

CIM_InstalledSoftwareIdentity SystemCardinality: 0..1



IBMZ_HardwareMessage LogCardinality: 1


IBMZ_AuditLogCardinality: 1


IBMZ_SecurityLogCardinality: 1

IBMZ_ElementSoftwareIdentity AntecedentCardinality: 1


IBMZ_ManagedSE ManagingConsoleCardinality: 1..*

IBMZ_SupportElementCardinality: *

Class properties and methods: The properties and methods of the IBMZ_HardwareManagementConsoleclass are defined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Hardware Management Console"


ElementName <string> HMC Name





CommunicationStatus {i} 2 "Communication OK"


HealthState {i} 5 "OK"

InstallDate <null>

Name <overridden>

OperatingStatus {i} 16 "In Service"

OperationalStatus[] {i} [ 2 "OK" ]

PrimaryStatus {i} 1 "OK"

Status {i,d} "OK"

StatusDescriptions[] {i} [ "Operating normally" ]

CIM_LogicalElement





EnabledDefault 5 "Not Applicable"

EnabledState {i} 2 "Enabled"





Method Comment


Enables or disables an HMC2 "Enabled", 3 "Disabled", 10 "Reboot" or 11 "Reset"<null> or 0<null>

CIM_System


CreationClassName {k} "IBMZ_HardwareManagementConsole"


Name {k,o} <string>





Roles[] <null>

IBMZ_HardwareManagementConsole


CIM_ComputerSystem


Dedicated[] [ 14 "Management" ]





Method Comment




Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_HardwareManagementConsole class.

Intrinsic methods: The IBMZ_HardwareManagementConsole class supports the following intrinsic CIMoperations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_HardwareManagementConsole instance.

Associators Returns the set of instances that are associated to a specificIBMZ_HardwareManagementConsole instance.

EnumerateInstanceNames Returns the complete set of IBMZ_HardwareManagementConsole referencesto instances.

EnumerateInstances Returns the complete set of IBMZ_HardwareManagementConsole instances.

GetInstance Returns a specific IBMZ_HardwareManagementConsole instance.

InvokeMethod Invokes an extrinsic method on a specificIBMZ_HardwareManagementConsole instance.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_HardwareManagementConsole instance.

References Returns the set of the association instances that reference a specificIBMZ_HardwareManagementConsole instance.

Extrinsic methods: The IBMZ_HardwareManagementConsole class supports the following extrinsic CIMoperations:


This method is used to shut down, reboot, or reset an HMC.

As the HMC hosts the CIM server, a CIM request cannot be used to enable it. A RequestedStateparameter value of "Enabled" is supported, but will be ignored.

A RequestedState parameter value of "Disabled" shuts down and powers off the HMC. If theHMC is already disabled, the request will never reach it.



A RequestedState parameter value of "Reboot" will restart the HMC by shutting down and thenrestarting the HMC system.

A RequestedState parameter value of "Reset" will restart the HMC application without restartingthe system.

The return code values and parameters for the RequestStateChange() method are specified inTable 21 and Table 22, respectively.


Value Description


2 Error occurred



IN RequestedState <uint16> The requested state. Must be oneof: 2 "Enabled", 3 "Disabled", 10"Reboot" or 11 "Reset"



Indications: The following indications are associated with the IBMZ_HardwareManagementConsoleclass:

Indication Trigger


IBMZ_AuditLogAn instance of IBMZ_AuditLog is associated with each HMC instance. It is the container for the audit logentries associated with the HMC.

Class hierarchy:

IBMZ_AuditLogCIM_RecordLog

CIM_LogCIM_EnabledLogicalElement


CIM_ManagedElement

Associations: Each instance of IBMZ_AuditLog participates in the associations defined in the followingtable.

Association Role To

CIM_LogManagesRecord LogCardinality: 1

CIM_LogEntryCardinality: *

CIM_UseOfLog DependentCardinality: 1

IBMZ_HardwareManagementConsoleCardinality: 1



Class properties and methods: The properties and methods of the IBMZ_AuditLog class are defined inthe following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Audit Log"


ElementName <string> ComputerSystem.ElementName





HealthState 5 "OK"

InstallDate <null>

Name <string> ElementName




Status {d} "OK"


CIM_LogicalElement




AvailableRequested States[] <null>


EnabledState 5 "Not Applicable"





Method Comment


CIM_Log

IBMZ_AuditLog



CurrentNumberOfRecords <null>

LogState 2 "Normal"

MaxNumberOfRecords 0 Not Applicable

OverwritePolicy 2 "Wraps When Full"

Method Comment

ClearLog() Deletes all entries from the audit log.

CIM_RecordLog



IBMZ_AuditLog


Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_AuditLog class.

Intrinsic methods: The IBMZ_AuditLog class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_AuditLog instance.

Associators Returns the set of instances that are associated to a specific IBMZ_AuditLoginstance.

EnumerateInstanceNames Returns the complete set of IBMZ_AuditLog references to instances.

EnumerateInstances Returns the complete set of IBMZ_AuditLog instances.

GetInstance Returns a specific IBMZ_AuditLog instance.

InvokeMethod Invokes an extrinsic method on a specific IBMZ_AuditLog instance.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_AuditLog instance.

References Returns the set of the association instances that reference a specificIBMZ_AuditLog instance.

Extrinsic methods: The IBMZ_AuditLog class supports the following extrinsic CIM operations:

ClearLog()This method is used to remove all entries from an audit log. The return code values for theClearLog() method are specified in Table 23. There are no parameters.

Table 23. ClearLog() Method Return Code Values

Value Description


2 Error occurred

IBMZ_AuditLog


Indications: There are no indications associated with the IBMZ_AuditLog class.

IBMZ_HardwareMessageLogAn instance of IBMZ_HardwareMessageLog is associated with each CPC and HMC instance. It is thecontainer for the hardware message log entries associated with the CPC or HMC.

All entries in a log can be deleted using the IBMZ_HardwareMessageLog.ClearLog() method.

Class hierarchy:

IBMZ_HardwareMessageLogCIM_RecordLog



CIM_ManagedElement

Associations: Each instance of IBMZ_HardwareMessageLog participates in the associations defined inthe following table.

Association Role To




IBMZ_CPC orIBMZ_HardwareManagementConsoleCardinality: 1

Class properties and methods: The properties and methods of the IBMZ_HardwareMessageLog classare defined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Hardware Message Log"







HealthState 5 "OK"

InstallDate <null>








Status {d} "OK"


CIM_LogicalElement











Method Comment


CIM_Log

Method Comment


LogState 2 "Normal"

MaxNumberOfRecords 0 Not Applicable

OverwritePolicy 7 "Never Overwrites"

Method Comment

ClearLog() Deletes all hardware messages from the log.

CIM_RecordLog

Method Comment




Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_HardwareMessageLog class.

Intrinsic methods: The IBMZ_HardwareMessageLog class supports the following intrinsic CIM operations:



Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_HardwareMessageLog instance.

Associators Returns the set of instances that are associated to a specificIBMZ_HardwareMessageLog instance.

EnumerateInstanceNames Returns the complete set of IBMZ_HardwareMessageLog references toinstances.

EnumerateInstances Returns the complete set of IBMZ_HardwareMessageLog instances.

GetInstance Returns a specific IBMZ_HardwareMessageLog instance.

InvokeMethod Invokes an extrinsic method on a specific IBMZ_HardwareMessageLoginstance.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_HardwareMessageLog instance.

References Returns the set of the association instances that reference a specificIBMZ_HardwareMessageLog instance.

Extrinsic methods: The IBMZ_HardwareMessageLog class supports the following extrinsic CIMoperations:

ClearLog()This method is used to remove all entries from a hardware message log. The return code valuesfor the ClearLog() method are specified in Table 24. There are no parameters.


Value Description


2 Error occurred

Indications: There are no indications associated with the IBMZ_HardwareMessageLog class.

IBMZ_SecurityLogAn instance of IBMZ_SecurityLog is associated with each HMC instance. It is the container for thesecurity log entries associated with the HMC.

Class hierarchy:

IBMZ_SecurityLogCIM_RecordLog



CIM_ManagedElement

Associations: Each instance of IBMZ_SecurityLog participates in the associations defined in thefollowing table.

Association Role To





Association Role To


IBMZ_HardwareManagementConsoleCardinality: 1

Class properties and methods: The properties and methods of the IBMZ_SecurityLog class are definedin the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Security Log"







HealthState 5 "OK"

InstallDate <null>





Status {d} "OK"


CIM_LogicalElement











Method Comment


IBMZ_SecurityLog


CIM_Log



LogState 2 "Normal"

MaxNumberOfRecords0 0 Not Applicable

OverwritePolicy 2 "Wrap When Full"

Method Comment

ClearLog() Deletes all entries from the security log.

CIM_RecordLog



IBMZ_SecurityLog


Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_SecurityLog class.

Intrinsic methods: The IBMZ_SecurityLog class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_SecurityLog instance.

Associators Returns the set of instances that are associated to a specificIBMZ_SecurityLog instance.

EnumerateInstanceNames Returns the complete set of IBMZ_SecurityLog references to instances.

EnumerateInstances Returns the complete set of IBMZ_SecurityLog instances.

GetInstance Returns a specific IBMZ_SecurityLog instance.

InvokeMethod Invokes an extrinsic method on a specific IBMZ_SecurityLog instance.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_SecurityLog instance.

References Returns the set of the association instances that reference a specificIBMZ_SecurityLog instance.

Extrinsic methods: The IBMZ_SecurityLog class supports the following extrinsic CIM operations:

ClearLog()This method is used to remove all entries from a security log. The return code values for theClearLog() method are specified in Table 25 on page 93. There are no parameters.

IBMZ_SecurityLog



Value Description


2 Error occurred

Indications: There are no indications associated with the IBMZ_SecurityLog class.

CIM_LogEntryEach instance of CIM_LogEntry represents an HMC or CPC log entry. There are three types of logs:hardware message, audit, and security. Both CPCs and HMCs generate hardware messages, generallyindicating error conditions. HMCs additionally have audit and security logs that record significant events.CIM_LogEntry instances are aggregated into a one of these logs, as indicated by aCIM_LogManagesRecord association to an instance of IBMZ_HardwareMessageLog, IBMZ_AuditLog orIBMZ_SecurityLog.

Hardware messages persist until they are explicitly deleted. Individual hardware messages can be deletedusing the intrinsic CIM_LogEntry.DeleteInstance() method. Audit and security logs are pruned when theyreach a fixed size. Their entries cannot be individually deleted. All messages in a log can be deleted usingthe ClearLog() method of the IBMZ_HardwareMessageLog, IBMZ_AuditLog or IBMZ_SecurityLogclasses.

Class hierarchy:

CIM_LogEntryCIM_RecordForLog

CIM_ManagedElement

Associations: Each instance of CIM_LogEntry participates in the associations defined in the followingtable.

Association Role To

CIM_LogManagedRecord RecordCardinality: *

IBMZ_HardwareMessage Log,IBMZ_AuditLogor IBMZ_SecurityLogCardinality: 1

Class properties and methods: The properties and methods of the CIM_LogEntry class are defined inthe following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Hardware Message","Audit Message", or"Security Message"


ElementName <null>

CIM_RecordForLog


Locale {d} <null>

IBMZ_SecurityLog



RecordData <string> The log entry message text

RecordFormat " " An empty string, indicating freeformat

CIM_LogEntry


CreationTimeStamp <datetime> Message timestamp


LogInstanceID <string> HardwareMessageLog.InstanceID,AuditLog.InstanceID orSecurityLog.InstanceID

LogName <null>

Message <null>

MessageArguments[] <null>

MessageID <null>

OwningEntity <null>

RecordID <string>

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theCIM_LogEntry class.

Intrinsic methods: The CIM_LogEntry class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificCIM_LogEntry instance.

Associators Returns the set of instances that are associated to a specific CIM_LogEntryinstance.

DeleteInstance Deletes a specific CIM_LogEntry instance. Entries associated with anIBMZ_AuditLog or IBMZ_SecurityLog do not support the DeleteInstanceoperation.

EnumerateInstanceNames Returns the complete set of CIM_LogEntry references to instances.

EnumerateInstances Returns the complete set of CIM_LogEntry instances.

GetInstance Returns a specific CIM_LogEntry instance.

InvokeMethod Invokes an extrinsic method on a specific CIM_LogEntry instance.

ReferenceNames Returns the set of association references to instances that reference a specificCIM_LogEntry instance.

References Returns the set of the association instances that reference a specificCIM_LogEntry instance.

Extrinsic methods: The CIM_LogEntry class does not support any extrinsic CIM operations.

Indications: The following indications are associated with the CIM_LogEntry class:

CIM_LogEntry


Indication Trigger

IBMZ_InstCreation A new CIM_LogEntry instance is created.

IBMZ_InstDeletion A CIM_LogEntry instance is deleted.

ServicesThis section describes the classes that are related to CIM Services. Services are collections of methods thatare applied to instances of one or more classes.

Boot controlThis section describes the service classes that are related to booting a computer system. It covers classesthat are described in the Boot Control profile.

CIM_BootServiceClass CIM_BootService defines a service that controls the boot process for a computer system. For CPCs(host computer systems), the boot process occurs during an Initial Module Load (IML). For Images(virtual computer systems), the boot process is also known as a Load.

Class hierarchy:

CIM_BootServiceCIM_Service



Associations: Each instance of CIM_BootService for a CPC participates in the following associations:

Association Role To


CIM_BootServiceCapabilitiesCardinality: 1

CIM_HostedService DependentCardinality: 1


CIM_ServiceAffectsElement AffectingElementCardinality: 1




Class properties and methods: The properties and methods of the CIM_BootService class are defined inthe following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Boot Service"


ElementName SupportElement.ElementName


CIM_LogEntry





HealthState 5 "OK"

InstallDate <null>

Name <overridden>




Status {d} "OK"


CIM_LogicalElement











Method Comment


CIM_Service


CreationClassName {k} "CIM_BootService"

Name {k,o} <string>



Started <true>

StartMode {d} <null>

SystemCreationClassName {k} SupportElement.CreationClassName


Method Comment

StartService Not supported

CIM_BootService


Method Comment

StopService Not supported

ChangeAffectedElementsAssignedSequence

Not supported

CIM_BootService


Method Comment

ApplyBootConfigSetting(ApplyConfigSetting {i,r},ScopingComputer

System {i},Job {o})

Applies a boot configuration to a computer system.<CIM_BootConfigSetting ref><null> or <IBMZ_ComputerSystem ref>

<null>

CreateBootConfigSetting Not Supported

SetBootConfigRole(

BootConfigSetting {i,r},Role {i,r},Job {o})

Sets the boot configuration used when a systemis next enabled.<CIM_BootConfigSetting ref>0 "IsNext"<null>

SetBootConfigUsage(

BootConfigSetting {i,r},ScopingComputer

System {i}Role {i,r},Job {o})

Sets the boot configuration used when a system is nextenabled.

<CIM_BootConfigSetting ref><null> or <IBMZ_ComputerSystem ref>

0 "IsNext"<null>

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theCIM_BootService class.

Intrinsic methods: The CIM_BootService class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificCIM_BootService instance.

Associators Returns the set of instances that are associated to a specific CIM_BootServiceinstance.

EnumerateInstanceNames Returns the complete set of CIM_BootService references to instances.

EnumerateInstances Returns the complete set of CIM_BootService instances.

GetInstance Returns a specific CIM_BootService instance.

InvokeMethod Invokes an extrinsic method on a specific CIM_BootService instance.

ReferenceNames Returns the set of association references to instances that reference a specificCIM_BootService instance.

References Returns the set of the association instances that reference a specificCIM_BootService instance.

Extrinsic methods: The CIM_BootService class supports the following extrinsic CIM operations:

ApplyBootConfig()

CIM_BootService


This method is used to apply an existing boot configuration to a computer system. The bootconfiguration must be one of the instances of CIM_BootConfigSetting that is related to thecomputer system via a CIM_ElementSettingData association. For CPCs (host computer systems),this is the equivalent of IMLing a CPC using a Reset Activation Profile. For Images (virtualcomputer systems), this is the equivalent of Loading an Image using an Image or Load ActivationProfile.

The return code values and parameters for the ApplyBootConfig() method are specified inTable 26 and Table 27, respectively.

Table 26. ApplyBootConfig() Method Return Code Values

Value Description


2 Error occurred

Table 27. ApplyBootConfig() Method Parameters


IN, REQ ApplyBootConfig <CIM_BootConfigSetting ref> The boot configuration to apply.

IN ScopingComputerSystem <null> or<IBMZ_ComputerSystem ref>

The computer system (CPC orImage) that is to be booted. If<null>, all computer systemsassociated to ApplyBootConfig viaCIM_ElementSettingDataassociations will be booted.


SetBootConfigRole()

This method is used to control which boot configuration is used to automatically boot a set ofcomputer systems when they are enabled. Each computer system that is associated to the selectedboot configuration via an instance of CIM_ElementSettingData is affected. For host computersystems (CPCs), this is the equivalent of setting the Next Activation Profile for the CPC. Forvirtual computer systems (Images), this is the equivalent of setting the Next Activation Profile forall Images hosted by a single CPC.

The boot configuration role applies only to the Hardware Management Console that services theCIM request. It does not affect the Next Activation Profile settings between the specifiedcomputer system and boot configuration on any other HMC.

The return code values and parameters for the SetBootConfigRole() method are specified inTable 28 and Table 29, respectively.

Table 28. SetBootConfigRole() Method Return Code Values

Value Description


2 Error occurred

Table 29. SetBootConfigRole() Method Parameters


IN, REQ BootConfigSetting <CIM_BootConfigSetting ref> The target boot configuration.

IN, REQ Role <uint16> The new role. Only 0 "IsNext" issupported.


CIM_BootService


SetBootConfigUsage()

This method is used to control which boot configuration is used to automatically boot a singlecomputer system or a set of computer systems when they are enabled. The selected bootconfiguration is applied to the selected computer system. If no computer system is selected, eachcomputer system that is associated to the selected boot configuration via an instance ofCIM_ElementSettingData is affected. For host computer systems (CPCs), this is the equivalent ofsetting the Next Activation Profile for the CPC. For virtual computer systems (Images), this is theequivalent of setting the Next Activation Profile for a single Image hosted by a single CPC (or forall Images hosted by the CPC). The boot configuration role applies only to the HardwareManagement Console that services the CIM request. It does not affect the Next Activation Profilesettings between the specified computer system and boot configuration on any other HMC.

The return code values and parameters for the SetBootConfigUsage() method are specified inTable 30 and Table 31, respectively.

Table 30. SetBootConfigUsage() Method Return Code Values

Value Description


2 Error occurred

Table 31. SetBootConfigUsage() Method Parameters


IN, REQ BootConfigSetting <CIM_BootConfigSetting ref> The target boot configuration.

IN ScopingComputer System <IBMZ_ComputerSystem ref> The affected computer system.If <null>, all computer systemsassociated to the target bootconfiguration will be affected.

OUT Role <uint16> The new role.Only 0 "IsNext" is supported.

OUT Job <CIM_ConcreteJob ref> Will always be <null>.

Indications: There are no indications associated with the CIM_BootService class.

CIM_BootServiceCapabilitiesAn instance of class CIM_BootServiceCapabilities is associated with each instance of CIM_BootService. Itdescribes boot related capabilities.

Class hierarchy:

CIM_BootServiceCapabilitiesCIM_EnabledLogicalElementCapabilities

CIM_CapabilitiesCIM_ManagedElement

Associations: This instance of CIM_BootServiceCapabilities participates in the following associations:

Association Role To


CIM_BootServiceCardinality; *

CIM_BootService


Class properties and methods: The properties and methods of the CIM_BootServiceCapabilities class aredefined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Boot Service Capabilities"



CIM_Capabilities




Method Comment

CreateGoalSettings Not Supported



ElementNameEditSupported <false>


MaxElementNameLen <null>

RequestedStates Supported[] <null>

StateAwareness[] <null>

CIM_BootServiceCapabilities


BootCapabilitiesSupported[] [ 2 "State Data Supported" ]

BootConfigCapabilities[] [ 3 "Applies Boot Configuration",4 "Sets Boot Role" and5 "Sets Boot Usage" ]

BootStringsSupported[] [ 2 "BootString" and4 "StructuredBootString" ]

OtherBootCapabilities Supported[] <null>

OtherBootConfig Capabilities[] <null>

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theCIM_BootServiceCapabilities class.

Intrinsic methods: The CIM_BootServiceCapabilities class supports the following intrinsic CIM operations:



Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificCIM_BootServiceCapabilities instance.

Associators Returns the set of instances that are associated to a specificCIM_BootServiceCapabilities instance.

EnumerateInstanceNames Returns the complete set of CIM_BootServiceCapabilities references toinstances.

EnumerateInstances Returns the complete set of CIM_BootServiceCapabilities instances.

GetInstance Returns a specific CIM_BootServiceCapabilities instance.

ReferenceNames Returns the set of association references to instances that reference a specificCIM_BootServiceCapabilities instance.

References Returns the set of the association instances that reference a specificCIM_BootServiceCapabilities instance.

Extrinsic methods: The CIM_BootServiceCapabilities class does not support any extrinsic CIM operations.

Indications: There are no indications associated with the CIM_BootServiceCapabilities class.

Image operationsThis section describes the service class that is related to Image operations.

IBMZ_ImageOperationsServiceAs single instance of class IBMZ_ImageOperationsService is used to perform operations on Images.

Class hierarchy:

IBMZ_ImageOperationsServiceCIM_Service



Associations: Each instance of IBMZ_ImageOperationsService participates in the following associations:

Association Role To





Class properties and methods: The properties and methods of the IBMZ_ImageOperationsService classare defined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Image Operations Service"









HealthState 5 "OK"

InstallDate <null>

Name <overridden>




Status {d} "OK"


CIM_LogicalElement











Method Comment


CIM_Service


CreationClassName {k} "IBMZ_ImageOperationsService"

Name {k,o} <string>



Started <true>




IBMZ_ImageOperationsService


Method Comment




Not supported



Method Comment

Load(TargetSystem {i,r},LoadAddress {i},LoadParameter {i},Clear {i},Timeout {i},StoreStatus {i},Force {i},Job {o})

Performs a Load on the Image<IBMZ_Image ref><null> or <uint16><null> or <string:8><null> or <boolean><null> or 60..600<null> or <boolean><null> or <boolean><null>

PSWRestart(TargetSystem {i,r},Force {i},Job {o})

Performs a PSW Restart on the Image.<IBMZ_Image ref><null> or <boolean><null>

ResetClear(TargetSystem {i,r},Force {i},Job {o})

Performs a Reset Clear on the Image.<IBMZ_Image ref><null> or <boolean><null>

ResetNormal(TargetSystem {i,r},Force {i},Job {o})

Performs a Reset Normal on the Image.<IBMZ_Image ref><null> or <boolean><null>

SCSIDump(TargetSystem {i,r},LoadAddress {i},LoadParameter {i},WorldWidePortName {i},LogicalUnitNumber {i},BootProgramSelector {i},OSLoadParameters {i},BootRecordAddress {i},Force {i},Job {o})

Performs a SCSI Dump on the Image.<IBMZ_Image ref><null> or <uint16><null> or <string:8><null> or <uint64><null> or <uint64><null> or 0..30<null> or <string:256><null> or <uint64><null> or <boolean><null>



Method Comment

SCSILoad(TargetSystem {i,r},LoadAddress {i},LoadParameter {i},WorldWidePortName {i},LogicalUnitNumber {i},BootProgramSelector {i},OSLoadParameters {i},BootRecordAddress {i},Force {i},Job {o})

Performs a SCSI Load on the Image.<IBMZ_Image ref><null> or <uint16><null> or <string:8><null> or <uint64><null> or <uint64><null> or 0..30<null> or <string:256><null> or <uint64><null> or <boolean><null>

Start(TargetSystem {i,r},Force {i},Job {o})

Performs a Start on the Image.<IBMZ_Image ref><null> or <boolean><null>

Stop(TargetSystem {i,r},Force {i},Job {o})

Performs a Stop on the Image.<IBMZ_Image ref><null> or <boolean><null>

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_ImageOperationsService class.

Intrinsic methods: The IBMZ_ImageOperationsService class supports the following intrinsic CIMoperations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_ImageOperationsService instance.

Associators Returns the set of instances that are associated to a specificIBMZ_ImageOperationsService instance.

EnumerateInstanceNames Returns the complete set of IBMZ_ImageOperationsService references toinstances.

EnumerateInstances Returns the complete set of IBMZ_ImageOperationsService instances.

GetInstance Returns a specific IBMZ_ImageOperationsService instance.

InvokeMethod Invokes an extrinsic method on a specific IBMZ_ImageOperationsServiceinstance.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_ImageOperationsService instance.

References Returns the set of the association instances that reference a specificIBMZ_ImageOperationsService instance.

Extrinsic methods: The IBMZ_ImageOperationsService class supports the following extrinsic CIMoperations:

Load()

This method is used to boot (load) a virtual computer system (Image). It is similar to theBootService.ApplyBootConfig() method acting upon a boot configuration with



IBMZ_ImageBootSettingData.LoadType set to 0 "Standard", except that the boot properties aresupplied as method parameters instead of being read from a persistent boot configuration.

See also IBMZ_ImageOperationsService.SCSIDump() andIBMZ_ImageOperationsService.SCSILoad().

The return code values and parameters for the Load() method are specified in Table 32 andTable 33, respectively.

Table 32. Load() Method Return Code Values

Value Description


2 Error occurred

Table 33. Load() Method Parameters


IN, REQ TargetSystem <IBMZ_Image ref> A reference to the IBMZ_Image towhich the Load operation istargeted.

IN LoadAddress <null> or <uint16> The address of the I/O devicewhich contains the boot image. If<null>, the LoadAddress used thelast time the Image was booted willbe used.

IN LoadParameter <null> or <string:8> A parameter string that is passed tothe boot process. If <null>, theLoadParameter used the last timethe Image was booted will be used.

IN Clear <null> or <boolean> If <true> or <null>, the Image’smemory will be cleared before theboot is initiated. If <false>, memorywill not be cleared.

IN Timeout <null> or <datetime:i> The number of seconds to allow forprocessing the boot request. Thevalue of Timeout must be between60 and 600. If <null>, Timeoutdefaults to 60.

IN StoreStatus <null> or <boolean> If <true>, status will be storedbefore the boot is initiated. If<false> or <null>, status will not bestored.

IN Force <null> or <boolean> If <true> or <null>, the boot willoccur regardless of the Image state.If <false>, the boot will fail if anoperating system is current activein the target Image.


PSWRestart()

This method is used to request a PSW Restart of a virtual computer system (Image).

The return code values and parameters for the PSWRestart () method are specified in Table 34 onpage 106 and Table 35 on page 106, respectively.



Table 34. PSWRestart() Method Return Code Values

Value Description


2 Error occurred

Table 35. PSWRestart() Method Parameters


IN, REQ TargetSystem <IBMZ_Image ref> A reference to the IBMZ_Image towhich the PSWRestart operation istargeted.

IN Force <null> or <boolean> If <true> or <null>, the PSWRestartwill occur regardless of the Imagestate. If <false>, the PSWRestartwill fail if an operating system iscurrent active in the target Image.


ResetClear()

This method is used to request a Reset Clear of a virtual computer system (Image).

The return code values and parameters for the ResetClear () method are specified in Table 36 andTable 37, respectively.

Table 36. ResetClear() Method Return Code Values

Value Description


2 Error occurred

Table 37. ResetClear() Method Parameters


IN, REQ TargetSystem <IBMZ_Image ref> A reference to the IBMZ_Image towhich the ResetClear operation istargeted.

IN Force <null> or <boolean> If <true> or <null>, the ResetClearwill occur regardless of the Imagestate. If <false>, the ResetClear willfail if an operating system iscurrent active in the target Image.


ResetNormal()

This method is used to request a Reset Normal of a virtual computer system (Image).

The return code values and parameters for the ResetNormal() method are specified in Table 38and Table 39 on page 107, respectively.

Table 38. ResetNormal() Method Return Code Values

Value Description


2 Error occurred



Table 39. ResetNormal() Method Parameters


IN, REQ TargetSystem <IBMZ_Image ref> A reference to the IBMZ_Image towhich the ResetNormal operation istargeted.

IN Force <null> or <boolean> If <true> or <null>, theResetNormal will occur regardlessof the Image state. If <false>, theResetNormal will fail if anoperating system is current activein the target


SCSIDump()

This method is used to boot (load) a dump program on a virtual computer system (Image) from aSCSI device. It is similar to the BootService.ApplyBootConfig() method acting upon a bootconfiguration with IBMZ_ImageBootSettingData.LoadType set to 2 "SCSI Dump", except that theboot properties are supplied as method parameters instead of being read from a persistent bootconfiguration.

See also IBMZ_ImageOperationsService.Load() and IBMZ_ImageOperationsService.SCSILoad().

The return code values and parameters for the SCSIDump() method are specified in Table 40 andTable 41, respectively.

Table 40. SCSIDump() Method Return Code Values

Value Description


2 Error occurred

Table 41. SCSIDump() Method Parameters


IN, REQ TargetSystem <IBMZ_Image ref> A reference to the IBMZ_Image towhich the SCSIDump operation istargeted.

IN LoadAddress <null> or <uint16> The address of the I/O devicewhich contains the boot image. If<null>, the LoadAddress used thelast time the Image was SCSIbooted will be used.

IN LoadParameter <null> or <string:8> A parameter string that is passed tothe boot process. If <null>, theLoadParameter used the last timethe Image was SCSI booted will beused.

IN WorldWidePortName <null> or <uint64> The WorldWide Port Name(WWPN) to be used to address theboot source If <null>, theWorldWidePortName used the lasttime the Image was SCSI bootedwill be used.



Table 41. SCSIDump() Method Parameters (continued)


IN LogicalUnitNumber <null> or <uint64> The logical unit number (LUN) tobe used to address the boot source.If <null>, the LogicalUnitNumberused the last time the Image wasSCSI booted will be used.

IN BootProgramSelector <null> or <uint8> The boot program selector to beused to address the boot source. If<null>, the BootProgramSelectorused the last time the Image wasSCSI booted will be used.

IN OSLoadParameters <null> or <string:256> Operating system parameters to beused for the boot. If <null>, theOSLoadParameters used the lasttime the Image was SCSI bootedwill be used.

IN BootRecordAddress <null> or <uint64> The boot record logical blockaddress to be used to address theboot source. If <null>, theBootRecordAddress used the lasttime the Image was SCSI bootedwill be used.



SCSILoad()

This method is used to boot (load) a virtual computer system (Image) from a SCSI device. It issimilar to the BootService.ApplyBootConfig() method acting upon a boot configuration withIBMZ_ImageBootSettingData.LoadType set to 1 "SCSI", except that the boot properties aresupplied as method parameters instead of being read from a persistent boot configuration.

See also IBMZ_ImageOperationsService.Load() and IBMZ_ImageOperationsService.SCSIDump().

The return code values and parameters for the SCSILoad() method are specified in Table 42 andTable 43, respectively.

Table 42. SCSILoad () Method Return Code Values

Value Description


2 Error occurred

Table 43. SCSILoad() Method Parameters


IN, REQ TargetSystem <IBMZ_Image ref> A reference to the IBMZ_Image towhich the SCSILoad operation istargeted.



Table 43. SCSILoad() Method Parameters (continued)


IN LoadAddress <null> or <uint16> The address of the I/O devicewhich contains the boot image. If<null>, the LoadAddress used thelast time the Image was SCSIbooted will be used.

IN LoadParameter <null> or <string:8> A parameter string that is passed tothe boot process. If <null>, theLoadParameter used the last timethe Image was SCSI booted will beused.

IN WorldWidePortName <null> or <uint64> The WorldWide Port Name(WWPN) to be used to address theboot source. If <null>, theWorldWidePortName used the lasttime the Image was SCSI bootedwill be used.

IN LogicalUnitNumber <null> or <uint64> The logical unit number (LUN) tobe used to address the boot source.If <null>, the LogicalUnitNumberused the last time the Image wasSCSI booted will be used.

IN BootProgramSelector <null> or <uint8> The boot program selector to beused to address the boot source. If<null>, the BootProgramSelectorused the last time the Image wasSCSI booted will be used.

IN OSLoadParameters <null> or <string:256> Operating system parameters to beused for the boot. If <null>, theOSLoadParameters used the lasttime the Image was SCSI bootedwill be used.

IN BootRecordAddress <null> or <uint64> The boot record logical blockaddress to be used to address theboot source. If <null>, theBootRecordAddress used the lasttime the Image was SCSI bootedwill be used.



Start()

This method is used to start all the processors of a virtual computer system (Image). It is theinverse of the IBMZ_ImageOperationsService.Stop() method.

The return code values and parameters for the Start() method are specified in Table 44 on page110 and Table 45 on page 110, respectively.



Table 44. Start() Method Return Code Values

Value Description


2 Error occurred

Table 45. Start() Method Parameters


IN, REQ TargetSystem <IBMZ_Image ref> A reference to the IBMZ_Image towhich the Start operation istargeted.

IN Force <null> or <boolean> If <true> or <null>, the Start willoccur regardless of the Image state.If <false>, the Start will fail if anoperating system is current activein the target Image.


Stop()

This method is used to stop all the processors of a virtual computer system (Image). It is theinverse of the IBMZ_ImageOperationsService.Start() method.

The return code values and parameters for the Stop() method are specified in Table 46 andTable 47, respectively.

Table 46. Stop() Method Return Code Values

Value Description


2 Error occurred

Table 47. Stop() Method Parameters


IN, REQ TargetSystem <IBMZ_Image ref> A reference to the IBMZ_Image towhich the Stop operation istargeted.

IN Force <null> or <boolean> If <true> or <null>, the Stop willoccur regardless of the Image state.If <false>, the Stop will fail if anoperating system is current activein the target Image.


Indications: There are no indications associated with the IBMZ_ImageOperationsService class.

Processor operationsThis section describes the class that is related to processor operations. This describes z Systems andLinuxONE specific functionality, so there are no applicable CIM defined profiles.

IBMZ_ProcessorOperationsServiceA single instance of class IBMZ_ProcessorOperationsService is used to affect processor operations.



||

Class hierarchy:

IBMZ_ProcessorOperationsServiceCIM_Service



Associations: Each instance of IBMZ_ProcessorOperationsService participates in the followingassociations:

Association Role To




CIM_ProcessorCardinality: *

Class properties and methods: The properties and methods of the IBMZ_ProcessorOperationsServiceclass are defined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Processor Operations Service"







HealthState 5 "OK"

InstallDate <null>

Name <overridden>




Status {d} "OK"


CIM_LogicalElement



IBMZ_ProcessorOperationsService










Method Comment


CIM_Service


CreationClassName {k} "IBMZ_ProcessorOperationsService"

Name {k,o} <string>



Started <true>




Method Comment




Not supported



Method Comment

ExternalInterrupt(TargetProcessor {i,r},Job {o})

Performs an External Interrupt on the processor.<CIM_Processor ref><null>

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_ProcessorOperationsService class.

Intrinsic methods: The IBMZ_ProcessorOperationsService class supports the following intrinsic CIMoperations:



Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_ProcessorOperationsService instance.

Associators Returns the set of instances that are associated to a specificIBMZ_ProcessorOperationsService instance.

EnumerateInstanceNames Returns the complete set of IBMZ_ProcessorOperationsService references toinstances.

EnumerateInstances Returns the complete set of IBMZ_ProcessorOperationsService instances.

GetInstance Returns a specific IBMZ_ProcessorOperationsService instance.

InvokeMethod Invokes an extrinsic method on a specific IBMZ_ProcessorOperationsServiceinstance.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_ProcessorOperationsService instance.

References Returns the set of the association instances that reference a specificIBMZ_ProcessorOperationsService instance.

Extrinsic methods: The IBMZ_ProcessorOperationsService class supports the following extrinsic CIMoperations:

ExternalInterrupt()

This method is used to issue an external interrupt request to a specific processor. The return codevalues and parameters for the ExternalInterrupt() method are specified in Table 48 and Table 49,respectively.

Table 48. ExternalInterrupt() Method Return Code Values

Value Description


2 Error occurred

Table 49. ExternalInterrupt() Method Parameters


IN, REQ Target Processor <CIM_Processor ref> A reference to the processorinstance that is the target of thisexternal interrupt request.

OUT Job <CIM_ConcreteJob ref> Will always be <null>.

Indications: There are no indications associated with the IBMZ_ProcessorOperationsService class.

Resource pool configurationThis section describes classes that are used to manage resource pools.

CIM_ResourcePoolConfigurationServiceAn instance of CIM_ResourcePoolConfigurationService is used to manage a Fibre Channel port pool. Forthe HMC, pool management is not supported, so this class provides no functional value. It is included tosatisfy the requirements of the Storage Adapter Resource Virtualization profile.

Class hierarchy:

CIM_ResourcePoolConfigurationServiceCIM_Service





Associations: Each instance of CIM_ResourcePoolConfigurationService participates in the followingassociations:

Association Role To


CIM_ResourcePoolConfigurationCapabilitiesCardinality: 1





Class properties and methods: The properties and methods of theCIM_ResourcePoolConfigurationService class are defined in the following tables, grouped by the class inwhich they are defined.

CIM_ManagedElement


Caption "Resource Pool ConfigurationService"







HealthState 5 "OK"

InstallDate <null>

Name <overridden>




Status {d} "OK"


CIM_LogicalElement



CIM_ResourcePoolConfigurationService










Method Comment


CIM_Service


CreationClassName {k} "CIM_ResourcePoolConfigurationService"

Name {k,o} <string>



Started <true>




Method Comment




Not supported



Method Comment

AddResourcesToResourcePool Not supported

ChangeParentResource Pool Not supported

CreateChildResourcePool Not supported

CreateResourcePool Not supported

DeleteResourcePool Not supported

RemoveResourcesFromResourcePool Not supported



Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_ResourcePoolConfigurationService class.

Intrinsic methods: The IBMZ_ResourcePoolConfigurationService class supports the following intrinsicCIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_ResourcePoolConfigurationService instance.

Associators Returns the set of instances that are associated to a specificIBMZ_ResourcePoolConfigurationService instance.

EnumerateInstanceNames Returns the complete set of IBMZ_ResourcePoolConfigurationServicereferences to instances.

EnumerateInstances Returns the complete set of IBMZ_ResourcePoolConfigurationServiceinstances.

GetInstance Returns a specific IBMZ_ResourcePoolConfigurationService instance.

InvokeMethod Invokes an extrinsic method on a specificIBMZ_ResourcePoolConfigurationService instance.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_ResourcePoolConfigurationService instance.

References Returns the set of the association instances that reference a specificIBMZ_ResourcePoolConfigurationService instance.

Extrinsic methods: The IBMZ_ResourcePoolConfigurationService class does not support any extrinsic CIMoperations.

Indications: There are no indications associated with the IBMZ_ResourcePoolConfigurationService class.

CIM_ResourcePoolConfigurationCapabilitiesA single instance of CIM_ResourcePoolConfigurationCapabilities is associated with all resourceconfiguration services to represent the management capabilities of that service.

Class hierarchy:

CIM_ResourcePoolConfigurationCapabilitiesCIM_Capabilities

CIM_ManagedElement

Associations: Each instance of CIM_ResourcePoolConfigurationCapabilities participates in the followingassociations:

Association Role To


CIM_ResourcePoolConfigurationServiceCardinality: *

Class properties and methods: The properties and methods of theCIM_ResourcePoolConfigurationCapabilities class are defined in the following tables, grouped by theclass in which they are defined.

CIM_ManagedElement




Caption "Resource Pool ConfigurationCapabilities"



CIM_Capabilities




Method Comment


CIM_ResourcePoolConfigurationCapabilities


AsynchronousMethodsSupported[] <empty> No asynchronous methods aresupported

SynchronousMethodsSupported[] <empty> No synchronous methods aresupported

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_ResourcePoolConfigurationCapabilities class.

Intrinsic methods: The IBMZ_ResourcePoolConfigurationCapabilities class supports the following intrinsicCIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_ResourcePoolConfigurationCapabilities instance.

Associators Returns the set of instances that are associated to a specificIBMZ_ResourcePoolConfigurationCapabilities instance.

EnumerateInstanceNames Returns the complete set of IBMZ_ResourcePoolConfigurationCapabilitiesreferences to instances.

EnumerateInstances Returns the complete set of IBMZ_ResourcePoolConfigurationCapabilitiesinstances.

GetInstance Returns a specific IBMZ_ResourcePoolConfigurationCapabilities instance.

InvokeMethod Invokes an extrinsic method on a specificIBMZ_ResourcePoolConfigurationCapabilities instance.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_ResourcePoolConfigurationCapabilities instance.

References Returns the set of the association instances that reference a specificIBMZ_ResourcePoolConfigurationCapabilities instance.

Extrinsic methods: The IBMZ_ResourcePoolConfigurationCapabilities class does not support any extrinsicCIM operations.



Indications: There are no indications associated with the IBMZ_ResourcePoolConfigurationCapabilitiesclass.

Virtual system managementThis section describes the classes that are related to the definition of Images. It covers classes that aredescribed in the System Virtualization profile.

CIM_VirtualSystemManagementServiceInstances of class CIM_VirtualSystemManagementService manage the definition of virtual systems.

Class hierarchy:

CIM_VirtualSystemManagementServiceCIM_Service



Associations: Each instance of CIM_VirtualSystemManagementService participates in the followingassociations:

Association Role To


CIM_VirtualSystemManagementCapabilitiesCardinality: 1





Class properties and methods: The properties and methods of theCIM_VirtualSystemManagementService class are defined in the following tables, grouped by the class inwhich they are defined.

CIM_ManagedElement


Caption "Image Definition Service"







HealthState 5 "OK"

InstallDate <null>

Name <overridden>







Status {d} "OK"


CIM_LogicalElement











Method Comment


CIM_Service


CreationClassName {k} "CIM_VirtualSystemManagementService"

Name {k,o} <string>



Started <true>




Method Comment




Not supported

CIM_VirtualSystemManagementService




Method Comment

AddResourceSettings Not supported

DefineSystem Not supported

DestroySystem Not supported

ModifyResourceSettings(

ResourceSettings[] {i},ResultingResource

Settings[] {o}Job {o})

Updates MemorySettingData or ProcessorSettingDatainstances.

<string><IBMZ_MemorySettingData ref> and/or

<IBMZ_ProcessorSettingData ref><null>

ModifySystemSettings(SystemSettings {i},Job {o})

Updates an ImageSettingData instance.<string><null>

RemoveResourceSettings Not supported

SelectSystem Configuration Not supported

SnapshotSystem Not supported

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theCIM_VirtualSystemManagementService class.

Intrinsic methods: The CIM_VirtualSystemManagementService class supports the following intrinsic CIMoperations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificCIM_VirtualSystemManagementService instance.

Associators Returns the set of instances that are associated to a specificCIM_VirtualSystemManagementService instance.

EnumerateInstanceNames Returns the complete set of CIM_VirtualSystemManagementServicereferences to instances.

EnumerateInstances Returns the complete set of CIM_VirtualSystemManagementServiceinstances.

GetInstance Returns a specific CIM_VirtualSystemManagementService instance.

InvokeMethod Invokes an extrinsic method on a specificCIM_VirtualSystemManagementService instance.

ReferenceNames Returns the set of association references to instances that reference a specificCIM_VirtualSystemManagementService instance.

References Returns the set of the association instances that reference a specificCIM_VirtualSystemManagementService instance.

Extrinsic methods: The CIM_VirtualSystemManagementService class supports the following extrinsic CIMoperations:

ModifyResourceSettings()

This method is used to update one or more memory or processor resource definitions. The newresource definitions are specified as embedded instances of classes IBMZ_MemorySettingData orIBMZ_ProcessorSettingData. The InstanceID property of each embedded instance must referencean existing instance. Only properties that are marked as writable in the Property and MethodDetails tables for these classes may be updated. If a resource definition does not exist, it will be



ignored, as will updates to values of any non-writable properties. References to the setting datainstances that have been updated are returned. The return code values and parameters for theModifyResourceSettings() method are specified in Table 50 and Table 51, respectively.

Table 50. ModifyResourceSettings() Method Return Code Values

Value Description


2 Error occurred

Table 51. ModifyResourceSettings() Method Parameters


IN, REQ ResourceSettings[] <string> Array of modified resources specifiedas embedded instances. TheInstanceID property value of eacharray element must reference anexisting IBMZ_MemorySettingData orIBMZ_ProcessorSettingData instance.Instances of both classes may beincluded.

OUT ResultingResource Settings[] <CIM_ResourceAllocationSettingData ref>

An array of references to the updatedresources.

OUT Job <CIM_ConcreteJob ref> Will always be <null>

ModifySystemSettings()

This method is used to update an Image setting data definition. The new resource definition isspecified as an embedded instance of class IBMZ_ImageSettingData. The InstanceID property ofthe embedded instance must reference an existing instance. Only properties that are marked aswritable in the Property and Method Details tables for this class may be updated. If the settingdata definition includes non-writable properties, they will be ignored. The return code values andparameters for the ModifySystemSettings() method are specified in Table 52 andTable 53,respectively.

Table 52. ModifySystemSettings() Method Return Code Values

Value Description


2 Error occurred

Table 53. ModifySystemSettings() Method Parameters


IN, REQ System Settings <string> Modified Image setting dataspecified as an embedded instance.The InstanceID property valuemust reference an existingIBMZ_ImageSettingData Instance.

OUT Job <CIM_ConcreteJob ref> Will always return <null>.

Indications: There are no indications associated with the CIM_VirtualSystemManagementService class.

CIM_VirtualSystemManagementCapabilitiesA singleton instance of class CIM_VirtualSystemManagementCapabilities defines the types of virtualsystems and the methods and indications that are supported by a CIM_VirtualSystemManagementService.



The zHMC model supports the virtual system types defined in Image Activation Profiles. Themodification of system and resource setting data is supported and will always be processedsynchronously. Indications are not supported.

Class hierarchy:

CIM_VirtualSystemManagementCapabilitiesCIM_EnabledLogicalElementCapabilities

CIM_CapabilitiesCIM_ManagedElement

Associations: Each instance of CIM_VirtualSystemManagementCapabilities participates in the followingassociations:

Association Role To


CIM_VirtualSystemManagementServiceCardinality: *

Class properties and methods: The properties and methods of theCIM_VirtualSystemManagementCapabilities class are defined in the following tables, grouped by theclass in which they are defined.

CIM_ManagedElement


Caption "Image Management Capabilities"



CIM_Capabilities




Method Comment




ElementNameEditSupported <false>



RequestedStatesSupported[] <empty>

StateAwareness[] <null>

CIM_VirtualServerManagementCapabilities

CIM_VirtualSystemManagementCapabilities



AsynchronousMethodsSupported[] <empty>

IndicationsSupported[] <empty>

SynchronousMethodsSupported[] [ 5 "ModifyResourceSettingsSupported",6 "ModifySystem SettingsSupported"]

VirtualSystemTypesSupported[] [ "ESA 390","ESA 390 TPF","Linux","CF","zVM","zAware" ]

For CPCs starting with z13s, a virtualsystem type of "zAware" refers to theFirmware Platform Container (FPC)type.

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_VirtualSystemManagementCapabilities class.

Intrinsic methods: The IBMZ_VirtualSystemManagementCapabilities class supports the following intrinsicCIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_VirtualSystemManagementCapabilities instance.

Associators Returns the set of instances that are associated to a specificIBMZ_VirtualSystemManagementCapabilities instance.

EnumerateInstanceNames Returns the complete set of IBMZ_VirtualSystemManagementCapabilitiesreferences to instances.

EnumerateInstances Returns the complete set of IBMZ_VirtualSystemManagementCapabilitiesinstances.

GetInstance Returns a specific IBMZ_VirtualSystemManagementCapabilities instance.

InvokeMethod Invokes an extrinsic method on a specificIBMZ_VirtualSystemManagementCapabilities instance.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_VirtualSystemManagementCapabilities instance.

References Returns the set of the association instances that reference a specificIBMZ_VirtualSystemManagementCapabilities instance.

Extrinsic methods: The IBMZ_VirtualSystemManagementCapabilities class does not support any extrinsicCIM operations.

Indications: There are no indications associated with the IBMZ_VirtualSystemManagementCapabilitiesclass.

Setting dataThis section describes setting data related classes. Setting data classes are collections of configurationdata. In the HMC CIM model, they are used to represent the Activation Profile data and temporarycapacity records.



||||

Boot controlThis section describes the setting data classes that are related to booting a computer system. It coversclasses that are described in the Boot Control profile.

CIM_BootConfigSetting (CPC)Class CIM_BootConfigSetting defines the aggregation point for the setting data that is associated with asingle CPC boot configuration. In system terminology, this represents a Reset Activation profile.

CIM_BootConfigSetting instances are related to CPCs via CIM_ElementSettingData associations. TheIsDefault, IsNext, and IsCurrent properties of instances of CIM_ElementSettingData are used to furtherdescribe the role the boot configuration plays with respect to a CPC:v One CIM_ElementSettingData instance will have its IsDefault property set to 1 "Is Default". This

identifies the system defined default configuration.v One CIM_ElementSettingData instance will have its IsNext property set to 1 "Is Next". This indicates

the boot configuration that will be automatically applied when the associated CPC is enabled (poweredon).

v If the CPC has been booted at least once, one CIM_ElementSettingData instance will have its IsCurrentproperty set to 1 "Is Current". This indicates the configuration that was last used to boot the associatedCPC.

A single instance of CIM_ElementSettingData might have more than one of these property values,indicating that it plays multiple roles.

Class hierarchy:

CIM_BootConfigSettingCIM_SettingData

CIM_ManagedElement

Associations: Each instance of CIM_BootConfigSetting for a CPC participates in the followingassociations:

Association Role To


IBMZ_CPCBootSettingDataCardinality: 1

CIM_ConcreteComponent PartComponentCardinality: *


CIM_ElementSettingData SettingDataCardinality: 1..*


Class properties and methods: The properties and methods of the CIM_BootConfigSetting class aredefined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "CPC Boot Configuration"



CIM_SettingData




ChangeableType 0 "Not Changeable - Persistent"

ConfigurationName <string> Reset Profile name

ElementName {o} <string> CPC.ElementName+":"+ConfigurationName


CIM_BootConfigSetting


Method Comment

ChangeBootOrder Not supported

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theCIM_BootConfigSetting class.

Intrinsic methods: The CIM_BootConfigSetting class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificCIM_BootConfigSetting instance.

Associators Returns the set of instances that are associated to a specificCIM_BootConfigSetting instance.

EnumerateInstanceNames Returns the complete set of CIM_BootConfigSetting references to instances.

EnumerateInstances Returns the complete set of CIM_BootConfigSetting instances.

GetInstance Returns a specific CIM_BootConfigSetting instance.

ReferenceNames Returns the set of association references to instances that reference a specificCIM_BootConfigSetting instance.

References Returns the set of the association instances that reference a specificCIM_BootConfigSetting instance.

Extrinsic methods: The CIM_BootConfigSetting class does not support any extrinsic CIM operations.

Indications: There are no indications associated with the CIM_BootConfigService class.

IBMZ_CPCBootSettingDataClass IBMZ_CPCBootSettingData defines the boot parameters that are specific to a CPC bootconfiguration. There will always be exactly one boot setting data per boot configuration.

Class hierarchy:

IBMZ_CPCBootSettingDataCIM_BootSettingData

CIM_SettingDataCIM_ManagedElement

Association: Each instance of IBMZ_CPCBootSettingData participates in the following associations:

CIM_BootConfigSetting (CPC)


Association Role To

CIM_ConcreteComponent PartComponentCardinality: 1

CIM_BootConfigSetting (CPC)Cardinality: 1

Class properties and methods: The properties and methods of the IBMZ_CPCBootSettingData class aredefined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "CPC Boot Settings"



CIM_SettingData


ChangeableType 2 "Changeable - Persistent"

ConfigurationName <string> Reset Profile name



CIM_BootSettingData


OwningEntity "IBM:ZHMC"

CIM_CPCBootSettingData


EndTimesliceOnWait {w} <null> or <boolean> From Reset Profile. <null> ifUserSpecifiedRunningTime is <false>

IMLMode {w} 0 "ESA 390" 1 "ESA 390 TPF" or 2"LPAR"

From Reset Profile

IOCDS {w} 0xA0, 0xA1, 0xA2, 0xA3, or 0xD0 From Reset Profile

RunningTime {w} <null> or 1..100 From Reset Profile. <null> ifUserSpecif>iedRunningTime is <false

UserSpecifiedRunningTime {w} <boolean> From Reset Profile

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_CPCBootSettingData class.

Intrinsic methods: The IBMZ_CPCBootSettingData class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_CPCBootSettingData instance.

IBMZ_CPCBootSettingData


Operation Comment

Associators Returns the set of instances that are associated to a specificIBMZ_CPCBootSettingData instance.

EnumerateInstanceNames Returns the complete set of IBMZ_CPCBootSettingData references toinstances.

EnumerateInstances Returns the complete set of IBMZ_CPCBootSettingData instances.

GetInstance Returns a specific IBMZ_CPCBootSettingData instance.

ModifyInstance Updates the value of one or more properties of a specificIBMZ_CPCBootSettingData instance. Only properties marked as writable inthe previous tables can be updated. If new values are specified fornon-writable properties, they will be ignored.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_CPCBootSettingData instance.

References Returns the set of the association instances that reference a specificIBMZ_CPCBootSettingData instance.

Extrinsic methods: The IBMZ_CPCBootSettingData class does not support any extrinsic CIM operations.

Indications: There are no indications associated with the CIM_CPCBootSettingData class.

CIM_BootConfigSetting (Image)Class CIM_BootConfigSetting defines the aggregation point for the source and setting data that areassociated with a single Image boot configuration. In system terminology, this represents a Load Profile.

An Image Activation Profile can contain Load Profile information. When present, this is used toautomatically boot the virtual computer system (Image) when it is enabled. In the CIM model, thisinformation is represented as a separate boot configuration, rather than as part of the virtual systemsetting data (Image Profile) data. It can be differentiated from the boot configurations that map to LoadActivation Profiles by the fact that its ConfigurationName property value matches the Image name.

CIM_BootConfigSetting instances are related to Images via CIM_ElementSettingData associations. TheIsDefault, IsNext, and IsCurrent properties of instances of CIM_ElementSettingData are used to furtherdescribe the role the boot configuration plays with respect to an Image:v One CIM_ElementSettingData instance will have its IsDefault property set to 1 "Is Default". This

identifies the system defined default configuration.v One CIM_ElementSettingData instance will have its IsNext property set to 1 "Is Next". This indicates

the boot configuration that will be automatically applied when the associated Image is enabled(activated).

v If the Image has been booted at least once, one CIM_ElementSettingData instance will have itsIsCurrent property set to 1 "Is Current". This indicates the configuration that was last used to boot theassociated Image.

A single instance of CIM_ElementSettingData may have more than one of these property values,indicating that it plays multiple roles.

Class hierarchy:

CIM_BootConfigSettingCIM_SettingData

CIM_ManagedElement

Associations: Each instance of CIM_BootConfigSetting for an Image participates in the followingassociations:



Association Role To


IBMZ_ImageBootSetting DataCardinality: 1



CIM_ElementSettingData SettingDataCardinality: 1..*


CIM_OrderedComponent GroupComponentCardinality: 1

IBMZ_ImageBootSourceSettingCardinality: 1

Class properties and methods: The properties and methods of the CIM_BootConfigSetting class aredefined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Image Boot Configuration"



CIM_SettingData



ConfigurationName <string> Image or Load Profile name



CIM_BootConfigSetting


Method Comment

ChangeBootOrder Not supported

ValidateSettings Not supported

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theCIM_BootConfigSetting class.

Intrinsic methods: The CIM_BootConfigSetting class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificCIM_BootConfigSetting instance.

Associators Returns the set of instances that are associated to a specificCIM_BootConfigSetting instance.

EnumerateInstanceNames Returns the complete set of CIM_BootConfigSetting references to instances.

CIM_BootConfigSetting (Image)


Operation Comment

EnumerateInstances Returns the complete set of CIM_BootConfigSetting instances.

GetInstance Returns a specific CIM_BootConfigSetting instance.

ReferenceNames Returns the set of association references to instances that reference a specificCIM_BootConfigSetting instance.

References Returns the set of the association instances that reference a specificCIM_BootConfigSetting instance.

Extrinsic methods: The CIM_BootConfigSetting class does not support any extrinsic CIM operations.

Indications: There are no indications associated with the CIM_BootConfigSetting class.

IBMZ_ImageBootSettingDataClass IBMZ_ImageBootSettingData defines the boot parameters that are specific to an Image bootconfiguration. There will always be exactly one boot setting data per boot configuration.

Class hierarchy:

IBMZ_ImageBootSettingDataCIM_BootSettingData


Associations: Each instance of IBMZ_ImageBootSettingData participates in the following associations:

Association Role To


CIM_BootConfigSetting (Image)Cardinality: 1

Class properties and methods: The properties and methods of the IBMZ_ImageBootSettingData class aredefined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Image Boot Settings"



CIM_SettingData






CIM_BootSettingData

CIM_BootConfigSetting (Image)



OwningEntity "IBM:ZHMC"

IBMZ_ImageBootSettingData


LoadParameter {w} <string> From Load Profile

LoadType {w} 0 "Standard",1 "SCSI",2 "SCSI Dump"

From Load Profile

OSLoadParameters {w} <null> or <string> From Load Profile.<null> if LoadType="Standard"

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_ImageBootSettingData class.

Intrinsic methods: The IBMZ_ImageBootSettingData class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_ImageBootSettingData instance.

Associators Returns the set of instances that are associated to a specificIBMZ_ImageBootSettingData instance.

EnumerateInstanceNames Returns the complete set of IBMZ_ImageBootSettingData references toinstances.

EnumerateInstances Returns the complete set of IBMZ_ImageBootSettingData instances.

GetInstance Returns a specific IBMZ_ImageBootSettingData instance.

ModifyInstance Updates the value of one or more properties of a specificIBMZ_ImageBootSettingData instance. Only properties marked as writable inthe previous tables can be updated. If new values are specified fornon-writable properties, they will be ignored.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_ImageBootSettingData instance.

References Returns the set of the association instances that reference a specificIBMZ_ImageBootSettingData instance.

Extrinsic methods: The IBMZ_ImageBootSettingData class does not support any extrinsic CIM operations.

Indications: There are no indications associated with the IBMZ_ImageBootSetting class.

IBMZ_ImageBootSourceSettingClass IBMZ_ImageBootSourceSetting defines the boot source. There will always be exactly one bootsource per boot configuration.

Class hierarchy:

IBMZ_ImageBootSourceSettingCIM_BootSourceSetting




Associations: Each instance of IBMZ_ImageBootSourceSetting participates in the following associations:

Association Role To

CIM_OrderedComponent PartComponentCardinality: 1

CIM_BootConfigSettingCardinality: 1

Class properties and methods: The properties and methods of the IBMZ_ImageBootSourceSetting classare defined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Image Boot Source"



CIM_SettingData






CIM_BootSourceSetting


BIOSBootString <null>

BootString <overridden>

FailThroughSupported 2 "Not Supported"

StructuredBootString <string> "CIM:Unknown:"+ BootString

IBMZ_ImageBootSourceSettingData


BootProgramSelector {w} <null> or 0..30 From Load Profile. <null> ifIBMZ_ImageBootSettingData.LoadType="Standard"

BootRecordAddress {w} <null> or <uint64> From Load Profile. <null> ifIBMZ_ImageBootSettingData.LoadType="Standard"

BootString {o,w} <string> LoadAddress from Load Profile.BootString must be convertible to anunsigned short integer value.

LogicalUnitNumber {w} <null> or <uint64> From Load Profile. <null> ifIBMZ_ImageBootSettingData.LoadType="Standard"

IBMZ_ImageBootSourceSetting



WorldWidePortName {w} <null> or <uint64> From Load Profile. <null> ifIBMZ_ImageBootSettingData.LoadType="Standard"

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_ImageBootSourceSetting class.

Intrinsic methods: The IBMZ_ImageBootSourceSetting class supports the following intrinsic CIMoperations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_ImageBootSourceSetting instance.

Associators Returns the set of instances that are associated to a specificIBMZ_ImageBootSourceSetting instance.

EnumerateInstanceNames Returns the complete set of IBMZ_ImageBootSourceSetting references toinstances.

EnumerateInstances Returns the complete set of IBMZ_ImageBootSourceSetting instances.

GetInstance Returns a specific IBMZ_ImageBootSourceSetting instance.

ModifyInstance Updates the value of one or more properties of a specificIBMZ_ImageBootSourceSetting instance. Only properties marked as writablein the previous tables can be updated. If new values are specified fornon-writable properties, they will be ignored.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_ImageBootSourceSetting instance.

References Returns the set of the association instances that reference a specificIBMZ_ImageBootSourceSetting instance.

Extrinsic methods: The IBMZ_ImageBootSourceSetting class does not support any extrinsic CIMoperations.

Indications: There are no indications associated with the IBMZ_ImageBootSourceSetting class.

Virtual system managementThis section describes the setting data classes that are related to the definition of Images.

IBMZ_ImageSettingData (Recorded)An instance of class IBMZ_ImageSettingData represents the aggregation point for the definition of avirtual computer system (Image). In system terminology this is known as an Image Profile. The ImageProfile processor quantity and weight settings for the various processor types are pulled out intoassociated instances of IBMZ_ProcessorSettingData. The storage related settings are pulled out intoassociated instances of IBMZ_MemorySettingData.

A recorded IBMZ_ImageSettingData instance is associated to a second instance of classIBMZ_ImageSettingData via a CIM_ElementSettingData association. This instance defines the run-timestate of virtual system configuration settings with respect to the Image. This state instance is documentedin its own section “IBMZ_ImageSettingData (State)” on page 135. When the Image is active, a thirdinstance of IBMZ_ImageSettingData exists to define the last used settings. This current instance isdocumented in its own section “IBMZ_ImageSettingData (Current)” on page 138. When the Image is notactive, the recorded IBMZ_ImageSettingData instance also represents the current settings, or in otherwords, the setting data that was used the last time the Image was enabled.



Class hierarchy:

IBMZ_ImageSettingDataCIM_VirtualSystemSettingData


Associations: Each instance of IBMZ_ImageSettingData participates in the associations defined in thefollowing table.

Association Role To




IBMZ_GroupSettingData (Recorded)Cardinality: 0..1

CIM_ElementSettingData SettingDataCardinality: 1

IBMZ_ImageSettingData (State)Cardinality: 1

CIM_VirtualSystemSettingDataComponent


IBMZ_MemorySettingData(Recorded)Cardinality: 1..*



IBMZ_FCPortSettingDataCardinality: *



IBMZ_ProcessorSetting Data(Recorded)Cardinality: 1..*

Class properties and methods: The properties and methods of the IBMZ_ImageSettingData class aredefined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Image Configuration"



CIM_SettingData


ChangeableType 2 "Changeable - Persistent" or3 "Not Changeable - Transient"

"Not Changeable" if an Image isdefined, but has no associated ImageProfile.

ConfigurationName <string> Image name

ElementName {o} <string> CPC.ElementName+ConfigurationName+ "(Recorded)"



IBMZ_ImageSettingData (Recorded)



AutomaticRecoveryAction <null>

AutomaticShutdownAction <null>

AutomaticStartupAction <null>

AutomaticStartupActionDelay <null>

AutomaticStartupActionSequenceNumber

<null>

ConfigurationDataRoot <null>

ConfigurationFile <null>

ConfigurationID <null>

CreationTime <null>

LogDataRoot <null>

Notes[] <null>

RecoveryFile <null>

SnapshotDataRoot <null>

SupendDataRoot <null>

SwapFileDataRoot <null>

VirtualSystemIdentifier <string> Image name

VirtualSystemType <overridden>



AESKeyImportFunctionsPermitted{w}

<null> or <boolean> From Image Profile. <null> ifVirtualSystemType="CF" orChangeableType=3

BasicCounterAuthorized {w} <null> or <boolean> From Image Profile. <null> ifVirtualSystemType="CF" orChangeableType=3

BasicSampleAuthorized {w} <null> or <boolean> From Image Profile. <null> ifVirtualSystemType="CF" orChangeableType=3

CoprocessorGroupCounterAuthorized {w}


CryptoActivityCounter Authorized{w}


DEAKeyImportFunctionsPermitted{w}


DefinedCapacity {w} <null> or <uint32> From Image Profile. <null> ifVirtualSystemType="CF" orChangeableType=3

DiagnosticSample Authorized {w} <null> or <boolean> From Image Profile. <null> ifVirtualSystemType="CF" orChangeableType=3




ExtendedCounter Authorized {w} <null> or <boolean> From Image Profile. <null> ifVirtualSystemType="CF" orChangeableType=3

ProblemStateCounter Authorized {w} <null> or <boolean> From Image Profile. <null> ifVirtualSystemType="CF" orChangeableType=3

VirtualSystemType {o,w} <null>,"ESA 390","ESA 390 TPF","Linux","zVM","CF",or"zAware"

Mode from Image Profile. <null> ifChangeableType=3


WorkLoadManaged {w} <null> or <boolean> From Image Profile. <null> ifVirtualSystemType="CF" orChangeableType=3

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_ImageSettingData class.

Intrinsic methods: The IBMZ_ImageSettingData class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_ImageSettingData instance.

Associators Returns the set of instances that are associated to a specificIBMZ_ImageSettingData instance.

EnumerateInstanceNames Returns the complete set of IBMZ_ImageSettingData references to instances.

EnumerateInstances Returns the complete set of IBMZ_ImageSettingData instances.

GetInstance Returns a specific IBMZ_ImageSettingData instance.

ModifyInstance Updates the value of one or more properties of a specificIBMZ_ImageSettingData instance. Only properties marked as writable in theprevious tables can be updated. If new values are specified for non-writableproperties, they will be ignored.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_ImageSettingData instance.

References Returns the set of the association instances that reference a specificIBMZ_ImageSettingData instance.

Extrinsic methods: The IBMZ_ImageSettingData class does not support any extrinsic CIM operations.

Indications: There are no indications associated with the IBMZ_ImageSettingData class.

IBMZ_ImageSettingData (State)A single instance of class IBMZ_ImageSettingData represents the virtualization related real-time statesettings of an Image. In system terminology, this is the Change LPAR Controls related data. The stateprocessor quantity and weight attributes for the various processor types are pulled out into instances ofIBMZ_ProcessorSettingData. The storage related settings are pulled out into associated instances ofIBMZ_MemorySettingData.



||||

The state instance of IBMZ_ImageSettingData will exist as long as its associated IBMZ_Image instanceexists, however many of its properties will be NULL when the Image is disabled.

Class hierarchy:




Association Role To


IBMZ_GroupSettingData (State)Cardinality: 0..1


IBMZ_ImageSettingData (Recorded)Cardinality: 1


IBMZ_ImageSettingData (Current)Cardinality: 0..1

CIM_SettingsDefineState SettingDataCardinality: 1




IBMZ_MemorySettingData (State)Cardinality: 1..*



IBMZ_ProcessorSetting Data (State)Cardinality: 1..*





CIM_ManagedElement


Caption "Image State"



CIM_SettingData


ChangeableType 1"Changeable - Transient" or3 "Not Changeable - Transient"

"Not Changeable" if an Image is notenabled.

ConfigurationName <null>

ElementName {o} <string> Image.ElementName+"(State)"



IBMZ_ImageSettingData (State)








<null>




CreationTime <null>

LogDataRoot <null>

Notes[] <null>

RecoveryFile <null>








AESKeyImportFunctionsPermitted {w} <null> or <boolean> From Image Profile. <null> ifVirtualSystemType="CF" orChangeableType=3

BasicCounterAuthorized <null>

BasicSampleAuthorized <null>

CoprocessorGroupCounterAuthorized <null>

CryptoActivityCounterAuthorized <null>

DEAKeyImportFunctionsPermitted {w} <null> or <boolean> From Image Profile. <null> ifVirtualSystemType="CF" orChangeableType=3

DefinedCapacity {w} <null> or <uint32> Defined Capacity from Change LogicalPartition Controls <null> ifVirtualSystemType="CF" or the Imageis not enabled

DiagnosticSampleAuthorized <null>

ExtendedCounterAuthorized <null>

ProblemStateCounterAuthorized <null>




VirtualSystemType {o} "ESA 390","LPAR","ESA 390 TPF","Linux","zVM","CF",or"zAware"


WorkLoadManaged {w} <null> or <boolean> WLM from Change Logical PartitionControls. <null> ifVirtualSystemType="CF" or the Imageis not enabled



Operation Comment






ModifyInstance Updates the value of one or more properties of a specificIBMZ_ImageSettingData instance. Only properties marked as writable in theprevious tables can be updated. If new values are specified for non-writableproperties, they will be ignored.





IBMZ_ImageSettingData (Current)A single instance of class IBMZ_ImageSettingData represents the last applied virtual systemconfiguration.

The current instance of IBMZ_ImageSettingData will exist as long as its associated IBMZ_Image instanceis active. When the Image is inactive, the recorded IBMZ_ImageSettingData instance will be marked asbeing current.



||||

Class hierarchy:




Association Role To


IBMZ_GroupSettingData (Recordedor State)Cardinality: 0..1

CIM_ElementSettingData SettingDataCardinality: 0..1







IBMZ_MemorySettingData(Recorded)Cardinality: 1..*



IBMZ_ProcessorSetting Data(Current)Cardinality: 1..*


CIM_ManagedElement


Caption "Current Image Configuration"



CIM_SettingData


ChangeableType 3 "Not Changeable - Transient"


ElementName {o} <string> Image.ElementName+"(Current)"







IBMZ_ImageSettingData (Current)





<null>




CreationTime <null>

LogDataRoot <null>

Notes[] <null>

RecoveryFile <null>








AESKeyImportFunctionsPermitted{w}


BasicCounterAuthorized <null>

BasicSampleAuthorized <null>

CoprocessorGroupCounterAuthorized <null>

DEAKeyImportFunctionsPermitted{w}


DefinedCapacity <null> or <uint32> Defined Capacity from ChangeLogical Partition Controls. <null> ifVirtualSystemType="CF"

DiagnosticSampleAuthorized <null>

ExtendedCounterAuthorized <null>

ProblemStateCounterAuthorized <null>

VirtualSystemType {o} "ESA 390","LPAR","ESA 390 TPF","Linux","zVM","CF", or"zAware"


WorkLoadManaged <null> or <boolean> WLM from Change Logical PartitionControls. <null> ifVirtualSystemType="CF"



||||



Operation Comment










IBMZ_ProcessorSettingData (Image Recorded)Recorded instances of IBMZ_ProcessorSettingData are associated to each recorded instance ofIBMZ_ImageSettingData via the CIM_VirtualSystemSettingDataComponent association. They representthe persistent configuration of each subset of the processors for a virtual system that share common typeand sharing attributes.

Class hierarchy:

IBMZ_ProcessorSettingDataCIM_ResourceAllocationSettingData


Associations: Each recorded instance of IBMZ_ProcessorSettingData participates in the associationsdefined in the following table.

Association Role To

CIM_ElementCapabilities ManagedElementCardinality: 1

CIM_AllocationCapabilities(Processor Setting Data)Cardinality: 0..1


IBMZ_ProcessorSettingData (State)Cardinality: 0..1


PartComponentCardinality: 1..*

IBMZ_ImageSettingData (Recorded)Cardinality: 1

Class properties and methods: The properties and methods of the IBMZ_ProcessorSettingData class aredefined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement



|


Caption "Processor Configuration"



CIM_SettingData



ConfigurationName <string> Image name+ " Dedicated " or "Shared "+ ResourceSubType

ElementName {o} <string> CPC.ElementName+":"+ConfigurationName+ "(Recorded)"




Address <null>

AllocationUnits "count(processor)"

AutomaticAllocation <true>

AutomaticDeallocation <true>

Connection[] <null>

ConsumerVisibility 2 "Passed-Through" or 3 "Virtualized" Dedicated or Shared

HostResource[] <null>

Limit VirtualQuantity

MappingBehavior <null>

OtherResourceType <null>

Parent <null>

PoolID <null>

Reservation VirtualQuantity

ResourceSubType <overridden>

ResourceType 3 "Processor"

VirtualQuantity <overridden>

Weight <overridden>



AbsoluteCappingProcessors {w} <null> or 0.01..255.0 Initial capping processor limit fromImage Profile. If <null>, no limit isspecified.

Capped {w} <null> or <boolean> Initial processing weight capped fromImage Profile. <null> ifConsumerVisibility=2

IBMZ_ProcessorSettingData (Recorded)



ReservedVirtualQuantity {w} 0..Max Reserved Processors Number of reserved processors fromImage Profile

ResourceSubType {o} "CP","zAAP","IFL","ICF" or"zIIP"

VirtualQuantity {o,w} 0..Max Processors Number of processors from ImageProfile

Weight {o,w} <null> or 1..999 Initial processing weight from ImageProfile. <null> ifConsumerVisibility=2

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_ProcessorSettingData class.

Intrinsic methods: The IBMZ_ProcessorSettingData class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_ProcessorSettingData instance.

Associators Returns the set of instances that are associated to a specificIBMZ_ProcessorSettingData instance.

EnumerateInstanceNames Returns the complete set of IBMZ_ProcessorSettingData references toinstances.

EnumerateInstances Returns the complete set of IBMZ_ProcessorSettingData instances.

GetInstance Returns a specific IBMZ_ProcessorSettingData instance.

ModifyInstance Updates the value of one or more properties of a specificIBMZ_ProcessorSettingData instance. Only properties marked as writable inthe tables above can be updated. If new values are specified for non-writableproperties, they will be ignored.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_ProcessorSettingData instance.

References Returns the set of the association instances that reference a specificIBMZ_ProcessorSettingData instance.

Extrinsic methods: The IBMZ_ProcessorSettingData class does not support any extrinsic CIM operations.

Indications: There are no indications associated with the IBMZ_ProcessorSettingData class.

IBMZ_ProcessorSettingData (Image State)State instances of IBMZ_ProcessorSettingData are associated to the state instance ofIBMZ_ImageSettingData via the CIM_VirtualSystemSettingDataComponent association. They representthe real-time state of each subset of the processors for a virtual system that share common type andsharing attributes. They correspond to the Change LPAR Controls capability on a Support Element orHMC.

IBMZ_ProcessorSettingData (Recorded)


|

Class hierarchy:



Associations: Each recorded instance of IBMZ_ProcessorSettingData participates in the associationsdefined in the following table.

Association Role To

CIM_ElementCapabilities ManagedElementCardinality: 1..2



IBMZ_ProcessorSettingData (Current)Cardinality: 0..1


IBMZ_ProcessorSettingData(Recorded)Cardinality: 1





CIM_ManagedElement


Caption "Processor State"



CIM_SettingData


ChangeableType 1 "Changeable - Transient"

ConfigurationName <string> Image name+ " Dedicated " or "Shared "+ ResourceSubType

ElementName {o} <string> CPC.ElementName+":"+ConfigurationName+ "(State)"




Address <null>




IBMZ_ProcessorSettingData (State)



Connection[] <null>

ConsumerVisibility 2 "Passed-Through" or 3 "Virtualized" Dedicated Shared





Parent <null>

PoolID <null>





Weight <overridden>



AbsoluteCappingProcessors {w} <null> or 0.01..255.0 Current capping processor limit fromChange Logical Partition Controls. If<null>, no limit is specified.

Capped {w} <null> or <boolean> Current Capping from ChangeLogical Partition Controls. <null> ifConsumerVisibility=2

ReservedVirtualQuantity <null>


VirtualQuantity {o,w} 0..Max Processors Number of Dedicated/Not dedicatedProcessors from Change LogicalPartition Controls

Weight {o,w} <null> or 1..999 Current Weight from Change LogicalPartition Controls. <null> ifConsumerVisibility=2



Operation Comment





Operation Comment




ModifyInstance Updates the value of one or more properties of a specificIBMZ_ProcessorSettingData instance. Only properties marked as writable inthe previous tables can be updated. If new values are specified fornon-writable properties, they will be ignored.





IBMZ_ProcessorSettingData (Image Current)Current instances of IBMZ_ProcessorSettingData are associated to the current instance ofIBMZ_ImageSettingData via the CIM_VirtualSystemSettingDataComponent association. They representthe last requested configuration of each subset of the processors for a virtual system that share commontype and sharing attributes. They correspond to the Change LPAR Controls capability on a SupportElement or HMC.

Class hierarchy:



Associations: Each current instance of IBMZ_ProcessorSettingData participates in the associationsdefined in the following table.

Association Role To

CIM_ElementCapabilities ManagedElementCardinality: 1



IBMZ_ProcessorSettingData (State)Cardinality: 0..1



IBMZ_ImageSettingData (Current)Cardinality: 1


CIM_ManagedElement


Caption "Current Processor Configuration"




|



CIM_SettingData


ChangeableType 3 "Not Changeable - Transient"

ConfigurationName <string> Image name+" Dedicated " or " Shared "+ResourceSubType

ElementName {o} <string> CPC.ElementName+":"+ConfigurationName+ "(Current)"




Address <null>




Connection[] <null>

ConsumerVisibility 2 "Passed-Through" or 3 "Virtualized" Dedicated or Shared





Parent <null>

PoolID <null>





Weight <overridden>



AbsoluteCappingProcessors <null> or 0.01..255.0 Initial capping processor limit fromChange Logical Partition Controls. If<null>, no limit is specified.

Capped <null> or <boolean> Initial Capping from Change LogicalPartition Controls. <NULL> ifConsumerVisibility=2


IBMZ_ProcessorSettingData (Current)




VirtualQuantity {o} 0..Max Processors Number of Dedicated/Not dedicatedProcessors from Change LogicalPartition Controls

Weight {o} <null> or 1..999 Initial Weight from Change LogicalPartition Controls. <NULL> ifConsumerVisibility=2



Operation Comment










CIM_AllocationCapabilities (Processor Setting Data)When Work Load Management is enabled, an instance of class CIM_AllocationCapabilities is associatedwith every instance of IBMZ_ProcessorSettingData that represents a shared processor subset. It connectsthe processor setting data with additional setting data instances that define the minimum and maximumprocessing weights.

Class hierarchy:

CIM_AllocationCapabilitiesCIM_Capabilities

CIM_ManagedElement

Associations: Each instance of CIM_AllocationCapabilities participates in the following associations:

IBMZ_ProcessorSettingData (Current)


Association Role To

CIM_ElementCapabilities CapabilitiesCardinality: 0..1

IBMZ_ProcessorSettingDataCardinality: 1..2

CIM_SettingsDefineCapabilities GroupComponentCardinality: 1

IBMZ_ProcessorSettingData(Minimum and Maximum)Cardinality: 2

Class properties and methods: The properties and methods of the CIM_AllocationCapabilities class aredefined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Processing Weight LimitCapabilities"



CIM_Capabilities


ElementName {o} <string> Image.ElementName+ " Shared "+ResourceSubType


Method Comment


CIM_AllocationCapabilities



RequestTypesSupported 0 "Unknown"

ResourceSubType IBMZ_ProcessorSettingData.ResourceSubType

ResourceType IBMZ_ProcessorSettingData.ResourceType

SharingMode 3 "Shared"

SupportedAddStates[] <null>

SupportedRemoveStates[] <null>

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theCIM_AllocationCapabilities class.

Intrinsic methods: The CIM_AllocationCapabilities class supports the following intrinsic CIM operations:

CIM_AllocationCapabilities (Processor Setting Data)


Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificCIM_AllocationCapabilities instance.

Associators Returns the set of instances that are associated to a specificCIM_AllocationCapabilities instance.

EnumerateInstanceNames Returns the complete set of CIM_AllocationCapabilities references toinstances.

EnumerateInstances Returns the complete set of CIM_AllocationCapabilities instances.

GetInstance Returns a specific CIM_AllocationCapabilities instance.

ReferenceNames Returns the set of association references to instances that reference a specificCIM_AllocationCapabilities instance.

References Returns the set of the association instances that reference a specificCIM_AllocationCapabilities instance.

Extrinsic methods: The CIM_AllocationCapabilities class does not support any extrinsic CIM operations.

Indications: There are no indications associated with the CIM_AllocationCapabilities class.

IBMZ_ProcessorSettingData (Minimum/Maximum Recorded)Two instances of IBMZ_ProcessorSettingData are associated to each recorded CIM_AllocationCapabilitiesinstance. They apply to the Weight property of the associated recorded IBMZ_ProcessorSettingDatainstance to define the minimum and maximum processor weights.

Class hierarchy:



Associations: Each minimum or maximum recorded instance of IBMZ_ProcessorSettingData participatesin the associations defined in the following table.

Association Role To

CIM_SettingsDefineCapabilities PartComponentCardinality: 2

CIM_AllocationCapabilities(Processor Setting Data)Cardinality: 1


CIM_ManagedElement


Caption "Minimum" or "Maximum" +"Processor Configuration"



CIM_SettingData

CIM_AllocationCapabilities (Processor Setting Data)




ConfigurationName <string> Image name+" Shared "+ResourceSubType

ElementName {o} <string> CPC.ElementName+":"+ConfigurationName+ "(MinRecorded)"or "(MaxRecorded)"




Address <null>

AllocationUnits <null>

AutomaticAllocation <null>

AutomaticDeallocation <null>

Connection[] <null>

ConsumerVisibility 3 "Virtualized" Shared


Limit <null>



Parent <null>

PoolID <null>

Reservation <null>




Weight <overridden>



AbsoluteCappingProcessors <null>

Capped <null>



VirtualQuantity {o} <null>

Weight {o,w} 1..999 Maximum or maximum processingweight from Image Profile

IBMZ_ProcessorSettingData (Minimum/Maximum Recorded)




Operation Comment











IBMZ_ProcessorSettingData (Minimum/Maximum State)Two instances of IBMZ_ProcessorSettingData are associated to each state CIM_AllocationCapabilitiesinstance. They apply to the Weight property of the associated IBMZ_ProcessorSettingData instances todefine the real-time and last requested minimum and maximum processor weights. The current minimumand maximum processor weights are always the same as the state weights. As a result, the state andcurrent processor configurations share the minimum/maximum state setting data instances.

Class hierarchy:



Associations: Each minimum or maximum state instance of IBMZ_ProcessorSettingData participates inthe associations defined in the following table.

Association Role To

CIM_SettingsDefineCapabilities PartComponentCardinality: 2

CIM_AllocationCapabilities(Processor Setting Data)Cardinality: 1


CIM_ManagedElement

IBMZ_ProcessorSettingData (Minimum/Maximum Recorded)



Caption "Minimum" or "Maximum" +"Processor State"



CIM_SettingData



ConfigurationName <string> Image name+" Shared "+ResourceSubType

ElementName {o} <string> CPC.ElementName+":"+ConfigurationName+ "(MinState)" or"(MaxState)"




Address <null>

AllocationUnits <null>

AutomaticAllocation <null>

AutomaticDeallocation <null>

Connection[] <null>

ConsumerVisibility 3 "Virtualized" Shared


Limit <null>



Parent <null>

PoolID <null>

Reservation <null>




Weight <overridden>



AbsoluteCappingProcessors <null>

Capped <null>


IBMZ_ProcessorSettingData (Minimum/Maximum State)




VirtualQuantity {o} <null>

Weight {o,w} 1..999 Min or Max Weight from ChangeLogical Partition Controls



Operation Comment











IBMZ_MemorySettingData (Recorded)Up to two instances of IBMZ_MemorySettingData are associated to each recorded and current instance ofIBMZ_ImageSettingData via the CIM_VirtualSystemSettingDataComponent association to represent thememory (storage) setting of each memory type (central and expanded).

Class hierarchy:

IBMZ_MemorySettingDataCIM_ResourceAllocationSettingData


Associations: Each instance of IBMZ_MemorySettingData participates in the associations defined in thefollowing table.

IBMZ_ProcessorSettingData (Minimum/Maximum State)


Association Role To


IBMZ_MemorySettingData (State)Cardinality: 0..1



IBMZ_ImageSettingData(Recorded or Current)Cardinality: 1..3

Class properties and methods: The properties and methods of the IBMZ_MemorySettingData class aredefined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Memory Configuration"



CIM_SettingData



ConfigurationName <string> Image name+" "+ ResourceSubType

ElementName {o} <string> CPC.ElementName+":"+ConfigurationName+ "(Recorded)"




Address <null>

AllocationUnits "byte*10^6"



Connection[] <null>

ConsumerVisibility 2 "Passed-Through"





Parent <null>

PoolID <null>



ResourceType 4 "Memory"


IBMZ_MemorySettingData (Recorded)



Weight <null>



ReservedVirtualQuantity {w} <uint64> Reserved Storage from Image Profile

ResourceSubType {o} "Central" or "Expanded"

VirtualQuantity {o,w} <uint64> Initial Storage from Image Profile

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_MemorySettingData class.

Intrinsic methods: The IBMZ_MemorySettingData class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_MemorySettingData instance.

Associators Returns the set of instances that are associated to a specificIBMZ_MemorySettingData instance.

EnumerateInstanceNames Returns the complete set of IBMZ_MemorySettingData references toinstances.

EnumerateInstances Returns the complete set of IBMZ_MemorySettingData instances.

GetInstance Returns a specific IBMZ_MemorySettingData instance.

ModifyInstance Updates the value of one or more properties of a specificIBMZ_MemorySettingData instance. Only properties marked as writable inthe previous tables can be updated. If new values are specified fornon-writable properties, they will be ignored.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_MemorySettingData instance.

References Returns the set of the association instances that reference a specificIBMZ_MemorySettingData instance.

Extrinsic methods: The IBMZ_MemorySettingData class does not support any extrinsic CIM operations.

Indications: There are no indications associated with the IBMZ_MemorySettingData class.

IBMZ_MemorySettingData (State)Up to two instances of IBMZ_MemorySettingData are associated to each state instance ofIBMZ_ImageSettingData via the CIM_VirtualSystemSettingDataComponent association to represent thememory (storage) setting of each memory type (central and expanded).

Class hierarchy:

IBMZ_MemorySettingDataCIM_ResourceAllocationSettingData


Associations: Each instance of IBMZ_MemorySettingData participates in the associations defined in thefollowing table.

IBMZ_MemorySettingData (Recorded)


Association Role To

CIM_ElementSettingData ManagedElementCardinality: 0..1

IBMZ_MemorySettingData(Recorded)Cardinality: 1




Class properties and methods: The properties and methods of the IBMZ_MemorySettingData class aredefined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Memory State"



CIM_SettingData


ChangeableType 3 "Not Changeable -Transient"

ConfigurationName <string> Image name+" "+ ResourceSubType

ElementName {o} <string> CPC.ElementName+":"+ConfigurationName+ " (State)"




Address <null>

AllocationUnits "byte*10^6"



Connection[] <null>






Parent <null>

PoolID <null>



ResourceType 4 "Memory"


IBMZ_MemorySettingData (State)



Weight <null>



ReservedVirtualQuantity <null> or <uint64> Reserved Storage from Image Profile.<null> if the Image is not enabled

ResourceSubType {o} "Central" or "Expanded"

VirtualQuantity {o} <null> or <uint64> Initial Storage from Image Profile.<null> if the Image is not enabled

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_MemorySettingData class.

Intrinsic methods: The IBMZ_MemorySettingData class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_MemorySettingData instance.

Associators Returns the set of instances that are associated to a specificIBMZ_MemorySettingData instance.

EnumerateInstanceNames Returns the complete set of IBMZ_MemorySettingData references toinstances.

EnumerateInstances Returns the complete set of IBMZ_MemorySettingData instances.

GetInstance Returns a specific IBMZ_MemorySettingData instance.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_MemorySettingData instance.

References Returns the set of the association instances that reference a specificIBMZ_MemorySettingData instance.

Extrinsic methods: The IBMZ_MemorySettingData class does not support any extrinsic CIM operations.

Indications: There are no indications associated with the IBMZ_MemorySettingData class.

IBMZ_FCPortSettingDataInstances of the IBMZ_FCPortSettingData class define data that affects the allocation and configuration ofvirtual (logical) FC ports.

Each instance of IBMZ_FCPortSettingData plays the roles of recorded, current and state. The instance willbe associated to a virtual CIM_FCPort instance via CIM_SettingsDefineState indicating that this instancerepresents the real-time state of the FC port. A self-referencing CIM_ElementSettingData association willbe present indicating that this instance also represents the state and recorded values.

Class hierarchy:

IBMZ_FCPortSettingDataCIM_ResourceAllocationSettingData


IBMZ_MemorySettingData (State)


Associations: Each instance of IBMZ_FCPortSettingData participates in the following associations:

Association Role To


IBMZ_FCPortSettingDataCardinality: 0..1

CIM_ElementSettingData SettingDataCardinality: 0..1

IBMZ_FCPortSettingDataCardinality: 1

CIM_ResourceAllocationFromPool DependentCardinality: *

CIM_ResourcePoolCardinality: 0..1

CIM_SettingsDefineState SettingDataCardinality: 0..1

CIM_FCPortCardinality: 0..1


PartComponentCardinality: *

IBMZ_ImageSettingDataCardinality: 1..3

Class properties and methods: The properties and methods of the IBMZ_FCPortSettingData class aredefined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "FCP Setting Data"



CIM_SettingData




ElementName {o} <string> ImageID+":"+ChannelSubsystemID+":"+ChannelPathID+":"+SubchannelSetID+":"+ DeviceNumber




Address <null>

AllocationUnits "bit/second"



Connection[] <null>

HostResource[] [ embedded CIM_FCPort instance ] The physical FC port that hosts thisvirtual FC port.


Limit <null>

MappingBehavior 5 "Hard Affinity"





Parent <null>

PoolID ResourcePool.InstanceID

Reservation <null>

ResourceSubType <null>

ResourceType 7 "FC HBA"

VirtualQuantity <null>

Weight <null>



ChannelPathID <uint32>

ChannelSubsystemID <uint32>

DeviceNumber <uint32>

ImageID <uint32>

SubchannelSetID <uint32>

WorldWidePortName <uint64>

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_FCPortSettingData class.

Intrinsic methods: The IBMZ_FCPortSettingData class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_FCPortSettingData instance.

Associators Returns the set of instances that are associated to a specificIBMZ_FCPortSettingData instance.

EnumerateInstanceNames Returns the complete set of IBMZ_FCPortSettingData references to instances.

EnumerateInstances Returns the complete set of IBMZ_FCPortSettingData instances.

GetInstance Returns a specific IBMZ_FCPortSettingData instance.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_FCPortSettingData instance.

References Returns the set of the association instances that reference a specificIBMZ_FCPortSettingData instance.

Extrinsic methods: The IBMZ_FCPortSettingData class does not support any extrinsic CIM operations.

Indications: There are no indications associated with the IBMZ_FCPortSettingData class.

IBMZ_GroupSettingData (Recorded)An instance of IBMZ_GroupSettingData represents the group capacity of a set of Images. In systemterminology this is known as an Image Group Profile.



A recorded IBMZ_GroupSettingData instance is associated to a second instance of classIBMZ_GroupSettingData via a CIM_ElementSettingData association. This instance defines the run-timegroup capacity. This state instance is documented in its own section “IBMZ_GroupSettingData (State)” onpage 162. The Images that are a member of the group are associated to an instance ofIBMZ_ImageSettingData via the CIM_ConcreteComponent association.

For CPCs starting with z13s, IBMZ_GroupSettingData instances are associated withIBMZ_ProcessorSettingData instances via the CIM_ConcreteComponent association. This instances definessettings related to specific processor types for virtual servers in the group.

Class hierarchy:

IBMZ_GroupSettingDataCIM_SettingData

CIM_ManagedElement

Associations: Each instance of IBMZ_GroupSettingData participates in the associations defined in thefollowing table.

Association Role To

CIM_ConcreteComponent GroupComponentCardinality: 0..1



IBMZ_SupportElementCardinality: 0..1

CIM_ConcreteComponent GroupComponent Cardinality: 1 IBMZ_ProcessorSettingDataCardinality: 0..n


IBMZ_GroupSettingData (State)Cardinality: 1

Class properties and methods: The properties and methods of the IBMZ_GroupSettingData class aredefined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Image Group Configuration"



CIM_SettingData



ConfigurationName <string> Group Profile name

ElementName {o} <string> CPC.ElementName+":"ConfigurationName+ " (Recorded)



IBMZ_GroupSettingData (Recorded)


|||

||||


Capacity {w} <uint64> Group Capacity from Group Profile

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_GroupSettingData class.

Intrinsic methods: The IBMZ_GroupSettingData class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_GroupSettingDataa instance.

Associators Returns the set of instances that are associated to a specificIBMZ_GroupSettingData instance.

EnumerateInstanceNames Returns the complete set of IBMZ_GroupSettingData references to instances.

EnumerateInstances Returns the complete set of IBMZ_GroupSettingData instances.

GetInstance Returns a specific IBMZ_GroupSettingData instance.

InvokeMethod Invokes an extrinsic method on a specific IBMZ_GroupSettingData instance.

ModifyInstance Updates the value of one or more properties of a specificIBMZ_GroupSettingData instance. Only properties marked as writable in theprevious tables can be updated. If new values are specified for non-writableproperties, they will be ignored.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_GroupSettingData instance.

References Returns the set of the association instances that reference a specificIBMZ_GroupSettingData instance.

Extrinsic methods: The IBMZ_GroupSettingData class does not support any extrinsic CIM operations.

Indications: There are no indications associated with the IBMZ_GroupSettingData class.

IBMZ_GroupSettingData (State)An instance of IBMZ_GroupSettingData represents the run-time group capacity of a set of Images. Insystem terminology this is the Change LPAR Group Controls related data.

The Images that are a member of the group are associated to an instance of IBMZ_ImageSettingData viathe CIM_ConcreteComponent association.

Class hierarchy:

IBMZ_GroupSettingDataCIM_SettingData

CIM_ManagedElement

Associations: Each instance of IBMZ_GroupSettingData participates in the associations defined in thefollowing table.

Association Role To

CIM_ConcreteComponent GroupComponentCardinality: 0..1



IBMZ_GroupSettingData (Recorded)Cardinality: 1

IBMZ_GroupSettingData (Recorded)


Association Role To

CIM_SettingsDefineState SettingDataCardinality: *


Class properties and methods: The properties and methods of the IBMZ_GroupSettingData class aredefined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Image Group State"



CIM_SettingData



ConfigurationName <string> Group Profile name

ElementName {o} <string> CPC.ElementName+":"ConfigurationName+ " (State)




Capacity {w} <null> or <uint64> Group Capacity Value from ChangeLPAR Group Controls. NULL if theImage is not active.

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_GroupSettingData class.

Intrinsic methods: The IBMZ_GroupSettingData class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_GroupSettingDataa instance.

Associators Returns the set of instances that are associated to a specificIBMZ_GroupSettingData instance.

EnumerateInstanceNames Returns the complete set of IBMZ_GroupSettingData references to instances.

EnumerateInstances Returns the complete set of IBMZ_GroupSettingData instances.

GetInstance Returns a specific IBMZ_GroupSettingData instance.

InvokeMethod Invokes an extrinsic method on a specific IBMZ_GroupSettingData instance.

ModifyInstance ModifyInstance Updates the value of one or more properties of a specificIBMZ_GroupSettingData instance. Only properties marked as writable in theprevious tables can be updated. If new values are specified for non-writableproperties, they will be ignored.

IBMZ_GroupSettingData (State)


Operation Comment

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_GroupSettingData instance.

References Returns the set of the association instances that reference a specificIBMZ_GroupSettingData instance.

Extrinsic methods: The IBMZ_GroupSettingData class does not support any extrinsic CIM operations.

Indications: There are no indications associated with the IBMZ_GroupSettingData class.

Temporary capacityThis section describes the classes that are related to the z Systems and LinuxONE Temporary Capacityfeature.

IBMZ_TemporaryCapacityRecordClass IBMZ_TemporaryCapacityRecord is the aggregation point for the collection of instances that definea temporary capacity record. This class defines common record elements. It contains one or moreinstances of IBMZ_TemporaryCapacityProcessorRecord and IBMZ_TemporaryCapacityTarget, related viaCIM_ConcreteComponent associations, to complete the record definition

Class hierarchy:

IBMZ_TemporaryCapacityRecordCIM_SettingData

CIM_ManagedElement

Associations: Each instance of IBMZ_TemporaryCapacityRecord participates in the followingassociations:

Association Role To


IBMZ_TemporaryCapacityProcessorRecordCardinality: 1..*


IBMZ_TemporaryCapacity TargetCardinality: 1..*



CIM_ElementSettingData SettingDataCardinality: *


Class properties and methods: The properties and methods of the IBMZ_TemporaryCapacityRecordclass are defined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Temporary Capacity Record"



CIM_SettingData

IBMZ_GroupSettingData (State)


|



ConfigurationName <string> Capacity record identifier



IBMZ_TemporaryCapacityRecord


ActivationDate <datetime>

ExpirationDate <datetime>

MaxDays <uint32>

MaxTestDays <uint32>

RecordType 0 "CBU",1 "O/O CoD",2 "Planned Event" or3 "Loaner Engines"

RemainingActivations <uint32>

RemainingDays <uint32>

RemainingTestActivations <uint32>

RemainingTestDays <uint32>

Status 0 "Available",1 "Unavailable",2 "Real" or3 "Test"

Method Comment

Activate(TargetModelCapacityID {i,r}ProcessorInfo[] {i,r},Force {i},Test {i},Job {o})

Activates a temporary capacity record<IBMZ_TemporaryCapacityTarget ref><string><boolean><boolean><null>

Deactivate(TargetModelCapacityID {i,r}ProcessorInfo[] {i,r},Job {o})

Deactivates a temporary capacity record<IBMZ_TemporaryCapacityTarget ref><string><null>

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_TemporaryCapacityRecord class.

Intrinsic methods: The IBMZ_TemporaryCapacityRecord class supports the following intrinsic CIMoperations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_TemporaryCapacityRecord instance.



Operation Comment

Associators Returns the set of instances that are associated to a specificIBMZ_TemporaryCapacityRecord instance.

EnumerateInstanceNames Returns the complete set of IBMZ_TemporaryCapacityRecord references toinstances.

EnumerateInstances Returns the complete set of IBMZ_TemporaryCapacityRecord instances.

GetInstance Returns a specific IBMZ_TemporaryCapacityRecord instance.

InvokeMethod Invokes an extrinsic method on a specific IBMZ_TemporaryCapacityRecordinstance.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_TemporaryCapacityRecord instance.

References Returns the set of the association instances that reference a specificIBMZ_TemporaryCapacityRecord instance.

Extrinsic methods: The IBMZ_TemporaryCapacityRecord class supports the following extrinsic CIMoperations:

Activate()This method is used activate a temporary capacity record. The target capacity of the system afterthe activation is defined by a target Model-Capacity Identifier, which defines the number andspeed of general-purpose processors (CPs), and zero or more processor descriptors, which definethe increase (if any) in each of the specialty processor engines. For Customer Backup Unit (CBU)records, there are two additional Boolean parameters that affect the capacity activation. CBUrecords can be activated in Test mode, which is intended to allow a user to test their temporarycapacity configuration, or in Real mode, which is intended for the times when temporary capacityis required for the production environment. CBU records can also be activated with the Forceparameter set. This simulates legacy CBU "all-or-nothing" activations. Setting the Force parameterto true will result in the capacity record being applied to its maximum capacity regardless of theavailability of resources. If the activation exceeds the available resources, processors will beactivated in Pending mode, and will automatically be enabled if and when they become available.The return code values and parameters for the Activate() method are specified in Table 54 andTable 55, respectively.

Table 54. Activate() Method Return Code Values

Value Description


2 Error occurred

Table 55. Activate() Method Parameters


IN, REQ TargetModelCapacityID <IBMZ_TemporaryCapacityTarget ref>

A reference to the targetModel-Capacity Identifier.

IN, REQ ProcessorInfo[] <string> An array of strings containingembedded instances of classIBMZ_TemporaryCapacityProcessor. Each instance defines theincrease in the number of a givenspecialty processor.



Table 55. Activate() Method Parameters (continued)


IN Force <boolean> If <true> a CBU record will beactivated to its maximum capacityregardless of the availableresources. Processor informationspecified in ProcessorInfo will beignored. If <false> or omitted orthe record is not of type CBU, therecord will be activated as specifiedin ProcessorInfo.

IN Test <boolean> If <true> a CBU record will beactivated in test mode. If <false> oromitted or the record is not of typeCBU, the record will be activated innormal mode.


Deactivate()This method is used to deactivate a temporary capacity record. The target capacity of the systemafter the deactivation is defined by a target Model-Capacity Identifier, which defines the numberand speed of general-purpose processors (CPs), and zero or more processor descriptors, whichdefine the decrease (if any) in each of the specialty processor engines. The return code values andparameters for the Deactivate() method are specified in Table 56 and Table 57, respectively.

Table 56. Deactivate() Method Return Code Values

Value Description


2 Error occurred

Table 57. Deactivate() Method Parameters


IN, REQ TargetModelCapacityID <IBMZ_TemporaryCapacityTarget ref>

A reference to the targetModel-Capacity Identifier.

IN, REQ ProcessorInfo[] <string> An array of strings containingembedded instances of classIBMZ_TemporaryCapacityProcessor. Each instance defines thedecrease in the number of a givenspecialty processor.


Indications: There are no indications associated with the IBMZ_TemporaryCapacityRecord class.

IBMZ_TemporaryCapacityProcessorClass IBMZ_TemporaryCapacityProcessor defines temporary capacity information for a specific processortype. Up to five instances of the base class, representing the different specialty processor types, are passedas arguments to the Activate and Deactivate methods of the IBMZ_TemporaryCapacityRecord class. Onlyextensions to this class will exist in a temporary capacity record.



Class hierarchy:

IBMZ_TemporaryCapacityProcessorCIM_SettingData

CIM_ManagedElement

Associations: Instances of the base IBMZ_TemporaryCapacityProcessor do not participate in anyassociations:

Class properties and methods: The properties and methods of the IBMZ_TemporaryCapacityProcessorclass are defined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption <null>

Description <null>


CIM_SettingData


ChangeableType <null>


ElementName {o} <null>

InstanceID <null>

IBMZ_TemporaryCapacityProcessor


ProcessorStep <uint32>

ProcessorType 2 "CP",3 "SAP",4 "zAAP",5 "IFL",6 "ICF" or7 "zIIP"

Method details: There are no intrinsic or extrinsic methods supported by the baseIBMZ_TemporaryCapacityProcessor class.

Indications: There are no indications associated with the IBMZ_TemporaryCapacityProcessor class.

IBMZ_TemporaryCapacityProcessorRecordClass IBMZ_TemporaryCapacityProcessorRecord defines processing capacity within a temporary capacityrecord for a specific processor type. Instances of this class are associated via CIM_ConcreteComponent totheir aggregating instance of IBMZ_TemporaryCapacityRecord.



Class hierarchy:

IBMZ_TemporaryCapacityProcessorRecordIBMZ_TemporaryCapacityProcessor


Associations: Each instance of IBMZ_TemporaryCapacityProcessorRecord participates in the followingassociations:

Association Role To

CIM_ConcreteComponent PartComponentCardinality: 1..*

IBMZ_TemporaryCapacityRecordCardinality: 1

Class properties and methods: The properties and methods of theIBMZ_TemporaryCapacityProcessorRecord class are defined in the following tables, grouped by the classin which they are defined.

CIM_ManagedElement


Caption "Temporary Capacity ProcessorRecord"



CIM_SettingData



ConfigurationName <string> Capacity record identifier+":"+Processor type






ProcessorType 2 "CP",3 "SAP",4 "zAAP",5 "IFL",6 "ICF" or7 "zIIP"

IBMZ_TemporaryCapacityProcessorRecord




MaxProcessors <null> or <uint32>

RemainingMSUTokens <null> or <uint32>

RemainingProcessorTokens <null> or <uint32>

SpeedStep <uint32>

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_TemporaryCapacityProcessorRecord class.

Intrinsic methods: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_TemporaryCapacityProcessorRecord class.

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_TemporaryCapacityProcessorRecord instance.

Associators Returns the set of instances that are associated to a specificIBMZ_TemporaryCapacityProcessorRecord instance.

EnumerateInstanceNames Returns the complete set of IBMZ_TemporaryCapacityProcessorRecordreferences to instances.

EnumerateInstances Returns the complete set of IBMZ_TemporaryCapacityProcessorRecordinstances.

GetInstance Returns a specific IBMZ_TemporaryCapacityProcessorRecord instance.

InvokeMethod Invokes an extrinsic method on a specificIBMZ_TemporaryCapacityProcessorRecord instance.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_TemporaryCapacityProcessorRecord instance.

References Returns the set of the association instances that reference a specificIBMZ_TemporaryCapacityProcessorRecord instance.

Extrinsic methods: The IBMZ_TemporaryCapacityProcessorRecord class does not support any extrinsicCIM operations.

Indications: There are no indications associated with the IBMZ_TemporaryCapacityProcessorRecordclass.

IBMZ_TemporaryCapacityTargetInstances of class IBMZ_TemporaryCapacityTarget define the allowed endpoints of a temporary capacityactivation or deactivation. Instances of this class are associated via CIM_ConcreteComponent to theiraggregating instance of IBMZ_TemporaryCapacityRecord.

Class hierarchy:

IBMZ_TemporaryCapacityTargetCIM_SettingData

CIM_ManagedElement

Associations: Each instance of IBMZ_TemporaryCapacityTarget participates in the followingassociations:



Association Role To

CIM_ConcreteComponent PartComponentCardinality: 1..*

IBMZ_TemporaryCapacity RecordCardinality: 1

Class properties and methods: The properties and methods of the IBMZ_TemporaryCapacityTarget classare defined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Temporary Capacity Target"



CIM_SettingData



ConfigurationName <string> Capacity record identifier+":"+ModelCapacityID



IBMZ_TemporaryCapacityTarget


BillableMSUCost <uint32>

BillableMSUDelta <uint32>

ModelCapacityID <uint32>


SpeedStep <uint32>

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theIBMZ_TemporaryCapacityTarget class.

Intrinsic methods: The IBMZ_TemporaryCapacityTarget class supports the following intrinsic CIMoperations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificIBMZ_TemporaryCapacityTarget instance.

Associators Returns the set of instances that are associated to a specificIBMZ_TemporaryCapacityTarget instance.

EnumerateInstanceNames Returns the complete set of IBMZ_TemporaryCapacityTarget references toinstances.

EnumerateInstances Returns the complete set of IBMZ_TemporaryCapacityTarget instances.



Operation Comment

GetInstance Returns a specific IBMZ_TemporaryCapacityTarget instance.

InvokeMethod Invokes an extrinsic method on a specific IBMZ_TemporaryCapacityTargetinstance.

ReferenceNames Returns the set of association references to instances that reference a specificIBMZ_TemporaryCapacityTarget instance.

References Returns the set of the association instances that reference a specificIBMZ_TemporaryCapacityTarget instance.

Extrinsic methods: The IBMZ_TemporaryCapacityTarget class does not support any extrinsic CIMoperations.

Indications: There are no indications associated with the IBMZ_TemporaryCapacityTarget class.

Logical devicesThis section describes the classes that relate to logical devices.

Fibre channelThis section describes the classes that relate to Fibre Channel logical devices. It covers classes that aredescribed in the Storage Adapter Resource Virtualization profile.

CIM_ResourcePoolAn instance of the CIM_ResourcePool class is associated with each host (physical) FC port to representthe pool of resources that are then allocated to create virtual FC ports.

Class hierarchy:

CIM_ResourcePoolCIM_LogicalElement


Associations: Each instance of CIM_ResourcePool participates in the following associations:

Association Role To

CIM_ConcreteComponent CIM_GroupComponentCardinality: 1

CIM_FCPort (Host)Cardinality: 1

CIM_ElementAllocatedFromPool CIM_AntecedentCardinality: 1



CIM_AllocationCapabilities(FC Port Pool)Cardinality: 1

CIM_HostedResourcePool CIM_PartComponentCardinality: *


CIM_ResourceAllocationFromPool CIM_AntecedentCardinality: 0..1


CIM_ServiceAffectsElement CIM_AffectedElementCardinality: *

CIM_ResourcePoolConfigurationServiceCardinality: 1



Class properties and methods: The properties and methods of the CIM_ResourcePool class are definedin the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "FC Port Resource Pool"


ElementName <string> CPC.ElementName+":"+ PCHID+"FCPort"





HealthState 5 "OK"

InstallDate <null>

Name ElementName




Status {d} "OK"


CIM_LogicalElement


CIM_ResourcePool


AllocationUnits "bit/second"

Capacity <null>



PoolID <string>

Promordial <true>

Reserved <null>



Method details: This section describes in detail the intrinsic and extrinsic methods supported by theCIM_ResourcePool class.

Intrinsic methods: The CIM_ResourcePool class supports the following intrinsic CIM operations:

CIM_ResourcePool


Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificCIM_ResourcePool instance.

Associators Returns the set of instances that are associated to a specificCIM_ResourcePool instance.

EnumerateInstanceNames Returns the complete set of CIM_ResourcePool references to instances.

EnumerateInstances Returns the complete set of CIM_ResourcePool instances.

GetInstance Returns a specific CIM_ResourcePool instance.

InvokeMethod Invokes an extrinsic method on a specific CIM_ResourcePool instance.

ReferenceNames Returns the set of association references to instances that reference a specificCIM_ResourcePool instance.

References Returns the set of the association instances that reference a specificCIM_ResourcePool instance.

Extrinsic methods: The CIM_ResourcePool class does not support any extrinsic CIM operations.

Indications: There are no indications associated with the CIM_ResourcePool class.

CIM_AllocationCapabilities (FC Port Pool)A single instance of class CIM_AllocationCapabilities is associated with every instance of CIM_FCPortResourcePool. It defines the allocation related capabilities of the resource pool.

Class hierarchy:

CIM_AllocationCapabilitiesCIM_Capabilities

CIM_ManagedElement

Associations: This instance of CIM_AllocationCapabilities participates in the following associations:

Association Role To





Class properties and methods: The properties and methods of the CIM_AllocationCapabilities class aredefined in the following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "FC Port Allocation Capabilities"



CIM_Capabilities



CIM_ResourcePool




Method Comment


CIM_AllocationCapabilities



RequestTypesSupported 0 "Unknown"



SharingMode 3 "Shared"

SupportedAddStates[] <null>

SupportedRemoveStates[] <null>

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theCIM_AllocationCapabilities class

Intrinsic methods: The CIM_AllocationCapabilities class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificCIM_AllocationCapabilities instance.

Associators Returns the set of instances that are associated to a specificCIM_AllocationCapabilities instance.

EnumerateInstanceNames Returns the complete set of CIM_AllocationCapabilities references toinstances.

EnumerateInstances Returns the complete set of CIM_AllocationCapabilities instances.

GetInstance Returns a specific CIM_AllocationCapabilities instance.

InvokeMethod Invokes an extrinsic method on a specific CIM_AllocationCapabilitiesinstance.

ReferenceNames Returns the set of association references to instances that reference a specificCIM_AllocationCapabilities instance.

References Returns the set of the association instances that reference a specificCIM_AllocationCapabilities instance.

Extrinsic methods: The CIM_AllocationCapabilities class does not support any extrinsic CIM operations.

Indications: There are no indications associated with the CIM_AllocationCapabilities class.

CIM_FCPort (Host)Host CIM_FCPort instances describe host (physical) Fibre Channel ports. Host FC ports are associatedwith CPCs.

Host FC port instances exist only after the CPC has been booted (IMLed).

CIM_AllocationCapabilities (FC Port Pool)


Class hierarchy:

CIM_FCPortCIM_NetworkPort

CIM_LogicalPortCIM_LogicalDevice



Associations: Each instance of CIM_FCPort participates in the following associations:

Association Role To


IBMZ_ResourcePoolCardinality: 1

CIM_HostedDependency AntecedentCardinality: 1


CIM_SystemDevice PartComponentCardinality: *


Class properties and methods: The properties and methods of the CIM_FCPort class are defined in thefollowing tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "FCP"


ElementName <string> PCHID



CommunicationStatus 1 "Not Available"

DetailedStatus 0 "Not Available"

HealthState 0 "Unknown"

InstallDate <null>

Name PermanentAddress

OperatingStatus 1 "Not Available"

OperationalStatus[] [ 0 "Unknown" ]

PrimaryStatus 0 "Unknown"

Status {d} "Unknown"

StatusDescriptions[] [ "Unknown" ]

CIM_LogicalElement


CIM_FCPort (Host)











Method Comment


CIM_LogicalDevice


AdditionalAvailability[] [ 2 "Unknown" ]

Availability {d} <null>

CreationClassName {k} "CIM_FCPort"

DeviceID {k} <string>

ErrorCleared {d} <null>

ErrorDescription {d} <null>


LastErrorCode {d} <null>

LocationIndicator 4 "Not Supported"

MaxQuieseTime {d} <null>



PowerManagement Supported {d} <null>

PowerOnHours {d} <null>

StatusInfo {d} <null>

SystemCreationClassName {k} CPC.CreationClassName

SystemName {k} CPC.Name

TotalPowerOnHours {d} <null>

Method Comment


Reset Not supported

EnableDevice {d} Not supported

OutlineDevice {d} Not supported

QuieseDevice {d} Not supported

SaveProperties {d} Not supported

CIM_FCPort (Host)


Method Comment

RestoreProperties {d} Not supported

CIM_LogicalPort


MaxSpeed <null>

OtherPortType <null>

PortType <overridden>

RequestedSpeed <null>

Speed <overridden>

UsageRestriction 3 "Back-end only"

CIM_NetworkPort


ActiveMaximumTransmissionUnit <null>

AutoSense <true>

FullDuplex <true>

LinkTechnology 4 "FC"

NetworkAddresses [] <null>

OtherLinkTechnology <null>

OtherNetworkPortType {d} <null>

PermanentAddress <string> Permanent WWPN

PortNumber <null>

Speed {o} <null>

SupportedMaximumTransmissionUnit "8192"

CIM_FCPort


ActiveCOS[] [ 2 "2" and 3 "3" ]

ActiveFC4Types[] [ 8 "SCSI-FCP" ]

PortType {o} 10 "N"

SupportedCOS[] [ 2 "2" and 3 "3" ]

SupportedFC4Types[] [ 8 "SCSI-FCP" ]

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theCIM_FCPort class.

Intrinsic methods: The CIM_FCPort class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificCIM_FCPort instance.

CIM_FCPort (Host)


Operation Comment

Associators Returns the set of instances that are associated to a specific CIM_FCPortinstance.

EnumerateInstanceNames Returns the complete set of CIM_FCPort references to instances.

EnumerateInstances Returns the complete set of CIM_FCPort instances.

GetInstance Returns a specific CIM_FCPort instance.

ReferenceNames Returns the set of association references to instances that reference a specificCIM_FCPort instance.

References Returns the set of the association instances that reference a specificCIM_FCPort instance.

Extrinsic methods: The CIM_FCPort class does not support any extrinsic CIM operations.

Indications: There are no indications associated with the CIM_FCPort class.

CIM_FCPort (Virtual)Virtual CIM_FCPort instances describe virtual (logical) Fibre Channel ports. Virtual FC ports areassociated with virtual computer systems (Images) and are hosted by a single host FC port.

Virtual FC port instances exist only after the CPC has been booted (IMLed) and the Image has beenenabled (activated).

Class hierarchy:

CIM_FCPortCIM_NetworkPort

CIM_LogicalPortCIM_LogicalDevice



Associations: Each instance of CIM_FCPort participates in the following associations:

Association Role To

CIM_ElementAllocatedFromPool DependentCardinality: *

CIM_ResourcePoolCardinality: 1

CIM_HostedDependency DependentCardinality: *

CIM_FCPort (Host)Cardinality: 1


IBMZ_FCPortSettingDataCardinality: 1

CIM_SystemDevice PartComponentCardinality: *


Class properties and methods: The properties and methods of the CIM_FCPort class are defined in thefollowing tables, grouped by the class in which they are defined.

CIM_ManagedElement

CIM_FCPort (Host)


Proprety Value Comment

Caption "Virtual FCP"


ElementName <string> PCHID+":"+MIFID+":"+CSSID+":"+CHPID+":"+SSID+":"+Device Number






InstallDate <null>

Name <string>

OperatingStatus 1 "Not Available"





CIM_LogicalElement











Method Comment


CIM_LogicalDevice




CreationClassName {k} "CIM_FCPort"

CIM_FCPort (Virtual)












PowerManagementSupported {d} <null>



SystemCreationClassName {k} Image.CreationClassName

SystemName {k} Image.Name


Method Comment




Reset Not supported




CIM_LogicalPort


MaxSpeed <null>

OtherPortType <null>

PortType <overridden>

RequestedSpeed <null>

Speed <overridden>

UsageRestriction 3 "Back-end only"

CIM_NetworkPort


ActiveMaximumTransmissionUnit <null>

AutoSense <true>

FullDuplex <true>

LinkTechnology 4 "FC"




NetworkAddress [] <null>

OtherLinkTechnology <null>

OtherNetworkPortType {d} <null>

PermanentAddress <string> Permanent WWPN

PortNumber <null>

Speed {o} <null>

SupportedMaximumTransmissionUnit "8192"

CIM_FCPort


ActiveCOS[] [ 2 "2" and 3 "3" ]

ActiveFC4Types[] Host FC port. ActiveFC4Types[]

PortType {o} 10 "N"

SupportedCOS[] [ 2 "2" and 3 "3" ]

SupportedFC4Types[] Host FC port. SupportedFC4Types[]

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theCIM_FCPort class.

Intrinsic methods: The CIM_FCPort class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificCIM_FCPort instance.

Associators Returns the set of instances that are associated to a specific CIM_FCPortinstance.

EnumerateInstanceNames Returns the complete set of CIM_FCPort references to instances.

EnumerateInstances Returns the complete set of CIM_FCPort instances.

GetInstance Returns a specific CIM_FCPort instance.

ReferenceNames Returns the set of association references to instances that reference a specificCIM_FCPort instance.

References Returns the set of the association instances that reference a specificCIM_FCPort instance.

Extrinsic methods: The CIM_FCPort class does not support any extrinsic CIM operations.

Indications: There are no indications associated with the CIM_FCPort class.

ProcessorsThis section describes the classes that relate to processors.

CIM_Processor (Host)Host CIM_Processor instances describe processor units (PU's). PU’s are physical processors associatedwith CPC’s (host computer systems).



Class hierarchy:

CIM_ProcessorCIM_LogicalDevice



Associations: Each instance of CIM_Processor participates in the following associations:

Association Role To



CIM_SystemDevice PartComponentCardinality: 1..*


Class properties and methods: The properties and methods of the CIM_Processor class are defined inthe following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Host Processor"


ElementName <string> Processor Type+" "+ ProcessorNumber





HealthState 0 "Unknown" or30 "Non-recoverable error"

"Non-recoverable error" if processoris defective.

InstallDate <null>

Name DeviceID

OperatingStatus 0 "Unknown" or1 "Stopped"

"Stopped" if processor is a spare or isdefective.

OperationalStatus[] [ 0 "Unknown",6 "Error" or10 "Stopped" ]

"Error" if processor is defective."Stopped" if processor is a spare.

PrimaryStatus 0 "Unknown" or4 "Error"

"Error" if processor is defective.

Status {d} "Unknown","Error" or"Stopped"

"Error" if processor is defective."Stopped" if processor is a spare.

StatusDescriptions[] [ "Unknown","Defective" or"Spare" ]

CIM_Processor (Host)


CIM_LogicalElement





EnabledDefault 2 "Enabled" or 3 "Disabled"

EnabledState 2 "Enabled" or 3 "Disabled"





Method Comment


CIM_LogicalDevice




CreationClassName {k} "CIM_Processor"













SystemCreationClassName {k} CPC.CreationClassName

SystemName {k} CPC.Name


Method Comment






Method Comment

Reset Not supported




CIM_Processor


AddressWidth <null>

Characteristics[] <null>

CPUStatus <null>

CurrentClockSpeed <null>

Datawidth <null>

ExternalBusClockSpeed <null>

Family 200 "S/390® and zSeries Family"

LoadPercentage <null>

MaxClockSpeed <null>

NumberofEnabledCores 1

OtherFamilyDescription <null>

Role "Spare","Defective","Central Processor","System Assist Processor

(SAP)","Application Assist

Processor (zAAP)","Integrated Facility for

Linux (IFL) Processor","Integrated Coupling

Facility (ICF) Processor" or"Integrated Information

Processor (zIIP)"

Stepping <null>

UniqueID <null>

UpgradeMethod 6 "None"

Method details: This section describes in detail the intrinsic and extrinsic methods supported by theCIM_Processor class.

Intrinsic methods: The CIM_Processor class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificCIM_Processor instance.

Associators Returns the set of instances that are associated to a specific CIM_Processorinstance.

EnumerateInstanceNames Returns the complete set of CIM_Processor references to instances.



Operation Comment

EnumerateInstances Returns the complete set of CIM_Processor instances.

GetInstance Returns a specific CIM_Processor instance.

ReferenceNames Returns the set of association references to instances that reference a specificCIM_Processor instance.

References Returns the set of the association instances that reference a specificCIM_Processor instance.

Extrinsic methods: The CIM_Processor class does not support any extrinsic CIM operations.

Indications: There are no indications associated with the CIM_Processor class.

CIM_Processor (Virtual)Virtual CIM_Processor instances describe central processors (CP's). CPs are virtual processors associatedwith Images (virtual computer systems).

Central processor instances exist only after the CPC has been IMLed and the Image has been activated.

Class hierarchy:

CIM_ProcessorCIM_LogicalDevice



Associations: Each instance of CIM_Processor participates in the following associations:

Association Role To



CIM_SystemDevice CIM_PartComponentCardinality: 1..*


Class properties and methods: The properties and methods of the CIM_Processor class are defined inthe following tables, grouped by the class in which they are defined.

CIM_ManagedElement


Caption "Virtual processor"


ElementName <string> Processor Type+" "+ ProcessorNumber









InstallDate <null>

Name DeviceID

OperatingStatus 0 "Unknown"





CIM_LogicalElement











Method Comment


CIM_LogicalDevice




CreationClassName {k} "CIM_Processor"











CIM_Processor (Virtual)





SystemCreationClassName {k} Image.CreationClassName

SystemName {k} Image.Name


Method Comment




Reset Not supported




CIM_Processor


AddressWidth <null>

Characteristics[] <null>

CPUStatus <null>

CurrentClockSpeed <null>

Datawidth <null>

ExternalBusClockSpeed <null>

Family 200 "S/390 and zSeries Family"

LoadPercentage <null>

MaxClockSpeed <null>

NumberofEnabledCores 1

OtherFamilyDescription <null>

Role "Central Processor","System Assist Processor

(SAP)","Application Assist

Processor (zAAP)","Integrated Facility for

Linux (IFL) Processor","Integrated Coupling

Facility (ICF) Processor" or"Integrated Information

Processor (zIIP)"

Stepping <null>

UniqueID <null>

UpgradeMethod 6 "None"



Method details: This section describes in detail the intrinsic and extrinsic methods supported by theCIM_Processor class.

Intrinsic methods: The CIM_Processor class supports the following intrinsic CIM operations:

Operation Comment

AssociatorNames Returns the set of references to instances that are associated to a specificCIM_Processor instance.

Associators Returns the set of instances that are associated to a specific CIM_Processorinstance.

EnumerateInstanceNames Returns the complete set of CIM_Processor references to instances.

EnumerateInstances Returns the complete set of CIM_Processor instances.

GetInstance Returns a specific CIM_Processor instance.

ReferenceNames Returns the set of association references to instances that reference a specificCIM_Processor instance.

References Returns the set of the association instances that reference a specificCIM_Processor instance.

Extrinsic methods: The CIM_Processor class does not support any extrinsic CIM operations.

Indications: There are no indications associated with the CIM_Processor class.

IndicationsThis section describes the classes that are related to CIM Indication.

Lifecycle indicationsThe following sections describe the lifecycle indication classes that are broadcast.

IBMZ_InstCreationWhen instances of certain CIM classes are created, an instance of IBMZ_InstCreation is broadcast to alllisteners that are registered for an applicable indication filter. Creation instances contain a representationof the new instance.

Class hierarchy:

IBMZ_InstCreationCIM_InstCreation

CIM_InstIndicationCIM_Indication

Class Properties: The properties and methods of the IBMZ_InstCreation class are defined in thefollowing tables, grouped by the class in which they are defined.

CIM_Indication


CorrelatedIndications[] <null>

IndicationIdentifier <string>

IndicationTime <datetime> The date and time the indicationinstance was created.



CIM_InstIndication


SourceInstance <string> A string representation (embeddedinstance) of the new instance.

CIM_InstCreation


IBMZ_InstCreation


IBMZ_InstDeletionWhen instances of certain CIM classes are deleted, an instance of IBMZ_InstDeletion is broadcast to alllisteners that are registered for an applicable indication filter. Deletion instances contain a representationof the deleted instance.

Class hierarchy:

IBMZ_InstDeletionCIM_InstDeletion


Class Properties: The properties and methods of the IBMZ_InstDeletion class are defined in thefollowing tables, grouped by the class in which they are defined.

CIM_Indication





CIM_InstIndication


SourceInstance <string> A string representation (embeddedinstance) of the deleted instance.

CIM_InstDeletion


IBMZ_InstDeletion


IBMZ_InstCreation


Modification indicationsThe following sections describe the modification indication classes that are broadcast.

IBMZ_InstModificationWhen instances of certain CIM classes are modified, an instance of IBMZ_InstModification is broadcast toall listeners that are registered for an applicable indication filter. Modification instances containrepresentations of the state of an instance before and after it was modified. The embedded instancescontain only the key properties and the property or properties that were updated.

Class hierarchy:

IBMZ_InstModificationCIM_InstModification


Class Properties: The properties and methods of the IBMZ_InstModification class are defined in thefollowing tables, grouped by the class in which they are defined.

CIM_Indication





CIM_InstIndication


SourceInstance <string> A string representation (embeddedinstance) of the modified instancecontaining the new property value(s).

CIM_InstModification


PreviousInstance <string> A string representation (embeddedinstance) of the modified instancecontaining the previous propertyvalue(s).

IBMZ_InstModification


Alert indicationsThe following sections describe the alert indication classes that are broadcast.

IBMZ_OSMessageAll messages that appear on an operating system console are made available to a CIM client as instancesof alert indication class IBMZ_OSMessage. Some messages just supply information, while others are held,

IBMZ_InstDeletion


meaning that they are expecting a user response. A CIM client can respond to a held message using theIBMZ_OperatingSystem.SendOSCommand() method. Held message, particularly those that result fromthe issuance of an OS command, might have addition descriptive prompt text associated with them.Some messages are marked as being priority messages, indicating that the operating system believes thatthey have special importance. Priority messages may be held or unheld.

Class hierarchy:

IBMZ_OSMessageCIM_AlertIndication

CIM_ProcessIndicationCIM_Indication

Class Properties: The properties and methods of the IBMZ_OSMessage class are defined in thefollowing tables, grouped by the class in which they are defined.

CIM_Indication




IndicationTime <datetime> The OS message timestamp.

CIM_ProcessIndication


CIM_AlertIndication


AlertingElementFormat 2 "CIMObjectPath"

AlertingManagedElement <string> OperatingSystem object path

AlertType 1 "Other"


EventID <string>

EventTime <null>

OtherAlertingElementFormat <null>

OtherAlertType "Console Message"

OtherSeverity <null>

PerceivedSeverity 5 "Major" or 2 "Information" Priority messages Normal messages

ProbableCause 0 "Unknown"

ProbableCauseDescription <null>

ProviderName <null>

RecommendedActions[] <null>

SystemCreationClassName "IBMZ_Image"

SystemName <string> Image.Name

Trending <null>

IBMZ_OSMessage


IBMZ_OSMessage


IsHeld <boolean> <true> if the console message isexpecting a response.

Message <string> The console message text.

PromptText <string> or <null> The prompt text, if it exists, or <null>otherwise.

IBMZ_OSMessage


IBMZ_OSMessage


Chapter 4. z specific classes in Managed Object Format

Following are the definitions of each of the IBMZ classes in Managed Object Format.

Classes

IBMZ_AuditLog

Note: For IBMZ_AuditLog class information, see “IBMZ_AuditLog” on page 85.

IBMZ_ComputerSystem

[Experimental,Description (

"The IBMZ_AuditLog class describes a repository of ""audit related messages."),

Version ("1.0.0")]class IBMZ_AuditLog : CIM_RecordLog {};

[Experimental,Abstract,Description (

"The IBMZ_ComputerSystem class is an abstract base class that ""describes element common to both host (CPC) and virtual ""(Image) computer systems."),

Version ("1.0.0")]class IBMZ_ComputerSystem : CIM_ComputerSystem {

[Write,Description (

"A subset of valid OperationalStatus values that represent ""the status values that are considered acceptable. The ""acceptable status values are used in the calculation of ""the boolean HasUnacceptableStatus property."),

ArrayType ("Indexed")]uint16 AcceptableStatus[];

[Description ("Indicates if at least one message is present for the ""computer system. For CPC’s, this indicator tracks ""hardware messages. For Images, it tracks Operating System ""messages. If TRUE, the computer system has at least one ""message. If FALSE, no messages are present.")]

boolean HasMessages;

[Description ("Indicates if the computer system has an unacceptable ""status. The status is considered unacceptable if at least ""one of the current values in OperationalStatus does not ""appear in list of values present in AcceptableStatus. If ""TRUE, the status is unacceptable. If FALSE, the status is ""acceptable."),

ModelCorrespondence {"IBMZ_ComputerSystem.AcceptableStatus"}]boolean HasUnacceptableStatus;

};



Note: For IBMZ_CoordinatedTimingNetwork class information, see “IBMZ_CoordinatedTimingNetwork”on page 53.


"Instances of the IBMZ_CoordinatedTimingNetwork class describe ""Coordinated Timing Network (CTN) domains."),

Version ( "1.1.0" )]class IBMZ_CoordinatedTimingNetwork : CIM_AdminDomain {

[Description ("Creates or updates the time server configuration for a ""Coordinated Timing Network. This request will set the ""designations of selected CPCs as \"Preferred\", \"Backup\"""or \"Arbiter\" and select which CPC is the current time ""server."),

Static,ValueMap { "0", "2", "4096" },Values { "Completed with No Error", "Unknown/Unspecified Error",

"Method Parameters Checked - Job Started" }]uint32 ConfigureTimeServers(

[Required,IN,Description (

"The CPC that is designated as the preferred time ""server. If a backup CPC has not been defined, the ""preferred CPC will be the current time server. If a ""backup is defined, then one or the other will be ""the current time server as designated by the ""CurrentTimeServer parameter.")]

IBMZ_CPC REF PreferredTimeServer,

[IN,Description (

"The CPC that is designated as the backup time ""server. If NULL, there will be no backup time ""server.")]

IBMZ_CPC REF BackupTimeServer,

[IN,Description (

"The CPC that is designated as the arbiter. The ""arbiter is a CPC with connectivity to both the ""current and backup servers that is used by the ""backup server when it loses connectivity to the ""current server as a means to determine if the ""loss of connectivity is due to the failure of ""the current server, in which case a failover is ""initiated, or a networking problem, in which ""case the backup does not take over as the ""current time server. If NULL, there will be no ""arbiter. If not NULL, a BackupServer must be ""specified.")]

IBMZ_CPC REF Arbiter,


[IN,Description (

"Designates whether the \"Preferred\" or the ""\"Backup\" server will be the current time ""server. If NULL, or if BackupServer is NULL, ""the preferred server will be made current."),

ValueMap { "2", "3" },Values { "Preferred", "Backup" }]

uint16 CurrentTimeServer,

[IN,Description (

"An indicator used to request unconditional ""processing of the ConfigureTimeServers method ""even if the requested configuration cannot be ""fully validated. If False or NULL, the request ""will fail if it cannot be validated.")]

boolean Force,

[IN ( false ), OUT,Description (

"Reference to the job (will always be null).")]CIM_ConcreteJob REF Job);

[Description ("Adds a CPC to a Coordinated Timing Network."),

ValueMap { "0", "2", "4096" },Values { "Completed with No Error", "Unknown/Unspecified Error",

"Method Parameters Checked - Job Started" }]uint32 AddMember(


"The CPC that is to be added to this Coordinated ""Timing Network.")]

IBMZ_CPC REF Member,



[Description ("Removes a CPC from a Coordinated Timing Network."),


"Method Parameters Checked - Job Started" }]uint32 RemoveMember(


"The CPC that is to be removed from this Coordinated ""Timing Network.")]

IBMZ_CPC REF Member,



};

Chapter 4. z specific classes in Managed Object Format 197

IBMZ_CPC

Note: For IBMZ_CPC class information, see “IBMZ_CPC” on page 43.


"The IBMZ_CPC class defines a base computer system or Central ""Processor Complex (CPC) that is known to a Hardware ""Management Console. When running in virtualized (LPAR) mode, ""the CPC is the host computer system"),

Version ("1.1.0")]class IBMZ_CPC : IBMZ_ComputerSystem {

[Description ("Indicates the CPC subsystems that are currently operating ""in degraded mode. If the CPC is not degraded, the value ""will be empty."),

ValueMap {"1", "2", "3", "4", "5","6", "7", "8"},

Values {"Memory", "MBA", "Node", "Ring", "CBU","MRU", "Ambient", "MRU IML"},

ArrayType ("Indexed")]uint16 DegradedSubsystem[];

[Description ("The node descriptor identifier calculated by using a ""location within the machine.")]

string ID;

[Description ("The Model-Capacity Identifier based on the permanent ""plus temporary processors.")]

string ModelCapacityID;

[Description ("The Model-Capacity Identifier based only on the ""permanent processors.")]

string ModelPermanentCapacityID;

[Description ("The Model-Capacity Identifier based on the permanent ""plus billable temporary processors.")]

string ModelTemporaryCapacityID;

[Description ("The MSU (Millions of Service Units) value for the CPC ""associated with the Model-Capacity ID based on the ""permanent and temporary processors."),

MaxValue (0x7fffffff)]uint32 MSU;

[Description ("The MSU (Millions of Service Units) value for the CPC ""associated with the Model-Capacity ID based only on ""the permanent processors."),

MaxValue (0x7fffffff)]uint32 PermanentMSU;


[Description ("The MSU (Millions of Service Units) value for the CPC ""associated with the Model-Capacity ID based on the ""permanent and billable temporary processors."),

MaxValue (0x7fffffff)]uint32 TemporaryMSU;

[Description ("The number of processors that are currently pending after ""an eBusiness on Demand record has been activated.")]

uint32 PendingProcessors;

[Write,ValueMap {

"2", "3", "6", "10", "11","13", "18", "..","0x8000", "0x8001", "0x8002"},

Values {"OK", "Degraded", "Error", "Stopped", "In Service","Lost Communication", "Power Mode", "DMTF Reserved","Status Check", "Service Required", "Power Save"},

Override ("AcceptableStatus")]uint16 AcceptableStatus[];

[Description ("Indicates the current status(es) of the CPC. The standard ""CPC status values are mapped to CIM status values. ""Because some of the CPC statuses map to the same base CIM ""status, four vendor specific status values are defined. ""In all cases, the first element of the OperationalStatus ""array will be set to one of the OperationalStatus values ""defined in the CIM_ManagedSystemElement class. In the ""cases where multiple CPC statuses map to a single CIM ""status, the second array element, possibly containing one ""of the vendor specific values, can be used to identify ""the specific CPC status value.\n\n""The following mapping is performed:\n""Operating = 2 \"OK\"\n""NotOperating = 10 \"Stopped\"\n""NotCommunicating = 13 \"Lost Communication\"\n""NoPower = 10 \"Stopped\" + 18 \"Power Mode\"\n""Exceptions = 6 \"Error\"\n""Service = 11 \"In Service\"\n""PowerSave = 3 \"Degraded\" + 0x8002 \"Power Save\"\n""StatusCheck = 13 \"Lost Communication\" + 0x8000 ""\"Status Check\"\n""ServiceRequired = 6 \"Error\" + 0x8001 ""\"Service Required\"\n""Degraded = 3 \"Degraded\"\n"),

ModelCorrespondence {"IBMZ_CPC.AcceptableStatus"},ValueMap {

"2", "3", "6", "10", "11","13", "18", "..","0x8000", "0x8001", "0x8002"},

Values {"OK", "Degraded", "Error", "Stopped", "In Service","Lost Communication", "Power Mode", "DMTF Reserved","Status Check", "Service Required", "Power Save"},

ArrayType ("Indexed"),Override ("OperationalStatus")]

uint16 OperationalStatus[];};



Note: For IBMZ_CPCBootSettingData class information, see “IBMZ_CPCBootSettingData” on page 125.


"The IBMZ_CPCBootSettingData class defines settings which ""are used when booting (IMLing) a host computer system ""(CPC). Each boot settings instance is connected via a ""CIM_ConcreteComponent association to an instance of ""CIM_BootConfigSetting, which serves as the root of the ""complete boot configuration.\n\n"

"Using standard terminology, CPC boot configurations ""represent Reset Activation Profiles, which consist primarily ""of hypervisor configuration parameters."),

Version ("1.0.0")]class IBMZ_CPCBootSettingData : CIM_BootSettingData {


"Determines if the Image loses its share of running time ""when it enters a wait state. A value of TRUE indicates ""that an Image should lose its share of running time when ""it enters a wait state. A value of FALSE indicates that a ""CPC Image keeps its share of running time when it enters ""a wait state. This value will be NULL if ""UserSpecifiedRunningTime is set to FALSE.")]

boolean EndTimesliceOnWait;


"The IML mode for the CPC. Note: Not all modes are allowed ""for all models."),

ValueMap {"0", "1", "2"},Values {"ESA 390", "ESA 390 TPF", "LPAR"}]

uint16 IMLMode;


"The Input/Output Configuration Data Set (IOCDS) ""identifier."),

ValueMap {"0xA0", "0xA1", "0xA2", "0xA3", "0xD0"}]uint8 IOCDS;



Note: For IBMZ_CPC class information, see “IBMZ_FCPortSettingData” on page 158.


"Defines the amount of continuous time that logical ""processors are allowed to perform jobs on a shared ""processor. The value is in milliseconds and must be an ""integer between 1 and 100. This value will be NULL if ""UserSpecifiedRunningTime is set to FALSE, and a system "

"defined value will be used instead."),Units ("MilliSeconds"),MinValue (1),MaxValue (100)]

uint8 RunningTime;


"Determines if the processor running time is dynamically ""determined by the system or set to a constant user ""defined value. If the value is set to TRUE, the processor ""running time is set to the user defined value specified ""in RunningTime. If the value is set to FALSE, the ""processor running is dynamically determined by the ""system."),

ModelCorrespondence {"IBMZ_CPCBootSettingData.EndTimesliceOnWait","IBMZ_CPCBootSettingData.RunningTime"}]

boolean UserSpecifiedRunningTime;};



Note: For IBMZ_GroupSettingData class information, see “IBMZ_GroupSettingData (Recorded)” on page160 and “IBMZ_GroupSettingData (State)” on page 162.


"The IBMZ_FCPortSettingData class defines settings for ""virtual Fibre Channel ports. Instances of this class, are ""connected to each IBMZ_ImageSettingData instance via ""CIM_ConcreteComponent associations."),

Version ("1.0.0")]class IBMZ_FCPortSettingData : CIM_ResourceAllocationSettingData {

[Description ("The Image Identifier for the virtual FC port.")]

uint32 ImageID;

[Description ("The Channel Path Identifier (CHPID) for the ""virtual FC port.")]

uint32 ChannelPathID;

[Description ("The Channel Subsystem Identifier (CSSID) for the ""virtual FC port.")]

uint32 ChannelSubsystemID;

[Description ("The device number for the virtual FC port.")]

uint32 DeviceNumber;

[Description ("The Subchannel Set Identifier (SSID) for the ""virtual FC port.")]

uint32 SubchannelSetID;

[Description ("The WorldWide Port Name for the virtual FC port.")]

uint64 WorldWidePortName;};


"The IBMZ_GroupSettingData class defines group capacity ""settings for Images that are members of the group. The ""settings are similar to the processing weights for ""processors, but are applied at a higher level to affect ""scheduling for all the group members relative to members of ""other active groups."),

Version ("1.1.0")]class IBMZ_GroupSettingData : CIM_SettingData {


"Defines a processing weight for Images that are members ""of the group. Its value is relative to the capacity ""defined for other active Groups.")]

uint64 Capacity;};



Note: For IBMZ_HardwareManagementConsole class information, see“IBMZ_HardwareManagementConsole” on page 82.


Note: For IBMZ_HardwareMessageLog class information, see “IBMZ_HardwareMessageLog” on page 88.

IBMZ_Image

Note: For IBMZ_Image class information, see “IBMZ_Image” on page 60.


"The IBMZ_HardwareManagementConsole class defines a Hardware ""Management Console that manages CPC’s and their Images."),

Version ("1.0.0")]class IBMZ_HardwareManagementConsole : CIM_ComputerSystem {};


"The IBMZ_HardwareMessageLog class describes a repository of ""hardware related messages."),

Version ("1.1.0")]class IBMZ_HardwareMessageLog : CIM_RecordLog {};


"The IBMZ_Image class defines a virtualized computer system ""(Image). Images are hosted by a host computer system (CPC), ""as indicated by CIM_HostedDependency associations between ""them. Image instances will exist only if the host computer ""system has been booted (IMLed)."),//"instances will exists as long as there "//"is a definition for the Image in the IOCDS. They are "//"enablable only if the CPC is IMLed in LPAR mode "//"(CpcBootSettingData.ImlMode is set to 2 \"LPAR\") using the "//"IOCDS that references the Image. It is possible that two or "//"more IOCDS’s can reference an image by the same name, "//"however they will all result in unique CIM Image instances."),

Version ("1.0.0")]class IBMZ_Image : IBMZ_ComputerSystem {

[Write,ValueMap {

"2", "6", "10", "..","0x8000", "0x8002", "0x8003"},

Values {"OK", "Error", "Stopped", "DMTF Reserved","Status Check", "Power Save", "Not Activated"},

Override ("AcceptableStatus")]uint16 AcceptableStatus[];



Note: For IBMZ_ImageBootSettingData class information, see “IBMZ_ImageBootSettingData” on page129.

[Description ("Indicates the current status(es) of the Image. The ""standard Image status values are mapped to CIM status ""values. Because two of the Image statuses map to the same ""base CIM status, a vendor specific status value is ""defined. In all cases, the first element of the ""OperationalStatus array will be set to one of the ""OperationalStatus values defined in the ""CIM_ManagedSystemElement class. In the cases where ""multiple Image statuses map to a single CIM status, the ""second array element, possibly containing one of the ""vendor specific values can be used to identify the ""specific Image status value.\n\n""The following mapping is performed:\n""Operating = 2 \"OK\"\n""NotOperating = 10 \"Stopped\"\n""NotActivated = 10 \"Stopped\" + 0x8000 ""\"Not Activated\"\n""NotCommunicating = 13 \"Lost Communication\"\n""NoPower = 10 \"Stopped\" + 18 \"Power Mode\"\n""Exceptions = 6 \"Error\"\n""Service = 11 \"In Service\"\n"),

ModelCorrespondence {"IBMZ_Image.AcceptableStatus"},ValueMap {

"2", "3", "6", "10", "11","13", "18", "..","0x8000", "0x8002", "0x8003"},

Values {"OK", "Degraded", "Error", "Stopped", "In Service","Lost Communication", "Power Mode", "DMTF Reserved","Status Check", "Power Save", "Not Activated"},

ArrayType ("Indexed"),Override ("OperationalStatus")]

uint16 OperationalStatus[];

// [Description ("The partition identifier for the Image."),// MaxValue (255)]//uint16 PartitionID;

};



Note: For IBMZ_ImageBootSourceSetting class information, see “IBMZ_ImageBootSourceSetting” on page130.


"The IBMZ_ImageBootSettingData class defines settings which ""are used when booting (IPLing) a virtual computer system ""(Image). Each boot settings instance is connected via a ""CIM_ConcreteComponent association to an instance of ""CIM_BootConfigSetting, which serves as the root of the ""complete boot configuration.\n\n"

"Using system terminology, this is a portion of the Load ""Activation Profile. Other settings normally grouped with a ""Load Activation Profile are represented in the CIM model by ""the IBMZ_ImageBootSourceSetting class"),

Version ("1.0.0")]class IBMZ_ImageBootSettingData : CIM_BootSettingData {

[Write,Description ("The load type."),ValueMap {"0", "1", "2"},Values {"Standard", "SCSI", "SCSI Dump"}]

uint16 LoadType;


"The load parameter. A NULL value is used to indicate that ""the next IPL parameter set by HCD will be used."),

MaxLen (8)]string LoadParameter;


"The extended load parameter used for SCSI Load and SCSI Dump ""operations. A NULL value is used to indicate that the next ""IPL parameter set by HCD will be used. If the LoadType ""parameter value for the associated IBMZ_ImageBootSourceSetting ""instance is 0 \"Standard\", this property is not used and its ""value will be always be NULL."),

MaxLen (256)]string OSLoadParameters;

};



Note: For IBMZ_ImageOperationsService class information, see “IBMZ_ImageOperationsService” on page101.


"The IBMZ_ImageBootSourceSetting class defines source ""settings which are used when booting (IPLing) a virtual ""computer system (Image). Each boot source settings ""instance is connected via a CIM_ConcreteComponent ""association to an instance of CIM_OrderedComponent, which ""serves as the root of the complete boot configuration.\n\n"

"Using system terminology, this is a portion of the Load ""Activation Profile. Other settings normally grouped with a ""Load Activation Profile are represented in the CIM model by ""the IBMZ_ImageBootSettingData class"),

Version ("1.0.0")]class IBMZ_ImageBootSourceSetting : CIM_BootSourceSetting {


"The load address. BootString must represent an unsigned ""16-bit integer. A NULL value is used to indicate that the ""next IPL address set by HCD will be used."),

MaxLen (4),Override ("BootString")]

string BootString;

[Write,Description ("The Boot Program Selector value. If the LoadType "

"parameter value for the associated IBMZ_ImageBootSettingData ""is 0 \"Standard\", this property is not used and its value "

"will be NULL."),MaxValue (30)]

uint8 BootProgramSelector;

[Write,Description ("The Boot Record Address value. If the LoadType "


"will be NULL.")]uint64 BootRecordAddress;

[Write,Description ("The logical unit number. If the LoadType "


"will be NULL.")]uint64 LogicalUnitNumber;

[Write,Description ("The WorldWide Port Name. If the LoadType "


"will be NULL.")]uint64 WorldWidePortName;

};



"The IBMZ_ImageOperationsService class provides the controls ""to operate an Image. This includes resetting the Image and ""loading an Operating System into that Image."),

Version ("1.1.0")]class IBMZ_ImageOperationsService : CIM_Service {

[Description ("Boots the Image using the supplied settings. Except for ""the target, all of the parameters in this method are ""optional. The default behavior when a parameter is not ""specified is described with each parameter."),


"Method Parameters Checked - Job Started" }]uint32 Load(

[Required, IN,Description (

"The Image that is affected by this load request.")]IBMZ_Image REF TargetSystem,

[IN,Description (

"The address to be used when performing the boot. The ""default will be to use the Load Address last used when ""the Image was booted.")]uint16 LoadAddress,

[IN,Description (

"The parameter string to be used when performing the ""boot. The default will be to use the Load Parameter ""last used when the Image was booted."),

MaxLen (8)]string LoadParameter,


[IN,Description (

"Indicates whether or not memory should be cleared ""before performing the boot. The default is to clear ""memory before performing the boot.")]

boolean Clear,

[IN,Description (

"The amount of time to wait for the boot ""to complete. The default timeout is 60 seconds."),

MinValue (60),MaxValue (600),Units ("Seconds")]

datetime Timeout,

[IN,Description (

"Indicates whether or not status should be stored ""before performing the boot. The default is to not ""store status before performing the boot.")]

boolean StoreStatus,

[IN,Description (

"An indicator used to request conditional processing of ""the Load method depending on the state of the Image. ""The default is to unconditionally perform the request ""(that is, Force=TRUE) regardless of the Image state.")]

boolean Force,



[Description ("Performs a PSW Restart on the Image."),ValueMap { "0", "2", "4096" },Values { "Completed with No Error", "Unknown/Unspecified Error",

"Method Parameters Checked - Job Started" }]uint32 PSWRestart(


"The Image that is affected by this restart request.")]IBMZ_Image REF TargetSystem,

[IN,Description (


boolean Force,




[Description ("Clears memory and performs a Reset on the Image."),


"Method Parameters Checked - Job Started" }]uint32 ResetClear(


"The Image that is affected by this reset request.")]IBMZ_Image REF TargetSystem,

[IN,Description (

"An indicator used to request conditional processing of ""the ResetClear method depending on the state of the ""Image. The default is to unconditionally perform the ""request (that is, Force=TRUE) regardless of the Image "

"state.")]boolean Force,



[Description ("Performs a Reset on the Image without clearing memory."),


"Method Parameters Checked - Job Started" }]uint32 ResetNormal(


"The Image that is affected by this reset request.")]IBMZ_Image REF TargetSystem,

[IN,Description (

"An indicator used to request conditional processing of ""the ResetNormal method depending on the state of the ""Image. The default is to unconditionally perform the ""request (that is, Force=TRUE) regardless of the Image "





[Description ("Boots a dump utility from a SCSI device. Except for the ""target, all of the parameters in this method are ""optional. The default behavior when a parameter is not ""specified is described with each parameter."),


"Method Parameters Checked - Job Started" }]uint32 SCSIDump(


"The Image that is affected by this dump request.")]IBMZ_Image REF TargetSystem,

[IN,Description (

"The address to be used when performing the boot. The ""default will be to use the Load Address last used when ""the Image was SCSI booted.")]uint16 LoadAddress,

[IN,Description (

"The parameter string to be used when performing the ""boot. The default will be to use the Load Parameter ""last used when the Image was SCSI booted."),


[IN,Description (

"The WorldWide Port Name (WWPN) to be used for the ""boot. The default will be to use the WorldWide Port ""Name last used when the Image was SCSI booted.")]

uint64 WorldWidePortName,


[IN,Description (

"The logical unit number (LUN) to be used for the boot. ""The default will be to use the logical unit number ""last used when the Image was SCSI booted.")]

uint64 LogicalUnitNumber,

[IN,Description (

"The boot program selector to be used for the boot. The ""default will be to use the boot program selector last ""used when the Image was SCSI booted."),

MaxValue (30)]uint8 BootProgramSelector,

[IN,Description (

"The operating system specific parameters to be used ""for the boot. The default will be to use the operating ""system specific parameters last used when the Image ""was SCSI booted."),

MaxLen (256)]string OSLoadParameters,

[IN,Description (

"The boot record logical block address to be used for ""the boot. The default will be to use the boot record ""logical block address last used when the Image was ""SCSI booted.")]

uint64 BootRecordAddress,

[IN,Description (

"An indicator used to request conditional processing of ""the SCSIDump method depending on the state of the ""Image. The default is to unconditionally perform the ""request (that is, Force=TRUE) regardless of the Image "




[Description ("Boots from a SCSI device. Except for the target, all of ""the parameters in this method are optional. The default ""behavior when a parameter is not specified is described ""with each parameter."),


"Method Parameters Checked - Job Started" }]uint32 SCSILoad(



"The Image that is affected by this load request.")]IBMZ_Image REF TargetSystem,

[IN,Description (

"The address to be used when performing the boot. The ""default will be to use the Load Address last used when ""the Image was SCSI booted.")]uint16 LoadAddress,

[IN,Description (

"The parameter string to be used when performing the ""boot. The default will be to use the Load Parameter ""last used when the Image was SCSI booted."),


[IN,Description (

"The WorldWide Port Name (WWPN) to be used for the ""boot. The default will be to use the WorldWide Port ""Name last used when the Image was SCSI booted.")]

uint64 WorldWidePortName,

[IN,Description (

"The logical unit number (LUN) to be used for the boot. ""The default will be to use the logical unit number ""last used when the Image was SCSI booted.")]

uint64 LogicalUnitNumber,

[IN,Description (

"The boot program selector to be used for the boot. The ""default will be to use the boot program selector last ""used when the Image was SCSI booted."),

MaxValue (30)]uint8 BootProgramSelector,

[IN,Description (

"The operating system specific parameters to be used ""for the boot. The default will be to use the operating ""system specific parameters last used when the Image ""was SCSI booted."),

MaxLen (256)]string OsLoadParameters,

[IN,Description (

"The boot record logical block address to be used for ""the boot. The default will be to use the boot record ""logical block address last used when the Image was ""SCSI booted.")]

uint64 BootRecordAddress,


[IN,Description (

"An indicator used to request conditional processing of ""the SCSILoad method depending on the state of the ""Image. The default is to unconditionally perform the ""request (that is, Force=TRUE) regardless of the Image "




[Description ("Performs a Start operation on all of the processors of an ""Image"),


"Method Parameters Checked - Job Started" }]uint32 Start(


"The Image that is affected by this start request.")]IBMZ_Image REF TargetSystem,

[IN,Description (


boolean Force,



[Description ("Performs a Stop operation on all of the processors of an ""Image"),


"Method Parameters Checked - Job Started" }]uint32 Stop(


"The Image that is affected by this stop request.")]IBMZ_Image REF TargetSystem,

[IN,Description (


boolean Force,



};



Note: For IBMZ_ImageSettingData class information, see “IBMZ_ImageSettingData (Recorded)” on page132, “IBMZ_ImageSettingData (State)” on page 135 and “IBMZ_ImageSettingData (Current)” on page 138.


"The IBMZ_ImageSettingData class is the aggregation point for ""the configuration information relating to a virtual computer ""system (Image). The settings defined in this class are used ""when enabling (activating) the virtual computer system to ""define the virtualized devices of the virtual system.\n\n"

"Each instance of class IBMZ_Image will be associated to an ""instance of this class representing the real-time state of ""the virtualization related Image properties via a ""CIM_SettingsDefineState association. A second instance of ""this class will be connected to the ’State’ instance via a ""CIM_ElementSettingData association with its IsCurrent ""property set to 1 (\"Is Current\"). This instance ""represents the last requested virtualization property set. ""A third instance will be connected to the ’State’ instance ""via a CIM_ElementSettingData association with its IsNext ""property set to 1 (\"Is Next\"). This instance ""represents the persistent configuration definition. Using ""standard terminology, this is the Image Activation ""Profile.\n\n"

"Much of the setting data that is traditionally bundled ""together in an Image Activation Profile is split into ""separate classes in the CIM representation:\n""Information relating to the number and type of the virtual ""processors is contained in IBMZ_ProcessorSettingData ""instances connected to instances of this class via ""CIM_ConcreteComponent associations.\n""Information relating to the quantity and type of the virtual ""memory is contained in IBMZ_MemorySettingData instances ""connected to instances of this class via ""CIM_ConcreteComponent associations.\n""Information relating to the OS that may be automatically ""booted (IPLed) in the Image is contained in an ""IBMZ_ImageBootSettingData instance connected to the instance ""of the IBMZ_Image class via a CIM_ElementSettingData ""association with its IsNext property set to 1 ""(\"Is Next\").\n""Information relating to certain I/O devices (Fibre Channel ""Ports), normally contained in the Reset Activation Profile ""Input/Output Configuration Data Set (IOCDS), is represented ""by IBMZ_FCPortSettingData instances also connected to ""instances of this class via CIM_ConcreteComponent ""associations."),

Version ("1.2.1")]class IBMZ_ImageSettingData : CIM_VirtualSystemSettingData {



"The defined capacity expressed in terms of Millions of ""Service Units (MSU)s per hour. MSUs is a measure of ""processor resource consumption. The amount of MSUs an ""Image consumes is dependent on the model, the number of ""logical processors available to the partition, and the ""amount of time the Image is dispatched. The defined ""capacity value specifies how much of the capacity the ""logical partition is to be managed by WorkLoad Manager ""for the purpose of software pricing. If this value is 0, ""no defined capacity is specified for this Image. ""DefinedCapacity is not applicable if VirtualSystemType is ""set to \"CF\". It is not used when ""WorkLoadManagerEnabled is FALSE.")]

uint32 DefinedCapacity;

[Write,Description ("The IML mode for the Image: Enterprise Systems Architecture ""390 (ESA 390), Enterprise Systems Architecture 390 ""Transaction Processing Facility (ESA 390 TPF), Coupling ""Facility (CF), Linux (Linux), System z Virtual Machine (zVM), ""and zAware (zAware). Notes: Starting with z13s , zAware ""refers to the Firmware Platform Container (FPC) IML mode."),

Override ("VirtualSystemType"),ValueMap {

"ESA 390", "ESA 390 TPF", "CF", "Linux","zVM","zAware"}]

string VirtualSystemType;


"Indicates whether the WorkLoad Manager (WLM) is allowed to ""adjust the weights of the shared processers in the Image ""to balance workload across Images. If Capped is TRUE for ""any IBMZ_ProcessorSettingData instance associated to this ""Image via CIM_ConcreteComponent, WorkLoadManaged must be ""FALSE.")]

boolean WorkLoadManaged;


"Indicates whether the Basic CPU Counter is authorized. If ""TRUE, the Basic CPU Counter is enabled and the Image is ""allowed to access it.")]

boolean BasicCounterAuthorized;


"Indicates whether the Problem State CPU Counter is ""authorized. If TRUE, the Problem State CPU Counter is ""enabled and the Image is allowed to access it. If not ""defined, the Image does not support this property.")]

boolean ProblemStateCounterAuthorized;


"Indicates whether the Cryptographic Activity CPU ""Counter is authorized. If TRUE, the Cryptographic ""Activity CPU Counter is enabled and the Image is ""allowed to access it.")]

boolean CryptoActivityCounterAuthorized;


||||||

IBMZ_InstCreation

Note: For IBMZ_InstCreation class information, see “IBMZ_InstCreation” on page 189.

IBMZ_InstDeletion

Note: For IBMZ_InstDeletion class information, see “IBMZ_InstDeletion” on page 190.


"Indicates whether the Extended CPU Counter is authorized. ""If TRUE, the Extended CPU Counter is enabled and the Image ""is allowed to access it.")]

boolean ExtendedCounterAuthorized;


"Indicates whether the Coprocessor Group CPU Counter is ""authorized. If TRUE, the Coprocessor Group CPU Counter is ""enabled and the Image is allowed to access it.")]

boolean CoprocessorGroupCounterAuthorized;


"Indicates whether the Basic CPU Sample is authorized. If ""TRUE, the Basic CPU Sample is enabled and the Image is ""allowed to access it.")]

boolean BasicSampleAuthorized;


"Indicates whether the Diagnostic CPU Sample is authorized. ""If TRUE, the Diagnostic CPU Sample is enabled and the Image ""is allowed to access it.")]

boolean DiagnosticSampleAuthorized;


"Indicates whether the \"AES key import\" functions within the ""CPACF Key Management Operations command set ""are permitted.")]boolean AESKeyImportFunctionsPermitted;


"Indicates whether the \"DEA key import\" functions within the ""CPACF Key Management Operations command set ""are permitted.")]boolean DEAKeyImportFunctionsPermitted;

};


"The IBMZ_InstCreation class describes instance creation ""events that occur in the root/ibmz namespace."),

Version ("1.1.0")]class IBMZ_InstCreation : CIM_InstCreation {};


IBMZ_InstModification

Note: For IBMZ_InstModification class information, see “IBMZ_InstModification” on page 191.


Note: For IBMZ_MemorySettingData class information, see “IBMZ_MemorySettingData (Recorded)” onpage 154, and “IBMZ_MemorySettingData (State)” on page 156.


"The IBMZ_InstDeletion class describes instance deletion ""events that occur in the root/ibmz namespace."),

Version ("1.1.0")]class IBMZ_InstDeletion : CIM_InstDeletion {};


"The IBMZ_InstModification class describes instance ""modification events that occur in the root/ibmz namespace."),

Version ("1.1.0")]class IBMZ_InstModification : CIM_InstModification {};


"The IBMZ_MemorySettingData class defines the allocation of ""physical memory to a virtual computer system (Image). Two ""instances of this class, representing each of the memory ""types (Central Storage and Expanded Storage), are connected ""to each IBMZ_ImageSettingData instance via ""CIM_ConcreteComponent associations."),

Version ("1.0.0")]class IBMZ_MemorySettingData : CIM_ResourceAllocationSettingData {


"The amount of memory (in MegaBytes) that is not initially ""allocated to the Image, but is allowed to be added at a ""later time."),

Units ("MegaBytes")]uint64 ReservedVirtualQuantity;

[Description ("The ResourceSubType distinguishes between the two types ""of memory: Central Storage and Expanded Storage"),

Override ("ResourceSubType"),ValueMap {"Central Storage", "Expanded Storage"}]

string ResourceSubType;


"VirtualQuantity represents the amount of memory (in ""MegaBytes) that is initially allocated to the Image."),

Override ("VirtualQuantity"),Units ("MegaBytes")]

uint64 VirtualQuantity;};



Note: For IBMZ_OperatingSystem class information, see “IBMZ_OperatingSystem” on page 65.

IBMZ_OSMessage

Note: For IBMZ_OSMessage class information, see “IBMZ_OSMessage” on page 191.


"The out-of-band view of an operating system running in an ""Image."),

Version ("1.1.0")]class IBMZ_OperatingSystem : CIM_OperatingSystem {

[Description ("The name of the Sysplex in which this Image is ""participating. This property is applicable only if the ""Image is running zOS. The value with be NULL otherwise.")]

string SysplexName;

[Description ("Sends a command or message response to the operation system ""running in an Image. The command or response will be echoed ""back as an IBMZ_OSMessage indication. Other IBMZ_OSMessage ""indications, possibly requiring responses, are also ""likely to occur."),

ValueMap { "0", "2" },Values { "Completed with No Error", "Unknown/Unspecified Error" }]

uint32 SendOSCommand(

[IN,Description (

"Indicates whether or not this is a priority operating ""system command or response. If not present, IsPriority ""defaults to FALSE.")]

boolean IsPriority,

[IN,Required,Description (

"The command or response text."),MinLen (1)]

string Command,


"Reference to the job spawned if the operation continues ""after the method returns. (May be null if the task is ""completed).")]

CIM_ConcreteJob REF Job);};



Note: For IBMZ_ProcessorOperationsService class information, see “IBMZ_ProcessorOperationsService”on page 110.


Note: For IBMZ_ProcessorSettingData class information, see “IBMZ_ProcessorSettingData (ImageRecorded)” on page 141, “IBMZ_ProcessorSettingData (Image State)” on page 143 and“IBMZ_ProcessorSettingData (Image Current)” on page 146.


"The IBMZ_OSMessage class describes operating system console messages."),Version ("1.1.0")]

class IBMZ_OSMessage : CIM_AlertIndication {

[Description ("The formatted message." ),

Override ( "Message" )]string Message;

[Description ("If the console message is expecting a response, PromptText "

"provides the prompt text for the message.")]string PromptText;

[Description ("Indicates that this message is held pending a response.")]

boolean IsHeld;};


"Provides the controls to operate a virtual processor. This ""includes sending an external interrupt to the processor."),

Version ("1.1.0")]class IBMZ_ProcessorOperationsService : CIM_Service {

[Description ("Performs an external interrupt on an Image processor.")]

uint32 ExternalInterrupt(


"The Processor that is affected by this interrupt ""request.")]

CIM_Processor REF TargetProcessor,



};


|||


"The IBMZ_ProcessorSettingData class defines the allocation ""of physical processors assigned to a virtual computer ""system (Image). Instances of this class server a number of ""different purposes:\n\n""’Recorded’\n""Represents processor settings defined in within a virtual ""computer system configuration (IBMZ_ImageSettingData).""A ’Recorded’ instance is related to its IBMZ_ImageSettingData ""instance via a CIM_ConcreteComponent association. The ""AbsoluteCappingProcessors, Capped, ReservedVirtualQuantity, ""VirtualQuantity and Weight properties of ’Recorded’ instances ""may be updated.\n""’MinRecorded’/’MaxRecorded’\n""Represents the minimum and maximum processing share settings ""within a virtual computer system configuration definition ""(IBMZ_ImageSettingData). ’MinRecorded’ and ’MaxRecorded’ ""settings are applicable only for shared processors for which ""workload management has been enabled. ’MinRecorded’ and ""’MaxRecorded’ instances are related to a ""CIM_AllocationCapabilites instance via ""CIM_ElementSettingData associations, which is in turn related ""to its IBMZ_ImageSettingData via a ""CIM_SettingsDefineCapabilities association. The Weight ""property of ’MinRecorded’ and ’MaxRecorded’ instances may ""be updated.\n""’State’\n""Represents the real-time processor settings for a virtual ""computer system. A ’State’ instance is related to its ""IBMZ_ImageSettingData instance via a CIM_ConcreteComponent ""association. The AbsoluteCappingProcessors, Capped, ""VirtualQuantity and Weight properties of ’State’ instances ""may be updated.\n""’Current’\n""Represents the last requested processor settings for an ""active virtual computer system. A ’Current’ instance is ""related to its IBMZ_ImageSettingData instance via a ""CIM_ConcreteComponent association. ’Current’ instances may ""not be updated.\n""’MinState’/’MaxState’\n""Represents the real-time minimum and maximum processing share ""for a shared processor for which workload management has been ""enabled. This also represents the last requested minimum and ""maximum processor share values, as the are always equal to ""the real-time values. ’MinState’ and ’MaxState’ instances are ""related to a CIM_AllocationCapabilites instance via ""CIM_ElementSettingData associations, which is in turn related ""to its IBMZ_ImageSettingData via a ""CIM_SettingsDefineCapabilities association. The ""Weight property of ’MinState’ and ’MaxState’ instances may be ""updated.\n\n""There can be muliple instances of each of the above types ""representing combinations of the ConsumerVisibility processor ""sharing (Passed-Through and Virtualized) and ResourceSubType ""(’CP’, ’zAAP’, ’IFL’, ’ICF’ and ’zIIP’) attributes."),

Version ("1.1.0")]class IBMZ_ProcessorSettingData : CIM_ResourceAllocationSettingData {



"An absolute limit on the number of physical processors ""that can be consumed by a virtual server. This value is not ""dependent on the number of other virtual servers or on ""the size of the processor pool. If not specified, no ""absolute limit will exist. The maximum value of this ""property is 255.0 and the minimum value is 0.01.")]

real32 AbsoluteCappingProcessors;


"Indicates whether the Weight value is a target or a limit. ""If TRUE, the Weight represents the virtual computer ""system’s maximum share of resources, regardless of the ""availability of excess processor resources. If FALSE, it ""represents the share of resources guaranteed to a virtual ""computer system when all processor resources are in use. ""Otherwise, when excess processor resources are available, ""the logical partition can use them if necessary. If ""WorkLoadManaged is TRUE in the IBMZ_ImageSettingData ""associated via CIM_ConcreteComponent, Capped must be ""FALSE."),

ModelCorrespondence {"IBMZ_ImageSettingData.WorkLoadManaged"} ]boolean Capped;


"The number of host processors that are not initially ""allocated to the Image, but are allowed to be added at a ""later time.")]

uint64 ReservedVirtualQuantity;

[Description ("The ResourceSubType distinguishes between the five ""processor types: Central (or General Purpose) Processor ""(CP), z Application Assist Processor (zAAP) ""(sometimes referred to as Integrated Facility for ""Applications Processor), Integrated Facility for Linux ""(IFL) Processor, Internal Coupling Facility (ICF) ""Processor and z Integrated Information Processor (zIIP)"),

Override ("ResourceSubType"),ValueMap {"CP", "zAAP", "IFL", "ICF", "zIIP"}]

string ResourceSubType;


"The number of host processors that are initially ""allocated to the Image."),

Override ("VirtualQuantity")]uint64 VirtualQuantity;


"The relative amount of shared processor resources ""initially allocated to the virtual computer system. If ""WorkloadManager is TRUE, the Capped value indicates how ""this value affects the processor share after the system ""is running."),

MaxValue ("999"),MinValue ("1"),Override ("Weight")]

uint32 Weight;};


IBMZ_SecurityLog

Note: For IBMZ_SecurityLog class information, see “IBMZ_SecurityLog” on page 90.

IBMZ_SupportElement

Note: For IBMZ_SupportElement class information, see “IBMZ_SupportElement” on page 70.


"The IBMZ_SecurityLog class describes a repository of ""security related messages."),

Version ("1.0.0")]class IBMZ_SecurityLog : CIM_RecordLog {};



Note: For IBMZ_TemporaryCapacityProcessor class information, see“IBMZ_TemporaryCapacityProcessor” on page 167.


"The IBMZ_SupportElement class defines a Support Element (SE) ""that assists a single CPC. An SE owns all of the setting data ""associated with a CPC and its Images, and hosts all of its ""services."),

Version ("1.0.0")]class IBMZ_SupportElement : CIM_ComputerSystem {

[Description ("Exports the setting data to a specified staging area."),


"Method Parameters Checked - Job Started" }]uint32 ExportSettingData(


"The target staging area. This must be a number between ""1 and 4"),

MinValue (1),MaxValue (4)]

uint8 StagingAreaID,



CIM_ConcreteJob REF Job);

[Description ("Imports the setting data from a specified staging area."),


"Method Parameters Checked - Job Started" }]uint32 ImportSettingData(


"The target staging area. This must be a number between ""1 and 4"),

MinValue (1),MaxValue (4)]

uint8 StagingAreaID,






Note: For IBMZ_TemporaryCapacityProcessorRecord class information, see“IBMZ_TemporaryCapacityProcessorRecord” on page 168.


"The IBMZ_TemporaryCapacityProcessor class defines information ""for a specific processor type. Instances of this class, ""representing the different processor types, are passed ""as arguments to the Activate and Deactivate methods of ""the IBMZ_TemporaryCapacityService class. Only extensions ""to this class will exist in a temporary capacity record."),

Version ("1.1.0")]class IBMZ_TemporaryCapacityProcessor : CIM_SettingData {

[Description ("The processor type that this record affects. The ""supported processor types are: \"General purpose ""processor (CP)\", \"System Assist Processor (SAP)\", ""\"Application Assist Processor (zAAP)\", \"Integrated ""Facility for Linux processor (IFL)\", \"Internal ""Coupling Facility processor (ICF)\" and \"Integrated ""Instruction Processor (zIIP)\""),

ValueMap {"2", "3", "4", "5", "6", "7"},Values {"CP", "SAP", "zAAP", "IFL", "ICF", "zIIP"}]

uint16 ProcessorType;

[Description ("The number of processors of the type specified in ""ProcessorType.\n\n""When an instance of IBMZ_TemporaryCapacityProcessor is ""used as an argument to the ""IBMZ_TemporaryCapacityService.Activate() method, this ""value represents the number of additional processors ""of the specified type in the upgraded system.\n\n.""When an instance of IBMZ_TemporaryCapacityProcessor is ""used as an argument to the ""IBMZ_TemporaryCapacityService.Deactivate() method, this ""value represents the number by which processors of the ""specified type will be reduced in the downgraded ""system.\n\n""For an instance of an extension to the ""IBMZ_TemporaryCapacityProcessor class, this value ""represents the maximum number of processors of the ""specified type that may be activated. A value of ""NULL indicates that the number of processors is not ""limited by this property."),

MaxValue (0x7fffffff)]uint32 ProcessorStep;

};



Note: For IBMZ_TemporaryCapacityRecord class information, see “IBMZ_TemporaryCapacityRecord” onpage 164.


"The IBMZ_TemporaryCapacityProcessorRecord class defines ""information for a specific processor type. Instances of ""this class, representing the different processor types, are ""contained in a temporary capacity record."),

Version ("1.1.0")]class IBMZ_TemporaryCapacityProcessorRecord : IBMZ_TemporaryCapacityProcessor {

[Description ("The delta to the current speed of CP processors that is ""attributable to this temporary capacity record. A ""SpeedStep of 0 indicates either that the temporary ""capacity record associated with this ""TemporaryCapacityProcessorRecord has not been activated ""or that it did not result in a change to the processor ""speed. A positive SpeedStep indicates this temporary ""capacity record is responsible for increasing CP speed. ""A negative SpeedStep indicates the temporary capacity ""record has decreased the CP speed. This value will be ""NULL if IBMZ_eBodProcessor.RecordType is not 2 \’CP\’.")]

sint32 SpeedStep;

[Description ("The maximum number of processors of type ProcessorType ""that can be activated using this temporary capacity ""record. A value of NULL indicates that the number of ""processors is not limited by this property."),

MaxValue (0x7fffffff)]uint32 MaxProcessors;

[Description ("The remaining capacity, expressing in processor tokens, ""for processors of type ProcessorType. A value of NULL ""indicates that activations are not limited by this ""property."),

MaxValue (0x7fffffff)]uint32 RemainingProcessorTokens;

[Description ("The remaining capacity, expressing Millions of Service ""Units (MSU) tokens, for processors of type ProcessorType. ""This property is applicable only when ""IBMZ_TemporaryCapacityProcessor.RecordType is 2 \’CP\’. ""A value of NULL indicates that the property is not ""applicable or that activations are not otherwise limited ""by this property."),

MaxValue (0x7fffffff)]uint32 RemainingMSUTokens;

};



"The IBMZ_TemporaryCapacityRecord class is the aggregation point ""for the collection of instances that define a temporary ""capacity record. This class defines common record elements. ""It contains one or more instances of ""IBMZ_TemporaryCapacityRecordInfo and ""IBMZ_TemporaryCapacityTarget, related via ""CIM_ConcreteComponent associations, to complete the record ""definition."),

Version ("1.1.0")]class IBMZ_TemporaryCapacityRecord : CIM_SettingData {

[Description ("The temporary capacity feature type. The supported feature ""types are: \"Capacity Backup Unit (CPU)\", \"On/Off ""Capacity on Demand (O/O CoD)\", \"Planned Event\" and ""\"Loaner Engines\""),

ValueMap {"0", "1", "2", "3"},Values {"CBU", "O/O CoD", "Planned Event", "Loaner Engines"}]

uint16 RecordType;

[Description ("The status of this temporary capacity record. If this ""record can be activated, the value of this property will ""be 0 \"Available\". If this record cannot be activated, ""for example if it is expired, the value of this property ""will be 1 \"Unavailable\". A CBU record may be ""activated in test mode. If the record has been ""activated in test mode, the value of this property will ""be 3 \"Test\". If this record has been activated in ""real mode, the value of this property will be 2 ""\"Real\"."),

ValueMap {"0", "1", "2", "3"},Values {"Available", "Unavailable", "Real", "Test"}]

uint16 Status;

[Description ("The date and time that this temporary capacity record ""was last activated. If this record has never been ""activated, the value of this property will be NULL.")]

datetime ActivationDate;


[Description ("The date and time at which this temporary capacity ""record expires. If this record is not deactivated by ""this date, it will be automatically deactivated and ""become expired. If NULL, this capacity record does ""not expire.")]

datetime ExpirationDate;

[Description ("The remaining number of times that this temporary ""capacity record can be activated in Real mode. A value ""of NULL indicates that Real mode activations are not ""limited by this property."),

MaxValue (0x7fffffff)]uint32 RemainingActivations;

[Description ("The remaining number of times that this temporary ""capacity record can be activated in Test mode. A value ""of NULL indicates that Test mode activations are not ""limited by this property."),

MaxValue (0x7fffffff)]uint32 RemainingTestActivations;

[Description ("The number of days in the original contract for which ""this temporary capacity record can remain activated in ""Real mode. A value of NULL indicates that Real mode ""activations are not limited by this property."),

MaxValue (0x7fffffff)]uint32 MaxDays;

[Description ("The number of days in the original contract for which ""this temporary capacity record can remain activated in ""Test mode. A value of NULL indicates that Test mode ""activations are not limited by this property."),

MaxValue (0x7fffffff)]uint32 MaxTestDays;

[Description ("The remaining number of days this temporary capacity ""record can be activated in Real mode. A value of NULL ""indicates that Real mode activations are not limited ""by this property."),

MaxValue (0x7fffffff)]uint32 RemainingDays;


[Description ("The remaining number of days this temporary capacity ""record can be activated in Test mode. A value of NULL ""indicates that Test mode activations are not limited ""by this property."),

MaxValue (0x7fffffff)]uint32 RemainingTestDays;

[Description ("Activates a temporary capacity record."),


"Method Parameters Checked - Job Started" }]uint32 Activate(


"The target model that will result from this capacity ""activation.")]

IBMZ_TemporaryCapacityTarget REF TargetModelCapacityID,


"An array of strings, each containing an imbedded ""instance of class IBMZ_TemporaryCapacityProcessor. ""These instances define the number of specialty ""processors that will be added when the record is ""activated. Information about the number of CP’s is ""not included in this array because it is implied ""by the target Model-Capacity Identifier."),

EmbeddedInstance("IBMZ_TemporaryCapacityProcessor")]string ProcessorInfo[],

[IN,Description (

"Indicates that the record is to be activated to its ""maximum capacity regardless of the available resources. ""If TRUE, the activation will activate as many resources ""as it can based on availablity, and any remaining ""processors will be become pending. Pending processors ""will automatically be activated if and when they ""become available. Processor information specified in ""the ProcessorInfo parameter will be ignored. If FALSE, ""or omitted, processors will be activated according to ""the information contained in the ProcessorInfo ""parameter. Force is applicable only for Capacity ""Backup Unit (CBU) record types.")]

boolean Force,



Note: For IBMZ_TemporaryCapacityTarget class information, see “IBMZ_TemporaryCapacityTarget” onpage 170.

[IN,Description (

"Indicates if a test or a real activation is performed. ""If TRUE, a test activation is performed. If FALSE or ""omitted, a real activation is performed. This ""parameter is applicable only for Capacity Backup Unit ""(CBU) record types.")]

boolean Test,



CIM_ConcreteJob REF Job);

[Description ("Deactivates a temporary capacity record."),


"Method Parameters Checked - Job Started" }]uint32 Deactivate(


"The target model that will result from this capacity ""deactivation.")]

IBMZ_TemporaryCapacityTarget REF TargetModelCapacityID,


"An array of strings, each containing an imbedded ""instance of class IBMZ_TemporaryCapacityProcessor. ""These instances define the number of specialty ""processors that will be removed when the record is ""deactivated. Information about the number of CP’s ""is not included in this array because it is implied ""by the target Model-Capacity Identifier."),

EmbeddedInstance("IBMZ_TemporaryCapacityProcessor")]string ProcessorInfo[],






"The IBMZ_TemporaryCapacityTarget class defines information ""about the CP configuration that is an allowed endpoint of ""a temporary capacity activation or deactivation. Instances of ""this class are contained in a temporary capacity record.\n\n""When a temporary capacity record is activated or deactivate, ""the end result is a new hardware configuration which can ""include a different number of general purpose processors ""(CPs) and/or different speeds of those CPs. This is the ""equivalent of a CPC with a different model number. The ""effective model is referred to as the \"Model-Capacity ""Identifier\"."),

Version ("1.1.0")]class IBMZ_TemporaryCapacityTarget : CIM_SettingData {

[Description ("The delta between the current number of CP’s and the ""number of CP’s in the target model.")]

sint32 ProcessorStep;

[Description ("The difference between the current CP processor speed ""and the processor speed in the target model. ""A SpeedStep of 0 indicates that the CP speed will not ""change. A positive SpeedStep indicates increasingly ""higher CP speeds. A negative SpeedStep indicates ""decreasingly lower CP speeds.")]

sint32 SpeedStep;

[Description ("The model identifier that represents the target CP ""configuration.")]

string ModelCapacityID;

[Description ("The absolute billable MSU (Millions of Service Units) ""cost for the target model."),

MaxValue (0x7fffffff)]uint32 BillableMSUCost;

[Description ("The delta between the current MSU (Millions of ""Service Units) cost and the MSU cost of the target ""model.")]

sint32 BillableMSUDelta;};


Association classes


[Experimental,Association,Aggregation,Description (

"The association between a Coordinated Timing Network (CTN) ""instance and a CPC that indicates the CPC is a member of ""CTN."),

Version ( "1.1.0" )]class IBMZ_CoordinatedTimingNetworkComponent: CIM_SystemComponent {

[Aggregate,Override ( "GroupComponent" ), Description (

"A CoordinatedTimingNetwork instance defining a CTN.")]IBMZ_CoordinatedTimingNetwork REF GroupComponent;

[Override ( "PartComponent" ), Description ("A CPC that is a member of the CTN.")]

IBMZ_CPC REF PartComponent;

[Description ("Indicates the role that a CPC plays in a Coordinated Timing ""Network.\n""\"Preferred Time Server\" indicates the CPC that has been ""designated by a user as the preferred system to be used as ""the time server in the network. There will be at most one ""CPC in a CTN with this designation. If the CPC is not a ""member of a RedundancySet, then the CPC will be the current ""time server for the network. If the CPC is a member of a ""RedundancySet, the CPC will be the current time server if ""it is not associated to the RedundancySet via an instance ""of the IsSpare association.\n""\"Backup Time Server\" indicates the CPC that has been ""designated by a user as the preferred system to be used as ""the backup time server in the network. There will be at ""most one CPC in a CTN with this designation. The backup CPC ""will be a member of a RedundancySet. The backup CPC will ""be the current time server if it is not associated to the ""RedundancySet via an instance of the IsSpare association.\n""\"Arbiter\" indicates the CPC performs the role of an ""arbiter in the CTN. There will be at most one CPC in an ""CTN with this designation. If an arbiter is defined, there ""will be a RedundancySet with two members indicating the ""the current and backup STP servers. The arbiter is a CPC ""with connectivity to both the current and backup servers ""that is used by the backup server when it loses ""connectivity to the current server as a means to determine ""if the loss of connectivity is due to the failure of the ""current server, in which case a failover is initiated, or ""a networking problem, in which case the backup does not ""take over as the current time server."),

ValueMap {"2", "3", "4"},Values {"Preferred Time Server", "Backup Time Server", "Arbiter"}]

uint16 Role;};


IBMZ_ElementSoftwareIdentity

[Experimental,Association,Description (

"The association between a Hardware Management Console or ""Support Element and various licensed internal code ""(Firmware) levels.\n\n""As internal code bundles must be applied sequentially, ""each available bundle is not individually represented. ""Rather the highest (most recent) bundle that represents a ""significant level is indicated by the ElementSoftwareStatus ""value(s) of this association."),

Version ( "1.1.0" )]class IBMZ_ElementSoftwareIdentity: CIM_ElementSoftwareIdentity {

[Override ( "Antecedent" ), Description ("A licensed internal code bundle.")]

CIM_SoftwareIdentity REF Antecedent;

[Override ( "Dependent" ), Description ("The console that manages internal code bundles.")]

CIM_ComputerSystem REF Dependent;

[Description ("An indication of a significant internal code level. ""\"Available\" indicates the level that can be installed. ""\"Current\" indicates the highest level that is currently ""installed and active. \"Installed\", in this ""implementation, is synonomous with \"Current\". These two ""indicators will always appear in tandem. \"Concurrent\" ""is used in conjuction with \"Available\" or \"Installed\" ""to indicate a level that can be concurrently installed or ""removed, respectively. \"Accepted\" indicates the level ""that has been permanently installed. Bundles at or below ""this level cannot be removed. \"Default\" indicates the ""the base code.\n""On other interfaces, the term \"Retrieved\" maps to ""\"Available\". The term \"Installable Concurrent\" maps ""to \"Available\" and \"Concurrent\". The term \"Activated\" ""maps to \"Installed\" and \"Current\". The term ""\"Accepted\" maps to \"Installed\", \"Current\" and ""\"Accepted\". The term \"Removable Concurrent\" maps to ""\"Installed\", \"Current\" and \"Concurrent\"."),

Override ("ElementSoftwareStatus"),ValueMap {"2", "5", "6", "8",

"32768", "32769"},Values {"Current", "Default", "Installed", "Available",

"Concurrent", "Accepted"}]uint16 ElementSoftwareStatus[];

};


IBMZ_ManagedSE

[Experimental,Association,Description (

"The IBMZ_ManagedSE class identifies the association between ""a Hardware Management Console and the Support Elements that ""it manages."),

Version ( "1.0.0" )]class IBMZ_ManagedSE {

[Key,Description (

"The managing Hardware Management Console.")]IBMZ_HardwareManagementConsole REF ManagingConsole;

[Key,Description (

"The managed Support Element.")]IBMZ_SupportElement REF ManagedConsole;

};


Appendix A. z Systems or LinuxONE to CIM status mappings

The values for a number of IBMZ_CPC and IBMZ_Image properties are derived from the z Systems orLinuxONE CPC and Image Status values that are displayed on an HMC or SE. The following tablesdescribe this mapping.

IBMZ_CPC z Systems or LinuxONE to CIM status mappingsTable 58. IBMZ_CPC EnabledState mappings

CPC Status EnabledState Value

Operating 2 "Enabled"

Not Operating 2 "Enabled"

Communication Not Active 0 "Unknown"

No Power 3 "Disabled"

Exceptions 2 "Enabled"

Service 2 "Enabled"

PowerSave 2 "Enabled"

Status Check 0 "Unknown"

Service Required 2 "Enabled"

Degraded 2 "Enabled"

Table 59. IBMZ_CPC OperationalStatus[] mappings

CPC Status OperationalStatus[] Values

Operating 2 "OK"

Not Operating 10 "Stopped"

Communication Not Active 13 "Lost Communication"

No Power 10 "Stopped", 18 "Power Mode"

Exceptions 6 "Error"

Service 11 "In Service"

PowerSave 3 "Degraded", 0x8002 "Power Save"

Status Check 13 "Lost Communication", 0x8000 "Status Check"

Service Required 6 "Error", 0x8001 "Service Required"

Degraded 3 "Degraded"

Table 60. IBMZ_CPC Status mappings

CPC Status Status Value

Operating "OK"

Not Operating "Stopped"

Communication Not Active "Lost Comm"

No Power "Stopped"

Exceptions "Error"

Service "Service"


||

|

Table 60. IBMZ_CPC Status mappings (continued)

CPC Status Status Value

Power Save "Degraded"

Status Check "Lost Comm"

Service Required "Error"

Degraded "Degraded"

IBMZ_Image z Systems or LinuxONE to CIM status mappingsTable 61. IBMZ_Image EnabledState mappings

Image Status EnabledState Value

Operating 2 "Enabled"

Not Operating 3 "Disabled"

Not Activated 3 "Disabled"

Communication Not Active 0 "Unknown"

No Power 3 "Disabled"

Exceptions 2 "Enabled"

Service 2 "Enabled"

PowerSave 2 "Enabled"

Status Check 0 "Unknown"

Table 62. IBMZ_Image OperationalStatus[] mappings

Image Status OperationalStatus[] Values

Operating 2 "OK"

Not Operating 10 "Stopped"

Not Activated 10 "Stopped", 0x8003 "Not Activated"

Communication Not Active 13 "Lost Communication"

No Power 10 "Stopped", 18 "Power Mode"

Exceptions 6 "Error"

Service 11 "In Service"

PowerSave 3 "Degraded", 0x8002 "Power Save"

Status Check 13 "Lost Communication", 0x8000 "Status Check"

Table 63. IBMZ_Image Status mappings

Image Status Status Value

Operating "OK"

Not Operating "Stopped"

Not Activated "Stopped"

Communication Not Active "Lost Comm"

No Power "Stopped"

Exceptions "Error"

Service "Service"


|

Table 63. IBMZ_Image Status mappings (continued)

Image Status Status Value

Power Save "Degraded"

Status Check "Lost Comm"

Appendix A. z Systems or LinuxONE to CIM status mappings 237

Appendix B. Notices

This information was developed for products and services offered in the US.

IBM may not offer the products, services, or features discussed in this document in other countries.Consult your local IBM representative for information on the products and services currently available inyour area. Any reference to an IBM product, program, or service is not intended to state or imply thatonly that IBM product, program, or service may be used. Any functionally equivalent product, program,or service that does not infringe any IBM intellectual property right may be used instead. However, it isthe user's responsibility to evaluate and verify the operation of any non-IBM product, program, orservice.

IBM may have patents or pending patent applications covering subject matter described in thisdocument. The furnishing of this document does not grant you any license to these patents. You can sendlicense inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle Drive, MD-NC119Armonk, NY 10504-1785US

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION “AS IS”WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOTLIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY ORFITNESS FOR A PARTICULAR PURPOSE. Some jurisdictions do not allow disclaimer of express orimplied warranties in certain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodicallymade to the information herein; these changes will be incorporated in new editions of the publication.IBM may make improvements and/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.

Any references in this information to non-IBM websites are provided for convenience only and do not inany manner serve as an endorsement of those websites. The materials at those websites are not part ofthe materials for this IBM product and use of those websites is at your own risk.

IBM may use or distribute any of the information you provide in any way it believes appropriate withoutincurring any obligation to you.

Information concerning non-IBM products was obtained from the suppliers of those products, theirpublished announcements or other publicly available sources. IBM has not tested those products andcannot confirm the accuracy of performance, compatibility or any other claims related to non-IBMproducts. Questions on the capabilities of non-IBM products should be addressed to the suppliers ofthose products.

Statements regarding IBM's future direction or intent are subject to change or withdrawal without notice,and represent goals and objectives only.

This information contains examples of data and reports used in daily business operations. To illustratethem as completely as possible, the examples include the names of individuals, companies, brands, andproducts. All of these names are fictitious and any similarity to actual people or business enterprise isentirely coincidental.


TrademarksIBM, the IBM logo, and ibm.com® are trademarks of International Business Machines Corp., registered inmany jurisdictions worldwide. Other product and service names might be trademarks of IBM or othercompanies. A current list of IBM trademarks is available on the web at “Copyright and trademarkinformation” at www.ibm.com/legal/copytrade.shtml.

Linux is a trademark of Linux Torvalds in the United States, other countries, or both.

Microsoft, Windows, and the Windows logo are trademarks of Microsoft Corporation in the UnitedStates, other countries, or both.

Other company, product, and service names may be trademarks or service marks of others.

Class A NoticesThe following Class A statements apply to this IBM product. The statement for other IBM productsintended for use with this product will appear in their accompanying manuals.

Federal Communications Commission (FCC) Statement

Note: This equipment has been tested and found to comply with the limits for a Class A digital device,pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection againstharmful interference when the equipment is operated in a commercial environment. This equipmentgenerates, uses, and can radiate radio frequency energy and, if not installed and used in accordance withthe instruction manual, may cause harmful interference to radio communications. Operation of thisequipment in a residential area is likely to cause harmful interference, in which case the user will berequired to correct the interference at his own expense.

Properly shielded and grounded cables and connectors must be used in order to meet FCC emissionlimits. IBM is not responsible for any radio or television interference caused by using other thanrecommended cables and connectors or by unauthorized changes or modifications to this equipment.Unauthorized changes or modifications could void the user's authority to operate the equipment.

This device complies with Part 15 of the FCC rules. Operation is subject to the following two conditions:(1) this device may not cause harmful interference, and (2) this device must accept any interferencereceived, including interference that may cause undesired operation.

Industry Canada Compliance Statement

This Class A digital apparatus complies with Canadian ICES-003.

Avis de conformité à la réglementation d'Industrie Canada

Cet appareil numérique de la classe A est conforme à la norme NMB-003 du Canada.

European Community Compliance Statement

This product is in conformity with the protection requirements of EU Council Directive 2014/30/EU onthe approximation of the laws of the Member States relating to electromagnetic compatibility. IBM cannotaccept responsibility for any failure to satisfy the protection requirements resulting from anon-recommended modification of the product, including the fitting of non-IBM option cards.


www.ibm.com/legal/copytrade.shtml

This product has been tested and found to comply with the limits for Class A Information TechnologyEquipment according to European Standard EN 55032. The limits for Class A equipment were derived forcommercial and industrial environments to provide reasonable protection against interference withlicensed communication equipment.

European Community contact:IBM Deutschland GmbHTechnical Regulations, Department M372IBM-Allee 1, 71139 Ehningen, GermanyTele: +49 (0) 800 225 5423 or +49 (0) 180 331 3233email: [email protected]

Warning: This is a Class A product. In a domestic environment, this product may cause radiointerference, in which case the user may be required to take adequate measures.

VCCI Statement - Japan

The following is a summary of the VCCI Japanese statement in the box above:

This is a Class A product based on the standard of the VCCI Council. If this equipment is used in adomestic environment, radio interference may occur, in which case the user may be required to takecorrective actions.

Japanese Electronics and Information Technology Industries Association (JEITA)Confirmed Harmonics Guideline (products less than or equal to 20 A per phase)

Japanese Electronics and Information Technology Industries Association (JEITA)Confirmed Harmonics Guideline with Modifications (products greater than 20 A perphase)

Appendix B. Notices 241

Electromagnetic Interference (EMI) Statement - People's Republic of China

Declaration: This is a Class A product. In a domestic environment, this product may cause radiointerference, in which case the user may need to perform practical action.

Electromagnetic Interference (EMI) Statement - Taiwan

The following is a summary of the EMI Taiwan statement above.

Warning: This is a Class A product. In a domestic environment, this product may cause radiointerference, in which case the user will be required to take adequate measures.

IBM Taiwan Contact Information:

Electromagnetic Interference (EMI) Statement - Korea

Germany Compliance Statement

Deutschsprachiger EU Hinweis: Hinweis für Geräte der Klasse A EU-Richtlinie zurElektromagnetischen Verträglichkeit

Dieses Produkt entspricht den Schutzanforderungen der EU-Richtlinie 2014/30/EU zur Angleichung derRechtsvorschriften über die elektromagnetische Verträglichkeit in den EU-Mitgliedsstaaten und hält dieGrenzwerte der EN 55032 Klasse A ein.

! ""# $%&( ')() *+,-./01 2 ""!34

56+ 7# 8&+# ! 91 :;<=" >?@, ABC;

DEFG 8&<# H1 I-() .4J.

A


Um dieses sicherzustellen, sind die Geräte wie in den Handbüchern beschrieben zu installieren und zubetreiben. Des Weiteren dürfen auch nur von der IBM empfohlene Kabel angeschlossen werden. IBMübernimmt keine Verantwortung für die Einhaltung der Schutzanforderungen, wenn das Produkt ohneZustimmung von IBM verändert bzw. wenn Erweiterungskomponenten von Fremdherstellern ohneEmpfehlung von IBM gesteckt/eingebaut werden.

EN 55032 Klasse A Geräte müssen mit folgendem Warnhinweis versehen werden:

"Warnung: Dieses ist eine Einrichtung der Klasse A. Diese Einrichtung kann im WohnbereichFunk-Störungen verursachen; in diesem Fall kann vom Betreiber verlangt werden, angemesseneMaßnahmen zu ergreifen und dafür aufzukommen."

Deutschland: Einhaltung des Gesetzes über die elektromagnetische Verträglichkeit von Geräten

Dieses Produkt entspricht dem “Gesetz über die elektromagnetische Verträglichkeit von Geräten(EMVG)“. Dies ist die Umsetzung der EU-Richtlinie 2014/30/EU in der Bundesrepublik Deutschland.

Zulassungsbescheinigung laut dem Deutschen Gesetz über die elektromagnetische Verträglichkeit vonGeräten (EMVG) (bzw. der EMC EG Richtlinie 2014/30/EU) für Geräte der Klasse A

Dieses Gerät ist berechtigt, in Übereinstimmung mit dem Deutschen EMVG das EG-Konformitätszeichen- CE - zu führen.

Verantwortlich für die Einhaltung der EMV Vorschriften ist der Hersteller:International Business Machines Corp.New Orchard RoadArmonk, New York 10504Tel: 914-499-1900

Der verantwortliche Ansprechpartner des Herstellers in der EU ist:IBM Deutschland GmbHTechnical Regulations, Abteilung M372IBM-Allee 1, 71139 Ehningen, GermanyTel: +49 (0) 800 225 5423 or +49 (0) 180 331 3233email: [email protected]

Generelle Informationen:

Das Gerät erfüllt die Schutzanforderungen nach EN 55024 und EN 55032 Klasse A.

Electromagnetic Interference (EMI) Statement - Russia

Appendix B. Notices 243

Glossary

This glossary includes terms and definitions from:v The Dictionary of Computing, SC20-1699.v The American National Standard Dictionary for

Information Systems, ANSI X3.172-1990,copyright 1990 by the American NationalStandards Institute (ANSI). Copies can bepurchased from the American NationalStandards Institute, 1430 Broadway, New York,New York 10018. Definitions are identified bythe symbol (A) after the definition.

v The Information Technology Vocabulary,developed by Subcommittee 1, Joint TechnicalCommittee 1, of the International Organizationfor Standardization and the InternationalElectrotechnical Commission (ISO/IECJTC1/SC1). Definitions of published parts ofthis vocabulary are identified by the symbol (I)after the definition; definitions taken from draftinternational standards, committee drafts, andworking papers being developed by ISO/IECJTC1/SC1 are identified by the symbol (T) afterthe definition, indicating that final agreementhas not yet been reached among theparticipating National Bodies of SC1.

The following cross-references are used in thisglossary:

Contrast with. This refers to a term that hasan opposed or substantively differentmeaning.See. This refers the reader to multiple-wordterms in which this term appears.See also. This refers the reader to terms thathave a related, buy not synonymous meaning.Synonym for. This indicates that the term hasthe same meaning as a preferred term, whichis defined in the glossary.

A

action One of the defined tasks that anapplication performs. Actions modify theproperties of an object or manipulate theobject in some way.

active windowThe window that users are currentlyinteracting with. This is the window thatreceives keyboard input.

addressA value that identifies a register, aparticular part of storage, a data source,or a data sink. The value is representedby one or more characters. (T)

To refer to a device or an item of data byits address. (I) (A)

The location in the storage of a computerwhere data is stored.

In data communication, the unique codeassigned to each device or workstationconnected to a network.

The identifier of a location, source, ordestination.

alert A unit of information, usually indicatingthe loss of a system resource, passed fromone machine or program to a host tosignal an error.

An error message sent to the systemservices control point (SSCP) at the hostsystem.

allocateTo assign a resource, such as a disk, toperform a task.

applicationThe use to which an informationprocessing system is put, for example, apayroll application, an airline reservationapplication, a network application.

A collection of software components usedto perform specific types of work on acomputer.

application programA program that is specific to the solutionof an application problem. (T)

A program written for or by a user thatapplies to the user’s work, such as aprogram that does inventory control orpayroll.

A program used to connect andcommunicate with stations in a network,enabling users to performapplication-oriented activities.

asynchronousPertaining to two or more processes that


do not depend upon the occurrence ofspecific events such as common timingsignals. (T)

Without regular time relationship;unexpected or unpredictable with respectto the execution of program instructions.Contrast with synchronous.

B

bit Either of the digits 0 or 1 when used inthe binary numeration system. (T) Seealso byte.

block A string of data elements recorded ortransmitted as a unit. The element may becharacters, words, or physical records. (T)

buffer A routine or storage used to compensatefor a difference in rate of flow of data, ortime of occurrence of events, whentransferring data from one device toanother. (A)

To allocate and schedule the use ofbuffers. (A)

A portion of storage used to hold input oroutput data temporarily.

byte A string that consists of a number of bits,treated as a unit, and representing acharacter. (T)

A binary character operated upon as aunit and usually shorter than a computerword. (A)

A string that consists of a particularnumber of bits, usually eight, that istreated as a unit, and that represents acharacter.

group of eight adjacent binary digits thatrepresent one extended binary-codeddecimal interchange code (EBCDIC)character.

C

central processor (CP)The part of the computer that contains thesequencing and processing facilities forinstruction execution, initial programload, and other machine operations.

central processor complex (CPC)The boundaries of a system, exclusive ofI/O control units and devices, that can becontrolled by a single operating system. ACPC consists of main storage, one ormore central processor units, time-of-day

clocks, and channels, which are or can beplaced in a single configuration. A CPCalso includes channel subsystems, serviceprocessors, and expanded storage whereinstalled.

changeAn alteration (addition, deletion, ormodification) of one or more informationsystem components, of one of thefollowing types: hardware (may includeinternal code), or software (system orapplication). The term change also refersto an SNA/File Services data objectcontaining internal code, internal codecustomizing data, software, softwarecustomizing data, applications data,procedures, or documentation.

channelA path along which signals can be sent,for example, input/output channel.

The system element that controls onechannel path, whose mode of operationdepends on the type of hardware towhich it is attached.

commandA character string from a source externalto a system that represents a request forsystem action.

A request from a terminal forperformance of an operation or executionof a program.

A value sent on an I/O interface from achannel to a control unit that specifies theoperation to be performed.

command retryA channel and control unit procedure thatcauses a command to be retried withoutrequiring an I/O interrupt.

Common Information Model (CIM)A systems management architecturedeveloped by the DistributedManagement Task Force.

componentHardware or software that is part of afunctional unit.

A functional part of an operating system;for example, the scheduler or supervisor.

configurationThe arrangement of a computer system ornetwork as defined by the nature,


number, and the chief characteristics of itsfunctional units. More specifically, theterm configuration may refer to ahardware configuration or a softwareconfiguration. (I) (A)

configureTo describe to the system the devices andoptional features installed on the system.

consoleA logical device used for communicationbetween the user and the system. (A)

coupling facilityA special logical partition that provideshigh-speed caching, list processing, andlocking functions in a sysplex.

coupling facility channelA high bandwidth fiber optic channel thatprovides the high-speed connectivityrequired for data sharing between acoupling facility and the central processorcomplexes directly attached to it.

CPC ImageThe set of CPC resources that support asingle control program.

D

defaultPertaining to an attribute, value, or optionthat is assumed when none is explicitlyspecified. (I)

degradedPertaining to a mode of operation inwhich the system operates with someresources not available.

Distributed Management Task Force (DMTF)A collaborative industry standardsorganization dedicated to creating andmanaging a systems managementarchitecture known as the CommonInformation Model (CIM).

E

elementA major part of a component (forexample, the buffer control element) or amajor part of a system (for example, thesystem control element).

enter An action that submits information to thecomputer for processing.

error The smallest detectable anomaly orexception that can occur in an information

system. Errors may be caused byhardware, software, internal code, media,or external causes, for example, people orenvironmental abnormalities.

error messageAn indication that an error has beendetected.

ESA Enterprise Systems Architecture.

ESA/390Enterprise Systems Architecture/390.

event An occurrence or happening.

An occurrence of significance to a task;for example, the completion of anasynchronous operation, such as aninput/output operation.

exchangeTo remove an item and put another in itsplace; for example, to remove afield-replaceable unit (FRU) and installanother of the same type.

extrinsic methodA method defined by a specific CIM classthat are invoked using the intrinsicInvokeMethod method. Examples includeCIM_ElementSettingData.RequestStateChange().See also Intrinsic Method.

F

facilityAn operational capability, or the meansfor providing such a capability. (T)

A service provided by an operatingsystem for a particular purpose; forexample, the checkpoint/restart facility.

failureAn uncorrected hardware error. Contrastwith error and fault.

Note: Failures are either recoverable ornot recoverable by the software or theoperator. The operator is always notifiedwhen failures occur. Usually, systemrecovery occurs through a hardwarereconfiguration. If this is not possible,recovery requires a repair of the failedhardware.

fault An accidental condition that causes afunctional unit to fail to perform itsrequired function. (I) (A) Contrast witherror and failure.

Glossary 247

featureA particular part of an IBM product thatcan be ordered separately.

function keyIn computer graphics, a button or switchthat may be operated to send a signal tothe computer program controlling thedisplay. (T)

A key that, when pressed, performs aspecified set of operations.

G

guest In interpretive execution mode, theinterpreted or virtual machine as opposedto the real machine (the host).

H

hard diskA rigid disk used in a hard disk drive.

hardwareThe equipment, as opposed to theprograms, of a computer system.

Hardware Management ConsoleA console used to monitor and controlhardware such as the System/390® andzSeries 900 processors.

Hardware Management Console Application(HWMCA)

A user customized, object-orientedgraphical user interface that provides asingle point of control for the system’shardware elements. The HWMCAprovides aggregated and individualreal-time system status via colors,consolidated hardware messages support,consolidated operating system messagessupport, consolidated service support,and hardware commands targeted at asingle system, multiple systems, or agroup of systems.

hexadecimalPertaining to a selection, choice, orcondition that has 16 possible values orstates. (I)

Pertaining to a fixed-radix numerationsystem, with radix of 16. (I)

Pertaining to a numbering system withbase of 16; valid numbers use the digits0–9 and characters A–F, where Arepresents 10 and F represents 15.

host The primary or controlling computer in amultiple computer installation.

host systemThe primary or controlling computer in anetwork.

I

IBM program support representativeAn IBM service representative whopreforms maintenance services for IBMLicensed Internal Code.

icon A pictorial representation of an object or aselection choice. Icons can representobjects that users want to work on oractions that users want to perform. Aunique icon also represents theapplication when it is minimized.

identifier (ID)One or more characters used to identifyor name a data element and possibly toindicate certain properties of that dataelement. (T)

A sequence of bits or characters thatidentifies a program, device, or system toanother program, device, or system.

initial machine load (IML)A procedure that prepares a device foruse.

initial program load (IPL)The initialization procedure that causes anoperating system to commence operation.

The process by which a configurationimage is loaded into storage at thebeginning of a work day or after a systemmalfunction.

The process of loading system programsand preparing a system to run jobs.

initializationThe operations required for setting adevice to a starting state, before the use ofa data medium, or before implementationof a process. (T)

Preparation of a system, device, orprogram for operation.

To set counters, switches, addresses,latches, or storage contents to zero or toother starting values at the beginning of,or at the prescribed points in, a computerprogram or process.


initializeTo prepare for use.

input Data to be processed.

input/output (I/O)Pertaining to a device whose parts canperform an input process and an outputprocess at the same time. (I)

Pertaining to a functional unit or channelinvolved in an input process, outputprocess, or both, concurrently or not, andto the data involved in such a process.

Pertaining to input, output, or both.

input/output configuration data set (IOCDS)The data set that contains an I/Oconfiguration definition built by the I/Oconfiguration program (IOCP).

interfaceA shared boundary between twofunctional units, defined by functionalcharacteristics, signal characteristics, orother characteristics as appropriate. Theconcept includes the specification of theconnection of two devices havingdifferent functions. (T)

Hardware, software, or both, that linkssystems, programs, or devices.

intrinsic methodA method defined by the CIMarchitecture that operate against instancesof any class. Examples includeEnumerateInstances(), GetInstance(),Associators() and InvokeMethod(). Seealso Extrinsic Method.

L

logical partitionA subset of the processor hardware that isdefined to support the operation of asystem control program (SCP). See alsologically partitioned (LPAR) mode.

logically partitioned (LPAR) modeA central processor complex (CPC)power-on reset mode that enables use ofthe PR/SM™ feature and allows anoperator to allocate CPC hardwareresources (including central processors,central storage, expanded storage, andchannel paths) among logical partitions.

loop A sequence of instructions that is to beexecuted iteratively (T)

A closed unidirectional signal pathconnecting input/output devices to asystem.

M

messageInformation sent to a user from aprogram or another user.

mode A method of operation.

MVS Multiple Virtual Storage.

MVS systemAn MVS image together with itsassociated hardware, which collectivelyare often referred to simply as a system,or MVS system.

N

networkAn arrangement of nodes and connectingbranches. (T)

A configuration of data processingdevices and software connected forinformation exchange.

node In a network, the point at which one ormore functional units connect channels ordata circuits. (I)

In a network topology, the point at theend of a branch. (T)

In SNA, an endpoint of a link, or ajunction common to two or more links ina network.

O

operandInformation entered with a commandname to define the data on which acommand processor operates and tocontrol the execution of the commandprocessor.

operateTo do a defined action, such as adding orcomparing, performed on one or moredata items.

operating system Software that controls the execution ofprograms and that may provide servicessuch as resource allocation, scheduling,input/output control, and datamanagement. Although operating systems

Glossary 249

are predominantly software, partialhardware implementations are possible.(T)

operations command facility (OCF)A facility of the central processor complexthat accepts and processes operationsmanagement commands.

outputData that has been processed.

P

panel A display of a list of available functionsfor selection by the operator.

parameterA variable that is given a constant valuefor a specified application and that maydenote the application. (I) (A)

An item in a menu for which the userspecifies a value or for which the systemprovides a value when the menu isinterpreted.

Data passed between programs orprocedures.

partitionSee logical partition.

passwordA value used in authentication or a valueused to establish membership in a set ofpeople having specific privileges.

A unique string of characters known tothe computer system, and to a user whomust specify it to gain full or limitedaccess to a system and to the informationstored within it.

pointerThe symbol displayed on the screen thatis moved by a pointing device, such as amouse. It is used to point at the objectsand actions users want to select.

power-on reset (POR)A function that reinitializes all thehardware in the system and loads theinternal code that enables the machine toload and run an operating system. Thisfunction is intended as a recoveryfunction.

problemAn error condition resulting in a loss ofavailability of a system resource to an enduser.

processing weightA relative value, ranging from 1 to 999,assigned to a partition of a systemrunning in logically partitioned mode. Itis used to calculate the share ofprocessing resource to be allocated to thatpartition.

processorIn a computer, a functional unit thatinterprets and executes instructions. Aprocessor consists of at least aninstruction control unit and an arithmeticand logic unit. (T)

The functional unit that interprets andexecutes instructions.

The boundaries of a system, exclusive ofI/O control units and devices, that can becontrolled by a single operating system. Aprocessor consists of main storage, one ormore central processors, time-of-dayclocks, and channels, which are, or can be,placed in a single configuration. Aprocessor also includes channelsubsystems, and expanded storage whereinstalled.

profileA description of the characteristics of anentity to which access is controlled.

Data that describes the significantcharacteristics of a user, a group of users,or one or more computer resources.

programSequence of instructions for a computer.A program interacts and relies on eitherthe hardware or other programs.

program status word (PSW)An area in storage used to indicate thesequence in which instructions areexecuted, and to hold and indicate thestatus of the computer system.

protocolA set of semantic and syntactic rules thatdetermines the behavior of functionalunits in achieving communication. (I)

In SNA, the meanings of and thesequencing rules for requests andresponses used for managing the network,transferring data, and synchronizing thestates of network components.


A specification for the format and relativetiming of information exchanged betweencommunicating parties.

push buttonA rounded-corner rectangle with textinside. Actions occur immediately whenthe push button is selected.

Q

quiesceTo bring a system or a device to a halt byrejecting new requests for work.

In a VTAM® application program, for onenode to stop another node from sendingsynchronous-flow messages.

R

registerA part of internal storage having aspecified storage capacity and usuallyintended for a specific purpose. (T)

remotePhysically distant. Pertains to a computeror device that is connected to anothercomputer or device over a communicationline. Contrast with local.

return codeA code used to influence the execution ofsucceeding instructions. (A)

A value returned to a program to indicatethe results of an operation requested bythat program.

S

S/370 System/370 mode.

schemaIn the Common Information Model(CIM), the object oriented framework ofclasses that provides a common definitionof systems and system components.

screen The physical surface of a workstation onwhich information is shown to users.

single point of controlThe characteristic a sysplex displays whenyou can accomplish a given set of tasksfrom a single workstation, even if youneed multiple IBM and vendor productsto accomplish that particular set of tasks.

single system imageThe characteristic a product displays

when multiple images of the product canbe viewed and managed as one image.

storageA functional unit into which data can beplaced, in which they can be retained, andfrom which they can be retrieved. (T)

The action of placing data into a storagedevice. (I) (A)

support elementAn internal control element of a processorthat assists in many of the processoroperational functions.

A hardware unit that providescommunications, monitoring, anddiagnostic functions to a central processorcomplex (CPC).

synchronousPertaining to two or more processes thatdepend o the occurrence of specificevents, such as common timing signals.(T)

Occurring with a regular or predictabletime relationship. Contrast withasynchronous.

systemComprises the processor complex and allattached and configured I/O andcommunication devices.

system resourceHardware, such as a central processor,I/O devices, channel paths, softwareprograms, or other components thatcontribute to system operation.

systems network architecture (SNA)SNA specifies how products connect andcommunicate with one another in anetwork. SNA is a design for a total datacommunication system, encompassingevery part of the communication networkfrom the user’s application program atthe central site to the terminal at a remotelocation possibly hundreds of miles away.SNA itself is not a system, but anarchitecture—a specified set of formatsand protocols to guide the design ofmachines and programs. The purpose ofSNA is to define uniform formats andprotocols for data communicationnetworks, which have traditionally been

Glossary 251

characterized by programs, devices, andcommunication techniques that often werenot compatible.

T

title barThe area at the top of each window thatcontains the window title and systemmenu icon. When appropriate, it alsocontains the minimize, maximize, andrestore icons.

token-ring networkA ring network that allows unidirectionaldata transmission between data stations,by a token passing procedure, such thatthe transmitted data return to thetransmitting station. (T)

Note: The IBM Token-Ring Network is abaseband LAN with a star-wired ringtopology that passes tokens from networkadapter to network adapter.

trap An unprogrammed conditional jump to aspecified address that is automaticallyactivated by hardware. A recording ismade of the location from which the jumpoccurred. (I)

A forced Licensed Internal Code branch,usually to an error routine.

U

user interfaceHardware, software, or both that allows auser to interact with and performoperations on a system, program, ordevice.

V

variableIn programming languages, a languageobject that may take different values, oneat a time. The values of a variable areusually restricted to a certain data type.(I)

A quantity that can assume any of a givenset of values. (A)

A name used to represent a data itemwhose value can be changed while theprogram is running.

W

windowAn area of the screen with visible

boundaries through which information isdisplayed. A window can be smaller thanor equal in size to the screen. Windowscan overlap on the screen and give theappearance of one window being on topof another

A choice in the action bar of someapplications. Users select it to arrange thedisplay of several windows or to changethe active window.

A choice in the action bar ofmultiple-document interface applications.

A choice in an action bar that allows theuser to arrange the display of all openwindows and to change the activewindow.

A choice in the action bar ofmultiple-document interface applicationsthat allows a user to arrange the displayof all open windows and to change theactive window.

work areaAn area reserved for temporary storage ofdata to be operated on.

workstationA functional unit at which a user works.A workstation often has some processingcapability. (T)

A terminal or microcomputer, usually onethat is connected to a mainframe ornetwork, at which a user can performapplications.


Index

Aaccessibility ix

contact IBM ixfeatures x

alert indications 191assistive technologies ixassociation class 30Association Classes 231associations 41authorization 8

BBoot Control 95boot setting data related classes 26

Ccapacity changes, enabling 4Central Processing Complex (CPC)

classes 43CIM Client Configuration 13CIM model descriptions 15CIM namespaces 13CIM Services 95CIM_AllocationCapabilities (FC Port

Pool) 174CIM_AllocationCapabilities (Processor

Setting Data) 148CIM_BootConfigSetting 124, 127CIM_BootService 95CIM_BootServiceCapabilities 99CIM_EnabledLogicalElementCapabilities

class 49, 68CIM_FCPort 175CIM_IndicationFilter 14CIM_IndicationSubscription 14CIM_IPProtocolEndpoint class 74CIM_ListenerDestinationCIMXML 14CIM_LogEntry 93CIM_Processor (Host) 182CIM_Processor (Virtual) 186CIM_Rack 50CIM_RedundancySet 58CIM_ResourcePool 172CIM_ResourcePoolConfiguration

Capabilities 116CIM_ResourcePoolConfiguration

Service 113CIM_SoftwareIdentity 77CIM_SystemSpecificCollection 80CIM_VirtualSystemManagement

Capabilities 121CIM_VirtualSystemManagement

Service 118class definitions 41Class relationships 31Common Information Model (CIM)

management architecture 1computer system related classes 15

Computer Systems 43CPC classes 43CPC relationships 31Customize Console Services window 2

DDistributed Management Task Force

(DMTF) 1DMTF 1DMTF schema 1

FFibre Channel logical devices 172

HHardware Management Console (HMC)

objects 82Hardware Management Console Settings

window 2, 3HMC User Configuration 4Host FC Ports 175

IIBMZ classes 195IBMZ_AuditLog 85, 195IBMZ_ComputerSystem 195IBMZ_CoordinatedTimingNetwork 53,

196IBMZ_CoordinatedTimingNetwork

Component 231IBMZ_CPC 198IBMZ_CPC class 43IBMZ_CPCBootSettingData 125, 200IBMZ_ElementSoftwareIdentity 232IBMZ_FCPortSettingData 158, 201IBMZ_GroupSettingData 202IBMZ_GroupSettingData (Recorded) 160IBMZ_GroupSettingData (State) 162IBMZ_HardwareManagementConsole 82,

203IBMZ_HardwareMessageLog 88, 203IBMZ_Image 203IBMZ_Image class 60IBMZ_ImageBootSettingData 129, 204IBMZ_ImageBootSourceSetting 130, 205IBMZ_ImageOperationsService 101, 206IBMZ_ImageSettingData 132, 135, 138,

214IBMZ_InstCreation 189, 216IBMZ_InstDeletion 190, 216IBMZ_InstModification 191, 217IBMZ_ManagedSE 233IBMZ_MemorySettingData 154, 156, 217IBMZ_OperatingSystem 65, 218IBMZ_OSMessage 191, 218

IBMZ_ProcessorOperationsService 110,219

IBMZ_ProcessorSettingData 141, 143,146, 150, 152, 219

IBMZ_ProcessorSettingData(Current) 146

IBMZ_ProcessorSettingData(Minimum/Maximum Recorded) 150

IBMZ_ProcessorSettingData(Minimum/Maximum State) 152

IBMZ_SecurityLog 90, 222IBMZ_Support Element 222IBMZ_TemporaryCapacityProcessor 167,

223IBMZ_TemporaryCapacityProcessor

Record 168, 224IBMZ_TemporaryCapacityRecord 164,

225IBMZ_TemporaryCapacityTarget 170,

229Image objects 60Image Operations 101indications 13, 189IPv4 and IPv6 sockets 13

Kkeyboard

navigation ix

Llifecycle indications 189logical device related classes 30logical devices 172

MManage Users Wizard task 4Managed Object Format 195Managed Object Format (MOF) syntax 2methods 42modification indications 191Modify User window 5MOF 2

Nnavigation

keyboard ix

Oobject oriented classes 1


PPort Number 13Processor operations 110properties 41

Rregistering for indications 14resource pool configuration 113Revisions x

Sservice related classes 24Services 95Setting data classes 123shortcut keys ixSSL (HTTPS) client connections 13Support Element (SE) objects 70Support Element classes 70

Ttarget authorization 8task authorization 10task authorization (HMC 2.13.0) 12TCP/IP address 13Temporary capacity 164

UUser and Password 13User Management task 6User Profiles window 4

Vvalue 41Virtual system management 118

Zz Systems or LinuxONE to CIM status

mappings 235


IBM®

Printed in USA

SB10-7165-01

CIM Management Interface

Documents

Transcript of CIM Management Interface