Class CIM_ZoneService
extends CIM_Service

The ZoneService if responsible for managing the Zone enforcement for the fabric. The ZoneService is hosted on an AdminDomain. This relationship is depicted by the HostedService association.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_Service
   |
   +--CIM_ZoneService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringThe ZoneService if responsible for managing the Zone enforcement for the fabric. The ZoneService is hosted on an AdminDomain. This relationship is depicted by the HostedService association.
UMLPackagePathstringCIM::Device::FC
Versionstring2.45.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
ConfigurationIDstring
DescriptionstringConfigurationID is the unique identifier that is used to determine whether the underlying zoning configuration has changed. For example, the ConfigurationID can be a checksum, date and time, sequence identification, as long as it unque to the client accessing the property.
DefaultZoningStateuint16
DescriptionstringDefaultZoningState indicates whether fabric members (devices) that are not in any other active Zones can access each other. In particular, if no Zones are active, a DefaultZoningState "Allow" indicates that all fabric members can access each other.
ValueMapstring0, 2, 3
ValuesstringUnknown, Allow, Deny
RequestedSessionStateuint165
DescriptionstringRequestedSessionState is an integer enumeration that indicates whether the ZoneService session has been requested to start (value=2), end (value=3), or terminate (value=4). Note that when RequestedSessionState is set to 4 ("Not Applicable"), then this property is not used. By default, the RequestedSessionState of the element is 5 ("No Change").
ModelCorrespondencestringCIM_ZoneService.SessionState, CIM_ZoneService.SessionControl
ValueMapstring2, 3, 4, 5
ValuesstringStart, End, Terminate, No Change
SessionStateuint164
DescriptionstringSessionState is an integer enumeration that indicates whether the session is currently starting (value=2) or has ended (value=3). It is possible that a particular instance of a ZoneService might not support sessions. If sessions are not supported, the value 4 ("Not Applicable") is used.
ValueMapstring0, 2, 3, 4
ValuesstringUnknown, Starting, Ended, Not Applicable

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LoSIDstringCIM_Service
LoSOrgIDstringCIM_Service
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

CreateZoneSet (uint32)

Method Qualifiers (CreateZoneSet)

NameData TypeValue
DescriptionstringThe method creates a ZoneSet and the association HostedCollection. The newly created association, HostedCollection, associates the Zone to the same AdminDomain that the ZoneService is hosted to. For the newly created ZoneSet, the Active property is always set to false. This method might be deprecated in the future in lieu of intrinsics after limitations in the CIM Operations are addressed.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10..0x0FFF, 0x1000..0x7777, 0x8000..
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, Access_Denied, Not_Found, Already_Exists, Insufficient_Resources, DMTF_Reserved, Method_Reserved, Vendor_Reserved

Method Parameters (CreateZoneSet)

NameTypeQualifiers
NameData TypeValue
ZoneSetNamestring
DescriptionstringA user-friendly name for the ZoneSet that is unique within the AdminDomain.
ModelCorrespondencestringCIM_ZoneSet.ElementName
Requiredbooleantrue
ZoneSet REF CIM_ZoneSet
DescriptionstringA reference to the newly created Zone.
OUTbooleantrue

CreateZone (uint32)

Method Qualifiers (CreateZone)

NameData TypeValue
DescriptionstringThe method creates a Zone and the association HostedCollection. The newly created association, HostedCollection, associates the Zone to the same AdminDomain that the ZoneService is hosted to. For the newly created Zone, the Active property is always set to false. This method might be deprecated in the future in lieu of intrinsics after limitations in the CIM Operations are addressed.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10..0x0FFF, 0x1000..0x7777, 0x8000..
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, Access_Denied, Not_Found, Already_Exists, Insufficient_Resources, DMTF_Reserved, Method_Reserved, Vendor_Reserved

Method Parameters (CreateZone)

