WS-Management > WS-Management Class Reference > AMT Classes > AMT_WiFiPortConfigurationService

Class AMT_WiFiPortConfigurationService

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_Service
               extended by CIM_NetworkPortConfigurationService
                  extended by AMT_WiFiPortConfigurationService


class AMT_WiFiPortConfigurationService
extends CIM_NetworkPortConfigurationService

General Information:
AMT_WiFiPortConfigurationService provides management of the Wi-Fi network interfaces associated with a Wi-Fi network port.

Qualifiers:
-------------
Version=4.0.0


Supported Fields Summary
 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
EnabledState is an integer enumeration that indicates the enabled and disabled states of an element . . .
 uint16 HealthState
Indicates the current health of the element . . .
 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 that is used in the creation of an instance . . .
 string Name Key
The Name property uniquely identifies the Service and provides an indication of the functionality that is managed . . .
 uint32 localProfileSynchronizationEnabled
Administrator's policy regarding enablement of local profile synchronization.Remote profile synchronization is always enabled.
 string LastConnectedSsidUnderMeControl
The SSID of the Wireless network that was last connected in ME Control state
 uint32 NoHostCsmeSoftwarePolicy
Setting Policy regarding no HOST CSME software.
 uint32 UEFIWiFiProfileShareEnabled
Enables or disables UEFI/CSME Wi-Fi Profile Sharing.

Methods Summary
 uint32 AddWiFiSettings(REF WiFiEndpoint, WiFiEndpointSettingsInput, IEEE8021xSettingsInput, REF ClientCredential, REF CACredential, REF WiFiEndpointSettings, REF IEEE8021xSettings)
Atomically creates an instance of CIM_WifiEndpointSettings from the embedded instance parameter and optionally an instance of CIM_IEEE8021xSettings from the embedded instance parameter (if provided), associates the CIM_WiFiEndpointSettings instance with the referenced instance of CIM_WiFiEndpoint using an instance of CIM_ElementSettingData optionally associates the newly created or referenced by parameter instance of CIM_IEEE8021xSettings with the instance of CIM_WiFiEndpointSettings using an instance of CIM_ConcreteComponent and optionally associates the referenced instance of AMT_PublicKeyCertificate (if provided) with the instance of CIM_IEEE8021xSettings (if provided) using an instance of CIM_CredentialContext.
 uint32 UpdateWiFiSettings(REF WiFiEndpointSettings, WiFiEndpointSettingsInput, IEEE8021xSettingsInput, REF ClientCredential, REF CACredential, REF IEEE8021xSettings)
Atomically updates the referenced instance of CIM_WifiEndpointSettings from the embedded instance of CIM_WiFiEndPointSettings and updates the referenced instance of CIM_IEEE8021xSettings from the embedded instance of CIM_IEEE8021xSettings.
 uint32 DeleteAllITProfiles()
Deletes all the instances of CIM_WiFiEndpointSettings and CIM_IEEE8021xSettings that were created by AddWiFiSettings requests . . .
 uint32 DeleteAllUserProfiles()
Deletes all the instances of CIM_WiFiEndpointSettings and CIM_IEEE8021xSettings that were created by local user applications . . .
 uint32 SetApplicationRequestedRfKill(ApplicationRequestedRfKill)
Notifies Intel(R) AMT WLAN that SW RF Kill is due to Host Adapter Switching
  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

Field Detail

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:
EnabledState is an integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value=4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled and disabled states:
Enabled (2) indicates that the element is or could be executing commands, will process any queued commands, and queues new requests.
Disabled (3) indicates that the element will not execute commands and will drop any new requests.
Shutting Down (4) indicates that the element is in the process of going to a Disabled state.
Not Applicable (5) indicates the element does not support being enabled or disabled.
Enabled but Offline (6) indicates that the element might be completing commands, and will drop any new requests.
Test (7) indicates that the element is in a test state.
Deferred (8) indicates that the element might be completing commands, but will queue any new requests.
Quiesce (9) indicates that the element is enabled but in a restricted mode.
Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11..32767, 32768..65535}
Values={Unknown, Other, Enabled, Disabled, Shutting Down, Not Applicable, Enabled but Offline, In Test, Deferred, Quiesce, Starting, DMTF Reserved, Vendor Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.OtherEnabledState}


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}


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 "Intel(r) AMT WiFiPort Configuration Service"

