fwInstallation  8.4.1
Functions | Variables
fwInstallationManager.ctl File Reference

Functions

int fwInstallationManager_getStartTime (string type, string options, time &manStartTime, string host="", int port=4999, string user="", string pwd="")
 
int fwInstallationManager_stopManagersForInstallation ()
 
string fwInstallationManager_removeManagerTypePrefix (string managerType)
 
int fwInstallationManager_stopAll (dyn_dyn_mixed exceptions, string host="", int port=4999, string user="", string pwd="", bool wait=false)
 
int fwInstallationManager_logCurrentConfiguration (string manager, string startMode, int secKill, int restartCount, int resetMin, string commandLine)
 
int fwInstallationManager_getAllInfoFromPvss (dyn_dyn_mixed &managersInfo)
 
int fwInstallationManager_add (string manager, string startMode, int secKill, int restartCount, int resetMin, string commandLine, string host="", int port=4999, string user="", string pwd="")
 
int _fwInstallation_add (string manager, string startMode, int secKill, int restartCount, int resetMin, string commandLine, string host="", int port=4999, string user="", string pwd="")
 
bool fwInstallationManager_isManagerFileExecutable (string managerName)
 
bool fwInstallationManager_isManagerPropertiesValid (string manager, string startMode, int secondsToKill, int restartCount, int resetStartCounter)
 
bool fwInstallationManager_isManagerStartModeValid (string startMode)
 
bool fwInstallationManager_isManagerSecondsToKillValid (int secondsToKill)
 
bool fwInstallationManager_isManagerRestartCountValid (int restartCount)
 
bool fwInstallationManager_isManagerResetStartCounterValid (int resetStartCounter)
 
int fwInstallationManager_appendDriver (string defActivated, string manTitle, string manager, string startMode, int secKill, int restartCount, int resetMin, string commandLine, string host="", int port=4999, string user="", string pwd="")
 
int fwInstallationManager_append (bool defActivated, string manTitle, string manager, string requestedStartMode, int secKill, int restartCount, int resetMin, string commandLine, string host="", int port=4999, string user="", string pwd="")
 
int fwInstallationManager_deleteReconfigurationAction (string manager, string startMode, int secKill, int restartCount, int resetMin, string commandLine)
 
int fwInstallationManager_setReconfigurationActions (dyn_string dsManager, dyn_string dsStartMode, dyn_int diSecKill, dyn_int diRestartCount, dyn_int diResetMin, dyn_string dsCommandLine)
 
int fwInstallationManager_getReconfigurationActions (dyn_string &dsManager, dyn_string &dsStartMode, dyn_int &diSecKill, dyn_int &diRestartCount, dyn_int &diResetMin, dyn_string &dsCommandLine)
 
int fwInstallationManager_executeReconfigurationAction (string manager, string startMode, int secKill, int restartCount, int resetMin, string commandLine, string host="", int port=4999, string user="", string pwd="")
 
int fwInstallationManager_executeAllReconfigurationActions (bool fromPostInstall=false)
 
string fwInstallationManager_startModeIntToString (int startModeInt)
 
int fwInstallationManager_startModeStringToInt (string startModeString)
 
int fwInstallationManager_setMode (string manager, string commandLine, string mode, string host="", int port=4999, string user="", string pwd="")
 
int fwInstallationManager_stopAllOfTypes (dyn_string types, string host="", int port=4999, string user="", string pwd="", bool wait=false, bool useKill=false)
 
int fwInstallationManager_stopAllScattered (dyn_string types=makeDynString(), bool wait=false)
 
int fwInstallationManager_getScripts (int num, dyn_string &scripts, string systemName="")
 
dyn_int fwInstallationManager_getRunningScattered (string type, dyn_string &remoteHosts)
 
int fwInstallationManager_exitScattered (dyn_string types, dyn_int pvssManagerTypes)
 
int fwInstallationManager_shallStopManagersOfType (string managerType)
 
int fwInstallationManager_command (string action, string manager, string commandLine, string host="", int port=4999, string user="", string pwd="", bool wait=false)
 
int fwInstallationManager_pmonGetManagers (dyn_dyn_mixed &managersInfo, string host="", int port=4999, string user="", string pwd="")
 
int fwInstallationManager_switch (bool driver, string name, int number, string host="", int port=4999, string user="", string pwd="")
 
int fwInstallationManager_restart (string name, string commandLine, string host="", int port=4999, string user="", string pwd="")
 
void fwInstallationManager_waitForState (bool running, int number, int retries=0, string systemName="")
 
