zhmcGetConsoleProperties function
zhmcGetConsoleProperties
zhmcGetConsoleProperties (hmcname)
Returns an RDL2 object containing the HMC console properties. The returned object contains properties as summarized in the following table. See the IBM System Z Hardware Management Console WebServices API document for complete details.
name | The name of the HMC |
description | The description of the HMC |
machine_info | An embedded object containing the machine_type, machine_serial and the machine_model |
is_auto_switch_enabled | A boolean indicating that automatic switching is enabled. |
version | The version number for the Console object |
ip_swapping_available | A boolean indicating if the current HMC IP address will be moved when making the alternate HMC the new primary. |
ec_mcl_description | An embedded object containing the Engineering Change and Microcode Level information. |
network-info | An embedded object containing the network information for the current HMC and it's paried_hmc. |
Parameters:
hmcname | The HMC session name. |
Returns:
An RDL2 object containing the properties, or false if there was an error.