Redundant Host API

This function just initiates the software disconnection and does not wait for its completion. The function RhGetDomainSwConnectionStatus can be used to track the progress of the pending disconnection.

In the cooperative switchover scenario, the domains should be software disconnected before the switchover; this guarantees that the former owning host software does not crash because of devices unexpectedly disappearing and that device activity does not crash the newly owning host immediately after the switchover.

The function can be called on a host that does not own the specified domains; in that case, the request may be forwarded to the owning host via an applicable inter-host communication channel. However, all specified domains must be owned by the same host.

The caller can specify how urgent the software disconnection request is by using the Timeout parameter. This value specifies the time interval (in milliseconds) during which the owning host should try to complete the software disconnection. The caller assumes that after this timeout expires:

It stops waiting for the software disconnection to complete

It either abandons the switchover attempt or initiates a forced switchover that may be partially cooperative if software disconnection succeeds for some device(s) by that time.

6.2.5.3RhCancelPrepareForSwitchover

Prototype:

HSI_STATUS

RhCancelPrepareForSwitchover(

IN RH_HANDLE Handle,

IN uint32 *pDomains,

IN uint32 DomainCount );

Arguments:

 

Handle –

the handle of the current session

pDomains –

pointer to the array of numbers of the domains to connect; all domains

 

must be owned by the same host

DomainCount

the number of elements in the array of domain numbers

Return Value:

 

HSI_STATUS_SUCCESS returned in the case of success

HSI_STATUS_INVALID_PARAMETER

invalid session handle or the specified domain does not exist

HSI_STATUS_REQUEST_DENIED

returned if the software connection request issued by the current host has been denied

HSI_STATUS_NOT_SUPPORTED

returned if this function is not supported by the infrastructure

Other, implementation-defined HSI_STATUS values

returned if other errors occurred during execution of this function

High Availability Software for the Intel® NetStructureTM ZT 4901 Technical Product Specification

65

Page 65
Image 65
Intel ZT 4901 manual RhCancelPrepareForSwitchover, Hsistatussuccess returned in the case of success