EN
Данное содержимое не доступно на вашем языке, используйте версию на английском языке.

MSFTSMNET_IPProtocolEndpoint class

Represents a protocol endpoint that is dedicated to running the IP protocol.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

class MSFTSMNET_IPProtocolEndpoint : CIM_IPProtocolEndpoint
{
  string   IPv4Address;
  string   IPv6Address;
  string   Address;
  string   SubnetMask;
  uint8    PrefixLength;
  uint16   AddressType;
  uint16   IPVersionSupport;
  uint16   ProtocolIFType = 1;
  string   Name;
  string   Description;
  uint16   OperationalStatus[];
  uint16   EnabledState;
  datetime TimeOfLastStateChange;
  string   NameFormat;
  uint16   ProtocolType;
  string   OtherTypeDescription;
  string   SystemCreationClassName;
  string   SystemName;
  string   CreationClassName;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault;
  uint16   AvailableRequestedStates[];
  uint16   TransitioningToState = 12;
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  datetime InstallDate;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  string   InstanceID;
  string   Caption;
  string   ElementName;
};

Members

The MSFTSMNET_IPProtocolEndpoint class has these types of members:

Methods

The MSFTSMNET_IPProtocolEndpoint class has these methods.

MethodDescription
RequestStateChange

Requests that the state of the element be changed to the specified value.

This method is inherited from the CIM_EnabledLogicalElement class.

 

Properties

The MSFTSMNET_IPProtocolEndpoint class has these properties.

Address
Data type: string
Access type: Read-only
Qualifiers: Deprecated (CIM_IPProtocolEndpoint.IPv4Address, CIM_IPProtocolEndpoint.IPv6Address)

Indicates the IP address of this protocol endpoint in a format that is defined by the AddressType property.

This property is inherited from the CIM_IPProtocolEndpoint class.

AddressType
Data type: uint16
Access type: Read-only
Qualifiers: Deprecated

Indicates the format of the Address property.

The possible values are.

Unknown (0)
IPv4 Only (1)
IPv6 Only (2)

This property is inherited from the CIM_IPProtocolEndpoint class.

AvailableRequestedStates
Data type: uint16 array
Access type: Read-only

Indicates the possible values for the RequestedState parameter of the RequestStateChange method.

The listed values must be a subset of the values that are contained in the RequestedStatesSupported property of the associated CIM_EnabledLogicalElementCapabilities instance. This property is NULL if the implementation cannot determine the set of possible values for the current state of the element.

The possible values are.

Enabled (2)
Disabled (3)
Shut Down (4)
Offline (6)
Test (7)
Defer (8)
Quiesce (9)
Reboot (10)
Reset (11)
DMTF Reserved (12 ≤ value )

This property is inherited from the CIM_EnabledLogicalElement class.

Caption
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

Indicates a short textual description of the object.

This property is inherited from the CIM_ManagedElement class.

CommunicationStatus
Data type: uint16
Access type: Read-only

Indicates the ability of the instrumentation to communicate with this element. A NULL value indicates that instrumentation does not support this property.

ValuesMeaning
Unknown
0

Indicates that the instrumentation cannot report on the CommunicationStatus property at this time.

Not Available
1

Indicates that the instrumentation is capable of reporting this property, but intentionally does not for this element.

Communication OK
2

Indicates only that communication is established with the element.

Lost Communication
3

Indicates that the element has been contacted in the past, but is currently unreachable.

No Contact
4

Indicates that the instrumentation has contact information for this element, but has never been able to communicate with it.

DMTF Reserved
5–0x7FFF

Reserved.

Vendor Reserved
0x8000 ≤ value

Reserved.

 

This property is inherited from the CIM_ManagedSystemElement class.

CreationClassName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256)

Indicates the name of the class that is used to create an instance.

This property is inherited from the CIM_ServiceAccessPoint class.

Description
Data type: string
Access type: Read-only
Qualifiers: Override, MappingStrings ("MIB.IETF|IF-MIB.ifDescr")

Indicates the instance.

Note  Values are mapped to the Internet Assigned Numbers Authority (IANA) ifDescr Management Information Base (MIB). For more information, see the IANA website at http://www.iana.org/protocols.

This property is inherited from the CIM_ProtocolEndpoint class.

DetailedStatus
Data type: uint16
Access type: Read-only

Indicates additional status details that complement the PrimaryStatus property. A NULL value indicates that the instrumentation does not support this property.

ValuesMeaning
Not Available
0

Indicates that the instrumentation is capable of reporting this property, but intentionally does not report it for this element.

No Additional Information
1

Indicates that no details have to be added to the PrimaryStatus property, for example when the PrimaryStatus is set to OK.

Stressed
2

Indicates that the element functions, but requires attention. Overload and overheated are examples of Stressed states.

