IODF object class definitions within LDAP
The following tables describe the object classes which are used
for the HCD LDAP DIT. In addition to other information, they contain
the names of the attributes of each object class. The required attributes
(shown in the row 'Must Contain') must be specified when adding an
object of that class. Their values cannot be deleted. Optional attributes
(shown in the row 'May Contain') may not always be required. They
may, however, be necessary for certain objects according to HCD configuration
rules. Attributes which are used to build the RDN of an object must
not be modified for the corresponding object class.
The row 'Supported Requests' contains information about which operations
are possible on entries of the corresponding object class. There are
some object classes which do not allow all contained (non-RDN) attributes
to be added (because they are read-only attributes) or modified. In
this case, the list of attributes which may be modified is specified
in the 'Supported Requests' row in parentheses after the MODIFY identifier.
Note:
For certain entries, there may be restrictions to
this general description as a result of HCD configuration rules.
The following rules apply for update requests on control unit and
device object classes:
1. Control Unit
The general attributes of a specific control unit exist in an appropriate
entry in class hcdControlUnit. For each connected processor,
the processor related attributes of that control unit are contained
in an entry of class hcdCssControlUnit. Hence, as a result
of this relation, an entry can only be added to class hcdCssControlUnit if
the corresponding entry in class hcdControlUnit is already
present. Likewise, if an entry of class hcdControlUnit is
deleted, all the entries for the corresponding control unit in class hcdCssControlUnit will
implicitly also be deleted.
2. Devices
Similar to the control units, the general attributes of a specific
device exist in an entry of class hcdDevice and may additionally
exist in entries of classes hcdCssDevice and hcdOsDevice.
The device attributes relating a device to a particular processor
are contained in a corresponding entry of class hcdCssDevice.
Such an entry can only exist if an entry for the device in class hcdDevice also
exists and the device is connected to a control unit defined via,
both an entry in the class hcdControlUnit, and an entry
in class hcdCssControlUnit. This dependency means that
it is not possible to explicitly add or delete an entry of class hcdCssDevice directly.
Instead, an entry of class hcdCssDevice will be implicitly
added if:
- A control unit defined in an hcdControlUnit entry that
has the particular device attached to it is defined also as an entry
in class hcdCssControlUnit.
- An entry in class hcdDevice is created containing the
attribute hcdConnControlUnits with a control unit number
of an hcdControlUnit entry that also has a corresponding hcdCssControlUnit entry
defined.
Implicitly added entries of class hcdCssDevice initially
have default attribute values. These attributes can be modified to
get their proper values.
An entry of class hcdCssDevice will be implicitly deleted
if:
- The entry in corresponding class hcdDevice is deleted,
or
- The connected control units in class hcdCssControlUnit are deleted,
or
- The connected control units in class hcdControlUnit are deleted.
Changes to the attributes of control unit and device entries may
affect all corresponding entries in the same logical control unit
of a processor configuration, i.e. all entries of classes hcdCssControlUnit and hcdCssDevice with
the same value of the attribute hcdLogicalControlUnit.
In such a case, it may be necessary to delete all entries belonging
to the same logical control unit and add them again with the changed
attributes. This should be done using the update sequence in transaction
mode.
For each operating system configuration, the operating system related
device attributes are contained in a corresponding entry in class hcdOsDevice.
An entry in class hcdOsDevice can only exist if the corresponding
entry in class hcdDevice also exists. An entry in class hcdOsDevice can
be explicitly added or deleted. This means that the device is connected
to or disconnected from the operating system configuration. An entry
in class hcdOsDevice is implicitly deleted if the corresponding
entry in class hcdDevice is deleted.
If a device entry in class hcdDevice is added which
has the same RDN attribute (hcdDeviceNumber) value of an
existing entry in that class, HCD assigns a non-zero suffix to the
device number (RDN attribute hcdDeviceSuffix) to make the
RDN unique. The attribute hcdDeviceSuffix cannot be specified
with an add request. If the value of attribute hcdDeviceSuffix is
0000, it need not be specified in the RDN, as this is the default
value. If the value of the attribute hcdDeviceSuffix is
not equal to 0000, it has to be specified in the RDN of the MODIFY
and DELETE requests for the corresponding device entry. Therefore,
the complete device RDN has to be retrieved via a preceding search
request in order to be able to specify the correct RDN of a device
entry.
Note:
To facilitate the search of the correct hcdDeviceSuffix of
devices in a device group, you can specify an LDAP search request
for a specific device number, but without device suffix, or with device
suffix 0000. Such a request will return all device entries with the
same device number with its different device suffixes. From the returned
entries, you can retrieve the suffix for the device that you now can
modify or delete with a subsequent request.
| Class | hcdChannelPath |
|---|
| Description | Describes a channel path of the processor configuration | | Type | structural | | Derived from | top | | Auxiliary Classes | | | Possible Superiors | hcdProcessorConfig | | Must Contain | hcdChannelPathId, hcdChannelPathType, hcdOperationMode, objectClass | | May Contain | hcdDescription, hcdDynSwitch, hcdConnChannelPath, hcdAccessingPartitions,
hcdCandidatePartitions, hcdConnPort, hcdIsOccupied, hcdIsManaged,
hcdSysplex, hcdMaximumFrameSize, hcdSpanningChannelSubsystems, hcdPhysicalChannelId,
hcdHasPrioQueuesDisabled, hcdHcaAdapterId, hcdHcaPort,
hcdChannelFunction,hcdPhysicalNetworkIds | | Supported Requests |
SEARCH
ADD
MODIFY
DELETE
| | Special Notes |
Attribute hcdIsOccupied is only shown if set to Yes.
Attribute hcdSpanningChannelSubsystems is output only.
A
spanned channel path is added/modified in one channel subsystem while
specifying partitions from more than one channel subsystem. It can
be defined with operation mode SHR or SPAN.
Attribute
hcdHasPrioQueuesDisabled is only shown if applicable. |
| Class | hcdControlUnit |
|---|
| Description | Describes a control unit | | Type | structural | | Derived from | top | | Auxiliary Classes | | | Possible Superiors | hcdIodf | | Must Contain | hcdControlUnitNumber, hcdUnit, objectClass | | May Contain | hcdDescription, hcdModel, hcdSerialNumber, hcdConnPorts | | Supported Requests |
|
| Class | hcdCssControlUnit |
|---|
| Description | Describes a control unit from the Channel Subsystem viewpoint | | Type | structural | | Derived from | top | | Auxiliary Classes | | | Possible Superiors | hcdProcessorConfig | | Must Contain | hcdControlUnitNumber, hcdConnChannelPaths, objectClass | | May Contain | hcdUnitAddressRanges, hcdControlUnitAddress, hcdIOConcurrencyLevel,
hcdControlUnitProtocol, hcdLogicalControlUnit, hcdManagedChannelPathsCount | | Supported Requests |
- SEARCH
- ADD (requires the existence of an object in class hcdControlUnit
with same RDN)
- MODIFY (hcdConnChannelPaths, hcdUnitAddressRanges, hcdControlUnitAddress,
hcdIOConcurrencyLevel, hcdControlUnitProtocol, hcdManagedChannelPathsCount)
- DELETE
|
| Class | hcdCssDevice |
|---|
| Description | Describes a device from the Channel Subsystem viewpoint | | Type | structural | | Derived from | top | | Auxiliary Classes | | | Possible Superiors | hcdProcessorConfig | | Must Contain | hcdDeviceNumber, objectClass | | May Contain | hcdDeviceSuffix, hcdDeviceRange, hcdUnitAddress, hcdStatusDetection,
hcdTimeOut, hcdPreferredChannelPath, hcdCandidatePartitions, hcdLogicalControlUnit, hcdSubchannelSetId | | Supported Requests |
- SEARCH
- MODIFY (hcdDeviceRange, hcdUnitAddress, hcdStatusDetection, hcdTimeOut,
hcdPreferredChannelPath, hcdCandidatePartitions)
| | Special Notes | For a MODIFY request, hcdDeviceRange specifies the number of
devices to which the request will be applied. |
| Class | hcdDevice |
|---|
| Description | Describes an I/O device | | Type | structural | | Derived from | top | | Auxiliary Classes | | | Possible Superiors | hcdIodf | | Must Contain | hcdDeviceNumber, hcdUnit, objectClass | | May Contain | hcdDescription, hcdModel, hcdDeviceSuffix, hcdDeviceRange,
hcdSerialNumber, hcdVolser, hcdConnControlUnits, hcdDevicePprcUsage | | Supported Requests |
- SEARCH
- ADD
- MODIFY (hcdDeviceRange, hcdUnit, hcdDescription, hcdModel, hcdSerialNumber,
hcdVolser, hcdConnControlUnits)
- DELETE
| | Special Notes | For ADD and MODIFY requests,
hcdDeviceRange specifies the
number of devices to which the request will be applied. |
| Class | hcdDistPackage |
|---|
| Description | Describes a distribution package of I/O configurations | | Type | structural | | Derived from | top | | Auxiliary Classes | | | Possible Superiors | hcdIodf | | Must Contain | hcdDistPackageId, objectClass | | May Contain | hcdDescription, hcdTargetNode, hcdTargetUser, hcdIsAttended,
hcdTargetIodf, hcdTargetVolser, hcdSentDate, hcdSentTime, hcdOsConfigs,
hcdProcessorConfigs | | Supported Requests |
- SEARCH
- ADD
- MODIFY (hcdDescription, hcdTargetNode, hcdTargetUser, hcdIsAttended,
hcdTargetIodf, hcdTargetVolser, hcdOsConfigs, hcdProcessorConfigs)
- DELETE
|
| Class | hcdEligibleDeviceTable |
|---|
| Description | Describes an Eligible Device Table of an OS configuration | | Type | structural | | Derived from | top | | Auxiliary Classes | | | Possible Superiors | hcdOsConfig | | Must Contain | hcdEligibleDeviceTableId, objectClass | | May Contain | hcdDescription, hcdLastUpdateDate, hcdUpdatedBy | | Supported Requests |
- SEARCH
- ADD
- MODIFY (hcdDescription)
- DELETE
|
| Class | hcdEsotericDeviceGroup |
|---|
| Description | Describes an esoteric device group of an EDT of an OS configuration | | Type | structural | | Derived from | top | | Auxiliary Classes | | | Possible Superiors | hcdEligibleDeviceTable | | Must Contain | hcdEsotericDeviceGroupId, objectClass | | May Contain | hcdEsotericDeviceGroupToken, hcdVirtualIO, hcdDeviceRanges | | Supported Requests |
| | Special Notes |
Attribute hcdVirtualIO is only shown if set to Yes. |
| Class | hcdGenericDeviceType |
|---|
| Description | Describes an update to a generic device type for an EDT of
an OS configuration | | Type | structural | | Derived from | top | | Auxiliary Classes | | | Possible Superiors | hcdEligibleDeviceTable | | Must Contain | hcdGenericDeviceTypeId, objectClass | | May Contain | hcdDevicePreferenceValue, hcdVirtualIO | | Supported Requests |
| | Special Notes | Entries of class hcdGenericDeviceType are implicitly added
when the first device entry with the corresponding generic device
type is added in class hcdOsDevice.
An entry of this class is deleted,
if the last device with the corresponding generic device type is deleted
from class hcdOsDevice.
Attribute hcdVirtualIO is only shown
if set to Yes. |
| Class | hcdIocds |
|---|
| Description | Describes an IOCDS of a processor configuration | | Type | structural | | Derived from | top | | Auxiliary Classes | | | Possible Superiors | hcdProcessorConfig | | Must Contain | hcdIocdsId, objectClass | | May Contain | hcdIocdsName, hcdLastUpdateDate, hcdLastUpdateTime, hcdProcessorConfigMode | | Supported Requests |
| | Special Notes | Entries in this class are implicitly added when an entry in
class hcdProcessorConfig is added. Entries in this class are implicitly
deleted if the appropriate entry in class hcdProcessorConfig is deleted. |
| Class | hcdIodf |
|---|
| Description | Describes the I/O configurations defined in an IODF | | Type | structural | | Derived from | top | | Auxiliary Classes | | | Possible Superiors | | | Must Contain | hcdIodfId, objectClass | | May Contain | hcdIodfType, hcdIodfDescription, hcdBackupIodf, hcdBlocksAllocated,
hcdBlocksUsed, hcdCreationDate, hcdLastUpdateDate, hcdLastUpdateTime,
hcdToken (output only) | | Supported Requests |
- SEARCH
- MODIFY (hcdIodfDescription)
| | Special Notes | Entries of this class cannot be added or deleted with the HCD
LDAP Backend. |
| Class | hcdOsConfig |
|---|
| Description | Describes an OS configuration | | Type | structural | | Derived from | top | | Auxiliary Classes | | | Possible Superiors | hcdIodf | | Must Contain | hcdOSConfigId, hcdOSConfigType, objectClass | | May Contain | hcdDescription, hcdOSDrSiteConfigId | | Supported Requests |
- SEARCH
- ADD
- MODIFY (hcdDescription)
- DELETE
|
| Class | hcdOsDevice |
|---|
| Description | Describes an I/O device from the OS viewpoint | | Type | structural | | Derived from | top | | Auxiliary Classes | | | Possible Superiors | hcdOsConfig | | Must Contain | hcdDeviceNumber, hcdUnit, objectClass | | May Contain | hcdDeviceSuffix, hcdDeviceRange, hcdModel, hcdGenericDeviceTypeId
hcdDeviceParameters, hcdDeviceFeatures, hcdConsoleNumber, hcdSubchannelSetId | | Supported Requests |
- SEARCH
- ADD (requires the existence of an object in class hcdDevice with
the same RDN)
- MODIFY (hcdDeviceRange, hcdDeviceParameters, hcdDeviceFeatures,
hcdConsoleNumber)
- DELETE
| | Special Notes | For ADD and MODIFY requests, hcdDeviceRange specifies the number
of devices to which the request will be applied. |
| Class | hcdPartition |
|---|
| Description | Describes a logical partition (LP) of a processor configuration | | Type | structural | | Derived from | top | | Auxiliary Classes | | | Possible Superiors | hcdProcessorConfig | | Must Contain | hcdPartitionId, objectClass | | May Contain | hcdDescription, hcdPartitionNumber, hcdPartitionUsage | | Supported Requests |
| | Special Notes | You can use the hcdPartitionNumber attribute to identify a
reserved partition. |
| Class | hcdPCIeFunction |
|---|
| Description | Describes a PCIe function of a processor configuration | | Type | structural | | Derived from | top | | Auxiliary Classes | | | Possible Superiors | hcdProcessorConfig | | Must Contain | hcdPCIeFunctionId, objectClass, | | May Contain | hcdPCIeFunctionType, hcdDescription,
hcdAccessingPartitions, hcdCandidatePartitions, hcdPhysicalChannelId, hcdVirtualFunctionNum, hcdPhysicalNetworkIds | | Supported Requests |
|
| Class | hcdPort |
|---|
| Description | Describes a port of an ESCON director | | Type | structural | | Derived from | top | | Auxiliary Classes | | | Possible Superiors | hcdSwitch | | Must Contain | hcdPortId, objectClass | | May Contain | hcdPortName, hcdIsOccupied, hcdIsInstalled, hcdConnPort | | Supported Requests |
| | Special Notes | Attribute hcdIsOccupied is only shown if set to Yes.
Entries
of this class are implicitly added or deleted if the corresponding
switch entry in class hcdSwitch is added or deleted, respectively. |
| Class | hcdPortConfig |
|---|
| Description | Describes a port configuration of a switch configuration | | Type | structural | | Derived from | top | | Auxiliary Classes | | | Possible Superiors | hcdSwitchConfig | | Must Contain | hcdPortId, objectClass | | May Contain | hcdAllowedDynConnPorts, hcdProhibitedDynConnPorts, hcdDedicatedPort,
hcdIsBlocked | | Supported Requests |
| | Special Notes | Entries in this class are implicitly added or deleted if the
corresponding entry in class hcdSwitchConfig is added or deleted,
respectively. |
| Class | hcdProcessorConfig |
|---|
| Description | Describes a processor configuration or, if it
is identified by an RDN of the form hcdProcessorConfigId+CssId, it
describes a channel subsystem of an XMP processor. | | Type | structural | | Derived from | top | | Auxiliary Classes | | | Possible Superiors | hcdIodf | | Must Contain | hcdProcessorConfigId, hcdUnit, hcdProcessorConfigMode, objectClass | | May Contain | hcdModel, hcdDescription, hcdSerialNumber, hcdNetworkName,
hcdSystem, hcdSupportLevel, hcdCssId, hcdSetZeroMaxDevices, hcdSetOneMaxDevices,
hcdSetTwoMaxDevices, hcdLocalSystemName, hcdToken (output only) | | Supported Requests |
| | Special Notes | Adding a channel subsystem requires that the processor configuration
has already been added.
To add, change or delete a channel
subsystem, an RDN consisting of hcdProcessorConfigId+hcdCssId has
to be used. The only applicable further attributes for a channel subsystem
are hcdDescription, hcdSetZeroMaxDevices, hcdSetOneMaxDevices, and hcdSetTwoMaxDevices.
The values of the required parameters hcdUnit and hcdProcessorConfigMode are ignored. |
| Class | hcdSwitch |
|---|
| Description | Describes a switch (ESCON or FICON Director or Fibre
Channel switch) | | Type | structural | | Derived from | top | | Auxiliary Classes | | | Possible Superiors | hcdIodf | | Must Contain | hcdSwitchId, hcdUnit, objectClass | | May Contain | hcdDescription, hcdModel, hcdSerialNumber, hcdSwitchAddress | | Supported Requests |
|
| Class | hcdSwitchConfig |
|---|
| Description | Describes a configuration of an ESCON Director | | Type | structural | | Derived from | top | | Auxiliary Classes | | | Possible Superiors | hcdSwitch | | Must Contain | hcdSwitchConfigId, objectClass | | May Contain | hcdDescription, hcdDefaultConn | | Supported Requests |
|
|
z/OS HCD User's Guide
Copyright IBM Corporation 1990, 2014