SUMMARY: NESTED | FIELD | | METHOD
DETAIL: FIELD | METHOD

Class CIM_LANEndpoint

CIM_ManagedElement
   extended by CIM_ManagedSystemElement
      extended by CIM_LogicalElement
         extended by CIM_EnabledLogicalElement
            extended by CIM_ServiceAccessPoint
               extended by CIM_ProtocolEndpoint
                  extended by CIM_LANEndpoint
Known Subclasses:
IPS_LANEndpoint CIM_WiFiEndpoint 
class CIM_LANEndpoint
 extends CIM_ProtocolEndpoint


General Information:
A communication endpoint which, when its 
associated interface device is connected to a LAN, may send and receive data 
frames. LANEndpoints include Ethernet, Token Ring and FDDI 
interfaces.

Qualifiers:
-------------
Version=2.7.0
UMLPackagePath=CIM::Network::ProtocolEndpoints









  
  

    Supported Fields 
      Summary

  

     uint16 
      
    ProtocolType 
Note: 
      This property is deprecated in lieu of the ProtocolIFType enumeration . . 
      .

  

     string 
      
    Name Key  
A string that identifies this ProtocolEndpoint 
      with either a port or an interface on a device . . .

  

     uint16 
      
    EnabledState 
    


  

     uint16 
      
    RequestedState 
      
RequestedState is an integer enumeration that indicates the 
      last requested or desired state for the element, irrespective of the 
      mechanism through which it was requested . . .

  

     string 
      
    Status 
A string 
      indicating the current status of the object . . .

  

     string 
      
    ElementName 
A 
      user-friendly name for the object . . .

  

     string 
      
    SystemCreationClassName Key  
The CreationClassName of the scoping 
      System.

  

     string 
      
    SystemName Key  
The Name of the scoping System.

  

     string 
      
    CreationClassName Key  
CreationClassName indicates the name 
      of the class or the subclass used in the creation of an instance . . 
    .

  

     string 
      
    LANID 
A label or 
      identifier for the LAN Segment to which the Endpoint is connected . . 
    .

  

     uint16 
      
    LANType 
An indication 
      of the kind of technology used on the LAN . . .

  

     string 
      
    MACAddress 
The 
      principal unicast address used in communication with the LANEndpoint . . 
      .




  
  

    Methods Summary

  

     uint32
    RequestStateChange(RequestedState, REF 
      Job, TimeoutPeriod) 
Requests that the state of the element be 
      changed to the value specified in the RequestedState parameter . . 
.

  

     
    Create(Instance, 
      ResourceCreated) 
Creates a new instance of this class

  

     
    Put(Instance) 
Changes 
      properties of the selected instance

  

     
    Get(Instance) 
Gets the 
      representation of the instance

  

     
    Delete() 
Deletes an 
      instance

  

     
    Pull(EnumerationContext, 
      MaxElements) 
Pulls instances of this class, following an 
      Enumerate operation

  

     
    Enumerate() 
      
Enumerates the instances of this class

  

     
    Release(EnumerationContext) 
      
Releases an enumeration context

  

     
    Subscribe() 
      
Subscribes to this resource (WS-Eventing)

  

     
    Unsubscribe() 
      
Remove subscription to this resource 
  (WS-Eventing)




  
  

    Field 
Detail


ProtocolType 
public uint16 ProtocolType



  
General Information:
Note: This property is deprecated in lieu 
  of the ProtocolIFType enumeration. This deprecation was done to have better 
  alignment between the IF-MIB of the IETF and this CIM class. 
Deprecated 
  description: ProtocolType is an enumeration that provides information to 
  categorize and classify different instances of this class. For most instances, 
  information in this enumeration and the definition of the subclass overlap. 
  However, there are several cases where a specific subclass of ProtocolEndpoint 
  is not required (for example, there is no Fibre Channel subclass of 
  ProtocolEndpoint). Therefore, this property is needed to define the type of 
  Endpoint.

Qualifiers:
-------------
Deprecated={CIM_ProtocolEndpoint.ProtocolIFType}
ValueMap={0, 
  1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 
  23, 24, 25, 26, 27}
