resources.rst

Reference: Resources

This section describes the resource model supported by the zhmcclient package.

Note that the zhmcclient package supports only a subset of the resources described in the HMC API book. We will grow the implemented subset over time, and if you find that a particular resource you need is missing, please open an issue in the zhmcclient issue tracker.

See Resource model concepts for a description of the concepts used in representing the resource model.

The resource descriptions in this section do not detail the resource properties. The description of the resource properties of a particular HMC resource type can be found in its "Data model" section in the HMC API book. Each Python resource class mentions the corresponding HMC resource type.

The data types used in these "Data model" sections are represented in Python data types according to the mapping shown in the following table:

HMC API data type	Python data type
Boolean	py:bool
Byte, Integer, Long, Short	integer
Float	py:float
String, String Enum	unicode string
timestamp	integer
Array	py:list
Object	py:dict

CPCs

zhmcclient._cpc

zhmcclient.CpcManager

zhmcclient.Cpc

Unmanaged CPCs

zhmcclient._unmanaged_cpc

zhmcclient.UnmanagedCpcManager

zhmcclient.UnmanagedCpc

Activation profiles

zhmcclient._activation_profile

zhmcclient.ActivationProfileManager

zhmcclient.ActivationProfile

LPARs

zhmcclient._lpar

zhmcclient.LparManager

zhmcclient.Lpar

Partitions

zhmcclient._partition

zhmcclient.PartitionManager

zhmcclient.Partition

Adapters

zhmcclient._adapter

zhmcclient.AdapterManager

zhmcclient.Adapter

Ports

zhmcclient._port

zhmcclient.PortManager

zhmcclient.Port

NICs

zhmcclient._nic

zhmcclient.NicManager

zhmcclient.Nic

HBAs

zhmcclient._hba

zhmcclient.HbaManager

zhmcclient.Hba

Virtual Functions

zhmcclient._virtual_function

zhmcclient.VirtualFunctionManager

zhmcclient.VirtualFunction

Virtual Switches

zhmcclient._virtual_switch

zhmcclient.VirtualSwitchManager

zhmcclient.VirtualSwitch

Storage Groups

zhmcclient._storage_group

zhmcclient.StorageGroupManager

zhmcclient.StorageGroup

Storage Volumes

zhmcclient._storage_volume

zhmcclient.StorageVolumeManager

zhmcclient.StorageVolume

Virtual Storage Resources

zhmcclient._virtual_storage_resource

zhmcclient.VirtualStorageResourceManager

zhmcclient.VirtualStorageResource

Storage Group Templates

zhmcclient._storage_group_template

zhmcclient.StorageGroupTemplateManager

zhmcclient.StorageGroupTemplate

Storage Volume Templates

zhmcclient._storage_volume_template

zhmcclient.StorageVolumeTemplateManager

zhmcclient.StorageVolumeTemplate

Capacity Groups

zhmcclient._capacity_group

zhmcclient.CapacityGroupManager

zhmcclient.CapacityGroup

Console

zhmcclient._console

zhmcclient.ConsoleManager

zhmcclient.Console

User

zhmcclient._user

zhmcclient.UserManager

zhmcclient.User

User Role

zhmcclient._user_role

zhmcclient.UserRoleManager

zhmcclient.UserRole

User Pattern

zhmcclient._user_pattern

zhmcclient.UserPatternManager

zhmcclient.UserPattern

Password Rule

zhmcclient._password_rule

zhmcclient.PasswordRuleManager

zhmcclient.PasswordRule

Task

zhmcclient._task

zhmcclient.TaskManager

zhmcclient.Task

LDAP Server Definition

zhmcclient._ldap_server_definition

zhmcclient.LdapServerDefinitionManager

zhmcclient.LdapServerDefinition