# 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

Name | Data Type | Value
--- | --- | ---
Description | string | 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.
UMLPackagePath | string | CIM::Device::FC
Version | string | 2.23.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
ConfigurationID | string |
Description | string | ConfigurationID 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.
Experimental | boolean | true
DefaultZoningState | uint16 |
Description | string | DefaultZoningState 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.
ValueMap | string | 0, 2, 3
Values | string | Unknown, Allow, Deny
RequestedSessionState | uint16 | 5
Description | string | RequestedSessionState 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").
ModelCorrespondence | string | CIM_ZoneService.SessionState, CIM_ZoneService.SessionControl
ValueMap | string | 2, 3, 4, 5
Values | string | Start, End, Terminate, No Change
SessionState | uint16 | 4
Description | string | SessionState 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.
ValueMap | string | 0, 2, 3, 4
Values | string | Unknown, Starting, Ended, Not Applicable

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_Service
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_EnabledLogicalElement
Generation | uint64 | CIM_ManagedElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
Name | string | CIM_Service
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
PrimaryOwnerContact | string | CIM_Service
PrimaryOwnerName | string | CIM_Service
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RequestedState | uint16 | CIM_EnabledLogicalElement
Started | boolean | CIM_Service
StartMode | string | CIM_Service
Status | string | CIM_ManagedSystemElement
SystemCreationClassName | string | CIM_Service
SystemName | string | CIM_Service
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
OperationalStatus | uint16[] | CIM_ManagedSystemElement
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Local Class Methods

#### CreateZoneSet (uint32)

#### Method Qualifiers (CreateZoneSet)

Name | Data Type | Value
--- | --- | ---
Description | string | The 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.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10..0x0FFF, 0x1000..0x7777, 0x8000..
Values | string | Success, 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)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
ZoneSetName | string
Description | string | A user-friendly name for the ZoneSet that is unique within the AdminDomain.
IN | boolean | true
ModelCorrespondence | string | CIM_ZoneSet.ElementName
Required | boolean | true
ZoneSet | REF CIM_ZoneSet
Description | string | A reference to the newly created Zone.
IN | boolean | true
OUT | boolean | true

#### CreateZone (uint32)

#### Method Qualifiers (CreateZone)

Name | Data Type | Value
--- | --- | ---
Description | string | The 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.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10..0x0FFF, 0x1000..0x7777, 0x8000..
Values | string | Success, 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)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
ZoneName | string
Description | string | A user-friendly name for the Zone that is unique within the AdminDomain.
IN | boolean | true
ModelCorrespondence | string | CIM_Zone.ElementName
Required | boolean | true
ZoneSubType | uint16
Description | string | Specific 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.
IN | boolean | true
ModelCorrespondence | string | CIM_Zone.ZoneSubType
ValueMap | string | 2, 3, 4
Values | string | SCSI, VI, IP
ZoneType | uint16
Description | string | The type of zoning to be enforced.
IN | boolean | true
ModelCorrespondence | string | CIM_Zone.ZoneType
ValueMap | string | 2, 3
Values | string | Default, Protocol
Zone | REF CIM_Zone
Description | string | A reference to the newly created Zone.
IN | boolean | true
OUT | boolean | true

#### CreateZoneAlias (uint32)

#### Method Qualifiers (CreateZoneAlias)

Name | Data Type | Value
--- | --- | ---
Description | string | The 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.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10..0x0FFF, 0x1000..0x7777, 0x8000..
Values | string | Success, 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)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
CollectionAlias | string
Description | string | A name (alias) for the ZoneAlias that is unique in the context of the hosting System.
IN | boolean | true
ModelCorrespondence | string | CIM_ZoneAlias.CollectionAlias
Required | boolean | true
ZoneAlias | REF CIM_NamedAddressCollection
Description | string | A reference to the newly created ZoneAlias.
IN | boolean | true
OUT | boolean | true

#### CreateZoneMembershipSettingData (uint32)

#### Method Qualifiers (CreateZoneMembershipSettingData)

Name | Data Type | Value
--- | --- | ---
Description | string | CreateZoneMembershipSettingData 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.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10..0x0FFF, 0x1000..0x7777, 0x8000..
Values | string | Success, 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)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
ConnectivityMemberID | string
Description | string | This 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'.
IN | boolean | true
ModelCorrespondence | string | CIM_ZoneMembershipSettingData.ConnectivityMemberID
Required | boolean | true
ConnectivityMemberType | uint16
Description | string | Identifies the type of identification placed in ConnectivityMemberID.
IN | boolean | true
ModelCorrespondence | string | CIM_ZoneMembershipSettingData.ZoneMemberType
Required | boolean | true
ValueMap | string | 0, 1, 2, 3, 4, 5, .., 0x8000..
Values | string | Unknown, Other, PermanentAddress, NetworkAddress, SwitchPortID, LogicalPortGroup, DMTF_Reserved, Vendor_Reserved
SystemSpecificCollection | REF CIM_SystemSpecificCollection
Description | string | The collection that the ZoneMembershipSettingData should be added to. The collection is either a Zone or ZoneAlias.
IN | boolean | true
Required | boolean | true
ZoneMembershipSettingData | REF CIM_ZoneMembershipSettingData
Description | string | A reference to the newly created ZoneMembershipSettingData.
IN | boolean | true
OUT | boolean | true

#### AddZone (uint32)

#### Method Qualifiers (AddZone)

