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

Class CIM_WiFiEndpointSettings

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_SettingData
      extended by CIM_WiFiEndpointSettings


class CIM_WiFiEndpointSettings
 extends CIM_SettingData


General Information:
CIM_WiFiEndpointSettings describes setting 
data that can be applied to an instance of CIM_WiFiEndpoint to enable it to 
associate to a particular Wi-Fi 
network.

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









  
  

    Supported Fields 
      Summary

  

     string 
      
    ElementName 
The 
      user-friendly name for this instance of SettingData . . .

  

     string 
      
    InstanceID Key  
Within the scope of the instantiating Namespace, 
      InstanceID opaquely and uniquely identifies an instance of this class . . 
      .

  

     uint8 
      
    Priority 
Priority 
      shall indicate the priority of the instance among all WiFiEndpointSettings 
      instances.

  

     string 
      
    SSID 
SSID shall indicate 
      the Service Set Identifier (SSID) that shall be used when the settings are 
      applied to a WiFiEndpoint . . .

  

     uint16 
      
    BSSType 
BSSType shall 
      indicate the Basic Service Set (BSS) Type that shall be used when the 
      settings are applied . . .

  

     uint16 
      
    EncryptionMethod 
      
EncryptionMethod shall specify the 802.11 encryption method 
      used when the settings are applied . . .

  

     uint16 
      
    AuthenticationMethod 
      
AuthenticationMethod shall specify the 802.11 authentication 
      method used when the settings are applied . . .

  

     string[4] 
      
    Keys 
Keys shall contain 
      the default WEP encryption keys . . .

  

     uint8 
      
    KeyIndex 
KeyIndex 
      shall contain the index of the active key in the Keys array property . . 
      .

  

     uint8[255] 
      
    PSKValue 
The actual 
      binary value of a PSK (pre-shared key) . . .

  

     string 
      
    PSKPassPhrase 
An 
      ASCII string of 8-63 printable characters used to generate a PSK (pre-shared key) . . 
    .




  
  

    Methods Summary

  

     
    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




  
  

    Field 
Detail


ElementName 
public string ElementName



  
General Information:
The user-friendly name for this instance of 
  SettingData. In addition, the user-friendly name can be used as an index 
  property for a search or query. (Note: The name does not have to be unique 
  within a namespace.)

Product Specific Usage:
The WLAN profile 
  name. 
The profile name can't be changed after the profile was 
  created.

Qualifiers:
-------------
Required
Override=ElementName
MaxLen=32


  

  





InstanceID Key 
public string InstanceID



  
General Information:
Within the scope of the instantiating 
  Namespace, InstanceID opaquely and uniquely identifies an instance of this 
  class. To ensure uniqueness within the NameSpace, the value of InstanceID 
  should be constructed using the following "preferred" algorithm: 
  
<OrgID>:<LocalID> 
Where <OrgID> and <LocalID> 
  are separated by a colon (:), and where <OrgID> must include a 
  copyrighted, trademarked, or otherwise unique name that is owned by the 
  business entity that is creating or defining the InstanceID or that is a 
  registered ID assigned to the business entity by a recognized global 
  authority. (This requirement is similar to the <Schema Name>_<Class 
  Name> structure of Schema class names.) In addition, to ensure uniqueness, 
  <OrgID> must not contain a colon (:). When using this algorithm, the 
  first colon to appear in InstanceID must appear between <OrgID> and 
  <LocalID>. 
<LocalID> is chosen by the business entity and 
  should not be reused to identify different underlying (real-world) elements. 
  If the above "preferred" algorithm is not used, the defining entity must 
  assure that the resulting InstanceID is not reused across any InstanceIDs 
  produced by this or other providers for the NameSpace of this instance. 
  
For DMTF-defined instances, the "preferred" algorithm must be used with 
  the <OrgID> set to CIM.

Product Specific Usage:
In 
  Intel AMT Release 6.0 and later releases value is "Intel(r) AMT:WiFi Endpoint 
  [User] Settings %s where %s is the profile name. "User" is used in the ID for 
  user 
  profiles.

Qualifiers:
-------------
Key
Override=InstanceID
MaxLen=100


  

  





Priority 
public uint8 Priority



  
General Information:
Priority shall indicate the priority of the 
  instance among all WiFiEndpointSettings instances.

  

  





SSID 
public string SSID



  
General Information:
SSID shall indicate the Service Set 
  Identifier (SSID) that shall be used when the settings are applied to a 
  WiFiEndpoint. An SSID identifies a wireless 
  network.

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


  

  





BSSType 
public uint16 BSSType



  
General Information:
BSSType shall indicate the Basic Service 
  Set (BSS) Type that shall be used when the settings are applied. A Basic 
  Service Set is a set of stations controlled by a single coordination 
  function.
* Independent: the WiFiEndpoint is associated directly to another 
  client station.
* Infrastructure: the WiFiEndpoint is associated to a 
  network via an access point.

Product Specific Usage:
Intel(r) 
  AMT supports only infrastructure 
  networks