NameTypeQualifiers
NameData TypeValue
ZoneNamestring
DescriptionstringA user-friendly name for the Zone that is unique within the AdminDomain.
ModelCorrespondencestringCIM_Zone.ElementName
Requiredbooleantrue
ZoneSubTypeuint16
DescriptionstringSpecific clarification to be used when the ZoneType has an enumeration that requires it. Specifically, if ZoneType is "Protocol", then SubType is the Fibre Channel FC4 type.
ModelCorrespondencestringCIM_Zone.ZoneSubType
ValueMapstring2, 3, 4
ValuesstringSCSI, VI, IP
ZoneTypeuint16
DescriptionstringThe type of zoning to be enforced.
ModelCorrespondencestringCIM_Zone.ZoneType
ValueMapstring2, 3
ValuesstringDefault, Protocol
Zone REF CIM_Zone
DescriptionstringA reference to the newly created Zone.
OUTbooleantrue

CreateZoneAlias (uint32)

Method Qualifiers (CreateZoneAlias)

NameData TypeValue
DescriptionstringThe method creates a ZoneAlias and the association HostedCollection. The newly created association, HostedCollection, associates the ZoneAlias to the same AdminDomain that the ZoneService is hosted to. For the newly created ZoneAlias, the Active property is always set to false. This method might be deprecated in the future in lieu of intrinsics after limitations in the CIM Operations are addressed.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10..0x0FFF, 0x1000..0x7777, 0x8000..
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, Access_Denied, Not_Found, Already_Exists, Insufficient_Resources, DMTF_Reserved, Method_Reserved, Vendor_Reserved

Method Parameters (CreateZoneAlias)

NameTypeQualifiers
NameData TypeValue
CollectionAliasstring
DescriptionstringA name (alias) for the ZoneAlias that is unique in the context of the hosting System.
Requiredbooleantrue
ZoneAlias REF CIM_NamedAddressCollection
DescriptionstringA reference to the newly created ZoneAlias.
OUTbooleantrue

CreateZoneMembershipSettingData (uint32)

Method Qualifiers (CreateZoneMembershipSettingData)

NameData TypeValue
DescriptionstringCreateZoneMembershipSettingData creates a ZoneMembershipSettingData and adds it to the specified Zone or ZoneAlias by creating a MemberOfCollection association. This method might be deprecated in the future in lieu of intrinsics after limitations in the CIM Operations are addressed.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10..0x0FFF, 0x1000..0x7777, 0x8000..
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, Access_Denied, Not_Found, Already_Exists, Insufficient_Resources, DMTF_Reserved, Method_Reserved, Vendor_Reserved

Method Parameters (CreateZoneMembershipSettingData)

NameTypeQualifiers
NameData TypeValue
ConnectivityMemberIDstring
DescriptionstringThis property specifies the type of identification used in the ConnectivityMemberID field. For Fibre Channel: * A ConnectivityMemberType of 'PermanentAddress', the ConnectivityMemberID is the NxPort WWN; * A ConnectivityMemberType of 'NetworkAddress', the ConnectivityMemberID is the NXPort Address ID; * A ConnectivityMemberType of 'SwitchPortID', the ConnectivityMemberID is 'Domain:PortNumber'.
ModelCorrespondencestringCIM_ZoneMembershipSettingData.ConnectivityMemberID
Requiredbooleantrue
ConnectivityMemberTypeuint16
DescriptionstringIdentifies the type of identification placed in ConnectivityMemberID.
Requiredbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, .., 0x8000..
ValuesstringUnknown, Other, PermanentAddress, NetworkAddress, SwitchPortID, LogicalPortGroup, DMTF_Reserved, Vendor_Reserved
SystemSpecificCollection REF CIM_SystemSpecificCollection
DescriptionstringThe collection that the ZoneMembershipSettingData should be added to. The collection is either a Zone or ZoneAlias.
Requiredbooleantrue
ZoneMembershipSettingData REF CIM_ZoneMembershipSettingData
DescriptionstringA reference to the newly created ZoneMembershipSettingData.
OUTbooleantrue

AddZone (uint32)

Method Qualifiers (AddZone)