Values={Unknown, Other, IPv4, IPv6, IPX, AppleTalk, 
  DECnet, SNA, CONP, CLNP, VINES, XNS, ATM, Frame Relay, Ethernet, TokenRing, 
  FDDI, Infiniband, Fibre Channel, ISDN BRI Endpoint, ISDN B Channel Endpoint, 
  ISDN D Channel Endpoint, IPv4/v6, BGP, OSPF, MPLS, UDP, 
  TCP}
ModelCorrespondence={CIM_ProtocolEndpoint.OtherTypeDescription}


  

  





Name Key 
public string Name



  
General Information:
A string that identifies this 
  ProtocolEndpoint with either a port or an interface on a device. To ensure 
  uniqueness, the Name property should be prepended or appended with information 
  from the Type or OtherTypeDescription properties. The method selected is 
  described in the NameFormat property of this 
  class.

Qualifiers:
-------------
Override=Name
MaxLen=30


  

  





EnabledState 
public uint16 EnabledState



  
General 
  Information:


Qualifiers:
-------------
Override=EnabledState
MappingStrings={MIB.IETF|IF-MIB.ifAdminStatus}


  

  





RequestedState 
public uint16 RequestedState



  
General Information:
RequestedState is an integer enumeration 
  that indicates the last requested or desired state for the element, 
  irrespective of the mechanism through which it was requested. The actual state 
  of the element is represented by EnabledState. This property is provided to 
  compare the last requested and current enabled or disabled states. Note that 
  when EnabledState is set to 5 ("Not Applicable"), then this property has no 
  meaning. Refer to the EnabledState property description for explanations of 
  the values in the RequestedState enumeration. 
"Unknown" (0) indicates the 
  last requested state for the element is unknown.
Note that the value "No 
  Change" (5) has been deprecated in lieu of indicating the last requested state 
  is "Unknown" (0). If the last requested or desired state is unknown, 
  RequestedState should have the value "Unknown" (0), but may have the value "No 
  Change" (5).Offline (6) indicates that the element has been requested to 
  transition to the Enabled but Offline EnabledState. 
It should be noted 
  that there are two new values in RequestedState that build on the statuses of 
  EnabledState. These are "Reboot" (10) and "Reset" (11). Reboot refers to doing 
  a "Shut Down" and then moving to an "Enabled" state. Reset indicates that the 
  element is first "Disabled" and then "Enabled". The distinction between 
  requesting "Shut Down" and "Disabled" should also be noted. Shut Down requests 
  an orderly transition to the Disabled state, and might involve removing power, 
  to completely erase any existing state. The Disabled state requests an 
  immediate disabling of the element, such that it will not execute or accept 
  any commands or processing requests. 

This property is set as the 
  result of a method invocation (such as Start or StopService on CIM_Service), 
  or can be overridden and defined as WRITEable in a subclass. The method 
  approach is considered superior to a WRITEable property, because it allows an 
  explicit invocation of the operation and the return of a result code. 
  

If knowledge of the last RequestedState is not supported for the 
  EnabledLogicalElement, the property shall be NULL or have the value 12 "Not 
  Applicable".

Qualifiers:
-------------
ValueMap={0, 2, 3, 
  4, 5, 6, 7, 8, 9, 10, 11, 12, .., 32768..65535}
Values={Unknown, Enabled, 
  Disabled, Shut Down, No Change, Offline, Test, Deferred, Quiesce, Reboot, 
  Reset, Not Applicable, DMTF Reserved, Vendor 
  Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.EnabledState}


  

  





Status 
public string Status



  
General Information:
A string indicating the current status of 
  the object. Various operational and non-operational statuses are defined. This 
  property is deprecated in lieu of OperationalStatus, which includes the same 
  semantics in its enumeration. This change is made for 3 reasons: 
1) Status 
  is more correctly defined as an array. This definition overcomes the 
  limitation of describing status using a single value, when it is really a 
  multi-valued property (for example, an element might be OK AND Stopped. 
2) 
  A MaxLen of 10 is too restrictive and leads to unclear enumerated values. 
  