Name | Data Type | Value
--- | --- | ---
Description | string | Adds 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.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10..0x0FFF, 0x1000..0x7777, 0x8000..
Values | string | Success, 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)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
Zone | REF CIM_Zone
Description | string | A reference to the Zone that is to be added to the ZoneSet.
IN | boolean | true
ZoneSet | REF CIM_ZoneSet
Description | string | A reference to the ZoneSet that the Zone is added to.
IN | boolean | true
Required | boolean | true

#### AddZoneMembershipSettingData (uint32)

#### Method Qualifiers (AddZoneMembershipSettingData)

Name | Data Type | Value
--- | --- | ---
Description | string | Adds 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.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10..0x0FFF, 0x1000..0x7777, 0x8000..
Values | string | Success, 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)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
SystemSpecificCollection | REF CIM_SystemSpecificCollection
Description | string | A reference to the Zone or ZoneAlias that the ZoneMembershipSettingData is to be added to.
IN | boolean | true
Required | boolean | true
ZoneMembershipSettingData | REF CIM_ZoneMembershipSettingData
Description | string | A reference to the ZoneMembershipSettingData that is to be added to the Zone or ZoneAlias.
IN | boolean | true

#### AddZoneAlias (uint32)

#### Method Qualifiers (AddZoneAlias)

Name | Data Type | Value
--- | --- | ---
Description | string | Adds 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.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10..0x0FFF, 0x1000..0x7777, 0x8000..
Values | string | Success, 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)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
Zone | REF CIM_Zone
Description | string | A reference to the Zone that the ZoneAlias is to be added to.
IN | boolean | true
Required | boolean | true
ZoneAlias | REF CIM_NamedAddressCollection
Description | string | A reference to the ZoneAlias that is to be added to the Zone.
IN | boolean | true

#### ActivateZoneSet (uint32)

#### Method Qualifiers (ActivateZoneSet)

Name | Data Type | Value
--- | --- | ---
Description | string | Activates 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.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 9, 10..0x0FFF, 0x1000..0x7777, 0x8000..
Values | string | Success, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, Access_Denied, Not_Found, Insufficient_Resources, DMTF_Reserved, Method_Reserved, Vendor_Reserved

#### Method Parameters (ActivateZoneSet)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
Activate | boolean
Description | string | Activate indicates whether the references to ZoneSet should be activated (Active=true) or deactivated (Active=false).
IN | boolean | true
Required | boolean | true
ZoneSet | REF CIM_ZoneSet
Description | string | A reference to the ZoneSet to be activated.
IN | boolean | true
Required | boolean | true

#### SessionControl (uint32)

#### Method Qualifiers (SessionControl)

Name | Data Type | Value
--- | --- | ---
Description | string | SessionControl requests that a session start (value=2), end (value=3), or terminate (value=4).
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 9, 10..0x0FFF, 0x1000..0x7777, 0x8000..
Values | string | Success, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, Access_Denied, Insufficient_Resources, DMTF_Reserved, Method_Reserved, Vendor_Reserved

#### Method Parameters (SessionControl)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
RequestedSessionState | uint16
Description | string | RequestedSessionState is an integer enumeration that indicates whether the ZoneService session has been requested to start (value=2), end (value=3), or terminate (value=4).
IN | boolean | true
ModelCorrespondence | string | CIM_ZoneService.RequestedSessionState
ValueMap | string | 2, 3, 4
Values | string | Start, End, Terminate

#### ActivateZoneSetWithJob (uint32)

#### Method Qualifiers (ActivateZoneSetWithJob)

Name | Data Type | Value
--- | --- | ---
Description | string | Activates 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.
Experimental | boolean | true
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 9, 10, .., 4096, 0x1001..0x7777, 0x8000..0xFFFF
Values | string | Success, 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)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
Activate | boolean
Description | string | Activate indicates whether the references to ZoneSet should be activated (Active=true) or deactivated (Active=false).
IN | boolean | true
Required | boolean | true
ConfigurationID | string
Description | string | ConfigurationID is the expected identifier of the underlying zoning configuration.
IN | boolean | true
OUT | boolean | true
Job | REF CIM_ConcreteJob
Description | string | Reference to the job (can be null if the task is completed).
IN | boolean | false
OUT | boolean | true
ZoneSet | REF CIM_ZoneSet
Description | string | A reference to the ZoneSet to be activated.
IN | boolean | true
Required | boolean | true

#### SessionControlWithJob (uint32)

#### Method Qualifiers (SessionControlWithJob)

Name | Data Type | Value
--- | --- | ---
Description | string | SessionControl 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.
Experimental | boolean | true
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 9, 10, .., 0x1000..0x7777, 0x8000..0xFFFF
Values | string | Success, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, Access_Denied, Insufficient_Resources, ConfigurationIDMismatch, DMTF_Reserved, Method_Reserved, Vendor_Reserved

#### Method Parameters (SessionControlWithJob)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
ConfigurationID | string
Description | string | ConfigurationID is the expected identifier of the underlying zoning configuration.
IN | boolean | true
OUT | boolean | true
RequestedSessionState | uint16
Description | string | RequestedSessionState is an integer enumeration that indicates whether the ZoneService session has been requested to start (value=2), end (value=3), or terminate (value=4).
IN | boolean | true
ModelCorrespondence | string | CIM_ZoneService.RequestedSessionState
ValueMap | string | 2, 3, 4
Values | string | Start, End, Terminate
Job | REF CIM_ConcreteJob
Description | string | Reference to the job (can be null if the task is completed).
IN | boolean | false
OUT | boolean | true

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
ChangeAffectedElementsAssignedSequence | uint32 | CIM_Service
RequestStateChange | uint32 | CIM_EnabledLogicalElement
StartService | uint32 | CIM_Service
StopService | uint32 | CIM_Service