Predictive Failure
3

Indicates that an element functions nominally, but predicts a failure in the near future.

Non-Recoverable Error
4

Indicates that this element is in an error condition that requires human intervention.

Supporting Entity in Error
5

Indicates that an element on which this element depends is in error. This element might be OK but cannot function because of the state of a dependent element. An example is a network service or endpoint that cannot function due to lower-layer networking problems.

DMTF Reserved
6–0x7FFF

Reserved.

Vendor Reserved
0x8000 ≤ value

Reserved.

 

This property is inherited from the CIM_ManagedSystemElement class.

ElementName
Data type: string
Access type: Read-only

Indicates a user-friendly name for the object. This property enables each instance to define a user-friendly name in addition to its key properties, identity data, and description information.

This property is inherited from the CIM_ManagedElement class.

EnabledDefault
Data type: uint16
Access type: Read/write

Indicates an administrator's default or startup configuration for the enabled state of an element. The default value is Enabled (2).

The possible values are.

Enabled (2)
Disabled (3)
Not Applicable (5)
Enabled but Offline (6)
No Default (7)
Quiesce (9)
DMTF Reserved (10–32767)
Vendor Reserved (32768–65535)

This property is inherited from the CIM_EnabledLogicalElement class.

EnabledState
Data type: uint16
Access type: Read-only
Qualifiers: Override, MappingStrings ("MIB.IETF|IF-MIB.ifAdminStatus")

Indicates the current state of the instance.

Note  Values are mapped to the Internet Assigned Numbers Authority (IANA) ifAdminStatus Management Information Base (MIB). For more information, see the IANA website at http://www.iana.org/protocols.

The possible values are.

up (1)
down (2)
testing (3)

This property is inherited from the CIM_ProtocolEndpoint class.

HealthState
Data type: uint16
Access type: Read-only

Indicates the current health of the element. This attribute expresses the health of this element, but not necessarily the health of its subcomponents.

ValuesMeaning
Unknown
0

The implementation cannot report on the HealthState property at this time.

OK
5

The element is fully functional and operates within normal operational parameters and without error.

Degraded/Warning
10

The element is in working order, and all functionality is provided. However, the element does not function to the best of its abilities. For example, the element might not operate at optimal performance, or it might report recoverable errors.

Minor failure
15

All functionality is available, but some functionality might be degraded.

Major failure
20

The element is failing. It is possible that some or all of the functionality of this component is degraded or does not work.

Critical failure
25

The element does not function, and recovery might not be possible.

Nonrecoverable error
30

The element has completely failed, and recovery is not possible. All functionality that this element provides has been lost.

DMTF Reserved
31 ≤ value

Reserved.

 

This property is inherited from the CIM_ManagedSystemElement class.

InstallDate
Data type: datetime
Access type: Read-only

Indicates when the object was installed. The lack of a value does not indicate that the object is not installed.

This property is inherited from the CIM_ManagedSystemElement class.

InstanceID
Data type: string
Access type: Read-only
Qualifiers: Key

Uniquely and opaquely identifies an instance of this class within the scope of the containing namespace.

Important  In order to ensure uniqueness within the namespace, the value of the InstanceID property should be constructed in the following pattern: OrgID:LocalID

OrgID must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity that defines the InstanceID, or be a registered ID that is assigned by a recognized global authority. This pattern is similar to the structure of schema class names. In addition, to ensure uniqueness, the first colon in InstanceID must be between the OrgID andLocalID. Therefore the OrgID must not contain a colon (':').

LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.

If the preceding pattern is not used, the defining entity must assure that the resultant InstanceID value is not re-used across any InstanceID properties that are produced by this or other providers for this namespace.

For Distributed Management Task Force (DMTF) defined instances, the pattern must be used with the OrgID set to CIM.

This property is inherited from the CIM_ManagedElement class.

IPv4Address
Data type: string
Access type: Read-only

Indicates the IPv4 address of this protocol endpoint.

This property is inherited from the CIM_IPProtocolEndpoint class.

IPv6Address
Data type: string
Access type: Read-only

Indicates the IPv6 address of this protocol endpoint.

This property is inherited from the CIM_IPProtocolEndpoint class.

IPVersionSupport
Data type: uint16
Access type: Read-only
Qualifiers: Deprecated

Indicates the support for different versions of the IP protocol for this endpoint.

The possible values are.

Unknown (0)
IPv4 Only (1)
IPv6 Only (2)
Both IPv4 and IPv6 (3)

This property is inherited from the CIM_IPProtocolEndpoint class.

Name
Data type: string
Access type: Read-only
Qualifiers: Key, Override, MaxLen (256)

Indicates an identifying string for this protocol endpoint. To ensure uniqueness, prefix or append information from the Type or OtherTypeDescription properties to the base name. Describe the method selected in the NameFormat property of this class.

