다음을 통해 공유


CIM_ProtocolEndpoint class

A communication point used to send and receive data between systems, computer interfaces, and logical networks.

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

Syntax

[Abstract, Version("2.10.0"), AMENDMENT]
class CIM_ProtocolEndpoint : CIM_ServiceAccessPoint
{
  string   Caption;
  string   ElementName;
  datetime InstallDate;
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  string   SystemCreationClassName;
  string   SystemName;
  string   CreationClassName;
  string   Description;
  uint16   OperationalStatus[];
  uint16   EnabledState;
  datetime TimeOfLastStateChange;
  string   Name;
  string   NameFormat;
  uint16   ProtocolType;
  uint16   ProtocolIFType;
  string   OtherTypeDescription;
  boolean  BroadcastResetSupported;
};

Members

The CIM_ProtocolEndpoint class has these types of members:

Methods

The CIM_ProtocolEndpoint class has these methods.

Method Description
BroadcastReset This method is not supported
RequestStateChange Requests that the state of the element be changed to the specified value.
This method is inherited from CIM_EnabledLogicalElement.

Properties

The CIM_ProtocolEndpoint class has these properties.

BroadcastResetSupported

Data type: boolean

Access type: Read-only

Qualifiers: Experimental, MappingStrings ("FC-SWAPI.INCITS-T11|SWAPI_PORT_CONFIG_CAPS_T.PortForceLipSupported"), ModelCorrespondence ("CIM_ProtocolEndpoint.BroadcastReset")

This method is not supported.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

A short textual description of the object.

This property is inherited from CIM_ManagedElement.

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (256)

The class name used to create an instance of this class. CreationClassName is combined with other key properties of this class to uniquely identify instances of this class and its subclasses.

This property is inherited from CIM_ServiceAccessPoint.

Description

Data type: string

Access type: Read-only

Qualifiers: Override ("Description"), MappingStrings ("MIB.IETF|IF-MIB.ifDescr")

A textual description of the object.

ElementName

Data type: string

Access type: Read-only

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

This property is inherited from CIM_ManagedElement.

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 Enabled (2).

This property is inherited from CIM_EnabledLogicalElement.

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

EnabledState

Data type: uint16

Access type: Read-only

Qualifiers: Override ("EnabledState"), MappingStrings ("MIB.IETF|IF-MIB.ifAdminStatus")

The enabled state of an element.

The possible values are:

Unknown (0)

The element is in an unknown state.

Other (1)

The element is in a known state that is not defined by other possible values.

Enabled (2)

The element can execute, process, and queue commands.

Disabled (3)

The element will drop commands and requests.

Shutting Down (4)

The element is in a transition to a disabled state.

Not Applicable (5)

The element does not support being enabled or disabled.

Enabled but Offline (6)

The element might be completing commands, and new requests are dropped.

In Test (7)

The element is in a test state.

Deferred (8)

The element is processing commands and queuing new requests.

Quiesce (9)

The element is in an enabled state, but with restricted capabilities.

Starting (10)

The element is in a transition to an enabled state, and new requests are queued.

DMTF Reserved

Reserved.

Vendor Reserved

Reserved.

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.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

The implementation cannot report on HealthState 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 is nonfunctional, and recovery might not be possible.

Non-recoverable error (30)

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

DMTF Reserved

Reserved.

InstallDate

Data type: datetime

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

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 CIM_ManagedSystemElement.

Name

Data type: string

Access type: Read-only

Qualifiers: Override ("Name"), MaxLen (256)

A unique identifier of the protocol endpoint that indicates the managed functionality. The naming convention for this property is defined in the NameFormat property.

NameFormat

Data type: string

Access type: Read-only

Qualifiers: MaxLen (256)

The naming convention used by the Name property to ensure that Name values are unique. For example, you can append the ProtocolIFType property value to the beginning of the name followed by an underscore.

OperationalStatus

Data type: uint16 array

Access type: Read-only

Qualifiers: Override ("OperationalStatus"), MappingStrings ("MIB.IETF|IF-MIB.ifOperStatus")

An array that contains the current status of the element. The first value of the OperationalStatus array should contain the primary status for the element.