NameData TypeValue
DescriptionstringAdds to the ZoneSet the specified Zone. Adding a Zone to a ZoneSet, extends the zone enforcement definition of the ZoneSet to include the members of that Zone. If adding the Zone is successful, the Zone should be associated with the ZoneSet by MemberOfCollection. This method might be deprecated in the future in lieu of intrinsics after limitations in the CIM Operations are addressed.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10..0x0FFF, 0x1000..0x7777, 0x8000..
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, Access_Denied, Not_Found, Already_Exists, Insufficient_Resources, DMTF_Reserved, Method_Reserved, Vendor_Reserved

Method Parameters (AddZone)

NameTypeQualifiers
NameData TypeValue
Zone REF CIM_Zone
DescriptionstringA reference to the Zone that is to be added to the ZoneSet.
ZoneSet REF CIM_ZoneSet
DescriptionstringA reference to the ZoneSet that the Zone is added to.
Requiredbooleantrue

AddZoneMembershipSettingData (uint32)

Method Qualifiers (AddZoneMembershipSettingData)

NameData TypeValue
DescriptionstringAdds to the Zone or ZoneAlias, the specified ZoneMembershipSettingData. If adding the ZoneMembershipSettingData is successful, an ElementSettingData association will be created between the ZoneMembershipSettingData and either the Zone or ZoneAlias. This method might be deprecated in the future in lieu of intrinsics after limitations in the CIM Operations are addressed.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10..0x0FFF, 0x1000..0x7777, 0x8000..
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, Access_Denied, Not_Found, Already_Exists, Insufficient_Resources, DMTF_Reserved, Method_Reserved, Vendor_Reserved

Method Parameters (AddZoneMembershipSettingData)

NameTypeQualifiers
NameData TypeValue
SystemSpecificCollection REF CIM_SystemSpecificCollection
DescriptionstringA reference to the Zone or ZoneAlias that the ZoneMembershipSettingData is to be added to.
Requiredbooleantrue
ZoneMembershipSettingData REF CIM_ZoneMembershipSettingData
DescriptionstringA reference to the ZoneMembershipSettingData that is to be added to the Zone or ZoneAlias.

AddZoneAlias (uint32)

Method Qualifiers (AddZoneAlias)

NameData TypeValue
DescriptionstringAdds to the Zone the specified ZoneAlias. This method might be deprecated in the future in lieu of intrinsics after limitations in the CIM Operations are addressed.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10..0x0FFF, 0x1000..0x7777, 0x8000..
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, Access_Denied, Not_Found, Already_Exists, Insufficient_Resources, DMTF_Reserved, Method_Reserved, Vendor_Reserved

Method Parameters (AddZoneAlias)

NameTypeQualifiers
NameData TypeValue
Zone REF CIM_Zone
DescriptionstringA reference to the Zone that the ZoneAlias is to be added to.
Requiredbooleantrue
ZoneAlias REF CIM_NamedAddressCollection
DescriptionstringA reference to the ZoneAlias that is to be added to the Zone.

ActivateZoneSet (uint32)

Method Qualifiers (ActivateZoneSet)

NameData TypeValue
DescriptionstringActivates the specified ZoneSet. After the ZoneSet is activated, the ZoneSet, associated Zone, ZoneAliases, and ZoneMembershipSettingData instances will have the active flag set to true. This method might be deprecated in the future in lieu of intrinsics after limitations in the CIM Operations are addressed.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 9, 10..0x0FFF, 0x1000..0x7777, 0x8000..
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, Access_Denied, Not_Found, Insufficient_Resources, DMTF_Reserved, Method_Reserved, Vendor_Reserved

Method Parameters (ActivateZoneSet)

NameTypeQualifiers
NameData TypeValue
Activateboolean
DescriptionstringActivate indicates whether the references to ZoneSet should be activated (Active=true) or deactivated (Active=false).
Requiredbooleantrue
ZoneSet REF CIM_ZoneSet
DescriptionstringA reference to the ZoneSet to be activated.
Requiredbooleantrue

SessionControl (uint32)

Method Qualifiers (SessionControl)