This property is inherited from the CIM_ProtocolEndpoint class.

NameFormat
Data type: string
Access type: Read-only
Qualifiers: MaxLen (256)

Contains the naming pattern that is selected to ensure that the value of the Name property is unique. For example, you might choose to prepend the name of the port or interface with the type of protocol endpoint of this instance, followed by an underscore, for example IPv4_.

This property is inherited from the CIM_ProtocolEndpoint class.

OperatingStatus
Data type: uint16
Access type: Read-only

Indicates the current operational condition of the element. This property can be used to provide more detail about the value of the EnabledState property. A NULL value indicates that the instrumentation does not support this property.

ValuesMeaning
Unknown
0

Indicates that the instrumentation cannot report on the OperatingStatus property at this time.

Not Available
1

Indicates that the instrumentation is capable of reporting this property, but intentionally does not report it for this element.

Servicing
2

Indicates that the element is in process to be configured, maintained, cleaned, or otherwise administered.

Starting
3

Indicates that the element is being initialized.

Stopping
4

Indicates that the element is being brought to an orderly stop.

Stopped
5

Indicates that the element is intentionally stopped.

Aborted
6

Indicates that the element stopped in an unexpected way.

Dormant
7

Indicates that the element is inactive or quiesced.

Completed
8

Indicates that the element completed its operation. We recommend using a PrimaryStatus property value of OK, Error, or Degraded to indicate success or failure of the operation.

Migrating
9

Indicates that the element is being moved between host elements.

Emigrating
10

Indicates that the element is being moved away from the host element.

Immigrating
11

Indicates that the element is being moved to a new host element.

Snapshotting
12

Indicates that a snapshot copy of the element is being created.

Shutting Down
13

Indicates that the element is being brought to an abrupt stop.

In Test
14

Indicates that the element is performing test functions.

Transitioning
15

Indicates that the element is between states and is not fully available in either state. Use another value that indicates a more specific transition if one is available.

In Service
16

Indicates that the element is in service and operational.

DMTF Reserved
17–0x7FFF

Reserved.

Vendor Reserved
0x8000 ≤ value

Reserved.

 

This property is inherited from the CIM_ManagedSystemElement class.

OperationalStatus
Data type: uint16 array
Access type: Read-only
Qualifiers: Override, MappingStrings ("MIB.IETF|IF-MIB.ifOperStatus")

Indicates the current status of the instance.

Note  Values are mapped to the Internet Assigned Numbers Authority (IANA) ifOperStatus Management Information Base (MIB). For more information, see the IANA website at http://www.iana.org/protocols.

The possible values are.

up (1)
down (2)
testing (3)
unknown (4)
dormant (5)
notPresent (6)
lowerLayerDown (7)

This property is inherited from the CIM_ProtocolEndpoint class.

OtherEnabledState
Data type: string
Access type: Read-only

Indicates the state of the element when the value of the EnabledState property is Other. This property must be set to NULL when EnabledState is not Other.

This property is inherited from the CIM_EnabledLogicalElement class.

OtherTypeDescription
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

Indicates the type of protocol endpoint when the ProtocolIFType property is Other. This property must be set to NULL when the ProtocolIFType property is not Other.

This property is inherited from the CIM_ProtocolEndpoint class.

PrefixLength
Data type: uint8
Access type: Read-only

Indicates the prefix length for the IPv6 address of this protocol endpoint, if one is defined.

This property is inherited from the CIM_IPProtocolEndpoint class.

PrimaryStatus
Data type: uint16
Access type: Read-only

Indicates a high-level status value.

The possible values are.

Unknown (0)
OK (1)
Degraded (2)
Error (3)
DMTF Reserved (4–0x7FFF)
Vendor Reserved (0x8000 ≤ value )

This property is inherited from the CIM_ManagedSystemElement class.

ProtocolIFType
Data type: uint16
Access type: Read-only
Qualifiers: Override, MappingStrings ("MIB.IETF|IF-MIB.ifType")

Indicates the protocol interface type, which is used to categorize and to classify CIM_ProtocolEndpoint instances. This property is limited to IP-related and reserved values for MSFTSMNET_IPProtocolEndpoint instances.

Note  Values are mapped to the Internet Assigned Numbers Authority (IANA) ifType Management Information Base (MIB). For more information, see the IANA website at http://www.iana.org/assignments/ianaiftype-mib.

If the ProtocolIFType property is set to 1 (Other), then the type information must be provided in the OtherTypeDescription property.

The possible values are.

Other (1)
IANA Reserved (225–4095)
IPv4 (4096)
IPv6 (4097)
DMTF Reserved (4301–32767)
Vendor Reserved (32768 ≤ value )

