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

Class CIM_WiFiEndpoint

Used in features: Wireless
Compatible with the following Intel AMT Releases: 4.0, 6.0, 6.1, 6.2, 7.0, 8.0, 8.1, 9.0, 9.5, 10.0, 11.0 
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
                     extended by CIM_WiFiEndpoint


class CIM_WiFiEndpoint
 extends CIM_LANEndpoint


General Information:
A wireless communication endpoint which, when 
its associated interface device is associated with an IEEE 802.11 wireless LAN, 
may send and receive data 
frames.

Qualifiers:
-------------
Version=2.22.0
UMLPackagePath=CIM::Network::Wireless









  
  

    Supported Fields 
      Summary

  

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

  

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

  

     string 
      
    SystemName Key  
The Name of the scoping System.

  

     string 
      
    SystemCreationClassName Key  
The CreationClassName of the scoping 
      System.

  

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

  

     uint16 
      
    HealthState 
      
Indicates the current health of the element . . .

  

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

  

     uint16 
      
    EnabledState 
    


  

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

  

     string 
      
    LANID 
LANID shall contain 
      the Service Set Identifier (SSID) of the wireless LAN with which the 
      Endpoint is associated, or shall be NULL if the Endpoint is not currently 
      associated or this information is not known.

  

     uint16 
      
    ProtocolIFType 
      
ProtocolIFType's enumeration is limited to Wi-Fi and reserved 
      values for this subclass of 
ProtocolEndpoint.




  
  

    Methods Summary

  

     
    Get(Instance) 
Gets the 
      representation of the 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




  
  

    Field 
Detail


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=20


  

  





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.

Product Specific 
  Usage:
In Intel AMT Release 6.0 and later releases value is 
  "CIM_WiFiEndpoint"

Qualifiers:
-------------
Key
MaxLen=17


  

  





SystemName Key 
public string SystemName



  
General Information:
The Name of the scoping 
  System.

Product Specific Usage:
In Intel AMT Release 6.0 and 
  later releases value is "Intel(r) 
  AMT"

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


  

  





SystemCreationClassName Key 
public string SystemCreationClassName



  
General Information:
The CreationClassName of the scoping 
  System.

Product Specific Usage:
In Intel AMT Release 6.0 and 
  later releases value is 
  "CIM_ComputerSystem"

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


  

  





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.

Product Specific Usage:
In Intel AMT Release 
  6.0 and later releases value is "WiFi Endpoint 
  0"

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


  

  





HealthState 
public uint16 HealthState



  
General Information:
Indicates the current health of the 
  element. This attribute expresses the health of this element but not 
  necessarily that of its subcomponents. The possible values are 0 to 30, where 
  5 means the element is entirely healthy and 30 means the element is completely 
  non-functional. The following continuum is defined: 
"Non-recoverable 
  Error" (30) - The element has completely failed, and recovery is not possible. 
  All functionality provided by this element has been lost. 
"Critical 
  Failure" (25) - The element is non-functional and recovery might not be 
  possible. 
"Major Failure" (20) - The element is failing. It is possible 
  that some or all of the functionality of this component is degraded or not 
  working. 
"Minor Failure" (15) - All functionality is available but some 
  might be degraded. 
"Degraded/Warning" (10) - The element is in working 
  order and all functionality is provided. However, the element is not working 
  to the best of its abilities. For example, the element might not be operating 
  at optimal performance or it might be reporting recoverable errors. 
"OK" 
  (5) - The element is fully functional and is operating within normal 
  operational parameters and without error. 
"Unknown" (0) - The 
  implementation cannot report on HealthState at this time. 
DMTF has 
  reserved the unused portion of the continuum for additional HealthStates in 
  the future.

Qualifiers:
-------------
ValueMap={0, 5, 10, 
  15, 20, 25, 30, .., 32768..65535}
Values={Unknown, OK, Degraded/Warning, 
  Minor failure, Major failure, Critical failure, Non-recoverable error, DMTF 
  Reserved, Vendor Specific}


  

  





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}


  

  





EnabledState 
public uint16 EnabledState



  
General Information:


Product Specific 
  Usage:
EnabledState can have the value of: 
- 2 (Enabled) if there's 
  an active wireless connection in the endpoint. 
- 3 (Disabled) if the radio 
  is off. 
- 6 (Enabled but Offline) if the radio is on but no connection 
  exists. 
  


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


  

  





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.

Product Specific 
  Usage:
In Intel AMT Release 6.0 and later releases value is "WiFi 
  Endpoint 
  0"

Qualifiers:
-------------
Override=Name
MaxLen=20


  

  





LANID 
public string LANID



  
General Information:
LANID shall contain the Service Set 
  Identifier (SSID) of the wireless LAN with which the Endpoint is associated, 
  or shall be NULL if the Endpoint is not currently associated or this 
  information is not 
  known.

Qualifiers:
-------------
Override=LANID
MappingStrings={IEEE 
  802.11-2007 | 7.3.2.1}
MaxLen=32


  

  





ProtocolIFType 
public uint16 ProtocolIFType



  
General Information:
ProtocolIFType's enumeration is limited to 
  Wi-Fi and reserved values for this subclass of 
  ProtocolEndpoint.

Qualifiers:
-------------
Override=ProtocolIFType
ValueMap={1, 
  71, 225..4095, 4301..32767, 32768..}
Values={Other, IEEE 802.11, IANA 
  Reserved, DMTF Reserved, Vendor Reserved}


  

  






  
  

    Method 
Detail


Get
public  Get([OUT]CIM_WiFiEndpoint Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM, ADMIN_SECURITY_GENERAL_INFO_REALM, 
  ADMIN_SECURITY_LOCAL_SYSTEM_REALM

General Information:
Gets 
  the representation of the instance

Product Specific 
  Usage:
Additional Notes: 
1) 'Get' in Intel AMT Release 6.0 and 
  later releases is permitted only to 'ADMIN_SECURITY_ADMINISTRATION_REALM' and 
  'ADMIN_SECURITY_LOCAL_SYSTEM_REALM ' 
2) Starting in Release 7.0, 'Get' is 
  permitted also to 'ADMIN_SECURITY_GENERAL_INFO_REALM'.





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






  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

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