Class AMT_RemoteAccessService

Used in features: Remote Access & User Initiated
Compatible with the following Intel AMT Releases: 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_ManagedSystemElement
      extended by CIM_LogicalElement
         extended by CIM_EnabledLogicalElement
            extended by CIM_Service
               extended by AMT_RemoteAccessService


class AMT_RemoteAccessService
extends CIM_Service

General Information:
Represents the Remote Access Service in the Intel(R) AMT subsystem.

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


Supported Fields Summary
 string Name Key
The Name property uniquely identifies the Service and provides an indication of the functionality that is managed . . .
 string CreationClassName Key
CreationClassName indicates the name of the class or the subclass that is 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 . . .

Methods Summary
 uint32 AddMpServer(AccessInfo, InfoFormat, Port, AuthMethod, REF Certificate, Username, Password, CN, REF MpServer)
Adds a Management Presence Server to the Intel(R) AMT subsystem . . .
 uint32 AddRemoteAccessPolicyRule(Trigger, TunnelLifeTime, ExtendedData, REF MpServer, REF PolicyRule)
Adds a Remote Access policy to the Intel(R) AMT subsystem . . .
 uint32 CloseRemoteAccessConnection()
Closes a remote access connection if one is opened.
  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

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 Remote Access Service"

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


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_RemoteAccessService"

Qualifiers:
-------------
Key
MaxLen=25


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=256
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 "Intel(r) AMT Remote Access Service"

Qualifiers:
-------------
MaxLen=36


Method Detail

AddMpServer

public uint32 AddMpServer([IN]string AccessInfo, [IN]uint16 InfoFormat, [IN]uint16 Port, [IN]uint32 AuthMethod, [IN]REF AMT_PublicKeyCertificate Certificate, [IN]string Username, [IN]string Password, [IN]string CN, [OUT]REF AMT_ManagementPresenceRemoteSAP MpServer)
Permission Information:
Permitted realms: ADMIN_SECURITY_ADMINISTRATION_REALM

General Information:
Adds a Management Presence Server to the Intel(R) AMT subsystem. Creates an AMT_ManagementPresenceRemoteSAP instance and an AMT_RemoteAccessCredentialContext association to a credential. This credential may be an existing AMT_PublicKeyCertificate instance (if the created MPS is configured to use mutual authentication). If the created MpServer is configured to use username password authentication, an AMT_MPSUsernamePassword instance is created and used as the associated credential.

Product Specific Usage:
This method will create an instance of AMT_ManagementPresenceRemoteSAP and its associations.

Qualifiers:
-------------
ValueMap={0, 1, 16, 23, 36, 38}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR, PT_STATUS_NOT_PERMITTTED, PT_STATUS_MAX_LIMIT_REACHED, PT_STATUS_INVALID_PARAMETER, PT_STATUS_FLASH_WRITE_LIMIT_EXCEEDED}


Parameters:
--------------
AccessInfo
General Information:
A string holding the IP address or FQDN of the server

Qualifiers:
-------------
Required
IN
MaxLen=256

InfoFormat
General Information:
An enumerated integer describing the format and interpretation of the AccessInfo property.

Qualifiers:
-------------
Required
IN
ValueMap={3, 4, 201}
Values={IPv4 Address, IPv6 Address, FQDN}

Port
General Information:
The port to be used to establish a tunnel with the MPS.

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

AuthMethod
General Information:
Authentication method to be used when the Intel(R) AMT subsystem opens a tunnel to the MpServer

Qualifiers:
-------------
Required
IN
ValueMap={1, 2}
Values={Mutual Authentication, Username Password Authentication}

Certificate
General Information:
A reference to a certificate. Required if AuthMethod is set to mutual authentication

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

Username
General Information:
A Username to be used for the connection with the MPS if Username-Pwd authentication is used. Limited to 16 alphanumeric characters

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

Password
General Information:
A Password to be used for the connection with the MPS if Username-Pwd authentication is used. Limited to 16 characters

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

CN
General Information:
A common name used when AccessInfo is an IP address.

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

MpServer
General Information:
A reference to the created MPS if the operation succeeded.

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



AddRemoteAccessPolicyRule

public uint32 AddRemoteAccessPolicyRule([IN]uint16 Trigger, [IN]uint32 TunnelLifeTime, [IN]uint8 ExtendedData[32], [IN]REF AMT_ManagementPresenceRemoteSAP MpServer[], [OUT]REF AMT_RemoteAccessPolicyRule PolicyRule)
Permission Information:
Permitted realms: ADMIN_SECURITY_ADMINISTRATION_REALM

General Information:
Adds a Remote Access policy to the Intel(R) AMT subsystem. The policy defines an event that will trigger an establishment of a tunnel between AMT and a pre-configured MPS. Creates an AMT_RemoteAccessPolicyRule instance and associates it to a given list of AMT_ManagementPresenceRemoteSAP instances with AMT_PolicySetAppliesToElement association instances.

Product Specific Usage:
This method will create an instance of AMT_RemoteAccessPolicyRule and its associations.

Qualifiers:
-------------
ValueMap={0, 1, 36, 38, 2058}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR, PT_STATUS_INVALID_PARAMETER, PT_STATUS_FLASH_WRITE_LIMIT_EXCEEDED, PT_STATUS_DUPLICATE}


Parameters:
--------------
Trigger
General Information:
The event that will trigger the establishment of the remote connection to the MpServer.

Qualifiers:
-------------
Required
IN
ValueMap={0, 1, 2, 3}
Values={User Initiated, Alert, Periodic, Home Provisioning}

TunnelLifeTime
General Information:
Defines the tunnel's lifetime in seconds, 0 means no lifetime- the tunnel should stay open until it is closed by CloseRemoteAccessConnection or when a different policy with higher priority needs to be processed.

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

ExtendedData
General Information:
Data associated with the policy, up to 32 bytes. The data should be in a network order. The extended data for a policy with a periodic trigger contains first a periodic type and after that the data for that type. For periodic type 0 [Interval - The CIRA connection will be established every fixed number of seconds] - the data should include a uint32 value that indicates the time period in seconds between tunnel establishments. For periodic type 1 [Daily - The CIRA connection will be established every day in a specific pre-defined time (hour and minutes)] - the data should include two uint32 values which define the wanted hour of the day and minutes of that hour. For the other triggers extended data is not defined and not needed. The length and data should be zero.

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

MpServer
General Information:
A list of MPSs the policy applies to. Maximum length is 2 MPSs.

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

PolicyRule
General Information:
A reference to the created policy if the operation succeeded.

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



CloseRemoteAccessConnection

public uint32 CloseRemoteAccessConnection()
Permission Information:
Permitted realms: ADMIN_SECURITY_ADMINISTRATION_REALM

General Information:
Closes a remote access connection if one is opened.

Qualifiers:
-------------
ValueMap={0, 2051}
Values={PT_STATUS_SUCCESS, PT_STATUS_INVALID_COMMAND}


Get

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