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

Class AMT_EnvironmentDetectionSettingData

Used in features: Security Administration
Compatible with the following Intel AMT Releases: 3.0, 3.2, 4.0, 5.0, 5.1, 6.0, 6.1, 6.2, 7.0, 8.0, 8.1, 9.0, 9.5
CIM_ManagedElement
   extended by CIM_SettingData
      extended by AMT_EnvironmentDetectionSettingData


class AMT_EnvironmentDetectionSettingData
extends CIM_SettingData

General Information:
The AMT_EnvironmentDetectionSettingData class represents configuration-related and operational parameters for the Environment-Detection service in the Intel(R) AMT.

Qualifiers:
-------------
Version=6.0.0


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 . . .
 uint16 DetectionAlgorithm
Specifies which algorithm is used to determine whether the system is in its intranet environment or in the Internet environment.
 string[5] DetectionStrings
An array of strings used in the environment detection algorithm . . .
 string[5] DetectionIPv6LocalPrefixes
Can be used for environment detection in IPv6 networks that do not configure the DNS suffix via DHCP . . .

Methods Summary
 uint32 SetSystemDefensePolicy(REF Policy)
Defines the System Defense policy which will be used by Environment Detection and updates the appropriate instances of AMT_EnvironmentDetectionInterfacePolicy.
 uint32 EnableVpnRouting(Enable)
This command is used to enable or disable VPN routing of Intel(R) AMT network messages.
  Put(Instance)
Changes properties of the selected instance
  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

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:
In Intel AMT Release 6.0 and later releases value is "Intel(r) AMT Environment Detection Settings"

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


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 Environment Detection Settings"

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


DetectionAlgorithm

public uint16 DetectionAlgorithm
General Information:
Specifies which algorithm is used to determine whether the system is in its intranet environment or in the Internet environment.

Product Specific Usage:
Currently, AMT supports only the "Local Domains" type.

Qualifiers:
-------------
Required
ValueMap={0, 1}
Values={Local Domains, Remote URLs}


DetectionStrings

public string[5] DetectionStrings
General Information:
An array of strings used in the environment detection algorithm. If DetectionAlgorithm is "Local Domains", DetectionStrings contains a set of local domain strings. If DetectionAlgorithm is "Remote URLs", then DetectionStrings contains a set of remote URLs.

Product Specific Usage:
Additional Notes:
1) 'Max Length' qualifier in Intel AMT Release 3.2 is '256'.

Qualifiers:
-------------
MaxLen=63


DetectionIPv6LocalPrefixes

public string[5] DetectionIPv6LocalPrefixes
General Information:
Can be used for environment detection in IPv6 networks that do not configure the DNS suffix via DHCP. The format is: "XXXX:XXXX:XXXX:XXXX/Y" where Y is the prefix length, the XXXX:XXXX:XXXX:XXXX part can include zeros compression (e.g. 0:0:0 or ::) formats.

Product Specific Usage:
Applicable only when IPv6 is supported by the SKU.

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


Method Detail

SetSystemDefensePolicy

public uint32 SetSystemDefensePolicy([IN]REF AMT_SystemDefensePolicy Policy)
Permission Information:
Permitted realms: ADMIN_SECURITY_ADMINISTRATION_REALM

General Information:
Defines the System Defense policy which will be used by Environment Detection and updates the appropriate instances of AMT_EnvironmentDetectionInterfacePolicy.

Qualifiers:
-------------
ValueMap={0, 1, 38}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR, PT_STATUS_FLASH_WRITE_LIMIT_EXCEEDED}


Parameters:
--------------
Policy
General Information:
The System Defense policy which will be applied to each interface separately when it is assumed that the interface is connected to an external network. When this parameter is Null, System Defense functionality is expected to remain the same when operating inside or outside the organization.

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



EnableVpnRouting

public uint32 EnableVpnRouting([IN]boolean Enable)
Permission Information:
Permitted realms: ADMIN_SECURITY_ADMINISTRATION_REALM

General Information:
This command is used to enable or disable VPN routing of Intel(R) AMT network messages.

Product Specific Usage:
Additional Notes:
1) 'EnableVpnRouting' method is supported in Intel AMT Release 4.0 and later releases.

Qualifiers:
-------------
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR, PT_STATUS_FLASH_WRITE_LIMIT_EXCEEDED}
ValueMap={0, 1, 38}


Parameters:
--------------
Enable
General Information:
Enable or disable the VPN routing feature.

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



Put

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

General Information:
Changes properties of the selected instance

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

ElementName (cannot be modified)
InstanceID (cannot be modified)
DetectionAlgorithm


Get

public  Get([OUT]AMT_EnvironmentDetectionSettingData Instance)
Permission Information:
Permitted realms: ADMIN_SECURITY_ADMINISTRATION_REALM, ADMIN_SECURITY_GENERAL_INFO_REALM

General Information:
Gets the representation of the 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

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