3) The change to a uint16 data type was discussed when CIM V2.0 was 
  defined. However, existing V1.0 implementations used the string property and 
  did not want to modify their code. Therefore, Status was grandfathered into 
  the Schema. Use of the deprecated qualifier allows the maintenance of the 
  existing property, but also permits an improved definition using 
  OperationalStatus.

Qualifiers:
-------------
Deprecated={CIM_ManagedSystemElement.OperationalStatus}
ValueMap={OK, 
  Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed, 
  NonRecover, No Contact, Lost Comm, Stopped}
MaxLen=10


  

  





ElementName 
public string ElementName



  
General Information:
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. 
Note that 
  the Name property of ManagedSystemElement is also defined as a user-friendly 
  name. But, it is often subclassed to be a Key. It is not reasonable that the 
  same property can convey both identity and a user-friendly name, without 
  inconsistencies. Where Name exists and is not a Key (such as for instances of 
  LogicalDevice), the same information can be present in both the Name and 
  ElementName properties. Note that if there is an associated instance of 
  CIM_EnabledLogicalElementCapabilities, restrictions on this properties may 
  exist as defined in ElementNameMask and MaxElementNameLen properties defined 
  in that 
class.

Qualifiers:
-------------
MaxLen=256


  

  





SystemCreationClassName Key 
public string SystemCreationClassName



  
General Information:
The CreationClassName of the scoping 
  System.

Qualifiers:
-------------
Key
MaxLen=20
Propagated=CIM_System.CreationClassName


  

  





SystemName Key 
public string SystemName



  
General Information:
The Name of the scoping 
  System.

Qualifiers:
-------------
Key
MaxLen=20
Propagated=CIM_System.Name


  

  





CreationClassName Key 
public string CreationClassName



  
General Information:
CreationClassName indicates the name of the 
  class or the subclass used in the creation of an instance. When used with the 
  other key properties of this class, this property allows all instances of this 
  class and its subclasses to be uniquely 
  identified.

Qualifiers:
-------------
Key
MaxLen=20


  

  





LANID 
public string LANID



  
General Information:
A label or identifier for the LAN Segment 
  to which the Endpoint is connected. If the Endpoint is not currently 
  active/connected or this information is not known, then LANID is 
  NULL.

Qualifiers:
-------------
ModelCorrespondence={CIM_LANConnectivitySegment.LANID, 
  CIM_LANSegment.LANID}
MaxLen=256


  

  





LANType 
public uint16 LANType



  
General Information:
An indication of the kind of technology 
  used on the LAN. This property is deprecated in lieu of ProtocolType, which is 
  an enumeration inherited from ProtocolEndpoint and which includes the Values 
  specified 
  here.

Qualifiers:
-------------
Deprecated={CIM_ProtocolEndpoint.ProtocolType}
ValueMap={0, 
  1, 2, 3, 4}
Values={Unknown, Other, Ethernet, TokenRing, 
  FDDI}
ModelCorrespondence={CIM_LANConnectivitySegment.ConnectivityType, 
  CIM_LANSegment.LANType}


  

  





MACAddress 
public string MACAddress



  
General Information:
The principal unicast address used in 
  communication with the LANEndpoint. The MAC address is formatted as twelve 
  hexadecimal digits (e.g., "010203040506"), with each pair representing one of 
  the six octets of the MAC address in "canonical" bit order according to RFC 
  2469.

Qualifiers:
-------------
MaxLen=12


  

  






  
  

    Method 
Detail


RequestStateChange
public uint32 RequestStateChange([IN]uint16 RequestedState, [OUT]REF CIM_ConcreteJob Job, [IN]datetime TimeoutPeriod)



  
Permission Information:
No permissions defined

General 
  Information:
Requests that the state of the element be changed to the 
  value specified in the RequestedState parameter. When the requested state 
  change takes place, the EnabledState and RequestedState of the element will be 
  the same. Invoking the RequestStateChange method multiple times could result 
  in earlier requests being overwritten or lost. 
A return code of 0 shall 
  indicate the state change was successfully initiated. 
A return code of 3 
  shall indicate that the state transition cannot complete within the interval 
  specified by the TimeoutPeriod parameter. 