Qualifiers:
-------------
ValueMap={0, 2, 3, 
  ..}
Values={Unknown, Independent, Infrastructure, DMTF 
  Reserved}
MappingStrings={IEEE 802.11-2007 | 3.16}


  

  





EncryptionMethod 
public uint16 EncryptionMethod



  
General Information:
EncryptionMethod shall specify the 802.11 
  encryption method used when the settings are applied.


  * Other (1): shall indicate that the desired encryption method is not specified in the list below. If this value is used, OtherEncryptionMethod should not be NULL and should not be empty.


  * WEP (2): shall indicate that the desired encryption method is Wired Equivalency Privacy (WEP). This value should be used only if AuthenticationMethod contains 3 ("Shared Key"). Note: This method has been deprecated. It is no longer supported starting from Intel CSME 15.0.


  * TKIP 
  (3): shall indicate that the desired encryption method is Temporal Key Integrity Protocol (TKIP). This value should be used only if AuthenticationMethod contains 4 ("WPA PSK"), 5 ("WPA IEEE 802.1x"), 6 ("WPA2 PSK"), or 7 ("WPA2 IEEE 802.1x"). Note: This method has been deprecated.It is no longer supported starting from Intel CSME 15.0.


  * CCMP 128 (4): shall indicate that the desired encryption method is Counter Mode with Cipher Block Chaining Message Authentication Code Protocol (CCMP 128). This value should be used only if AuthenticationMethod contains 4 ("WPA PSK"), 5 ("WPA IEEE 802.1x"), 6 ("WPA2 PSK"), 7 ("WPA2/WPA3 IEEE 802.1x"), WPA3 SAE (32768) or WPA3 OWE (32769).


  * None (5): shall indicate that no 
  encryption is desired. This value should be used only if AuthenticationMethod 
  contains 2 ("Open System").


  * GCMP 256 (32768): shall indicate that the desired encryption method is Galois/Counter Mode with Cipher Block Chaining Message Authentication Code Protocol (GCMP). This value should be used only if AuthenticationMethod contains 7 ("WPA2/WPA3 IEEE 802.1x").
  


  Product Specific 
  Usage:
Can be one of the values in 
  CIM_WiFiEndpointCapabilities.SupportedEncryptionMethods.

Qualifiers:
-------------

  ValueMap={1, 2, 3, 4, 5, 6..32767, 32768, 32769}
Values={Other, WEP, TKIP, CCMP 128, None, DMTF Reserved, GCMP 256, Vendor Reserved}
MappingStrings={IEEE 802.11-2007 | 
  8}
ModelCorrespondence={CIM_WiFiEndpoint.EncryptionMethod, 
  CIM_WiFiEndpointSettings.AuthenticationMethod, 
  CIM_WiFiEndpointSettings.OtherEncryptionMethod}


  

  





AuthenticationMethod 
public uint16 AuthenticationMethod



  
General Information:
AuthenticationMethod shall specify the 
  802.11 authentication method used when the settings are applied.


  * Other (1): shall indicate that the desired authentication method is not specified in the 
  list below. If AuthenticationMethod contains 1, OtherAuthenticationMethod 
  should not be NULL and should not be empty.


  * Open System (2): shall 
  indicate that the desired authentication method is Open System. 
  AuthenticationMethod should contain 2 only if EncryptionMethod contains 5 ("None").


  * Shared Key (3): shall indicate that the desired 
  authentication method is Shared Key. AuthenticationMethod should contain 3 
  only if EncryptionMethod contains 2 ("WEP"). Note: This method has been deprecated. It is no longer supported starting from Intel CSME 15.0.


  * WPA PSK (4): 
  shall indicate that the desired authentication method is WPA (Wi-Fi Protected Access) PSK (Pre-Shared Key). AuthenticationMethod should contain 4 only if EncryptionMethod contains 3 ("TKIP") or 4 ("CCMP 128 "). Note: TKIP has been deprecated. It is no longer supported starting from Intel CSME 15.0.


  * WPA IEEE 802.1x (5): 
  shall indicate that the desired authentication method is WPA (Wi-Fi Protected Access) IEEE 802.1x. AuthenticationMethod should contain 5 only if EncryptionMethod contains 3 ("TKIP") or 4 ("CCMP 128 "). Note: TKIP has been deprecated. It is no longer supported starting from Intel CSME 15.0.


  * WPA2 PSK (6): WPA2 PSK (6): shall indicate that the desired authentication method is WPA2 (Wi-Fi Protected Access Version 2) PSK (Pre-Shared Key). AuthenticationMethod should containt 6 only if EncryptionMethod contains 3 ("TKIP") or 4 ("CCMP 128 "). Note: TKIP has been deprecated. It is no longer supported starting from Intel CSME 15.0.


  * WPA2 IEEE 802.1x (7): WPA2 IEEE 802.1x (7): shall indicate that the desired authentication method is WPA2 (Wi-Fi Protected Access Version 2) IEEE 802.1x. AuthenticationMethod should contain 7 only if EncryptionMethod contains 3 ("TKIP") or 4 ("CCMP 128 ") or 32768 (GCMP 256 when WPA3 802.1x is used). Note: TKIP has been deprecated. It is no longer supported starting from Intel CSME 15.0.


  * WPA3 SAE (32768)(Supported in Intel CSME 12.0.80.1708, Intel CSME 14.0 and later): shall indicate that WPA3 (Wi-Fi Protected Access Version 3) SAE authentication is supported. SupportedAuthenticationMethods shall contain 32768 only if SupportedEncryptionMethods contains 4 (CCMP 128).


  * WPA3 OWE (32769) (Supported in Intel CSME 12.0.80.1708, Intel CSME 14.0 and later): shall indicate that WPA3 (Wi-Fi Protected Access Version 3) OWE (Opportunistic Wireless Encryption) authentication is supported. SupportedAuthenticationMethods shall contain 32769 only if SupportedEncryptionMethods contains 4 (CCMP 128).
  

  
