IMR_IDEROpenTCPSession

SDK Resources > Redirection Library > Redirection Library API > Functions for Handling Storage Redirection > IMR_IDEROpenTCPSession

IMR_IDEROpenTCPSession

note-icon Note:

When working in Linux, Redirection is supported with physical disks only. There is no Linux Redirection support for iso or img files.

This function opens a Storage Redirection session with the specified client over a new TCP connection. If the client uses secure communications, a TLS session will be negotiated with it. The function returns only when the session is established or if an error has occurred. If the credentials are not NULL and there is no corresponding ACL entry, the connection attempt will fail. If the credential parameters are NULL, the library will attempt to connect with the Active Directory credentials of the application user. After the session is open the client can initiate data transfers. This function is deprecated in Intel AMT Release 4.0 and later releases in favor of IMR_IDEROpenTCPSessionEx.

Function Header

IMRResult IMR_IDEROpenTCPSession(

ClientID id,

TCPSessionParams *params,

IDERTout TCPSessionParams *params,

IDERTout *touts,

char *drive0,

char *drive1

);

Function Parameters

Field	Input/Output	Value or Description
id	Input	The ID of the relevant client.
params	Input	A pointer to a struct with session parameters. This parameter must not be NULL.
touts	Input	A pointer to a struct with timeout parameters. This parameter may be NULL, in which case the default values of the parameters will be used. See the struct definition for the default values.
drive0	Input	A pointer to a NULL-terminated string holding the name of the floppy disk drive on the Management Console platform that will be used for storage redirection (e.g. “A:”). For the Windows dynamic library, the string can also hold the path to a binary floppy image file (recommended, see Performance). This parameter must not be NULL.
drive1	Input	A pointer to a NULL-terminated string holding the name of the CD or DVD (Windows only) drive on the Management Console platform that will be used for storage redirection (e.g. “E:”). For the Windows dynamic library, the string can also hold a path to an *.ISO CD/DVD image file. This parameter must not be NULL.

Function Return Status

For a complete list of possible error codes, see Error Codes.

Status	Value or Description
IMR_RES_OK	The command finished successfully.
IMR_RES_SESSION_ALREADY_OPEN	A Storage Redirection session is already open with the specified client.
IMR_RES_CLIENT_BUSY	The specified client already has an open Storage Redirection session with another application.
IMR_RES_USER_CONSENT_REQUIRED	Command cannot complete until user consent sequence completes.