NMS GR303 and V5 Library Developer's Reference Manual (9000-62083-11): Function Reference
(Page 32 of 32 in this chapter) Version
NMS_V5SwitchOverVariantData
Description
- Switches the interface to a specified standby variant.
Prototype
- NMS_V5_RESULT_T NMS_V5SwitchOverVariantData
(NMS_GR303_INTERFACE_ID_T interfaceId)
- interfaceId Interface ID of a provisioned interface.
Return Values
Events
- None.
Details
- This function stops an interface (if the interface is started), destroys the active variant connections and configurations, and configures the standby variant as active. No standby variant is defined on the interface after the switchover process finishes. Applications should then call NMS_V5StartInterface to start the interface. The application must provision the standby variant (with NMS_V5ProvisionStandByVariant) before initiating a switchover.
- If a failure occurs during any stage of the switchover process, both active and standby variants are destroyed and the application must destroy and reprovision the entire interface.
See Also
- NMS_V5ProvisionInterface, NMS_V5ProvisionStandByVariant, NMS_V5DestroyStandByVariant
Example
void SwitchOverVariantData( void )
{
NMS_V5_RESULT_T NmsResult;
DWORD InterfaceId;
printf("NMS_V5SwitchOverVariantData:\n");
/* Get parameters */
promptdw_nodft("Enter interfaceId", &InterfaceId);
NmsResult = NMS_V5SwitchOverVariantData( InterfaceId );
printf ("NMS_V5SwitchOverVariantData:
Result=%s\n",PRINT_RESULT(NmsResult));
}
(Page 32 of 32 in this chapter) Version
Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2001, NMS Communications Corporation. All rights
reserved.