Intel AMT Features > User Consent > Use Cases > Get User Consent Status
CollapseAll image

Get User Consent Status

The following steps describe how to retrieve the user consent status.

1.  Retrieve the instance of IPS_OptInService, where the “Name” key equals “Intel(r) AMT OptIn Service”.

2.  Examine the following properties to obtain the user consent (optIn) status.

Property

Description

            Values

OptInRequired

Indicates The User Consent (OptIn) Policy. This value determines whether consent is required or not.

NONE (returned value is 0): user consent is not required.

KVM (returned value is 1): user consent is required only for KVM.

ALL (returned value is 0xFFFFFFFF}: user consent is required for KVM, Storage Redirection, set boot options.

This value is ALL and not changeable in Client Control mode. It is configurable in Admin Control mode when CanModifyOptInPolicy is true.

When the property is modifiable and the platform is in Admin Control mode, then:

   If the platform supports KVM, then the default value is KVM.

   If the platform does not support KVM, then the default value is NONE.

OptInState

Read Only. Indicates the state of user consent (OptIn).

 

NOT STARTED: User consent is required.

REQUESTED: a console has requested a user consent code. The code was created, but it was not displayed to the user yet.

DISPLAYED: the user consent code was displayed to the user.

RECEIVED: user consent code was successfully entered by the IT operator.  Note that when opening a KVM session in Sx, the OptInState remains RECEIVED until the Sx state is exited.  This is different from a Storage Redirection session.

IN SESSION: There is a Storage Redirection or KVM session open. 

Note that a Storage Redirection session moves to IN SESSION directly while a KVM session only after exiting the Sx state in which the session was opened.

OptInDisplayTimeout

The maximum amount of time the user consent form will be displayed.

The amount of time in seconds that the user consent form will be displayed. If this optional field is not set, the value is 5 minutes (300 seconds). The valid range is 10 to 4095 seconds. The OptInDisplayTimeout cannot be changed while the OptInState is either REQUESTED or DISPLAYED.

OptInCodeTimeout

Indicates the idle timeout, in seconds, after which the opt-in code expires.

The default value is fixed to 2 minutes (120 seconds). Configurable to 1 to 15 minutes (60 to 900 seconds). The OptInCodeTimeout cannot be changed while the OptInState is either RECEIVED or IN SESSION.

CanModifyOptInPolicy

Indicates if Modifying the OptIn Policy via WS-Management is enabled.

This parameter is true if the ability to change the opt-in is enabled in the MEBx. If Intel AMT was setup locally and is in Client Control mode, the value of the field will be false. If Intel AMT was setup in Admin Control mode, the value of the field will be true.

 

Click here for a snippet demonstrating this step

You can execute this snippet by inserting it into the execution template found here.

  

$optInServiceRef = $wsmanConnectionObject.NewReference("SELECT * FROM IPS_OptInService WHERE Name='Intel(r) AMT OptIn Service'")

$optInServiceInstance = $optInServiceRef.Get()

$optInRequired = $optInServiceInstance.GetProperty("OptInRequired")

$optInState = $optInServiceInstance.GetProperty("OptInState")

$optInDisplayTimeout = $optInServiceInstance.GetProperty("OptInDisplayTimeout")

$optInCodeTimeout = $optInServiceInstance.GetProperty("OptInCodeTimeout")

$canModifyOptInPolicy = $optInServiceInstance.GetProperty("CanModifyOptInPolicy")

 

 

Instance Diagram

Classes Used in This Flow

SDK Sample

If there is a sample demonstrating this flow, it is included in the SDK installation file. See SDK Installation Layout for details.

 

See Also:

   User Consent Tool

 

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