Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 51 additions & 4 deletions docs/appendix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -527,6 +527,32 @@ Resources scoped to CPCs in DPM mode
Storage Port
Short term for a :term:`Port` of a :term:`Storage Adapter`.

Storage Site
A location that houses a set of storage switches and storage subsystems
within the FICON storage configuration of a DPM-enabled :term:`CPC`.
A Storage Site object with `type="primary"` always exists for the primary
site and cannot be deleted. Additional Storage Site objects can be created
and deleted.

For details, see section :ref:`Storage Sites`.

Storage Fabric
A collection of interconnected storage switches in the FICON storage
configuration of a DPM-enabled :term:`CPC`. A storage fabric can span
multiple :term:`Storage Sites <Storage Site>` and is the logical grouping
to which :term:`Storage Switches <Storage Switch>` belong.

For details, see section :ref:`Storage Fabrics`.

Storage Switch
A physical storage switch in the FICON storage configuration of a
DPM-enabled :term:`CPC`. A storage switch belongs to exactly one
:term:`Storage Site` and one :term:`Storage Fabric`, and can be moved
between sites and fabrics. Storage switches can be defined and undefined
via the :term:`Console`.

For details, see section :ref:`Storage Switches`.

Storage Volume
An FCP or ECKD (=FICON) storage volume defined in context of a
:term:`storage group`. The life cycle of a storage volume includes being
Expand All @@ -539,13 +565,34 @@ Resources scoped to CPCs in DPM mode

Storage Volume Template
A template for :term:`Storage Volumes <Storage Volume>`.

Tape library
Tape Library
A Tape Library represents one physical tape storage unit connected to
a CPC.Tape libraries are automatically discovered,but discovery requires
preprocessing,A single Worldwide Port Name (WWPN) must be zoned so the CPC
a CPC. Tape libraries are automatically discovered, but discovery requires
preprocessing. A single Worldwide Port Name (WWPN) must be zoned so the CPC
can see the tape library.
For details, see section :ref:`Tape Libraries`.
Tape Link
A Tape Link represents a single tape link associated with a DPM-enabled
:term:`CPC`. Tape links define pathways to :term:`Tape Library` storage
that can be attached to :term:`Partitions <Partition>`.

When a tape link is attached to a partition, its fulfilled resources are
virtualized and the partition's view of them is represented by
:term:`Virtual Tape Resources <Virtual Tape Resource>`.

Tape Link resources are top-level resources whose conceptual parent is
the :term:`Console`; a linked tape library is identified by the
``tape-library-uri`` property of the tape link.

For details, see section :ref:`Tape Links`.

Virtual Tape Resource
A representation of a tape-related z/Architecture device in a :term:`Partition`.
A Virtual Tape Resource object represents access to a tape drive through a
:term:`Tape Link`. Each virtual tape resource is associated with a specific
adapter port and provides the partition with a device number for accessing
the tape drive.
For details, see section :ref:`Virtual Tape Resources`.

vHBA
Synonym for :term:`HBA`. In this resource model, HBAs are always
Expand Down
100 changes: 100 additions & 0 deletions docs/resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,46 @@ Tape Libraries
:special-members: __str__


.. _`Tape Links`:

Tape Links
----------

.. automodule:: zhmcclient._tape_link

.. autoclass:: zhmcclient.TapeLinkManager
:members:
:autosummary:
:autosummary-inherited-members:
:special-members: __str__

.. autoclass:: zhmcclient.TapeLink
:members:
:autosummary:
:autosummary-inherited-members:
:special-members: __str__


.. _`Virtual Tape Resources`:

Virtual Tape Resources
----------------------

.. automodule:: zhmcclient._virtual_tape_resource

.. autoclass:: zhmcclient.VirtualTapeResourceManager
:members:
:autosummary:
:autosummary-inherited-members:
:special-members: __str__

.. autoclass:: zhmcclient.VirtualTapeResource
:members:
:autosummary:
:autosummary-inherited-members:
:special-members: __str__


.. _`Virtual Storage Resources`:

Virtual Storage Resources
Expand Down Expand Up @@ -418,6 +458,66 @@ Storage Volume Templates
:special-members: __str__


.. _`Storage Fabrics`:

Storage Fabrics
---------------

.. automodule:: zhmcclient._storage_fabric

.. autoclass:: zhmcclient.StorageFabricManager
:members:
:autosummary:
:autosummary-inherited-members:
:special-members: __str__

.. autoclass:: zhmcclient.StorageFabric
:members:
:autosummary:
:autosummary-inherited-members:
:special-members: __str__


.. _`Storage Sites`:

Storage Sites
-------------

.. automodule:: zhmcclient._storage_site

.. autoclass:: zhmcclient.StorageSiteManager
:members:
:autosummary:
:autosummary-inherited-members:
:special-members: __str__

.. autoclass:: zhmcclient.StorageSite
:members:
:autosummary:
:autosummary-inherited-members:
:special-members: __str__


.. _`Storage Switches`:

Storage Switches
----------------

.. automodule:: zhmcclient._storage_switch

.. autoclass:: zhmcclient.StorageSwitchManager
:members:
:autosummary:
:autosummary-inherited-members:
:special-members: __str__

.. autoclass:: zhmcclient.StorageSwitch
:members:
:autosummary:
:autosummary-inherited-members:
:special-members: __str__


.. _`Partition Links`:

Partition Links
Expand Down
64 changes: 64 additions & 0 deletions tests/end2end/mocked_hmc_z14.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -355,6 +355,70 @@ hmc_definition:
adapter-port-uri: /api/adapters/fcp1
partition-uri: /api/partitions/part1

storage_fabrics:
- properties:
# class: created automatically
# parent: created automatically
# object-uri: created automatically
object-id: sfabric1
name: "Storage Fabric A"
cpc-uri: /api/cpcs/cpc_dpm
description: "Primary storage fabric for CPC DPM"
high-integrity: false
- properties:
# class: created automatically
# parent: created automatically
# object-uri: created automatically
object-id: sfabric2
name: "Storage Fabric B"
cpc-uri: /api/cpcs/cpc_dpm
description: "Alternate storage fabric for CPC DPM"
high-integrity: true

storage_sites:
- properties:
# class: created automatically
# parent: created automatically
# object-uri: created automatically
object-id: ss1
name: Primary Site
description: Primary storage site local to the CPC
cpc-uris:
- /api/cpcs/cpc_dpm
- properties:
# class: created automatically
# parent: created automatically
# object-uri: created automatically
object-id: ss2
name: Alternate Site
description: Alternate storage site at a remote location
cpc-uris:
- /api/cpcs/cpc_dpm

storage_switches:
- properties:
# class: created automatically
# parent: created automatically
# object-uri: created automatically
object-id: sw1
name: "Storage switch 11"
domain-id: "11"
storage-fabric-uri: /api/storage-fabrics/sfabric1
storage-site-uri: /api/storage-sites/ss1
description: "Storage switch 11 on Fabric A at Primary Site"
port-count: 256
- properties:
# class: created automatically
# parent: created automatically
# object-uri: created automatically
object-id: sw2
name: "Storage switch 21"
domain-id: "21"
storage-fabric-uri: /api/storage-fabrics/sfabric2
storage-site-uri: /api/storage-sites/ss2
description: "Storage switch 21 on Fabric B at Alternate Site"
port-count: 256

hw_messages:
- properties:
# class: created automatically
Expand Down
Loading