Qualifiers:
-------------
MaxLen=45


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=25
Propagated=CIM_System.CreationClassName


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=25
Propagated=CIM_System.Name


CreationClassName Key

public string CreationClassName
General Information:
CreationClassName indicates the name of the class or the subclass that is 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 "AMT_WiFiPortConfigurationService"

Qualifiers:
-------------
Key
MaxLen=35


Name Key

public string Name
General Information:
The Name property uniquely identifies the Service and provides an indication of the functionality that is managed. This functionality is described in more detail in the Description property of the object.

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

Qualifiers:
-------------
Key
Override=Name
MaxLen=45


localProfileSynchronizationEnabled

public uint32 localProfileSynchronizationEnabled
General Information:
Administrator's policy regarding enablement of local profile synchronization.Remote profile synchronization is always enabled.

Product Specific Usage:
Additional Notes:
1) 'localProfileSynchronizationEnabled' is only supported in Intel AMT Release 6.0 and later releases.

Qualifiers:
-------------
ValueMap={0, 1..2, 3, 4..}
Values={Local synchronization disabled, Vendor Reserved, Unrestricted synchronization, Reserved}


LastConnectedSsidUnderMeControl

public string LastConnectedSsidUnderMeControl
General Information:
The SSID of the Wireless network that was last connected in ME Control state

Qualifiers:
-------------
MaxLen=33


NoHostCsmeSoftwarePolicy

public uint32 NoHostCsmeSoftwarePolicy
General Information:
Setting Policy regarding no HOST CSME software.

Qualifiers:
-------------
ValueMap={0, 1, 2}
Values={NoHostCsmeSoftwareRelaxedPolicy, NoHostCsmeSoftwareAggressivePolicy, Reserved}


UEFIWiFiProfileShareEnabled

public uint32 UEFIWiFiProfileShareEnabled
General Information:
Enables or disables UEFI/CSME Wi-Fi Profile Sharing.

The feature is available from Intel® CSME 16.0.
The feature can be disabled even if the value of AMT_BootCapabilities.UEFIWiFiCoExistenceAndProfileShare is False.

Valid Values:
-------------
1: Enable
0: Disable


Method Detail

AddWiFiSettings

public uint32 AddWiFiSettings([IN]REF CIM_WiFiEndpoint WiFiEndpoint, [IN]string WiFiEndpointSettingsInput, [IN]string IEEE8021xSettingsInput, [IN]REF CIM_Credential ClientCredential, [IN]REF CIM_Credential CACredential, [OUT]REF CIM_WiFiEndpointSettings WiFiEndpointSettings, [OUT]REF CIM_IEEE8021xSettings IEEE8021xSettings)
Permission Information:
Permitted realms: ADMIN_SECURITY_ADMINISTRATION_REALM, ADMIN_SECURITY_LOCAL_SYSTEM_REALM

General Information:
Atomically creates an instance of CIM_WifiEndpointSettings from the embedded instance parameter and optionally an instance of CIM_IEEE8021xSettings from the embedded instance parameter (if provided), associates the CIM_WiFiEndpointSettings instance with the referenced instance of CIM_WiFiEndpoint using an instance of CIM_ElementSettingData optionally associates the newly created or referenced by parameter instance of CIM_IEEE8021xSettings with the instance of CIM_WiFiEndpointSettings using an instance of CIM_ConcreteComponent and optionally associates the referenced instance of AMT_PublicKeyCertificate (if provided) with the instance of CIM_IEEE8021xSettings (if provided) using an instance of CIM_CredentialContext.

