The IBMzOS_FCCUPort class represents FICON Control Unit ports attached to the z/OS system.

• CIM_ManagedElement
• ← CIM_ManagedSystemElement
• ← CIM_LogicalElement
• ← CIM_EnabledLogicalElement
• ← CIM_LogicalDevice
• ← CIM_LogicalPort
• ← CIM_NetworkPort
• ← CIM_FCPort
• ← IBMzOS_FCSBPort
• ← IBMzOS_FCCUPort

The module name of the CMPI provider that is registered for a CIM class which is used by the cimprovider command line tool for the administration of CMPI providers is

• IBMzOS_FCCUPortProviderModule

The physical name of a CMPI provider’s shared object library as it is stored in the hierarchical file system is

• libcmpiIBMzOS_FCCUPortProvider.so

string Caption

Returns IBM z/OS FICON Control Unit Port.

string Description

Returns IBM z/OS FICON Control Unit Port.

string ElementName

Returns the same value as NodeDescriptor.

string Name

Returns the same value as NodeDescriptor.

uint16 OperationalStatus [ ]

The first array element ([0]) returns

0

unknown

uint16 EnabledState

Returns

0

unknown

uint16 RequestedState

Returns

11

not applicable

uint16 EnabledDefault

Returns

3

not applicable

string SystemCreationClassName [key]

Returns IBMzOS_ComputerSystem.

string SystemName [key]

Displays the fully qualified host name of the system.

string CreationClassName [key]

Indicates the name of the class or the subclass used in the creation of an instance.

Returns IBMzOS_FCCUPort.

string DeviceID [key]

Returns a unique name for the logical device.

uint16 PortNumber

Returns the interface ID of the control unit port.

uint16 UsageRestriction

Returns

2

front-end-only

uint16 PortType

Specifies the specific mode currently enabled for the port.

Returns

10

N-Port

uint16 LinkTechnology

Specifies the type of link.

Returns

4

FC

string PermanentAddress

Defines the network address of the port.

Returns

WWPN

if a network address is available

NULL

else

uint16 SupportedCOS []

Indicates the Fibre Channel Class of Service that is supported.

The first array element ([0]) returns 3.

uint16 ActiveCOS []

Indicates the Fibre Channel Class of Service that is active.

The first array element ([0]) returns 3.

uint16 SupportedFC4Types []

Indicates the supported Fibre Channel FC-4 protocol.

The first array element ([0]) returns

27

FC-SB-x channel

uint16 ActiveFC4Types []

Indicates the currently running Fibre Channel FC-4 protocol.

The first array element ([0]) returns

27

FC-SB-x channel

NodeDescriptor

Indicates the node descriptor of the control unit port in the format:

type.model.manufacturer.plant.sequenceNumber.tag

Example: 002107.900.IBM.75.0000000CF811.0230

uint32 AssignWWN()

Assigns a world wide name to the port, if no WWPN is present in the PermanentAddress property.

Note:

After IPL the assignment is lost.

Parameters:

uint64 wwn

The world wide name to be assigned to the port in decimal number format.

Return values:

0

Completed without error.

1

The WWN could not be assigned because the logical device already has a fixed WWPN, discovered from the hardware.

2

The logical device already has the same WWPN bound to it.

3

Unexpected error.

Exceptions:

CIM_ERR_NOT_FOUND

The switch port pointed to by the object path does not exist.

CIM_ERR_ACCESS_DENIED

The caller is not authorized for this function. (You require UPDATE access to profile IOSPORTS CL(FACILITY).)

CIM_ERR_INVALID_PARAMETER

The specified WWN is invalid.

CIM_ERR_NOT_SUPPORTED

The requested operation is not supported by the underlying Operating System.

CIM_ERR_FAILED

General Error, for details see status description message.

uint32 Decommission()

Takes all channels or devices attached to the port offline.

The system will not take a device offline if it would remove the last path to an online device. Exceptions will be made if the Force parameter is set to true.

Parameters:

boolean Force

Specifies whether or not the last path to a used device is to be removed.

The default is false: The system will not remove the last path to a device.

If set to true, the system takes all channel paths for the specified port offline, even if it is the last path to a device or if there were any other reason that affects the systems ability to communicate with a device over this path.

In any case, the system will not remove the last path to a device that has any of the following attributes: "Allocated", "In use by the system", "A Console", "Assigned to JES3".

string EmbeddedInstance("CIM_Message") messages[]

If available, the CIM_Message instances contain IOS messages with additional information.

Return values:

0 (Confirmed)

The port was taken offline.

1 (Denied other)

The port cannot be taken offline for an unspecified reason. Not all devices could be taken offline due to other reasons. All eligible devices were taken offline.

2 (Denied In Use)

The port cannot be taken offline because it is still in use. Not all devices could be taken offline due to last path - in use. All eligible devices were taken offline.

3 (Denied last Path)

The port cannot be taken offline because it is the last path to a device. Not all devices could be taken offline due to last path. All eligible devices were taken offline.

Exceptions:

CIM_ERR_NOT_FOUND

The port pointed does not exist

CIM_ERR_ACCESS_DENIED

The caller is not authorized for this function. (You require UPDATE access to profile IOSPORTS CL(FACILITY).)

CIM_ERR_NOT_SUPPORTED

The requested operation is not supported by the underlying Operating System.

CIM_ERR_FAILED

General error, for details see the status description message.

uint32 Recommission()

Brings all channels or devices attached to the port that were online before they had previously been decommissioned back online.

Parameters:

string EmbeddedInstance("CIM_Message") messages[]

Returns one or more messages describing the effect that the recommissioning had on the attached devices.

Return values:

0 (OK)

The port and all associated paths were successfully brought online.

1 (Other)

The port cannot be taken online for an unspecified reason. See the messages output parameter for details.

2 (Denied)

The port is not in state decommissioned and therefore cannot be recommissioned.

Exceptions:

CIM_ERR_NOT_FOUND

The port does not exist

CIM_ERR_ACCESS_DENIED

The caller is not authorized for this function. (You require UPDATE access to profile IOSPORTS CL(FACILITY).)

CIM_ERR_NOT_SUPPORTED

The requested operation is not supported by the underlying Operating System.

CIM_ERR_FAILED

General error, for details see the status description message.

IBMzOS_CSFCPort

Source

IBMzOS_ComputerSystem

Target

IBMzOS_FCCUPort

see

Association IBMzOS_CSFCPort