The possible values are:

Unknown (0)

The implementation cannot report the status at this time.

Other (1)

An undefined state.

OK (2)

Full functionality without errors.

Degraded (3)

The element is in working order and that 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.

Stressed (4)

The element functions, but requires attention. Overload and overheated are examples of Stressed states.

Predictive Failure (5)

The element functions nominally, will probably fail in the near future.

Error (6)

An error has occurred.

Non-Recoverable Error (7)

A nonrecoverable error has occurred.

Starting (8)

The job is starting.

Stopping (9)

The job is stopping.

Stopped (10)

The element has been intentionally stopped.

In Service (11)

The element is in process to be configured, maintained, cleaned, or otherwise administered.

No Contact (12)

The monitoring system has information about this element, but has never been able to establish communications with it.

Lost Communication (13)

The monitoring system has successfully contacted this element in the past, but it is currently unavailable.

Aborted (14)

The job stopped in an unexpected way. The state and configuration of the job might require an update.

Dormant (15)

The job is inactive.

Supporting Entity in Error (16)

An element on which this job 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.

Completed (17)

The job has completed its operation. This value should be combined with either OK, Error, or Degraded to indicate to a client whether the complete operation Completed with OK and passed, or completed with Error and failed, or completed with Degraded and finished the operation, but did not complete OK or did not report an error.

Power Mode (18)

The element has additional power model information that is contained in the associated power management service.

DMTF Reserved

Reserved.

Vendor Reserved

Reserved.

OtherEnabledState

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

Describes 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 CIM_EnabledLogicalElement.

OtherTypeDescription

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64), ModelCorrespondence ("CIM_ProtocolEndpoint.ProtocolType", "CIM_ProtocolEndpoint.ProtocolIFType")

A description of a network protocol type that is used when the ProtocolIFType property is set to "1" (Other); otherwise, this value should be set to null.

ProtocolIFType

Data type: uint16

Access type: Read-only

Qualifiers: MappingStrings ("MIB.IETF|IF-MIB.ifType"), ModelCorrespondence ("CIM_ProtocolEndpoint.OtherTypeDescription")

An enumeration used to categorize and classify different instances of this class. The possible values for this property are synchronized with the Internet Assigned Numbers Authority (IANA) ifType MIB-module (management information base), which is maintained at http://www.iana.org/assignments/ianaiftype-mib. Additional values defined by the DMTF are included.

Note

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

Unknown (0)

Other (1)

Regular 1822 (2)

HDH 1822 (3)

DDN X.25 (4)

RFC877 X.25 (5)

Ethernet CSMA/CD (6)

ISO 802.3 CSMA/CD (7)

ISO 802.4 Token Bus (8)

ISO 802.5 Token Ring (9)

ISO 802.6 MAN (10)

StarLAN (11)

Proteon 10Mbit (12)

Proteon 80Mbit (13)

HyperChannel (14)

FDDI (15)

LAP-B (16)

SDLC (17)

DS1 (18)

E1 (19)

Basic ISDN (20)

Primary ISDN (21)

Proprietary Point-to-Point Serial (22)

PPP (23)

Software Loopback (24)

EON (25)

Ethernet 3Mbit (26)

NSIP (27)

SLIP (28)

Ultra (29)

DS3 (30)

SIP (31)

Frame Relay (32)

RS-232 (33)

Parallel (34)

ARCNet (35)

ARCNet Plus (36)

ATM (37)

MIO X.25 (38)

SONET (39)

X.25 PLE (40)

ISO 802.211c (41)

LocalTalk (42)

SMDS DXI (43)

Frame Relay Service (44)

V.35 (45)

HSSI (46)

HIPPI (47)

Modem (48)

AAL5 (49)

SONET Path (50)

SONET VT (51)

SMDS ICIP (52)

Proprietary Virtual/Internal (53)

Proprietary Multiplexor (54)

IEEE 802.12 (55)

Fibre Channel (56)

HIPPI Interface (57)

Frame Relay Interconnect (58)

ATM Emulated LAN for 802.3 (59)

ATM Emulated LAN for 802.5 (60)

ATM Emulated Circuit (61)