void fwInstallationManager_wait (bool running, string manager, string commandLine, int timeout, bool &expired, string host="", int port=4999, string user="", string pwd="")
 
int fwInstallationManager_isRunning (string manager, string commandLine, bool &isRunning, string host="", int port=4999, string user="", string pwd="")
 
bool fwInstallationManager_isDriverRunning (int number, string systemName="", int reduHostNum=0)
 
int fwInstallationManager_getProperties (string type, string options, dyn_mixed &properties, string host="", int port=4999, string user="", string pwd="")
 
int fwInstallationManager_setProperties (string type, string currentOptions, dyn_mixed properties, string host="", int port=4999, string user="", string pwd="")
 
int fwInstallationManager_getNum (string type, string options, int &manNum, string host="", int port=4999, string user="", string pwd="")
 
int _fwInstallationManager_getManagersProtectedFromStopping (dyn_string &protectedManagers)
 
int _fwInstallationManager_setManagersProtectedFromStopping (dyn_string protectedManagers)
 
int fwInstallationManager_remove (string manager, string commandLine, string host="", int port=4999, string user="", string pwd="")
 

Variables

const string csFwInstallationManagerLibVersion = "8.4.1"
 
fwInstallationManager.ctl: Definition of constants

that are used by this library.

const int FW_INSTALLATION_MANAGER_PMON_IDX = 1
 
const int FW_INSTALLATION_MANAGER_PMON_USER = 2
 
const int FW_INSTALLATION_MANAGER_PMON_PWD = 3
 
const int FW_INSTALLATION_MANAGER_PMON_PORT = 4
 
const int FW_INSTALLATION_MANAGER_HOST = 5
 
const int FW_INSTALLATION_MANAGER_TYPE = 6
 
const int FW_INSTALLATION_MANAGER_OPTIONS = 7
 
const int FW_INSTALLATION_MANAGER_START_MODE = 8
 
const int FW_INSTALLATION_MANAGER_SEC_KILL = 9
 
const int FW_INSTALLATION_MANAGER_RESTART_COUNT = 10
 
const int FW_INSTALLATION_MANAGER_RESET_MIN = 11
 
const int FW_INSTALLATION_MANAGER_DONT_STOP_RESTART = 12
 
const int FWINSTALLATION_MANAGER_MIN_SEC_KILL = 1
 
const int FWINSTALLATION_MANAGER_MAX_SEC_KILL = 9999
 
const int FWINSTALLATION_MANAGER_MIN_RESTART_COUNT = 1
 
const int FWINSTALLATION_MANAGER_MAX_RESTART_COUNT = 100
 
const int FWINSTALLATION_MANAGER_MIN_RESET_MIN = 1
 
const int FWINSTALLATION_MANAGER_MAX_RESET_MIN = 60
 
const dyn_string FWINSTALLATION_MANAGER_START_MODES = makeDynString("manual", "always", "once")
 

Detailed Description

This library contains general functions of the FW Component Installation tool to manipulate managers.

Author
Fernando Varela (EN-ICE)
Date
August 2010

Function Documentation

int fwInstallationManager_getStartTime ( string  type,
string  options,
time &  manStartTime,
string  host = "",
int  port = 4999,
string  user = "",
string  pwd = "" 
)
This function retrieves the manager start time
Parameters
typetype of manager
optionsmanager options
manNummanager number
hosthostname
portpmon port
userpmon user
pwdpmon password
Returns
0 if OK, -1 if error
int fwInstallationManager_stopManagersForInstallation ( )

Stops managers for the installation process.

Returns
0 on sucess, -1 on error

fwInstallation_stopManagers?

string fwInstallationManager_removeManagerTypePrefix ( string  managerType)

This function removes WinCC OA prefix ('WCCOA' or 'WCCIL') from manager type.

Parameters
managerType(string) IN manager type
Returns
value of type 'string' manager type without prefix
int fwInstallationManager_stopAll ( dyn_dyn_mixed  exceptions,
string  host = "",
int  port = 4999,
string  user = "",
string  pwd = "",
bool  wait = false 
)

This function stops all manager of the project except those given in 'exceptions' argument. All scattered managers are also stopped.

Parameters
exceptions(dyn_dyn_mixed) IN list of mangers that should stay running [type, command line arg]
host(string) IN is optional with default value '""' hostname
port(int) IN is optional with default value '4999' pmon port
user(string) IN is optional with default value '""' pmon user
pwd(string) IN is optional with default value '""' pmon password
wait(bool) IN is optional with default value 'false' indicates if wait for a manager to be in a particular state
Returns
value of type 'int'