Product Specific Usage:
Additional Notes:
1) 'AddWiFiSettings' in Intel AMT Release 6.0 and later releases is permitted only to 'ADMIN_SECURITY_ADMINISTRATION_REALM' and 'ADMIN_SECURITY_LOCAL_SYSTEM_REALM '
2) When selecting the value EAP-TLS or EAP-FAST/TLS in AuthenticationProtocol property in IEEE8021xSettings - ClientCredential is mandatory.


Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4, .., 32768..65535}
Values={Completed with No Error, Not Supported, Failed, Invalid Parameter, Invalid Reference, Method Reserved, Vendor Specific}


Parameters:
--------------
WiFiEndpoint
General Information:
The endpoint to associate the new settings with

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

WiFiEndpointSettingsInput
General Information:
a string encoded embedded instance of CIM_WiFiEndpointSettings. In a case of ambiguity (e.g. 2 contradictory properties were supplied), a valid profile will be created according to an internal precedence.

Qualifiers:
-------------
Required
IN
EmbeddedInstance=CIM_WiFiEndpointSettings

IEEE8021xSettingsInput
General Information:
a string encoded embedded instance of CIM_IEEE8021xSettings. In a case of ambiguity (e.g. 2 contradictory properties were supplied), a valid profile will be created according to an internal precedence.

Qualifiers:
-------------
IN
EmbeddedInstance=CIM_IEEE8021xSettings

ClientCredential
General Information:
a Reference to an AMT_PublicKeyCertificate, which represents the client certificate

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

CACredential
General Information:
a Reference to an AMT_PublicKeyCertificate, which represents the CA certificate

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

WiFiEndpointSettings
General Information:
A reference to a new CIM_WiFiEndpointSettings instance that shall be created by the method using the property values in WiFiEndpointSettingsInput.

Qualifiers:
-------------
OUT

IEEE8021xSettings
General Information:
A reference to a new CIM_IEEE8021xSettings instance that shall be created by the method using the property values in IEEE8021xSettingsInput

Qualifiers:
-------------
OUT



UpdateWiFiSettings

public uint32 UpdateWiFiSettings([IN]REF CIM_WiFiEndpointSettings WiFiEndpointSettings, [IN]string WiFiEndpointSettingsInput, [IN]string IEEE8021xSettingsInput, [IN]REF CIM_Credential ClientCredential, [IN]REF CIM_Credential CACredential, [OUT]REF CIM_IEEE8021xSettings IEEE8021xSettings)
Permission Information:
Permitted realms: ADMIN_SECURITY_ADMINISTRATION_REALM, ADMIN_SECURITY_LOCAL_SYSTEM_REALM

General Information:
Atomically updates the referenced instance of CIM_WifiEndpointSettings from the embedded instance of CIM_WiFiEndPointSettings and updates the referenced instance of CIM_IEEE8021xSettings from the embedded instance of CIM_IEEE8021xSettings.

Product Specific Usage:
The profile name can't be updated

Additional Notes:
1) 'UpdateWiFiSettings' in Intel AMT Release 6.0 and later releases is permitted only to 'ADMIN_SECURITY_ADMINISTRATION_REALM' and 'ADMIN_SECURITY_LOCAL_SYSTEM_REALM '
2) When selecting the value EAP-TLS or EAP-FAST/TLS in AuthenticationProtocol property in IEEE8021xSettings - ClientCredential is mandatory.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4, .., 32768..65535}
Values={Completed with No Error, Not Supported, Failed, Invalid Parameter, Invalid Reference, Method Reserved, Vendor Specific}


Parameters:
--------------
WiFiEndpointSettings
General Information:
The endpoint settings to update

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

WiFiEndpointSettingsInput
General Information:
a string encoded embedded instance of update parameters of CIM_WiFiEndpointSettings. Properties that aren't being changed should also be supplied. In a case of ambiguity (e.g. 2 contradictory properties were supplied), a valid profile will be created according to an internal precedence.

Qualifiers:
-------------
Required
IN
EmbeddedInstance=CIM_WiFiEndpointSettings

IEEE8021xSettingsInput
General Information:
a string encoded embedded instance of update parameters of CIM_IEEE8021xSettings. Properties that aren't being changed should also be supplied. In a case of ambiguity (e.g. 2 contradictory properties were supplied), a valid profile will be created according to an internal precedence.