NameData TypeValue
DescriptionstringSessionControl requests that a session start (value=2), end (value=3), or terminate (value=4).
ValueMapstring0, 1, 2, 3, 4, 5, 6, 9, 10..0x0FFF, 0x1000..0x7777, 0x8000..
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, Access_Denied, Insufficient_Resources, DMTF_Reserved, Method_Reserved, Vendor_Reserved

Method Parameters (SessionControl)

NameTypeQualifiers
NameData TypeValue
RequestedSessionStateuint16
DescriptionstringRequestedSessionState is an integer enumeration that indicates whether the ZoneService session has been requested to start (value=2), end (value=3), or terminate (value=4).
ModelCorrespondencestringCIM_ZoneService.RequestedSessionState
ValueMapstring2, 3, 4
ValuesstringStart, End, Terminate

ActivateZoneSetWithJob (uint32)

Method Qualifiers (ActivateZoneSetWithJob)

NameData TypeValue
DescriptionstringActivates the specified ZoneSet with the expectation that a job will be created. It has an optional input, ConfigurationID, which is used to confirm that the ZoneSet being activated matches the definition the client previously discovered. If the input ConfigurationID matches, then the method attempts to activate the ZoneSet. If the ConfigurationIDs do not match, the method exits without activating the ZoneSet. After the ZoneSet is activated, the ZoneSet, associated Zone, ZoneAliases, and ZoneMembershipSettingData instances will have the active flag set to true. If 0 is returned, the function completed successfully and no ConcreteJob instance was required. If 4096/0x1000 is returned, a ConcreteJob is started to perform the activation. The Job's reference will be returned in the output parameter Job.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 9, 10, .., 4096, 0x1001..0x7777, 0x8000..0xFFFF
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, Access_Denied, Not_Found, Insufficient_Resources, ConfigurationIDMismatch, DMTF_Reserved, Method Parameters Checked - Job Started, Method_Reserved, Vendor_Reserved

Method Parameters (ActivateZoneSetWithJob)

NameTypeQualifiers
NameData TypeValue
Activateboolean
DescriptionstringActivate indicates whether the references to ZoneSet should be activated (Active=true) or deactivated (Active=false).
Requiredbooleantrue
ConfigurationIDstring
DescriptionstringConfigurationID is the expected identifier of the underlying zoning configuration.
OUTbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (can be null if the task is completed).
INbooleanfalse
OUTbooleantrue
ZoneSet REF CIM_ZoneSet
DescriptionstringA reference to the ZoneSet to be activated.
Requiredbooleantrue

SessionControlWithJob (uint32)

Method Qualifiers (SessionControlWithJob)

NameData TypeValue
DescriptionstringSessionControl requests that a session start (value=2), end (value=3), or terminate (value=4). It has an optional input, ConfigurationID, which is used to confirm that the session being locked matches the definition the client previously discovered. If the input ConfigurationID matches, then the method attempts to start the session. If the ConfigurationIDs do not match, the method exits without actstarting the session. When a session is ended (value=3), the expectation is that a job will be created.If 0 is returned, the function completed successfully and no ConcreteJob instance was required. If 4096/0x1000 is returned, a ConcreteJob is started to end the session. The Job's reference will be returned in the output parameter Job.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 9, 10, .., 0x1000..0x7777, 0x8000..0xFFFF
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, Access_Denied, Insufficient_Resources, ConfigurationIDMismatch, DMTF_Reserved, Method_Reserved, Vendor_Reserved

Method Parameters (SessionControlWithJob)

NameTypeQualifiers
NameData TypeValue
ConfigurationIDstring
DescriptionstringConfigurationID is the expected identifier of the underlying zoning configuration.
OUTbooleantrue
RequestedSessionStateuint16
DescriptionstringRequestedSessionState is an integer enumeration that indicates whether the ZoneService session has been requested to start (value=2), end (value=3), or terminate (value=4).
ModelCorrespondencestringCIM_ZoneService.RequestedSessionState
ValueMapstring2, 3, 4
ValuesstringStart, End, Terminate
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (can be null if the task is completed).
INbooleanfalse
OUTbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service