should it return 0 even in case of failed to change manger properties.

int fwInstallationManager_logCurrentConfiguration ( string  manager,
string  startMode,
int  secKill,
int  restartCount,
int  resetMin,
string  commandLine 
)

This function log the current configuration of a manager by writing it into an internal datapoint of the installation tool

Parameters
managermanager type
startMode{always, once, manual}
secKillseconds before the manager is flag as in the wrong state
restartCountrestart counter
resetMintime in min that the manager must be OK before the reset counter is reset
Returns
0 if OK, -1 if error
int fwInstallationManager_getAllInfoFromPvss ( dyn_dyn_mixed &  managersInfo)

This function retrieves all managers' properties for the local project. Data is read from progs file in 'config/' folder

Parameters
managersInfomanagers' properties as a dyn_dyn_mixed matrix
Returns
0 if OK, -1 if error
int fwInstallationManager_add ( string  manager,
string  startMode,
int  secKill,
int  restartCount,
int  resetMin,
string  commandLine,
string  host = "",
int  port = 4999,
string  user = "",
string  pwd = "" 
)

This function allows to insert a manager into a project. It is checked before, if the manager already exists.

Parameters
managername of the manager
startMode{manual, once, always}
secKillseconds to kill after stop
restartCountnumber of restarts
resetMinrestart counter reset time (minutes)
commandLinecommandline for the manager
hosthostname
portpmon port
userpmon user
pwdpmon password
Returns
1 - manager added, 2 - manager already existing, 3 - manager addition disabled, 0 - manager addition failed
Author
F. Varela (original idea by S. Schmeling)

For versions above 3.8-SP2, make sure that managers are added with the WinCC OA prefix

int _fwInstallation_add ( string  manager,
string  startMode,
int  secKill,
int  restartCount,
int  resetMin,
string  commandLine,
string  host = "",
int  port = 4999,
string  user = "",
string  pwd = "" 
)

Add manager to WinCC OA console.

Parameters
manager(string) IN manager to add
startMode(string) IN start mode: manual, always, once
secKill(int) IN
restartCount(int) IN maximum count of restarts within resetMin before pmon stops restarting the manager
resetMin(int) IN maximum time before stop restarting the manager
commandLine(string) IN command line options for new manager
host(string) IN host for pmon manager
port(int) IN port for pmon manager
user(string) IN username for pmon manager
pwd(string) IN password for pmon manager
Returns
value of type 'int' -1 on error, 0 - success, 2 - such manager already exists in WinCC OA Console
bool fwInstallationManager_isManagerFileExecutable ( string  managerName)

Checks if executable binary file exists for given manager.

Note
On Linux it checks if file has executable flag set, on Windows it searches for .exe file
Parameters
managerName(in) WinCC OA manager name
Returns
true if manager binary file exists, false if not

For versions above 3.8-SP2, make sure that managers are added with the WinCC OA prefix

bool fwInstallationManager_isManagerPropertiesValid ( string  manager,
string  startMode,
int  secondsToKill,
int  restartCount,
int  resetStartCounter 
)
This function checks if following manager console parameters are valid.
Parameters
manager(in) Name of the manager (obsolete, legacy - use fwInstallationManager_isManagerFileExecutable() to check if manager name is valid)
startMode(in) WinCC OA console manager start mode. Allowed values: [manual, once, always]
secondsToKill(in) Seconds to kill manager (kill -9) if it didn't stop with 'normal' stop signal (kill -15)
restartCount(in) Maximum number of manager restart attempts in a time period
resetStartCounter(in) Time after which the manager restart attempts counter is reset
Returns
true when all properties are valid, false if one or more properties are invalid
bool fwInstallationManager_isManagerStartModeValid ( string  startMode)

Checks if given manager start mode is valid.

Note
The allowed WinCC OA manager start modes are: "always", "once", "manual"
Parameters
startMode(in) Manager start mode
Returns
true if given start mode is correct, false if not
bool fwInstallationManager_isManagerSecondsToKillValid ( int  secondsToKill)

Checks if manager console parameter "Seconds to kill" is correct.

Note
"Seconds to kill" value must be in range 1 - 9999.
Parameters
secondsToKill(in) Manager "Seconds to kill" parameter value
Returns
true if given "Seconds to kill" value is correct, false if not
bool fwInstallationManager_isManagerRestartCountValid ( int  restartCount)

