tfIkeClearSasByPriority

Table of Contents >> IPsec/IKE Programmer's Reference >> IPsec/IKE Function Reference

#include <trsocket.h>

int tfIkeClearSasByPriority	(
	ttUser16Bit priority,
	ttUser16Bit options
	);

Function Description

This function is used to remove all IKE SAs associated with an IKE Policy. The IKE Policy is specified by the priority to which it is assigned.

Usage

Call this function to clear all IKE SAs associated with a given IKE Policy. The IKE Policy is specified by the priority to which it is assigned. As new needs arise for IKE SAs associated with the given policy, they will be renegotiated. For example, an IPsec SA rekey or the need for a new IPsec SA due to outgoing traffic with a matching policy will begin the renegotiation process.

Parameters

• priority

  This is set to the priority to which the IKE Policy of interest is assigned.

• options

  This parameter is reserved for future use.

Returns

• TM_ENOERROR

  This indicates success. The caller must free the memory allocated for the structure passed to this function as a copy is made and managed by the kernel.

• TM_EIKENOTSARTED

  This indicates failure because IKE has not been started.

• TM_ENOENT

  This indicates failure because the kernel did not have any IKE Policies defined.

• TM_EINVAL

  This indicates failure because an IKE Policy was not found at the given priority.

Table of Contents >> IPsec/IKE Programmer's Reference >> IPsec/IKE Function Reference