Qualifiers:
-------------
IN
EmbeddedInstance=CIM_IEEE8021xSettings

ClientCredential
General Information:
a Reference to an AMT_PublicKeyCertificate, which represents the client certificate

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

CACredential
General Information:
a Reference to an AMT_PublicKeyCertificate, which represents the CA certificate

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

IEEE8021xSettings
General Information:
A reference to the CIM_IEEE8021xSettings instance that shall be updated (or created) by the method using the property values in IEEE8021xSettingsInput

Qualifiers:
-------------
OUT



DeleteAllITProfiles

public uint32 DeleteAllITProfiles()
Permission Information:
Permitted realms: ADMIN_SECURITY_ADMINISTRATION_REALM, ADMIN_SECURITY_LOCAL_SYSTEM_REALM

General Information:
Deletes all the instances of CIM_WiFiEndpointSettings and CIM_IEEE8021xSettings that were created by AddWiFiSettings requests. Also deletes all the associations that reference the instances of CIM_WiFiEndpointSettings and CIM_IEEE8021xSettings that were deleted.

Product Specific Usage:
Additional Notes:
1) 'DeleteAllITProfiles' in Intel AMT Release 6.0 and later releases is permitted only to 'ADMIN_SECURITY_ADMINISTRATION_REALM' and 'ADMIN_SECURITY_LOCAL_SYSTEM_REALM '
2) When localProfileSynchronizationEnabled property is "Unrestricted"(3) or "Admin"(2), local access is allowed.



Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4, .., 32768..65535}
Values={Completed with No Error, Not Supported, Failed, Invalid Parameter, Invalid Reference, Method Reserved, Vendor Specific}


DeleteAllUserProfiles

public uint32 DeleteAllUserProfiles()
Permission Information:
Permitted realms: ADMIN_SECURITY_ADMINISTRATION_REALM, ADMIN_SECURITY_LOCAL_SYSTEM_REALM

General Information:
Deletes all the instances of CIM_WiFiEndpointSettings and CIM_IEEE8021xSettings that were created by local user applications. Also deletes all the associations that reference the instances of CIM_WiFiEndpointSettings and CIM_IEEE8021xSettings that were deleted.

Product Specific Usage:
Additional Notes:
1) 'DeleteAllUserProfiles' in Intel AMT Release 6.0 and later releases is permitted only to 'ADMIN_SECURITY_ADMINISTRATION_REALM' and 'ADMIN_SECURITY_LOCAL_SYSTEM_REALM '
2) When localProfileSynchronizationEnabled property is "Unrestricted"(3) or "User"(1), local access is allowed.


Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4, .., 32768..65535}
Values={Completed with No Error, Not Supported, Failed, Invalid Parameter, Invalid Reference, Method Reserved, Vendor Specific}


SetApplicationRequestedRfKill

public uint32 SetApplicationRequestedRfKill([IN]boolean ApplicationRequestedRfKill)
Permission Information:
Permitted realms: ADMIN_SECURITY_LOCAL_SYSTEM_REALM, ADMIN_SECURITY_ADMINISTRATION_REALM

General Information:
Notifies Intel(R) AMT WLAN that SW RF Kill is due to Host Adapter Switching

Qualifiers:
-------------
ValueMap={0, 1, 2, 3..}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR, PT_STATUS_NOT_SUPPORTED, RESERVED}


Parameters:
--------------
ApplicationRequestedRfKill
General Information:
Indicates the adapter switching state

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



Put

public  Put([IN]AMT_WiFiPortConfigurationService Instance)
Permission Information:
Permitted realms: ADMIN_SECURITY_ADMINISTRATION_REALM

General Information:
Changes properties of the selected instance

Product Specific Usage:
Additional Notes:
1) 'Put' in Intel AMT Release 6.0 and later releases is permitted only to 'ADMIN_SECURITY_ADMINISTRATION_REALM' and 'ADMIN_SECURITY_LOCAL_SYSTEM_REALM '

Get

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

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