Structures

SDK Resources > KVM Application Developers Guide > KVM Custom Transport Library > Structures

Structures

The KVM custom transport library API includes the following structures.

Header

The Header structure indicates whether the connection will include an explicit Active Directory (Kerberos) user or not.

typedef struct _Header

{

ConnectionDataType type;

size_t length;

}Header;

Field	Value or Description
type	Type of user specification: Indicates whether the user information in the ConnectionData structure (user/password/domain) is normal (username/password – a Digest user, or no username/password – the application user is a Kerberos user), or the user is an explicit Kerberos user – the structure includes username and domain.
length	Length, in bytes, of the ConnectionData structure, not including the header.

ConnectionData

This structure is returned by the ConnectionInfo function and contains the data used by the proxy to establish a connection with an Intel AMT platform.

typedef struct _ConnectionData

{

Header header;

char host[LENGTH_URL];

unsigned short host_port;

char user[LENGTH_USER_NAME];

char pwd[LENGTH_PWD];

char domain[LENGTH_DOMAIN]

char proxy[LENGTH_URL];

unsigned short proxy_port;

char proxy_user[LENGTH_USER_NAME];

char proxy_pwd[LENGTH_PWD];

}ConnectionData;

Field	Value or Description
header	Indicates whether the user information (user/password/domain) is normal (username/password – a Digest user, or no username/password – the application user is a Kerberos user), or the user is an explicit Kerberos user – the structure includes username and domain.
host	URL of the target Intel AMT platform. For TLS connections, this must be the FQDN. For non-TLS connections, this can be the Intel AMT IP address (either IPv4 or IPv6).
host_port	Port used to connect to the target platform (16994 for a non-TLS connection or 16995 for a TLS connection).
user	Username for a user with an Intel AMT Digest ACL entry that has sufficient privileges to initiate a KVM connection. If this parameter is a Null string, the library will treat the current user as Kerberos user. If the header indicates an explicit Kerberos user, this field is the Kerberos username.
pwd	Password for a Digest user, or Null.
domain	Domain of an explicit Kerberos user. Applicable only when header shows the explicit Kerberos user option.
proxy	Proxy host FQDN or IP address, if there is a proxy server between the viewer application and the Intel AMT platform.
proxy_port	Proxy server port
proxy_user	Proxy server user (if a user is defined)
proxy_pwd	Proxy server password (if a password is defined)