Checks if manager console parameter "Restart Counter" is correct.

Note
"Restart Counter" must be in range 1 - 100.
Parameters
restartCount(in) Restart counter - how often (at most) manager can be restarted in a specified period
Returns
true if given "Restart Counter" value is correct, false if not
bool fwInstallationManager_isManagerResetStartCounterValid ( int  resetStartCounter)

Checks if manager console parameter "Reset Start Counter" is correct.

Note
"Reset Start Counter" must be in range 1 - 60
Parameters
resetStartCounter(in) Time in minutes, after which the counter of manager restart attempts is reset
Returns
true if given "Reset Start Counter" value is correct, false if not
int fwInstallationManager_appendDriver ( string  defActivated,
string  manTitle,
string  manager,
string  startMode,
int  secKill,
int  restartCount,
int  resetMin,
string  commandLine,
string  host = "",
int  port = 4999,
string  user = "",
string  pwd = "" 
)
This function allows to insert a driver and the correspoding simulator in

the local project. It is checked before, if the manager already exists.

Parameters
defActivatedif by the default the manager must be activated (i.e. no selection is done in the popup windows and the timer expires)
manTitleText shown as title
managername of the manager
startMode{manual, once, always}
secKillseconds to kill after stop
restartCountnumber of restarts
resetMinrestart counter reset time (minutes)
commandLinecommandline for the manager
Returns
1 - manager added, 2 - manager already existing, 3 - manager addition disabled, 0 - manager addition failed, -1 - invalid manager properties
Author
F. Varela (original idea by S. Schmeling)
int fwInstallationManager_append ( bool  defActivated,
string  manTitle,
string  manager,
string  requestedStartMode,
int  secKill,
int  restartCount,
int  resetMin,
string  commandLine,
string  host = "",
int  port = 4999,
string  user = "",
string  pwd = "" 
)
This function appends a manager to the console of the local project.
Parameters
defActivatedif by the default the manager must be activated (i.e. no selection is done in the popup windows and the timer expires)
manTitleText shown as title
managername of the manager
requestedStartMode{manual, once, always}
secKillseconds to kill after stop
restartCountnumber of restarts
resetMinrestart counter reset time (minutes)
commandLinecommandline for the manager
Returns
1 - manager added, 2 - manager already existing, 3 - manager addition disabled, 0 - manager addition failed
Author
F. Varela (original idea by S. Schmeling)
int fwInstallationManager_deleteReconfigurationAction ( string  manager,
string  startMode,
int  secKill,
int  restartCount,
int  resetMin,
string  commandLine 
)
This function deletes a manager reconfiguration action
Parameters
managername of the manager
startMode{manual, once, always}
secKillseconds to kill after stop
restartCountnumber of restarts
resetMinrestart counter reset time (minutes)
commandLinecommandline for the manager
Returns
0 if OK, -1 if error
int fwInstallationManager_setReconfigurationActions ( dyn_string  dsManager,
dyn_string  dsStartMode,
dyn_int  diSecKill,
dyn_int  diRestartCount,
dyn_int  diResetMin,
dyn_string  dsCommandLine 
)
This function stores a set of manager reconfiguration action in an internal dp
Parameters
dsManagernames of the managers
dsStartModearray of {manual, once, always}
diSecKillarray of seconds to kill after stop
diRestartCountarray of number of restarts
diResetMinarray of restart counter reset time (minutes)
dsCommandLinearray of commandline for the manager
Returns
0 if OK, -1 if error
int fwInstallationManager_getReconfigurationActions ( dyn_string &  dsManager,
dyn_string &  dsStartMode,
dyn_int &  diSecKill,
dyn_int &  diRestartCount,
dyn_int &  diResetMin,
dyn_string &  dsCommandLine 
)
This function retrieves from an internal dp, the list of manager reconfiguration actions
Parameters
dsManagernames of the managers
dsStartModearray of {manual, once, always}
diSecKillarray of seconds to kill after stop
diRestartCountarray of number of restarts
diResetMinarray of restart counter reset time (minutes)
dsCommandLinearray of commandline for the manager
Returns
0 if OK, -1 if error
int fwInstallationManager_executeReconfigurationAction ( string  manager,
string  startMode,
int  secKill,
int  restartCount,
int  resetMin,
string  commandLine,
string  host = "",
int  port = 4999,
string  user = "",
string  pwd = "" 
)
This function executes a manager reconfiguration action
Parameters
managername of the manager
startMode{manual, once, always}
secKillseconds to kill after stop
restartCountnumber of restarts
resetMinrestart counter reset time (minutes)
commandLinecommandline for the manager
hosthostname
portpmon port
userpmon user
pwdpmon password
Returns
0 if OK, -1 if error
int fwInstallationManager_executeAllReconfigurationActions ( bool  fromPostInstall = false)
This function executes all manager reconfiguration action
Parameters
fromPostInstallif false this function does nothing
Returns
0 if OK, -1 if error
string fwInstallationManager_startModeIntToString ( int  startModeInt)