Fast Ethernet (100BaseT) (62)

ISDN (63)

V.11 (64)

V.36 (65)

G703 at 64K (66)

G703 at 2Mb (67)

QLLC (68)

Fast Ethernet 100BaseFX (69)

Channel (70)

IEEE 802.11 (71)

IBM 260/370 OEMI Channel (72)

ESCON (73)

Data Link Switching (74)

ISDN S/T Interface (75)

ISDN U Interface (76)

LAP-D (77)

IP Switch (78)

Remote Source Route Bridging (79)

ATM Logical (80)

DS0 (81)

DS0 Bundle (82)

BSC (83)

Async (84)

Combat Net Radio (85)

ISO 802.5r DTR (86)

Ext Pos Loc Report System (87)

AppleTalk Remote Access Protocol (88)

Proprietary Connectionless (89)

ITU X.29 Host PAD (90)

ITU X.3 Terminal PAD (91)

Frame Relay MPI (92)

ITU X.213 (93)

ADSL (94)

RADSL (95)

SDSL (96)

VDSL (97)

ISO 802.5 CRFP (98)

Myrinet (99)

Voice Receive and Transmit (100)

Voice Foreign Exchange Office (101)

Voice Foreign Exchange Service (102)

Voice Encapsulation (103)

Voice over IP (104)

ATM DXI (105)

ATM FUNI (106)

ATM IMA (107)

PPP Multilink Bundle (108)

IP over CDLC (109)

IP over CLAW (110)

Stack to Stack (111)

Virtual IP Address (112)

MPC (113)

IP over ATM (114)

ISO 802.5j Fibre Token Ring (115)

TDLC (116)

Gigabit Ethernet (117)

HDLC (118)

LAP-F (119)

V.37 (120)

X.25 MLP (121)

X.25 Hunt Group (122)

Transp HDLC (123)

Interleave Channel (124)

FAST Channel (125)

IP (for APPN HPR in IP Networks) (126)

CATV MAC Layer (127)

CATV Downstream (128)

CATV Upstream (129)

Avalon 12MPP Switch (130)

Tunnel (131)

Coffee (132)

Circuit Emulation Service (133)

ATM SubInterface (134)

Layer 2 VLAN using 802.1Q (135)

Layer 3 VLAN using IP (136)

Layer 3 VLAN using IPX (137)

Digital Power Line (138)

Multimedia Mail over IP (139)

DTM (140)

DCN (141)

IP Forwarding (142)

MSDSL (143)

IEEE 1394 (144)

IF-GSN/HIPPI-6400 (145)

DVB-RCC MAC Layer (146)

DVB-RCC Downstream (147)

DVB-RCC Upstream (148)

ATM Virtual (149)

MPLS Tunnel (150)

SRP (151)

Voice over ATM (152)

Voice over Frame Relay (153)

ISDL (154)

Composite Link (155)

SS7 Signaling Link (156)

Proprietary P2P Wireless (157)

Frame Forward (158)

RFC1483 Multiprotocol over ATM (159)

USB (160)

IEEE 802.3ad Link Aggregate (161)

BGP Policy Accounting (162)

FRF .16 Multilink FR (163)

H.323 Gatekeeper (164)

H.323 Proxy (165)

MPLS (166)

Multi-Frequency Signaling Link (167)

HDSL-2 (168)

S-HDSL (169)

DS1 Facility Data Link (170)

Packet over SONET/SDH (171)

DVB-ASI Input (172)

DVB-ASI Output (173)

Power Line (174)

Non Facility Associated Signaling (175)

TR008 (176)

GR303 RDT (177)

GR303 IDT (178)

ISUP (179)

Proprietary Wireless MAC Layer (180)

Proprietary Wireless Downstream (181)

Proprietary Wireless Upstream (182)

HIPERLAN Type 2 (183)

Proprietary Broadband Wireless Access Point to Mulipoint (184)

SONET Overhead Channel (185)

Digital Wrapper Overhead Channel (186)

ATM Adaptation Layer 2 (187)

Radio MAC (188)

ATM Radio (189)

Inter Machine Trunk (190)

MVL DSL (191)