Product Specific Usage:
Can be one of the values in 
  CIM_WiFiEndpointCapabilities.SupportedAuthenticationMethods.

Qualifiers:
-------------

  ValueMap={1, 2, 3, 4, 5, 6, 7, 8..32767, 32768, 32769, 32770..}
Values={Other, Open System, Shared Key, WPA PSK, WPA 
  IEEE 802.1x, WPA2 PSK, WPA2 IEEE 802.1x, DMTF 
  Reserved, WPA3 SAE, WPA3 OWE, Vendor Reserved}
MappingStrings={IEEE 802.11-2007 | 
  8}
ModelCorrespondence={CIM_WiFiEndpoint.AuthenticationMethod, 
  CIM_WiFiEndpointSettings.EncryptionMethod, 
  CIM_WiFiEndpointSettings.OtherAuthenticationMethod}


  

  





Keys 
public string[4] Keys



  
General Information:
Keys shall contain the default WEP 
  encryption keys. Keys should be non-NULL if and only if EncryptionMethod 
  contains 2 
  ("WEP"). Note:This method has been deprecated. It is no longer supported starting from Intel CSME 15.0.

Qualifiers:
-------------
OctetString
ArrayType=Indexed
MappingStrings={MIB.IETF|IEEE 
  802.11 
  MIB.dot11WEPDefaultKeys}
ModelCorrespondence={CIM_WiFiEndpointSettings.KeyIndex, 
  CIM_WiFiEndpointSettings.EncryptionMethod}
MaxLen=256


  

  





KeyIndex 
public uint8 KeyIndex



  
General Information:
KeyIndex shall contain the index of the 
  active key in the Keys array property. KeyIndex should be non-NULL if and only 
  Keys is 
  non-NULL.

Qualifiers:
-------------
MappingStrings={MIB.IETF|IEEE 
  802.11 
  MIB.dot11WEPDefaultKeyID}
ModelCorrespondence={CIM_WiFiEndpointSettings.Keys}


  

  





PSKValue 
public uint8[255] PSKValue



  
General Information:
The actual binary value of a PSK 
  (pre-shared key). PSKValue and PSKPassPhrase should not both be non-NULL. 
  PSKValue should be NULL if AuthenticationMethod does not contain 4 ("WPA PSK"), 
  6 ("WPA2 
  PSK") or 32768 (WPA3 SAE).

Qualifiers:
-------------
OctetString
MappingStrings={MIB.IETF|IEEE 
  802.11 
  MIB.dot11RSNAConfigPSKValue}
ModelCorrespondence={CIM_WiFiEndpointSettings.PSKPassPhrase, 
  CIM_WiFiEndpointSettings.AuthenticationMethod}


  

  





PSKPassPhrase 
public string PSKPassPhrase



  
General Information:
An ASCII string of 8-63 printable characters used to 
  generate a PSK (pre-shared key). PSKPassPhrase and PSKValue should not both be 
  non-NULL. PSKPassPhrase should be NULL if AuthenticationMethod does not 
  contain 4 ("WPA PSK"), 6 ("WPA2 
  PSK") or 32768 (WPA3 SAE).

Qualifiers:
-------------
MinLen=8
MaxLen=63
MappingStrings={MIB.IETF|IEEE 
  802.11 
  MIB.dot11RSNAConfigPSKPassPhrase}
ModelCorrespondence={CIM_WiFiEndpointSettings.PSKValue, 
  CIM_WiFiEndpointSettings.AuthenticationMethod}


  

  






  
  

    Method 
Detail


Get
public  Get([OUT]CIM_WiFiEndpointSettings 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 '





Delete
public  Delete()



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM, 
  ADMIN_SECURITY_LOCAL_SYSTEM_REALM

General 
  Information:
Deletes an instance

Product Specific 
  Usage:
Additional Notes: 
1) 'Delete' in Intel AMT Release 6.0 and 
  later releases is permitted only to 'ADMIN_SECURITY_ADMINISTRATION_REALM' and 
  'ADMIN_SECURITY_LOCAL_SYSTEM_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.