This property is inherited from the CIM_IPProtocolEndpoint class.

ProtocolType
Data type: uint16
Access type: Read-only
Qualifiers: Deprecated ("CIM_ProtocolEndpoint.ProtocolIFType")

Provides information to categorize and classify different instances of this class.

The possible values are.

Unknown (0)
Other (1)
IPv4 (2)
IPv6 (3)
IPX (4)
AppleTalk (5)
DECnet (6)
SNA (7)
CONP (8)
CLNP (9)
VINES (10)
XNS (11)
ATM (12)
Frame Relay (13)
Ethernet (14)
TokenRing (15)
FDDI (16)
Infiniband (17)
Fibre Channel (18)
ISDN BRI Endpoint (19)
ISDN B Channel Endpoint (20)
ISDN D Channel Endpoint (21)
IPv4/v6 (22)
BGP (23)
OSPF (24)
MPLS (25)
UDP (26)
TCP (27)

This property is inherited from the CIM_ProtocolEndpoint class.

RequestedState
Data type: uint16
Access type: Read-only

Indicates the last requested state for the element. The current state is indicated by the EnabledState property. This property enables you to compare the last requested and current states.

Note  When the value of the EnabledState property is Not Applicable, this property has no meaning.

ValuesMeaning
Enabled
2

Indicates that the element executes or could execute commands, can process any queued commands, and queues new requests.

Disabled
3

Indicates a request to immediately disable the element, such that it does not execute or accept any commands or processing requests.

Shut Down
4

Indicates a request for an orderly transition to the Disabled state and might require you to shut off the power, to completely erase any existing state.

No Change
5

No state change has been requested. This is the default value if the RequestStateChange method is supported.

Offline
6

Indicates a request to transition to the Enabled but Offline state.

Test
7

Indicates that the element is in a test state.

Deferred
8

Indicates that the element might be completing commands, but queues any new requests.

Quiesce
9

Indicates that the element is enabled, but is in a restricted mode.

Reboot
10

Indicates a request to shut down and then change to an Enabled state.

Reset
11

Indicates a request to change to a Disabled state and then to an Enabled state.

Not Applicable
12

Indicates that this instance does not support the RequestedState property.

DMTF Reserved
13–32767

Reserved.

Vendor Reserved
32768–65535

Reserved.

 

This property is inherited from the CIM_EnabledLogicalElement class.

Status
Data type: string
Access type: Read-only
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus") , MaxLen (10)

Indicates the primary status of the object.

Note  This property is deprecated. It is replaced by the OperationalStatus property. If you choose to use the Status property for backward compatibility, it should be secondary to the OperationalStatus property.

The possible values are.

OK
Error
Degraded
Unknown
Pred Fail
Starting
Stopping
Service
Stressed
NonRecover
No Contact
Lost Comm
Stopped

This property is inherited from the CIM_ManagedSystemElement class.

StatusDescriptions
Data type: string array
Access type: Read-only

Indicates descriptions of the corresponding values in the OperationalStatus array. For example, if an element in OperationalStatus contains the value Stopping, then the element at the same array index in this property might contain an explanation as to why an object is being stopped.

This property is inherited from the CIM_ManagedSystemElement class.

SubnetMask
Data type: string
Access type: Read-only

Indicates the mask for the IPv4 address of this protocol endpoint, if one is defined.

This property is inherited from the CIM_IPProtocolEndpoint class.

SystemCreationClassName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256)

Indicates the CreationClassName property of the CIM_System object that provides the scope for this endpoint.

This property is inherited from the CIM_ServiceAccessPoint class.

SystemName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256)

Indicates the Name property of the CIM_System object that provides the scope for this endpoint.

This property is inherited from the CIM_ServiceAccessPoint class.

TimeOfLastStateChange
Data type: datetime
Access type: Read-only
Qualifiers: Override, MappingStrings ("MIB.IETF|IF-MIB.ifLastChange")

Indicates the time of the last state change.

This property is inherited from the CIM_ProtocolEndpoint class.

TransitioningToState
Data type: uint16
Access type: Read-only

Indicates the target state to which the instance is transitioning.

A value of No Change indicates that no transition is in progress. A value of Not Applicable indicates that the implementation does not report ongoing transitions.

The possible values are.

Unknown (0)
Enabled (2)
Disabled (3)
Shut Down (4)
No Change (5)
Offline (6)
Test (7)
Defer (8)
Quiesce (9)
Reboot (10)
Reset (11)
Not Applicable (12)
DMTF Reserved (13 ≤ value )

This property is inherited from the CIM_EnabledLogicalElement class.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012 R2

Namespace

\\.\root\cimv2\storage\iscsitarget

MOF

SmIscsiTarget.mof

See also

iSCSI Target Server Reference

 

 

Показ:
© 2014 Microsoft