Long Read DSL (192)

Frame Relay DLCI Endpoint (193)

ATM VCI Endpoint (194)

Optical Channel (195)

Optical Transport (196)

Proprietary ATM (197)

Voice over Cable (198)

Infiniband (199)

TE Link (200)

Q.2931 (201)

Virtual Trunk Group (202)

SIP Trunk Group (203)

SIP Signaling (204)

CATV Upstream Channel (205)

Econet (206)

FSAN 155Mb PON (207)

FSAN 622Mb PON (208)

Transparent Bridge (209)

Line Group (210)

Voice E&M Feature Group (211)

Voice FGD EANA (212)

Voice DID (213)

MPEG Transport (214)

6To4 (215)

GTP (216)

Paradyne EtherLoop 1 (217)

Paradyne EtherLoop 2 (218)

Optical Channel Group (219)

HomePNA (220)

GFP (221)

ciscoISLvlan (222)

actelisMetaLOOP (223)

Fcip (224)

IANA Reserved

225 4095

IPv4 (4096)

IPv6 (4097)

IPv4/v6 (4098)

IPX (4099)

DECnet (4100)

SNA (4101)

CONP (4102)

CLNP (4103)

VINES (4104)

XNS (4105)

ISDN B Channel Endpoint (4106)

ISDN D Channel Endpoint (4107)

BGP (4108)

OSPF (4109)

UDP (4110)

TCP (4111)

802.11a (4112)

802.11b (4113)

802.11g (4114)

802.11h (4115)

NFS (4200)

CIFS (4201)

DAFS (4202)

WebDAV (4203)

HTTP (4204)

FTP (4205)

NDMP (4300)

Telnet (4400)

SSH (4401)

SM CLP (4402)

SMTP (4403)

LDAP (4404)

RDP (4405)

HTTPS (4406)

DMTF Reserved

4407 32767

Vendor Reserved

32768 65535

ProtocolType

Data type: uint16

Access type: Read-only

Qualifiers: Deprecated ("CIM_ProtocolEndpoint.ProtocolIFType"), ModelCorrespondence ("CIM_ProtocolEndpoint.OtherTypeDescription")

Note

Deprecated description: An enumeration used to categorize and classify different instances of this class.

This property is deprecated. Instead, use the ProtocolIFType property.

RequestedState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

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.

This property is inherited from CIM_EnabledLogicalElement.

The possible values are.

Unknown (0)

Indicates the last requested state for the element is unknown.

Enabled (2)

Indicates that the element executes or could execute commands, processes 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.

Offline (6)

Indicates a request to change 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 that it 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 change to an Enabled state.

Not Applicable (12)

Indicates that this instance does not support the RequestedState property.

DMTF Reserved

Reserved.

Vendor Reserved

Reserved.

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.

This property is inherited from CIM_ManagedSystemElement.

StatusDescriptions

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")

Indicates descriptions of the corresponding values in the OperationalStatus array. For example, if an element in the OperationalStatus property 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 CIM_ManagedSystemElement.

SystemCreationClassName

Data type: string

Access type: Read-only

Qualifiers: Key, Propagated ("CIM_System.CreationClassName"), MaxLen (256)

The class name used to create an instance of the system that contains the SAP. SystemCreationClassName is combined with other key properties of this class to uniquely identify instances of this class and its subclasses.

This property is inherited from CIM_ServiceAccessPoint.

SystemName

Data type: string

Access type: Read-only

Qualifiers: Key, Propagated ("CIM_System.Name"), MaxLen (256)

The name of the system that contains the SAP.

This property is inherited from CIM_ServiceAccessPoint.

TimeOfLastStateChange

Data type: datetime

Access type: Read-only

Qualifiers: Override ("TimeOfLastStateChange"), MappingStrings ("MIB.IETF|IF-MIB.ifLastChange")

The date and time when the EnabledState property last changed. If EnabledState has not changed and this property is populated, then it must be set to a zero interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated.

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2008
End of client support
None supported
End of server support
Windows Server 2012 R2
Namespace
Root\virtualization
MOF
WindowsVirtualization.mof

See also

CIM_ServiceAccessPoint