This function converts start mode given as an integer value into corresponding text (i.e. 0 -> "manual").

Parameters
startModeInt(int) IN
Returns
value of type 'string'
int fwInstallationManager_startModeStringToInt ( string  startModeString)

This function converts start mode given as an text into corresponding integer value (i.e. "manual" -> 0).

Parameters
startModeInt(int) IN
Returns
value of type 'string'
int fwInstallationManager_setMode ( string  manager,
string  commandLine,
string  mode,
string  host = "",
int  port = 4999,
string  user = "",
string  pwd = "" 
)
This function sets the start mode of a manager
Parameters
managername of the manager
commandLinecommandline for the manager
mode{manual, once, always}
Returns
0 if OK, -1 if error
int fwInstallationManager_stopAllOfTypes ( dyn_string  types,
string  host = "",
int  port = 4999,
string  user = "",
string  pwd = "",
bool  wait = false,
bool  useKill = false 
)
This stops all managers of a set of particular types
Parameters
typestypes of manager to be stopped, e.g. PVSS00ui or WCCOAui
hosthostname
portpmon port
userpmon user
pwdpmon password
Returns
0 if OK, -1 if error
int fwInstallationManager_stopAllScattered ( dyn_string  types = makeDynString(),
bool  wait = false 
)

Stop all scattered managers.

Parameters
types(dyn_string) IN which types of manager to stop, empty = all
wait(bool) IN wait for managers to stop if true
Returns
0 - success, -1 - operation failed
int fwInstallationManager_getScripts ( int  num,
dyn_string &  scripts,
string  systemName = "" 
)

Return what script is being run by ctrl manager.

Parameters
num(int) IN manager number
scripts(dyn_string) variable to receive (output) scripts that are being run
systemName(string) system where to check running scripts
Returns
0 on success, -1 on error
dyn_int fwInstallationManager_getRunningScattered ( string  type,
dyn_string &  remoteHosts 
)

Get manager numbers and hosts where they are running.

Parameters
type(string) type of manager (ex. "Ctrl")
remoteHosts(dyn_string) variable to receive remote host names
Returns
manager numbers (also check remoteHosts)
int fwInstallationManager_exitScattered ( dyn_string  types,
dyn_int  pvssManagerTypes 
)

Stop scattered managers.

Parameters
types(dyn_string) type of manager (ex. "Ctrl")
pvssManagerTypes(dyn_int) manager type (ex. CTRL_MAN)
Returns
0 on success, -1 on error
int fwInstallationManager_shallStopManagersOfType ( string  managerType)
This function retrieves from an internal dp of the installation tool whether

the managers of a particular type have to be stopped prior to the installation of a component or not

