.. Copyright 2016-2017 IBM Corp. All Rights Reserved. .. .. Licensed under the Apache License, Version 2.0 (the "License"); .. you may not use this file except in compliance with the License. .. You may obtain a copy of the License at .. .. http://www.apache.org/licenses/LICENSE-2.0 .. .. Unless required by applicable law or agreed to in writing, software .. distributed under the License is distributed on an "AS IS" BASIS, .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .. See the License for the specific language governing permissions and .. limitations under the License. .. .. _`Appendix`: Appendix ======== This section contains information that is referenced from other sections, and that does not really need to be read in sequence. .. _`BaseManager`: .. _`BaseResource`: .. _`Base classes for resources`: Base classes for resources -------------------------- .. automodule:: zhmcclient._manager .. autoclass:: zhmcclient.BaseManager :members: :special-members: __str__ .. automodule:: zhmcclient._resource .. autoclass:: zhmcclient.BaseResource :members: :special-members: __str__ .. _`Glossary`: Glossary -------- This documentation uses a few special terms: .. glossary:: HMC Hardware Management Console; the node the zhmcclient talks to. session-id an opaque string returned by the HMC as the result of a successful logon, for use by subsequent operations instead of credential data. The HMC gives each newly created session-id a lifetime of 10 hours, and expires it after that. .. _`Special type names`: Special type names ------------------ This documentation uses a few special terms to refer to Python types: .. glossary:: string a :term:`unicode string` or a :term:`byte string` unicode string a Unicode string type (:func:`unicode ` in Python 2, and :class:`py3:str` in Python 3) byte string a byte string type (:class:`py2:str` in Python 2, and :class:`py3:bytes` in Python 3). Unless otherwise indicated, byte strings in this package are always UTF-8 encoded. number one of the number types :class:`py:int`, :class:`py2:long` (Python 2 only), or :class:`py:float`. integer one of the integer types :class:`py:int` or :class:`py2:long` (Python 2 only). timestamp a Timestamp-typed value as used in the HMC API. This is a non-negative :term:`integer` value representing a point in time as milliseconds since the UNIX epoch (1970-01-01 00:00:00 UTC), or the value -1 to indicate special treatment of the value. json object a :class:`py:dict` object that is a Python representation of a valid JSON object. See :ref:`py:py-to-json-table` for details. header dict a :class:`py:dict` object that specifies HTTP header fields, as follows: * `key` (:term:`string`): Name of the header field, in any lexical case. Dictionary key lookup is case sensitive, however. * `value` (:term:`string`): Value of the header field. callable a type for callable objects (e.g. a function, calling a class returns a new instance, instances are callable if they have a :meth:`~py:object.__call__` method). DeprecationWarning a standard Python warning that indicates the use of deprecated functionality. See section :ref:`Deprecations` for details. HMC API version an HMC API version, as a tuple of (api_major_version, api_minor_version), where: * `api_major_version` (:term:`integer`): The numeric major version of the HMC API. * `api_minor_version` (:term:`integer`): The numeric minor version of the HMC API. .. _`Resource model`: Resource model -------------- This section lists the resources that are available at the :term:`HMC API`. The term *resource* in this documentation is used to denote a managed object in the system. The result of retrieving a resource through the HMC API is termed a *resource representation*. Python classes for resources are termed to *represent* a resource. For resources within a :term:`CPC`, this section covers CPCs in DPM mode and classic mode, but omits any resources that are available only in ensemble mode. See section :ref:`CPCs` for a definition of the CPC modes. Some of the items in this section are qualified as *short terms*. They are not separate types of resources, but specific usages of resources. For example, "storage adapter" is a short term for the resource "adapter" when used for attaching storage. Resources scoped to the HMC ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. glossary:: Console The HMC itself. Group TBD - Not yet supported. Hardware Message TBD - Not yet supported. Also scoped to CPCs in any mode. Job The execution of an asynchronous HMC operation. LDAP Server Definition The information in an HMC about an LDAP server that may be used for HMC user authorization purposes. Metrics Context A user-created definition of metrics that can be retrieved. Password Rule A rule which HMC users need to follow when creating a HMC logon password. Session A session between a client of the HMC API and the HMC. Task An action that an HMC user with appropriate authority can perform. User An HMC user. User Pattern A pattern for HMC user IDs that are not defined on the HMC as users but can be verified by an LDAP server for user authentication. User Role An authority role which can be assigned to one or more HMC users. Resources scoped to CPCs in any mode ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. glossary:: Capacity Record TBD - Not yet supported. CPC Central Processor Complex, a physical IBM Z or LinuxONE computer. For details, see section :ref:`CPCs`. Resources scoped to CPCs in DPM mode ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. glossary:: Accelerator Adapter Short term for an :term:`Adapter` providing accelerator functions (e.g. the z Systems Enterprise Data Compression (zEDC) adapter for data compression). Adapter A physical adapter card (e.g. OSA-Express adapter, Crypto adapter) or a logical adapter (e.g. HiperSockets switch). For details, see section :ref:`Adapters`. Adapter Port Synonym for :term:`Port`. Capacity Group TBD - Not yet supported. Crypto Adapter Short term for an :term:`Adapter` providing cryptographic functions. FCP Adapter Short term for a :term:`Storage Adapter` supporting FCP (Fibre Channel Protocol). FCP Port Short term for a :term:`Port` of an :term:`FCP Adapter`. HBA A logical entity that provides a :term:`Partition` with access to external storage area networks (SANs) through an :term:`FCP Adapter`. For details, see section :ref:`HBAs`. Network Adapter Short term for an :term:`Adapter` for attaching networks (e.g. OSA-Express adapter). Network Port Short term for a :term:`Port` of a :term:`Network Adapter`. NIC Network Interface Card, a logical entity that provides a :term:`Partition` with access to external communication networks through a :term:`Network Adapter`. For details, see section :ref:`NICs`. Partition A subset of the hardware resources of a :term:`CPC` in DPM mode, virtualized as a separate computer. For details, see section :ref:`Partitions`. Port The physical connector port (jack) of an :term:`Adapter`. For details, see section :ref:`Ports`. Storage Adapter Short term for an :term:`Adapter` for attaching storage. Storage Port Short term for a :term:`Port` of a :term:`Storage Adapter`. vHBA Synonym for :term:`HBA`. In this resource model, HBAs are always virtualized because they belong to a :term:`Partition`. Therefore, the terms vHBA and HBA can be used interchangeably. Virtual Function A logical entity that provides a :term:`Partition` with access to an :term:`Accelerator Adapter`. For details, see section :ref:`Virtual functions`. Virtual Switch A virtualized networking switch connecting :term:`NICs ` with a :term:`Network Port`. For details, see section :ref:`Virtual switches`. vNIC Synonym for :term:`NIC`. In this resource model, NICs are always virtualized because they belong to a :term:`Partition`. Therefore, the terms vNIC and NIC can be used interchangeably. Resources scoped to CPCs in classic (and ensemble) mode ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. glossary:: Activation Profile A general term for specific types of activation profiles: * :term:`Reset Activation Profile` * :term:`Image Activation Profile` * :term:`Load Activation Profile` Group Profile TBD Image Activation Profile A specific :term:`Activation Profile` that defines characteristics of an :term:`LPAR`. Load Activation Profile A specific :term:`Activation Profile` that defines an operating system image that can be loaded (booted) into an :term:`LPAR`. Logical Partition LPAR A subset of the hardware resources of a :term:`CPC` in classic mode (or ensemble mode), virtualized as a separate computer. For details, see section :ref:`LPARs`. Reset Activation Profile A specific :term:`Activation Profile` that defines characteristics of a :term:`CPC`. .. _`Bibliography`: Bibliography ------------ .. glossary:: X.509 `ITU-T X.509, Information technology - Open Systems Interconnection - The Directory: Public-key and attribute certificate frameworks `_ RFC2616 `IETF RFC2616, Hypertext Transfer Protocol - HTTP/1.1, June 1999 `_ RFC2617 `IETF RFC2617, HTTP Authentication: Basic and Digest Access Authentication, June 1999 `_ RFC3986 `IETF RFC3986, Uniform Resource Identifier (URI): Generic Syntax, January 2005 `_ RFC6874 `IETF RFC6874, Representing IPv6 Zone Identifiers in Address Literals and Uniform Resource Identifiers, February 2013 `_ HMC API The Web Services API of the z Systems Hardware Management Console, described in the following books: HMC API 2.11.1 `IBM SC27-2616, z Systems Hardware Management Console Web Services API (Version 2.11.1) `_ HMC API 2.12.0 `IBM SC27-2617, z Systems Hardware Management Console Web Services API (Version 2.12.0) `_ HMC API 2.12.1 `IBM SC27-2626, z Systems Hardware Management Console Web Services API (Version 2.12.1) `_ HMC API 2.13.0 `IBM SC27-2627, z Systems Hardware Management Console Web Services API (Version 2.13.0) `_ HMC API 2.13.1 `IBM SC27-2634, z Systems Hardware Management Console Web Services API (Version 2.13.1) `_ HMC API 2.14.0 `IBM SC27-2636, z Systems Hardware Management Console Web Services API (Version 2.14.0) `_ HMC Operations Guide The operations guide of the z Systems Hardware Management Console, described in the following books: HMC Operations Guide 2.11.1 `IBM SC28-6905, System z Hardware Management Console Operations Guide (Version 2.11.1) `_ HMC Operations Guide 2.13.1 `IBM z Systems Hardware Management Console Operations Guide (Version 2.13.1) `_ KVM for IBM z Systems V1.1.2 System Administration `IBM SC27-8237, KVM for IBM z Systems V1.1.2 System Administration `_ .. _`Related projects`: Related projects ---------------- .. glossary:: zhmccli project `zhmccli project at GitHub `_ zhmccli package `zhmccli package on Pypi `_ .. include:: changes.rst