zhmcGetLparProperties function


zhmcGetLparProperties

zhmcGetLparProperties (hmcname, lpar)

Gets the complete set of properties for an LPAR. The available properties are summarized in the table below.

name

The LPAR name.

description

The LPAR description.

status

The current status.

acceptable_status

An array of acceptable status.

partition_number

The partition number.

partition_identifier

The partition ID

has_unacceptable_status

Boolean, true if the current status is not one of the acceptable statuses/

os_name

The operating system name.

os_type

The operating system type.

os_level

The operating system level.

sysplex_name

The sysplex of which this LPAR is a member.

has_operating_system_messages

Boolean indicating that operating system messages are present.

activation_mode

The current activation mode.

next_activation_profile_name

The name of the activation profile to be used for the next activate.

last_used_activation_profile

The last used activation profile name.

initial_processing_weight

The initial processing weight for the general purpose processors.

initial_processing_weight_capped

true if the general purpose initial processor weight is capped, false if not.

minimum_processing_weight

The minimum weight for the general general purpose processors.

maximum_processing_weight

The maximum weight for the general general purpose processors.

current_processing_weight

The current weight for the general general purpose processors.

current_processing_weight_capped

Indicates that the current general purpose processor weight is a limit or a target.

workload_manager_enabled

Indicates that the z/OS Workload Manager is allowed to change processing weight properties.

defined_capacity

The defined capacity in MSUs

cluster_name

The cluster name.

initial_aap_processing_weight

The initial processing weight for the Application Assist (zAAP) Processors.

initial_aap_processing_weight_capped

true if the the Application Assist Processor initial processor weight is capped, false if not.

minimum_aap_processing_weight

The minimum weight for the zAAP processors.

maximum_aap_processing_weight

The maximum weight for the zAAP processors.

current_aap_processing_weight

The current weight for the zAAP processors.

current_aap_processing_weight_capped

Indicates that the current zAAP processor weight is a limit or a target.

initial_ifl_processing_weight

The initial processing weight for the Integrated Facility for Linux (IFL) processors.

initial_ifl_processing_weight_capped

true if the the IFL initial processor weight is capped, false if not.

minimum_ifl_processing_weight

The minimum weight for the IFL processors.

maximum_ifl_processing_weight

The maximum weight for the IFL processors.

current_ifl_processing_weight

The current weight for the IFL processors.

current_ifl_processing_weight_capped

Indicates that the current IFL processor weight is a limit or a target.

initial_ziip_processing_weight

The initial processing weight for the Integrated Information Processors (zIIP).

initial_ziip_processing_weight_capped

true if the the zIIP initial processor weight is capped, false if not.

minimum_ziip_processing_weight

The minimum weight for the zIIP processors.

maximum_ziip_processing_weight

The maximum weight for the zIIP processors.

current_ziip_processing_weight

The current weight for the zIIP processors.

current_ziip_processing_weight_capped

Indicates that the current zIIP processor weight is a limit or a target.

initial_cf_processing_weight

The initial processing weight for the Internal Coupling Facility (ICF) processors.

initial_cf_processing_weight_capped

true if the the ICF initial processor weight is capped, false if not.

minimum_cf_processing_weight

The minimum weight for the ICF processors.

maximum_cf_processing_weight

The maximum weight for the ICF processors.

current_cf_processing_weight

The current weight for the ICF processors.

current_cf_processing_weight_capped

Indicates that the current ICF processor weight is a limit or a target.

is_locked

Indicates that the LPAR is locked and disruptive actions may not be performed on it.

program_status_word_information

Contains an array of PSW information for each CP.

os_ipl_token

The IPL token associated with a z/OS LPAR.

group_profile_capacity

The current capacity value of the Group Profile.

Parameters:

hmcname

The HMC session name.

lpar

An LPAR object as returned from zhmcGetLpars()

Returns:

An object containing the LPAR properties, or false if the operation failed.

Example

cpc = getCpc(hmc, 'BBL1')
lpars = zhmcGetLpars(hmc, cpc)
do i = 0 to lpars.size() - 1
lparprops = zhmcGetLparProperties(hmc, lpars[i])
if lparprops != false then
if lparprops.status != 'operating' then
trace('LPAR ' & lpar[i].name & ' is not operating', RED)
endif
else
trace('LPAR Properties error: ' & hmcGetLastError(), RED)
endif
end

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*