SetIscsiIKEInfo function

The SetIscsiIKEInfo function establishes the IPsec policy and preshared key for the indicated initiator to use when performing iSCSI connections.

Syntax


HRESULT WINAPI SetIscsiIKEInfo(
  _In_  PTCHAR InitiatorName,
  _In_  ULONG PortNumber,
  _In_  PIKE_AUTHENTICATION_INFORMATION AuthInfo,
  _In_  BOOLEAN Persist
);

Parameters

InitiatorName [in]

The name of the initiator HBA for which the IPsec policy is established.

PortNumber [in]

The port on the initiator HBA with which to associate the key. If this parameter contains a value of ISCSI_ALL_INITIATOR_PORTS, all ports on the initiator are associated with the key.

AuthInfo [in]

A pointer to a IKE_AUTHENTICATION_INFORMATION structure that contains the authentication method. Currently, only the IKE_AUTHENTICATION_PRESHARED_KEY_METHOD is supported.

Persist [in]

If true, this parameter indicates that the preshared key information will be stored in non-volatile memory and will persist across restarts of the computer or the iSCSI initiator service.

Return value

Returns ERROR_SUCCESS if the operation succeeds. Otherwise, it returns the appropriate Win32 or iSCSI error code.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Iscsidsc.h

Library

Iscsidsc.lib

DLL

Iscsidsc.dll

Unicode and ANSI names

SetIscsiIKEInfoW (Unicode) and SetIscsiIKEInfoA (ANSI)

See also

IKE_AUTHENTICATION_INFORMATION
GetIscsiIKEInfo

 

 

Community Additions

ADD
Show:
© 2014 Microsoft