Functions | Variables

fwInstallationRedu.ctl File Reference

Functions

string fwInstallationRedu_getLocalDp (string dp)
int fwInstallationRedu_dpTypeChange (dyn_dyn_string elements, dyn_dyn_int types)
int fwInstallationRedu_dpTypeCreate (dyn_dyn_string elements, dyn_dyn_int types)
int fwInstallationRedu_dpDelete (string dpname)
int fwInstallationRedu_dpCreate (string dpname, string dptype)
int fwInstallationRedu_dpSet (string dpname, anytype val)
int fwInstallationRedu_isPassive ()
string fwInstallationRedu_getPair ()
bool fwInstallationRedu_isComponentInstalledInPair (string component, string version)

Variables

const string csFwInstallationReduLibVersion = "5.0.0"

Detailed Description

This library contains helper functions to address redundant systems

Author:
Fernando Varela Rodriguez (EN-ICE)
Date:
August 2010

Function Documentation

int fwInstallationRedu_dpCreate ( string  dpname,
string  dptype 
)

Wrapper function for the standard PVSS function dpCreate to work in redundant systems.

Parameters:
dpname name of the dp to be created
dptype dp-type of the new dp
Returns:
0 if OK, -1 if error
Author:
F. Varela
int fwInstallationRedu_dpDelete ( string  dpname  ) 

Wrapper function for the standard PVSS function dpCreate to work in redundant systems.

Parameters:
dpname,: name of the dp to be deleted
Returns:
0 if OK, -1 if error
Author:
F. Varela
int fwInstallationRedu_dpSet ( string  dpname,
anytype  val 
)

Wrapper function for the standard PVSS function dpSet to work in redundant systems.

Parameters:
dpname,: name of the dp to be set
val,: value to be set
Returns:
0 if OK, -1 if error
Author:
F. Varela
int fwInstallationRedu_dpTypeChange ( dyn_dyn_string  elements,
dyn_dyn_int  types 
)

Wrapper function for the standard PVSS function dpTypeCreate to work in redundant systems.

Parameters:
elements,: dp-type elements
types,: dp-type element types
Returns:
0 if OK, -1 if error
Author:
F. Varela
int fwInstallationRedu_dpTypeCreate ( dyn_dyn_string  elements,
dyn_dyn_int  types 
)

Wrapper function for the standard PVSS function dpTypeCreate to work in redundant systems.

Parameters:
elements,: dp-type elements
types,: dp-type element types
Returns:
0 if OK, -1 if error
Author:
F. Varela
string fwInstallationRedu_getLocalDp ( string  dp  ) 

This functions appends the suffix '_'+ myRedHostNum() to the dp passed as input argument

Parameters:
dp,: name of the dp
Returns:
dp if redu system is number 1, dp + "_" + myReduHostNumber() if redu number is greater than 1
Author:
F. Varela
string fwInstallationRedu_getPair (  ) 

This functions returns the name of the host where the redundant pair runs

Returns:
name of the redundant pair
Author:
F. Varela
bool fwInstallationRedu_isComponentInstalledInPair ( string  component,
string  version 
)

This functions checks if a particular version of a component is installed in the redundant pair

Parameters:
component (in) name of the component
version (in) version of the component
Returns:
True if the component is installed in the pair. Otherwise, false
Author:
F. Varela
int fwInstallationRedu_isPassive (  ) 

This functions checks whether the local system is the passive peer in a redundant system or not.

Returns:
FALSE - local system is not the passive peer, TRUE the local system is the passive peer
Author:
F. Varela

Variable Documentation

const string csFwInstallationReduLibVersion = "5.0.0"

Version of this library. Used to determine the coherency of all libraries of the installtion tool

 All Files Functions Variables