A return code of 4096 (0x1000) 
  shall indicate the state change was successfully initiated, a ConcreteJob has 
  been created, and its reference returned in the output parameter Job. Any 
  other return code indicates an error 
  condition.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 
  4, 5, 6, .., 4096, 4097, 4098, 4099, 4100..32767, 
  32768..65535}
Values={Completed with No Error, Not Supported, Unknown or 
  Unspecified Error, Cannot complete within Timeout Period, Failed, Invalid 
  Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, 
  Invalid State Transition, Use of Timeout Parameter Not Supported, Busy, Method 
  Reserved, Vendor 
  Specific}
ModelCorrespondence={CIM_EnabledLogicalElement.RequestedState}


Parameters:
--------------

  

    
RequestedState 
    
General Information:
The state requested for the element. This 
    information will be placed into the RequestedState property of the instance 
    if the return code of the RequestStateChange method is 0 ('Completed with No 
    Error'), or 4096 (0x1000) ('Job Started'). Refer to the description of the 
    EnabledState and RequestedState properties for the detailed explanations of 
    the RequestedState 
    values.

Qualifiers:
-------------
IN
ValueMap={2, 3, 
    4, 6, 7, 8, 9, 10, 11, .., 32768..65535}
Values={Enabled, Disabled, Shut 
    Down, Offline, Test, Defer, Quiesce, Reboot, Reset, DMTF Reserved, Vendor 
    Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.RequestedState}


    
Job 
    
General Information:
May contain a reference to the 
    ConcreteJob created to track the state transition initiated by the method 
    invocation.

Qualifiers:
-------------
IN=false
OUT


    
TimeoutPeriod 
    
General Information:
A timeout period that specifies the 
    maximum amount of time that the client expects the transition to the new 
    state to take. The interval format must be used to specify the 
    TimeoutPeriod. A value of 0 or a null parameter indicates that the client 
    has no time requirements for the transition. 
If this property does not 
    contain 0 or null and the implementation does not support this parameter, a 
    return code of 'Use Of Timeout Parameter Not Supported' shall be 
    returned.

Qualifiers:
-------------
IN







Create
public  Create([IN]CIM_LANEndpoint Instance, [OUT] REF CIM_LANEndpoint ResourceCreated)



  
Permission Information:
No permissions defined

General 
  Information:
Creates a new instance of this class

Product 
  Specific Usage:
The following properties must be included in any 
  representation of CIM_LANEndpoint: 

Name 
SystemCreationClassName 
  
SystemName 
CreationClassName 






Put
public  Put([IN]CIM_LANEndpoint Instance)



  
Permission Information:
No permissions defined

General 
  Information:
Changes properties of the selected 
  instance

Product Specific Usage:
The following properties 
  must be included in any representation of CIM_LANEndpoint: 

Name 
  
SystemCreationClassName 
SystemName 
CreationClassName 







Get
public  Get([OUT]CIM_LANEndpoint Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM, 
  ADMIN_SECURITY_GENERAL_INFO_REALM

General Information:
Gets 
  the representation of the instance





Delete
public  Delete()



  
Permission Information:
No permissions defined

General 
  Information:
Deletes an instance





Pull
public  Pull([IN]String EnumerationContext, [IN]String MaxElements)



  
Permission Information:
All users permitted to use method, only 
  instances to whom the user has permissions will be returned

General 
  Information:
Pulls instances of this class, following an Enumerate 
  operation





Enumerate
public  Enumerate()



  
Permission Information:
All users permitted to use 
  method

General Information:
Enumerates the instances of this 
  class





Release
public  Release([IN]String EnumerationContext)



  
Permission Information:
All users permitted to use 
  method

General Information:
Releases an enumeration 
  context





Subscribe
public  Subscribe()



  
Permission Information:
No permissions defined

General 
  Information:
Subscribes to this resource (WS-Eventing)





Unsubscribe
public  Unsubscribe()



  
Permission Information:
No permissions defined

General 
  Information:
Remove subscription to this resource 
(WS-Eventing)






  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

    
      
Copyright © 2006-2022, Intel 
      Corporation. All rights 
reserved.