Parameters
managerTypetype of manager, e.g. PVSS00ui
Returns
1 if manager shall be stopped, 0 if not or Agent DP doesn't exist
int fwInstallationManager_command ( string  action,
string  manager,
string  commandLine,
string  host = "",
int  port = 4999,
string  user = "",
string  pwd = "",
bool  wait = false 
)
This function send a pmon command onto a manager
Parameters
action{START, STOP, RESTART}
managermanager type
commandLinecommandline for the manager
hosthostname
portpmon port
userpmon user
pwdpmon password
Returns
0 if OK, -1 if error
int fwInstallationManager_pmonGetManagers ( dyn_dyn_mixed &  managersInfo,
string  host = "",
int  port = 4999,
string  user = "",
string  pwd = "" 
)
This function retrieves all managers from pmon
Parameters
managersInfo(out) managers properties
host(in) host name where the project runs
port(in) pmon port
user(in) pmon user
pwd(in) pmon password
Returns
0 if OK, -1 if error
Author
F. Varela based on an original implmentation done by S. Schmeling
int fwInstallationManager_switch ( bool  driver,
string  name,
int  number,
string  host = "",
int  port = 4999,
string  user = "",
string  pwd = "" 
)
This function switches between the real driver and the simulator.
Parameters
driverif set to one the real driver is started, otherwise the simulator
namemanager type
numberdriver number
hosthostname
portpmon port
userpmon user
pwdpmon password
Returns
0 if OK, -1 if error
int fwInstallationManager_restart ( string  name,
string  commandLine,
string  host = "",
int  port = 4999,
string  user = "",
string  pwd = "" 
)
This function restarts a manager.
Parameters
namemanager type
commandLinecommandline for the manager
hosthostname
portpmon port
userpmon user
pwdpmon password
Returns
0 if OK, -1 if error
void fwInstallationManager_waitForState ( bool  running,
int  number,
int  retries = 0,
string  systemName = "" 
)
This function wait for a manager to be in a particular state
Parameters
runningif set to one the function waits for the manager to be running, otherwise to be stopped
numberdriver number
retrieshow many time to retry
systemNamename of the pvss system where to check the state of the manager
Returns
0 if OK, -1 if error
void fwInstallationManager_wait ( bool  running,
string  manager,
string  commandLine,
int  timeout,
bool &  expired,
string  host = "",
int  port = 4999,
string  user = "",
string  pwd = "" 
)
This function wait for a manager to be in a particular state
Parameters
running(in) if true the desired state of the manager is running, otherwise it is stopped
manager(in) type of the pvss manager
commandLine(in) manager options
timeout(int) how long to wait for in seconds
timeout(in) if true, the time has expired, otherwise the manager reached the desired state within the timeout time
host(in) hostname
port(in) pmon port
user(in) pmon user
pwd(in) pmon password
int fwInstallationManager_isRunning ( string  manager,
string  commandLine,
bool &  isRunning,
string  host = "",
int  port = 4999,
string  user = "",
string  pwd = "" 
)
This function checks if a manager is running or not
Parameters
manager(in) type of the pvss manager
commandLine(in) manager options
isRunning(out) manager state. If 1 the manager runs, otherwise it is stopped
host(in) hostname
port(in) pmon port
user(in) pmon user
pwd(in) pmon password
Returns
0 if OK, -1 if error
bool fwInstallationManager_isDriverRunning ( int  number,
string  systemName = "",
int  reduHostNum = 0 
)
This function checks if a driver is running.
Parameters
numberdriver number
systemNamePVSS system where to find the manager
Returns
true if the driver runs, false otherwise
int fwInstallationManager_getProperties ( string  type,
string  options,
dyn_mixed &  properties,
string  host = "",
int  port = 4999,
string  user = "",
string  pwd = "" 
)
This function retrieves the manager properties
Parameters
typetype of manager
optionsmanager options
propertiesmanager properties
hosthostname
portpmon port
userpmon user
pwdpmon password
Returns
0 if OK, -1 if error
int fwInstallationManager_setProperties ( string  type,
string  currentOptions,
dyn_mixed  properties,
string  host = "",
int  port = 4999,
string  user = "",
string  pwd = "" 
)
This function sets the manager properties
Parameters
typetype of manager
currentOptionsmanager options
propertiesmanager properties
hosthostname
portpmon port
userpmon user
pwdpmon password
Returns
0 if OK, -1 if error
int fwInstallationManager_getNum ( string  type,
string  options,
int &  manNum,
string  host = "",
int  port = 4999,
string  user = "",
string  pwd = "" 
)
This function retrieves the manager number
Parameters
typetype of manager
optionsmanager options
manNummanager number
hosthostname
portpmon port
userpmon user
pwdpmon password
Returns
0 if OK, -1 if error
int _fwInstallationManager_getManagersProtectedFromStopping ( dyn_string &  protectedManagers)

This function read the list of managers protected from stopping stored in agent parametrisation dp

Parameters
protectedManagers(dyn_string) IN/OUT
Returns
value of type 'int' - 0 if OK, -1 if error
int _fwInstallationManager_setManagersProtectedFromStopping ( dyn_string  protectedManagers)

This function sets the list of managers protected from stopping in agent parametrisation dp

Parameters
protectedManagers(dyn_string) IN/OUT
Returns
value of type 'int' - 0 if OK, -1 if error
int fwInstallationManager_remove ( string  manager,
string  commandLine,
string  host = "",
int  port = 4999,
string  user = "",
string  pwd = "" 
)

This function removes a manager from pmon. It is only possible to remove it if no manager following it is running.

Parameters
manager
commandLine
host
port
user
pwd
Returns
0 if OK, -1 if error

Variable Documentation

const string csFwInstallationManagerLibVersion = "8.4.1"

Version of this library. Used to determine the coherency of all libraries of the installation tool Please do not edit it manually