Functions | Variables

fwInstallationDB.ctl File Reference

Functions

int fwInstallationDB_printLibVersions ()
 Beginning of executable code:
int fwInstallationDB_setConnectionTimeout ()
int fwInstallationDB_beginTransaction ()
int fwInstallationDB_executeTransaction (string sql)
int fwInstallationDB_rollbackTransaction ()
int fwInstallationDB_commitTransaction ()
int fwInstallationDB_execute (string sql, dyn_mixed record)
int fwInstallationDB_executeQuery (string sql, dyn_mixed record, dyn_dyn_mixed &data)
int fwInstallationDB_registerReinstallation (string host, string project, string component, string version, string descFile, int restartProject, int overwriteFiles)
int fwInstallationDB_unregisterProjectReinstallations (string host, string project)
int fwInstallationDB_isReinstallationRegistered (int project_id, int component_id, int &id)
int fwInstallationDB_getProjectPendingReinstallations (string host, string project, dyn_dyn_mixed &reinstallationsInfo)
int fwInstallationDB_unregisterProjectReinstallation (string host, string project, string component, string version)
int fwInstallationDB_closeDBConnection ()
int fwInstallationDB_setupConnection ()
int fwInstallationDB_executeDBCommand (string sql, dyn_dyn_mixed data)
int fwInstallationDB_executeDBQuery (string sql, dyn_dyn_mixed &data, bool columnWise=FALSE, int maxRecords=0, dyn_int columnTypes=0)
bool fwInstallationDB_getInitialized ()
int fwInstallationDB_setInitialized (bool value)
int fwInstallationDB_deleteConnection ()
int fwInstallationDB_tableExists (string tableName, bool &tableExists)
int fwInstallationDB_viewExists (string viewName, bool &viewExists)
int fwInstallationDB_getSchemaVersion (string &version)
bool fwInstallationDB_compareSchemaVersion ()
int fwInstallationDB_registerComponentFromXml (string xmlFile)
synchronized int fwInstallationDB_connect ()
string fwInstallationDB_getSchemaOwner ()
synchronized int fwInstallationDB_openDBConnection (string database, string username, string password, string owner, string driver="QOCI8")
bool fwInstallationDB_getUseDB ()
int fwInstallationDB_setUseDB (bool useDB)
int fwInstallationDB_registerProject (string projectName="", string host="", int pmon_port=4999, string pmon_username="", string pmon_password="", string projectDir="", string systemName="", int systemNumber=-1, int dataPortNr=4897, int eventPortNr=4998, int distPort=4777, int centrallyManaged=0, string pvssVersion="", string os="", string reduHost="", string systemComputer="", int deleteFiles=0)
int fwInstallationDB_unregisterInstallationPath (string installationPath, string projectName="", string computerName="")
int fwInstallationDB_deleteAllProjectPaths (string projectName="", string computerName="")
int fwInstallationDB_getInstallationPaths (dyn_string &dbInstallationPaths, dyn_string &dbInstallationPathsIds, string projectName="", string computerName="")
int fwInstallationDB_getPvssProjects (dyn_string &projectNames, string computerName="", bool onlyActive=true)
int fwInstallationDB_registerComponent (string componentName, string componentVersion, int isSubComponent)
int fwInstallationDB_isComponentRegistered (string componentName, string componentVersion, int &id)
int fwInstallationDB_isProjectRegistered (int &project_id, string projectName="", string computerName="")
int fwInstallationDB_registerPC (string host="", dyn_mixed hostInfo="")
int fwInstallationDB_deletePC (string host="")
int fwInstallationDB_deleteProject (string project="", string host="", bool deleteSystem=false)
int fwInstallationDB_deleteSystem (string systemName)
int fwInstallationDB_deleteProjectManager (dyn_mixed managerInfo, string project="", string host="")
int fwInstallationDB_isPCRegistered (int &id, string host="")
int fwInstallationDB_registerSystem (dyn_mixed systemProperties)
int fwInstallationDB_isSystemRegistered (int &id, string systemName="")
int fwInstallationDB_isInstallationPathRegistered (string installationPath, int &installation_path_id, int &project_id, string projectName="", string computerName="")
int fwInstallationDB_registerInstallationPath (string installationPath, int isDefault, string projectName="", string computerName="")
int fwInstallationDB_getPatchList (string host, string version, string os, dyn_string &patches)
int fwInstallationDB_getPvssVersions (string host="", dyn_string &versions, dyn_string &oss)
int fwInstallationDB_registerPvssVersion (string version="", string os="")
int fwInstallationDB_isPvssVersionRegistered (string version, string os, int &id)
int fwInstallationDB_registerPvssPatch (string patch, string version="", string os="")
int fwInstallationDB_isPvssPatchRegistered (string patch, string version, string os, int &patch_id, int &pvss_id)
int fwInstallationDB_registerPvssBase (string host="", string version="", string os="")
int fwInstallationDB_isPvssBaseRegistered (string host, string version, string os, int &base_id, int &pvss_id, int &host_id)
int fwInstallationDB_registerPvssSetup (string host="", string version="", string os="", dyn_string patches="")
int fwInstallationDB_unregisterSetupPvssPatch (string host, string version, string os, string patch)
int fwInstallationDB_isPvssSetupEntryRegistered (int base_id, int patch_id, int &setup_id)
int fwInstallationDB_registerProjectPaths ()
int fwInstallationDB_isProjectComponentRegistered (string component, string version, string project, string hostname, int &component_id, int &project_id, int &projectComponentId)
int fwInstallationDB_registerProjectFwComponents (string project="", string hostname="")
int fwInstallationDB_unregisterCurrentProjectComponent (string component, string version, string project="", string host="")
int fwInstallationDB_registerProjectManagers ()
int fwInstallationDB_executeSqlSimple (string sql)
int fwInstallationDB_executeSqlFromFile (string fileName, bool breakOnDbError=TRUE)
int fwInstallationDB_getHostsInfo (dyn_dyn_mixed &hostsInfo)
int fwInstallationDB_getHosts (dyn_string &hostnames, dyn_string &ips, dyn_string &macs, dyn_string &ips2, dyn_string &macs2, dyn_string &bmc_ips, dyn_string &bmc_ips2)
int fwInstallationDB_getPvssSystems (dyn_dyn_mixed &systemsInfo, bool onlyActive=true)
int fwInstallationDB_getComponentProperties (string component, string version, int &isSubComponent)
int fwInstallationDB_getAllComponents (dyn_dyn_mixed &componentsInfo)
int fwInstallationDB_getHostProperties (string hostname, dyn_mixed &hostInfo)
int fwInstallationDB_setHostProperties (string hostname, dyn_mixed hostInfo)
int fwInstallationDB_getCentrallyManaged ()
int fwInstallationDB_setCentrallyManaged (int centrallyManaged, string project="", string hostname="")
int fwInstallationDB_getProjectManagementMode (bool &isCentrallyManaged, string project="", string hostname="")
int fwInstallationDB_getProjectProperties (string project, string hostname, dyn_mixed &projectProperties, int &projectId)
int fwInstallationDB_getReduPair (string hostname, string project, string &reduHost)
int fwInstallationDB_getProjectPvssInfo (string project, string hostname, dyn_mixed &dbPvssInfo)
int fwInstallationDB_getProjectPaths (string project="", string hostname="", dyn_string &projectPaths)
int fwInstallationDB_setProjectProperties (string project, string hostname, dyn_mixed projectProperties)
int fwInstallationDB_setSystemProperties (dyn_mixed systemProperties)
int fwInstallationDB_setComponentProperties (string component, string version, int isSubComponent)
int fwInstallationDB_addChildSystem (string parentSystem, string childSystem)
int fwInstallationDB_removeChildSystem (string systemName)
int fwInstallationDB_removeSystemHierarchy ()
int fwInstallationDB_getChildSystems (string parentSystem, dyn_dyn_mixed &childSystems)
int fwInstallationDB_getSystemHierarchy (dyn_dyn_mixed &hierarchyInfo)
int fwInstallationDB_getPvssSystemProperties (string systemName, dyn_mixed &systemInfo)
int fwInstallationDB_getSystemConnectivity (string systemName, dyn_mixed &connectedSystemsInfo)
int fwInstallationDB_getRemoteConnections (string systemName, dyn_mixed &connectedSystemsInfo)
int fwInstallationDB_getSystemProjects (string systemName, dyn_dyn_mixed &projectsInfo)
int fwInstallationDB_registerProjectManager (dyn_mixed managerInfo, string project="", string hostname="")
int fwInstallationDB_setPvssManagerProperties (dyn_mixed managerInfo, string project="", string hostname="")
int fwInstallationDB_isProjectManagerRegistered (dyn_mixed managerInfo, string project, string hostname, int &manager_id, int &project_id)
int fwInstallationDB_registerPvssManagerType (dyn_mixed managerTypeInfo)
int fwInstallationDB_isPvssManagerTypeRegistered (string managerType, bool &isRegistered)
int fwInstallationDB_getProjectManagers (dyn_dyn_mixed &managersInfo, string projectName="", string computerName="")
int fwInstallationDB_getProjectComponents (dyn_dyn_mixed &componentsInfo, string projectName="", string computerName="")
int fwInstallationDB_addSystemConnection (string peer1Name, string peer2Name)
int fwInstallationDB_removeSystemConnection (string peer1Name, string peer2Name)
int fwInstallationDB_getSystemProjectHost (string systemName, dyn_dyn_mixed &projectSystemHostInfo)
int fwInstallationDB_getProjectGroupProperties (string group, dyn_mixed &projectGroupInfo, string projectName="", string computerName="")
int fwInstallationDB_getCurrentProjectComponents (dyn_dyn_mixed &componentsInfo, string projectName="", string computerName="")
int fwInstallationDB_registerPathMapping (string windowsPath, string linuxPath)
int fwInstallationDB_isPathMappingRegistered (int &id, string windowsPath, string linuxPath)
int fwInstallationDB_unregisterPathMapping (string windowsPath, string linuxPath)
int fwInstallationDB_getMappedPath (string path, string &mappedPath)
int fwInstallationDB_getAllMappedPaths (string pattern, dyn_mixed &pathMapping)
int fwInstallationDB_getComputerSystems (string computer, dyn_string &systems)
int fwInstallationDB_getComponentsIncorrectlyInstalled (dyn_dyn_mixed &componentsInfo)
int fwInstallationDB_getSystemName (string sysNumber, string &name, int reduNr=1)

Variables

const string csFwInstallationDBLibVersion = "5.0.0"
fwInstallation.ctl: Definition of variables

The following variables are used by the fwInstallationManager.ctl library

const string FW_INSTALLATION_SCHEMA_TBL = "FW_SYS_STAT_SCHEMA"
const string FW_INSTALLATION_DB_REQUIRED_SCHEMA_VERSION = "4.1.2"
const int FW_INSTALLATION_DB_SYSTEM_NAME = 1
const int FW_INSTALLATION_DB_SYSTEM_NUMBER = 2
const int FW_INSTALLATION_DB_SYSTEM_DATA_PORT = 3
const int FW_INSTALLATION_DB_SYSTEM_EVENT_PORT = 4
const int FW_INSTALLATION_DB_SYSTEM_DIST_PORT = 5
const int FW_INSTALLATION_DB_SYSTEM_PARENT_SYS_ID = 6
const int FW_INSTALLATION_DB_SYSTEM_COMPUTER = 7
int FW_INSTALLATION_DB_SYSTEM_ID_IDX = 3
int FW_INSTALLATION_DB_SYSTEM_PARENT_ID_IDX = 4
const int FW_INSTALLATION_DB_PROJECT_NAME = 1
const int FW_INSTALLATION_DB_PROJECT_HOST = 2
const int FW_INSTALLATION_DB_PROJECT_DIR = 3
const int FW_INSTALLATION_DB_PROJECT_SYSTEM_NAME = 4
const int FW_INSTALLATION_DB_PROJECT_SYSTEM_NUMBER = 5
const int FW_INSTALLATION_DB_PROJECT_PMON_PORT = 6
const int FW_INSTALLATION_DB_PROJECT_PMON_USER = 7
const int FW_INSTALLATION_DB_PROJECT_PMON_PWD = 8
const int FW_INSTALLATION_DB_PROJECT_TOOL_VER = 9
const int FW_INSTALLATION_DB_PROJECT_CENTRALLY_MANAGED = 10
const int FW_INSTALLATION_DB_PROJECT_PVSS_VER = 11
const int FW_INSTALLATION_DB_PROJECT_DATA = 12
const int FW_INSTALLATION_DB_PROJECT_EVENT = 13
const int FW_INSTALLATION_DB_PROJECT_DIST = 14
const int FW_INSTALLATION_DB_PROJECT_OS = 15
const int FW_INSTALLATION_DB_PROJECT_PROJECT_OK = 16
const int FW_INSTALLATION_DB_PROJECT_PVSS_OK = 17
const int FW_INSTALLATION_DB_PROJECT_HOST_OK = 18
const int FW_INSTALLATION_DB_PROJECT_PATH_OK = 19
const int FW_INSTALLATION_DB_PROJECT_MANAGER_OK = 20
const int FW_INSTALLATION_DB_PROJECT_GROUP_OK = 21
const int FW_INSTALLATION_DB_PROJECT_COMPONENT_OK = 22
const int FW_INSTALLATION_DB_PROJECT_EXT_PROCESS_OK = 23
const int FW_INSTALLATION_DB_PROJECT_LAST_CHECK = 24
const int FW_INSTALLATION_DB_PROJECT_SYSTEM_OVERVIEW = 25
const int FW_INSTALLATION_DB_PROJECT_UPGRADE = 26
const int FW_INSTALLATION_DB_PROJECT_REDU_HOST = 27
const int FW_INSTALLATION_DB_PROJECT_SYSTEM_COMPUTER = 28
const int FW_INSTALLATION_DB_PROJECT_DELETE_FILES = 29
const int FW_INSTALLATION_DB_WINDOWS_PATH = 1
const int FW_INSTALLATION_DB_LINUX_PATH = 2
global bool g_fwInstallationSqlDebug = false
global bool g_fwInstallationVerbose = false
global dbConnection gFwInstallationDBConn
string FW_INSTALLATION_DB_CONNECTION_NAME = "fwInstallationToolConnection"
const int FW_INSTALLATION_DB_MANAGER_NAME_IDX = 1
const int FW_INSTALLATION_DB_MANAGER_START_IDX = 2
const int FW_INSTALLATION_DB_MANAGER_RESTART_IDX = 3
const int FW_INSTALLATION_DB_MANAGER_RESETMIN_IDX = 4
const int FW_INSTALLATION_DB_MANAGER_SECKILL_IDX = 5
const int FW_INSTALLATION_DB_MANAGER_OPTIONS_IDX = 6
const int FW_INSTALLATION_DB_MANAGER_TRIGGERS_ALERTS_IDX = 7
const int FW_INSTALLATION_DB_MANAGER_TYPE_NAME_IDX = 1
const int FW_INSTALLATION_DB_MANAGER_TYPE_DESCRIPTION_IDX = 2
const int FW_INSTALLATION_DB_MANAGER_TYPE_GROUP_IDX = 3
const int FW_INSTALLATION_DB_COMPUTER_FLAG_IDX = 1
const int FW_INSTALLATION_DB_PVSS_FLAG_IDX = 2
const int FW_INSTALLATION_DB_PROJECT_FLAG_IDX = 3
const int FW_INSTALLATION_DB_MANAGERS_FLAG_IDX = 4
const int FW_INSTALLATION_DB_FW_COMPONENTS_FLAG_IDX = 5
const int FW_INSTALLATION_DB_EXTERNAL_PROCESSES_FLAG_IDX = 6
const int FW_INSTALLATION_DB_DIST_PEERS_FLAG_IDX = 7
const int FW_INSTALLATION_DB_COMPONENT_NAME_IDX = 1
const int FW_INSTALLATION_DB_COMPONENT_VERSION_IDX = 2
const int FW_INSTALLATION_DB_COMPONENT_SUBCOMP_IDX = 3
const int FW_INSTALLATION_DB_COMPONENT_DESC_FILE_IDX = 4
const int FW_INSTALLATION_DB_COMPONENT_INSTALLATION_NOT_OK_IDX = 5
const int FW_INSTALLATION_DB_COMPONENT_RESTART_IDX = 6
const int FW_INSTALLATION_DB_EXT_PROCESS_NAME_IDX = 1
const int FW_INSTALLATION_DB_EXT_PROCESS_PATH_IDX = 2
const int FW_INSTALLATION_DB_EXT_PROCESS_OPTIONS_IDX = 3
const int FW_INSTALLATION_DB_PROJ_SYS_HOST_PROJ = 1
const int FW_INSTALLATION_DB_PROJ_SYS_HOST_SYS_NAME = 2
const int FW_INSTALLATION_DB_PROJ_SYS_HOST_SYS_NUMBER = 3
const int FW_INSTALLATION_DB_PROJ_SYS_HOST_DISTPORT = 4
const int FW_INSTALLATION_DB_PROJ_SYS_HOST_HOST = 5
const int FW_INSTALLATION_DB_PROJ_COMP_NAME_IDX = 1
const int FW_INSTALLATION_DB_PROJ_COMP_VERSION_IDX = 2
const int FW_INSTALLATION_DB_PROJ_COMP_IS_SUBCOMP_IDX = 3
const int FW_INSTALLATION_DB_PROJ_COMP_DESCFILE_IDX = 4
const int FW_INSTALLATION_DB_PROJ_COMP_OVERWRITE_IDX = 5
const int FW_INSTALLATION_DB_PROJ_COMP_FORCE_IDX = 6
const int FW_INSTALLATION_DB_PROJ_COMP_IS_SILENT_IDX = 7
const int FW_INSTALLATION_DB_PROJ_COMP_IS_PATCH_IDX = 8
const int FW_INSTALLATION_DB_PROJ_COMP_RESTART_PROJECT_IDX = 9
const int FW_INSTALLATION_DB_PVSS_INFO_VERSION_IDX = 1
const int FW_INSTALLATION_DB_PVSS_INFO_OS_IDX = 2
const int FW_INSTALLATION_DB_PVSS_INFO_PATCHES_IDX = 3
const int FW_INSTALLATION_DB_HOST_NAME_IDX = 1
const int FW_INSTALLATION_DB_HOST_IP_1_IDX = 2
const int FW_INSTALLATION_DB_HOST_MAC_1_IDX = 3
const int FW_INSTALLATION_DB_HOST_IP_2_IDX = 4
const int FW_INSTALLATION_DB_HOST_MAC_2_IDX = 5
const int FW_INSTALLATION_DB_HOST_BMC_IP_IDX = 6
const int FW_INSTALLATION_DB_HOST_BMC_USER_IDX = 7
const int FW_INSTALLATION_DB_HOST_BMC_PWD_IDX = 8
const int FW_INSTALLATION_DB_HOST_FMC_ENABLE_IPMI_IDX = 9
const int FW_INSTALLATION_DB_HOST_FMC_IPMI_DEVICE_NAME_IDX = 10
const int FW_INSTALLATION_DB_HOST_FMC_ENABLE_MONITORING_IDX = 11
const int FW_INSTALLATION_DB_HOST_FMC_MONITORING_LEVEL_IDX = 12
const int FW_INSTALLATION_DB_HOST_FMC_ENABLE_TM_IDX = 13
const int FW_INSTALLATION_DB_HOST_FMC_ENABLE_LOGGER_IDX = 14
const int FW_INSTALLATION_DB_HOST_DB_IDX = 15
const int FW_INSTALLATION_DB_HOST_FMC_ENABLE_PROCESS_IDX = 16
const int FW_INSTALLATION_DB_HOST_FMC_WIN_PROCS_CONTROLLER_IDX = 17
const int FW_INSTALLATION_DB_HOST_FMC_LOCATION_IDX = 18
const int FW_INSTALLATION_DB_HOST_DESCRIPTION_IDX = 19
const int FW_INSTALLATION_DB_HOST_FMC_OS_IDX = 20
const int FW_INSTALLATION_DB_HOST_FMC_IPMI_MASTER_IDX = 21
const int FW_INSTALLATION_DB_HOST_FMC_ARCHIVING_IDX = 22
const int FW_INSTALLATION_DB_HOST_FMC_ALARMS_IDX = 23
const int FW_INSTALLATION_DB_COMP_BAD_HOST = 1
const int FW_INSTALLATION_DB_COMP_BAD_PROJECT = 2
const int FW_INSTALLATION_DB_COMP_BAD_NAME = 3
const int FW_INSTALLATION_DB_COMP_BAD_VERSION = 4
const int FW_INSTALLATION_DB_CONNECTION_TIMEOUT = 600

Detailed Description

This library contains all functions that serve as interface between the installation tool and a external Oracle DB. The functions in these library are not intended to be called from user scripts

Author:
Fernando Varela Rodriguez (IT-CO/BE)
Version:
3.3.10
Date:
April 2007

Function Documentation

int fwInstallationDB_addChildSystem ( string  parentSystem,
string  childSystem 
)

This function defines a child system for a particular PVSS system

Parameters:
parentSystem Name of the parent PVSS system
childSystem Name of the child PVSS system
Returns:
0 if OK, -1 if errors
int fwInstallationDB_addSystemConnection ( string  peer1Name,
string  peer2Name 
)

This function registers in the System Configuration DB the connection between two dist-peers

Parameters:
peer1Name Name of the first peer
peer2Name Name of the second peer
Returns:
0 if OK, -1 if errors
int fwInstallationDB_beginTransaction (  ) 

This function initiates a DB transaction

Returns:
0 if OK, -1 if error
int fwInstallationDB_closeDBConnection (  ) 

This function closes the connection to the System Configuration DB

Returns:
0 if OK, -1 if error
int fwInstallationDB_commitTransaction (  ) 

This function commits a DB transaction

Returns:
0 if OK, -1 if error
bool fwInstallationDB_compareSchemaVersion (  ) 

This function compares the current and required DB schema versions

Returns:
True if the current is equal or newer than the required one, otherwise false
synchronized int fwInstallationDB_connect (  ) 

This function establishes a connection to the System Configuration DB

Returns:
0 if OK, -1 if error
int fwInstallationDB_deleteAllProjectPaths ( string  projectName = "",
string  computerName = "" 
)

This function unregisters all project paths at once from the System Configuration DB

Parameters:
projectName project name
computerName hostname
Returns:
0 if OK, -1 if errors
int fwInstallationDB_deleteConnection (  ) 

This function deletes a DB connection

Returns:
0 if OK, -1 if error
int fwInstallationDB_deletePC ( string  host = ""  ) 

This function deletes a host from the System Configuration DB

Parameters:
host host to be deleted
Returns:
0 if OK, -1 if errors
int fwInstallationDB_deleteProject ( string  project = "",
string  host = "",
bool  deleteSystem = false 
)

This function deletes a project from the System Configuration DB

Parameters:
project project name
host hostname
deleteSystem flag indicating if the PVSS system must also be deleted
Returns:
0 if OK, -1 if errors
int fwInstallationDB_deleteProjectManager ( dyn_mixed  managerInfo,
string  project = "",
string  host = "" 
)

This function deletes a project manager from the System Configuration DB

Parameters:
managerInfo manager information as a dyn_mixed
project project name
host hostname
Returns:
0 if OK, -1 if errors
int fwInstallationDB_deleteSystem ( string  systemName  ) 

This function deletes a PVSS system from the System Configuration DB

Parameters:
systemName system name
Returns:
0 if OK, -1 if errors
int fwInstallationDB_execute ( string  sql,
dyn_mixed  record 
)

This function executes a SQL instruction

Parameters:
sql (in) sql sentence to be executed
record (in) bind variables as a dyn_mixed
Returns:
0 if OK, -1 if error
int fwInstallationDB_executeDBCommand ( string  sql,
dyn_dyn_mixed  data 
)

This function executes a DB command

Parameters:
sql SQL command
data Command data as a dyn_dyn_mixed array
Returns:
0 if OK, -1 if error
int fwInstallationDB_executeDBQuery ( string  sql,
dyn_dyn_mixed &  data,
bool  columnWise = FALSE,
int  maxRecords = 0,
dyn_int  columnTypes = 0 
)

This function executes a DB query

Parameters:
sql SQL query to be executed
data retrieved data
columnWise defines if the data must be sorted by columns
maxRecords Maximum number of records allowed in the data
columnTypes data types of the retrieved columns
Returns:
0 if OK, -1 if error
int fwInstallationDB_executeQuery ( string  sql,
dyn_mixed  record,
dyn_dyn_mixed &  data 
)

This function executes a SQL query

Parameters:
sql (in) sql sentence to be executed
record (in) bind variables as a dyn_mixed
data (out) result of the query as a dyn_dyn_mixed
Returns:
0 if OK, -1 if error
int fwInstallationDB_executeSqlFromFile ( string  fileName,
bool  breakOnDbError = TRUE 
)

executes SQL statements stored in a file

Note that the all commands in the file should be terminated by the semicolon (;) character, which should be the last characted in the line. The comments (lines starting with "-" character) and white-spaces are a also automatically removed.

Parameters:
fileName the name of the file, where the SQL statements are stored. The file needs to be in the "config" directory of the project.
breakOnDbError (optional, default is TRUE) determines if the function should return terminate with an exception upon first encountered error, or it should rather try to finish the remaining commands (the errors encountered in a meantime will be reported at the end).
int fwInstallationDB_executeSqlSimple ( string  sql  ) 

This function executes a simple SQL sentence

Parameters:
sql SQL command to be executed
Returns:
0 if OK, -1 if errors
int fwInstallationDB_executeTransaction ( string  sql  ) 

This function executes a DB transaction

Parameters:
sql (in) sql sentence to be executed
Returns:
0 if OK, -1 if error
int fwInstallationDB_getAllComponents ( dyn_dyn_mixed &  componentsInfo  ) 

This function retrieves the information about all components registered in the System Configuration DB

Parameters:
componentsInfo components information as a dyn_dyn_mixed
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getAllMappedPaths ( string  pattern,
dyn_mixed &  pathMapping 
)

This function reads from the System Configuration DB all path mappings defined

Parameters:
pattern search string pattern
pathMapping array of path mappings a dyn_mixed
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getCentrallyManaged (  ) 

This function checks if a project is centrally managed from the System Configuration DB

Returns:
1 if centrally managed, 0 if locally managed
int fwInstallationDB_getChildSystems ( string  parentSystem,
dyn_dyn_mixed &  childSystems 
)

This function retrieves the list of child systems of a particular parent as defined in the system configuration DB

Parameters:
parentSystem Name of the parent PVSS system
childSystems Children properties as a dyn_dyn_mixed matrix
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getComponentProperties ( string  component,
string  version,
int &  isSubComponent 
)

This function checks if a component has be registered as a subcomponent in the System Configuration DB

Parameters:
component name of the component
version version of the component
isSubComponent if 1 the component is a subcomponent
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getComponentsIncorrectlyInstalled ( dyn_dyn_mixed &  componentsInfo  ) 

This function reads from the System Configuration DB the properties of the components wrongly installed all projects

Parameters:
componentsInfo component properties
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getComputerSystems ( string  computer,
dyn_string &  systems 
)

This function reads from the System Configuration DB all PVSS systems in a computer

Parameters:
computer hostname
systems list of PVSS systems found
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getCurrentProjectComponents ( dyn_dyn_mixed &  componentsInfo,
string  projectName = "",
string  computerName = "" 
)

This function reads from the System Configuration DB the current list of components installed in a project

Parameters:
componentsInfo components' properties
projectName project name
computerName hostname
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getHostProperties ( string  hostname,
dyn_mixed &  hostInfo 
)

This function retrieves the properties of a host from the System Configuration DB

Parameters:
hostname name of the host
hostInfo host properties as a dyn_mixed
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getHosts ( dyn_string &  hostnames,
dyn_string &  ips,
dyn_string &  macs,
dyn_string &  ips2,
dyn_string &  macs2,
dyn_string &  bmc_ips,
dyn_string &  bmc_ips2 
)

This function retrives the hosts properties from the DB

Parameters:
hostnames list of hostnames
ips list of IP addresses
macs list of MAC addresses
ips2 list of second IP addresses
macs2 list of second MAC addresses
bmc_ips list of IP addresses of the BMC (IPMI)
bmc_ips2 list of second IP addresses of the BMC (IPMI)
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getHostsInfo ( dyn_dyn_mixed &  hostsInfo  ) 

This function retrieves all hosts information from the System Configuration DB

Parameters:
hostsInfo information for all hosts registered in the DB as a dyn_dyn_mixed matrix
Returns:
0 if OK, -1 if errors
bool fwInstallationDB_getInitialized (  ) 

This function returns the initialization status of the DB connection

Returns:
true if the connection is initialized and false otherwise
int fwInstallationDB_getInstallationPaths ( dyn_string &  dbInstallationPaths,
dyn_string &  dbInstallationPathsIds,
string  projectName = "",
string  computerName = "" 
)

This function retrieves all registered project paths from the System Configuration DB

Parameters:
dbInstallationPaths list of project paths
dbInstallationPathsIds list of DB indices of the different project paths
projectName project name
computerName hostname
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getMappedPath ( string  path,
string &  mappedPath 
)

This function reads from the System Configuration DB the path mapped to a particular path in a different operating system

Parameters:
path path, e.g. P: or /afs/cern.ch
mappedPath mapped path in the other operating system, e.g. /afs/cern.ch or P:
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getPatchList ( string  host,
string  version,
string  os,
dyn_string &  patches 
)

This function retrieves the list of patches applied to a PVSS installation

Parameters:
host hostname
version PVSS version to check the patches for
os host operating system
patches list of applied patches
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getProjectComponents ( dyn_dyn_mixed &  componentsInfo,
string  projectName = "",
string  computerName = "" 
)

This function retrieves list of components installed in a project registered in the System Configuration DB

Parameters:
componentsInfo Components' properties as a dyn_dyn_mixed
projectName project name
computerName hostname
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getProjectGroupProperties ( string  group,
dyn_mixed &  projectGroupInfo,
string  projectName = "",
string  computerName = "" 
)

This function reads from the System Configuration DB the groups of components registered in a project

Parameters:
group Name of the group of components
projectGroupInfo group properties
projectName project name
computerName hostname
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getProjectManagementMode ( bool &  isCentrallyManaged,
string  project = "",
string  hostname = "" 
)

This function retrieves the project management mode

Parameters:
isCentrallyManaged flag indicating if the project is centrally managed (1). 0 if locally managed
project project name
hostname hostname
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getProjectManagers ( dyn_dyn_mixed &  managersInfo,
string  projectName = "",
string  computerName = "" 
)

This function retrieves the list of managers in a project registered in the System Configuration DB

Parameters:
managersInfo Manager properties as a dyn_dyn_mixed
projectName project name
computerName hostname
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getProjectPaths ( string  project = "",
string  hostname = "",
dyn_string &  projectPaths 
)

This function retrieves list of paths registered in the System Configuration DB for a project

Parameters:
project project name
hostname hostname
projectPaths list of project paths
Returns:
0 if OK, -1 if errors

Project paths:

int fwInstallationDB_getProjectPendingReinstallations ( string  host,
string  project,
dyn_dyn_mixed &  reinstallationsInfo 
)

This function retrieves the list of pending reinstalaltions for a given project

Parameters:
host name of the host where the project runs
project name of the project
reinstallationsInfo list of reinstallations
Returns:
0 if OK, -1 if error
int fwInstallationDB_getProjectProperties ( string  project,
string  hostname,
dyn_mixed &  projectProperties,
int &  projectId 
)

This function retrieves the project properties from the System Configuration DB

Parameters:
project project name
hostname name of the host
projectProperties Project properties as a dyn_mixed array
projectId DB index of the project
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getProjectPvssInfo ( string  project,
string  hostname,
dyn_mixed &  dbPvssInfo 
)

This function retrieves the properties of the PVSS installation for a particular project from the System Configuration DB

Parameters:
project project name
hostname name of the host where the project runs
dbPvssInfo PVSS information as a dyn_mixed array
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getPvssProjects ( dyn_string &  projectNames,
string  computerName = "",
bool  onlyActive = true 
)

This function retrieves all PVSS project registered in the System Configuration DB

Parameters:
projectNames list of project names
computerName hostname
onlyActive if true ignores the history of projects
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getPvssSystemProperties ( string  systemName,
dyn_mixed &  systemInfo 
)

This function retrievesthe properties of a PVSS system from the System Configuration DB

Parameters:
systemName Name of the PVSS system
systemInfo System properties as a dyn_mixed array
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getPvssSystems ( dyn_dyn_mixed &  systemsInfo,
bool  onlyActive = true 
)

This function retrieves the list of PVSS systems registered in the System Configuration DB

Parameters:
systemsInfo information about all PVSS systems as a dyn_dyn_mixed
onlyActive if true, ignores all history
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getPvssVersions ( string  host = "",
dyn_string &  versions,
dyn_string &  oss 
)

This function retrieves the list of PVSS versions registered for a host in the System Configuration DB

Parameters:
host hostname
versions PVSS versions installed
oss list of OS for different PVSS versions installed
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getReduPair ( string  hostname,
string  project,
string &  reduHost 
)

This function retrieves redundant pair of a projec registered in the System Configuration DB

Parameters:
hostname name of the host
project name of the project
reduHost name of the host where the redundant pair runs
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getRemoteConnections ( string  systemName,
dyn_mixed &  connectedSystemsInfo 
)

This function retrieves the list of remote distpeers of a particular system from the system configuration DB

Parameters:
systemName Name of the parent PVSS system
connectedSystemsInfo List of connected dist-peers
Returns:
0 if OK, -1 if errors
string fwInstallationDB_getSchemaOwner (  ) 

This function retrieves the schema owner to be used during the db connection

Returns:
schema owner as string
int fwInstallationDB_getSchemaVersion ( string &  version  ) 

This function retrieves the current DB schema version

Parameters:
version Version of the System Configuration DB schema
Returns:
0 if OK, -1 if error
int fwInstallationDB_getSystemConnectivity ( string  systemName,
dyn_mixed &  connectedSystemsInfo 
)

This function retrieves the list of dist peers of a system as defined in the system configuration DB

Parameters:
systemName Name of the PVSS system to retrieve the list of dist-peers for
connectedSystemsInfo Dist-peers properties as a dyn_mixed array
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getSystemHierarchy ( dyn_dyn_mixed &  hierarchyInfo  ) 

This function retrieves the information about the hierarchy of PVSS systems defined in the system configuration DB

Parameters:
hierarchyInfo Hierarchy information as a dyn_dyn_mixed matrix
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getSystemName ( string  sysNumber,
string &  name,
int  reduNr = 1 
)

This function reads from the System Configuration DB name of a systems with a particular number

Parameters:
sysNumber PVSS system number
name PVSS system name
reduNr redundancy number (not used. Obsolete, legacy)
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getSystemProjectHost ( string  systemName,
dyn_dyn_mixed &  projectSystemHostInfo 
)

This function reads from the System Configuration DB the project and host properties for a PVSS system

Parameters:
systemName Name of the PVSS system
projectSystemHostInfo projects and hosts properties as a dyn_dyn_mixed matrix
Returns:
0 if OK, -1 if errors
int fwInstallationDB_getSystemProjects ( string  systemName,
dyn_dyn_mixed &  projectsInfo 
)

This function retrieves the list of projects pointing to a single system (scattered projects)

Parameters:
systemName Name of the parent PVSS system
projectsInfo Projects' properties as a dyn_dyn_mixed matrix
Returns:
0 if OK, -1 if errors
bool fwInstallationDB_getUseDB (  ) 

This function returns whether the DB-agent of the installation tool must access the System Configuration DB or not

Returns:
true if the user has chosen to use the System Configuration DB, otherwise false
int fwInstallationDB_isComponentRegistered ( string  componentName,
string  componentVersion,
int &  id 
)

This function checks if a component is registered in the System Configuration DB

Parameters:
componentName component name
componentVersion component version
id DB index. -1 if the compnent is not registered in the DB
Returns:
0 if OK, -1 if errors
int fwInstallationDB_isInstallationPathRegistered ( string  installationPath,
int &  installation_path_id,
int &  project_id,
string  projectName = "",
string  computerName = "" 
)

This function checks if a project path is registered in the System Configuration DB

Parameters:
installationPath Project path
installation_path_id DB index of the project path. -1 if the project path is not yet registered in the DB.
project_id DB index of the project. -1 if the project is not yet registered in the DB.
projectName project name
computerName hostname
Returns:
0 if OK, -1 if errors
int fwInstallationDB_isPathMappingRegistered ( int &  id,
string  windowsPath,
string  linuxPath 
)

This function check from the System Configuration DB if a path mapping is registered

Parameters:
id DB index of the path mapping
windowsPath Windows path, e.g. P:
linuxPath Linux path, e.g. /afs/cern.ch
Returns:
0 if OK, -1 if errors
int fwInstallationDB_isPCRegistered ( int &  id,
string  host = "" 
)

This function checks if a host is registered in the System Configuration DB

Parameters:
id DB index of the host. -1 if the host is not registered in the DB.
host hostname
Returns:
0 if OK, -1 if errors
int fwInstallationDB_isProjectComponentRegistered ( string  component,
string  version,
string  project,
string  hostname,
int &  component_id,
int &  project_id,
int &  projectComponentId 
)

This function checks if a component is registered in the System Configuration DB

Parameters:
component Name of the component
version Version of the component
project Project name
hostname hostname
component_id DB index identifying the component
project_id DB index identifying the project
projectComponentId DB index identifying the component in a project. -1 if the component is not registered in the project
Returns:
0 if OK, -1 if errors
int fwInstallationDB_isProjectManagerRegistered ( dyn_mixed  managerInfo,
string  project,
string  hostname,
int &  manager_id,
int &  project_id 
)

This function checks if a manager is registered in a project in the system configuration DB

Parameters:
managerInfo manager properties
project project name
hostname hostname
manager_id DB index of the manager
project_id DB index of the project
Returns:
0 if OK, -1 if errors
int fwInstallationDB_isProjectRegistered ( int &  project_id,
string  projectName = "",
string  computerName = "" 
)

This function checks if a project is registered in the System Configuration DB

Parameters:
project_id DB index of the project. -1 if the project is not registered in the DB.
projectName project name
computerName hostname
Returns:
0 if OK, -1 if errors
int fwInstallationDB_isPvssBaseRegistered ( string  host,
string  version,
string  os,
int &  base_id,
int &  pvss_id,
int &  host_id 
)

This function checks if a PVSS base version is registed in the System Configuration DB

Parameters:
host hostname
version PVSS version name
os operating system type
base_id DB index of the PVSS base version. -1 if not registered in the DB.
pvss_id DB index of the PVSS version
host_id DB index of the host
Returns:
0 if OK, -1 if errors
int fwInstallationDB_isPvssManagerTypeRegistered ( string  managerType,
bool &  isRegistered 
)

This function checks if a manager type is registered in the System Configuration DB

Parameters:
managerType Manager type properties as a dyn_mixed
isRegistered true if the manager type is registered
Returns:
0 if OK, -1 if errors
int fwInstallationDB_isPvssPatchRegistered ( string  patch,
string  version,
string  os,
int &  patch_id,
int &  pvss_id 
)

This function registers a PVSS patch for a given PVSS version in the System Configuration DB

Parameters:
patch PVSS patch name
version PVSS version name
os operating sytem type {WINDOWS, LINUX}
patch_id DB index of the patch once registered.
pvss_id DB index of the PVSS version
Returns:
0 if OK, -1 if errors
int fwInstallationDB_isPvssSetupEntryRegistered ( int  base_id,
int  patch_id,
int &  setup_id 
)

This function checks if a patch is for a PVSS version in a host is registered in the System Configuration DB

Parameters:
base_id DB index corresponding to the base PVSS version
patch_id DB index identifying a patch
setup_id DB index of the PVSS setup where the patch is registered. -1 if the patch is not registered in the PVSS setup
Returns:
0 if OK, -1 if errors
int fwInstallationDB_isPvssVersionRegistered ( string  version,
string  os,
int &  id 
)

This function checks if a PVSS version is registered in the System Configuration DB

Parameters:
version name of the PVSS version to be checked
os operating system type {WINDOWS, LINUX}
id DB index of the PVSS version. -1 means that the PVSS version is not registered in the DB.
Returns:
0 if OK, -1 if errors
int fwInstallationDB_isReinstallationRegistered ( int  project_id,
int  component_id,
int &  id 
)

This function checks if a component reinstallation has already been registered in the DB for a given project

Parameters:
project_id DB index of the project
component_id DB index of the component
id DB index of the reinstallation. -1 means that the reinstallation is not yet registered in the DB
Returns:
0 if OK, -1 if error
int fwInstallationDB_isSystemRegistered ( int &  id,
string  systemName = "" 
)

This function checks if a PVSS system is registered in the System Configuration DB

Parameters:
id DB index of the system. -1 if the system is not registered in the DB.
systemName system name
Returns:
0 if OK, -1 if errors
synchronized int fwInstallationDB_openDBConnection ( string  database,
string  username,
string  password,
string  owner,
string  driver = "QOCI8" 
)

This function opens a connection to the System Configuration DB

Parameters:
database (in) database server name
username (in) user name
password (in) password
owner (in) schema owner
driver (in) driver to be used. By default "QOCI8".
Returns:
0 if OK, -1 if error
int fwInstallationDB_printLibVersions (  ) 

Beginning of executable code:

This function prints the versions of the libraries in the current distribution

Returns:
0
int fwInstallationDB_registerComponent ( string  componentName,
string  componentVersion,
int  isSubComponent 
)

This function registers a component in the System Configuration DB

Parameters:
componentName component name
componentVersion component version
isSubComponent flag indicating if the component is a subcomponent
Returns:
0 if OK, -1 if errors
int fwInstallationDB_registerComponentFromXml ( string  xmlFile  ) 

This function registers in the DB a Framework component

Parameters:
xmlFile Component description file
Returns:
0 if OK, -1 if error
int fwInstallationDB_registerInstallationPath ( string  installationPath,
int  isDefault,
string  projectName = "",
string  computerName = "" 
)

This function registers a project path in the System Configuration DB

Parameters:
installationPath Project path
isDefault flag indicating if this path is the default installation path
projectName project name
computerName hostname
Returns:
0 if OK, -1 if errors
int fwInstallationDB_registerPathMapping ( string  windowsPath,
string  linuxPath 
)

This function registers in the System Configuration DB the mapping between Windows and Linux paths, e.g. /afs/cern.ch - p:

Parameters:
windowsPath Windows path
linuxPath Linux path
Returns:
0 if OK, -1 if errors
int fwInstallationDB_registerPC ( string  host = "",
dyn_mixed  hostInfo = "" 
)

This function registers a host in the System Configuration DB

Parameters:
host hostname
hostInfo host properties
Returns:
0 if OK, -1 if errors
int fwInstallationDB_registerProject ( string  projectName = "",
string  host = "",
int  pmon_port = 4999,
string  pmon_username = "",
string  pmon_password = "",
string  projectDir = "",
string  systemName = "",
int  systemNumber = -1,
int  dataPortNr = 4897,
int  eventPortNr = 4998,
int  distPort = 4777,
int  centrallyManaged = 0,
string  pvssVersion = "",
string  os = "",
string  reduHost = "",
string  systemComputer = "",
int  deleteFiles = 0 
)

This function registers a PVSS project in the System Configuration DB

Parameters:
projectName project name
host hostname
pmon_port pmon port
pmon_username pmon username
pmon_password pmon password
projectDir project directory
systemName system name
systemNumber system number
dataPortNr data port
eventPortNr event manager port
distPort distributed port
centrallyManaged flag indicating whether project is centrally or locally managed
pvssVersion version of PVSS
os operating system {Windows or Linux}
reduHost name of the host where the redundant peer runs
systemComputer name of the host where the pair DB and event manager runs
deleteFiles flag indicating whether component files are deleted after the deletion of a component
Returns:
0 if OK, -1 if errors
int fwInstallationDB_registerProjectFwComponents ( string  project = "",
string  hostname = "" 
)

This function registers all components installed in a project in the System Configuration DB

Parameters:
project project name
hostname hostname
Returns:
0 if OK, -1 if errors
int fwInstallationDB_registerProjectManager ( dyn_mixed  managerInfo,
string  project = "",
string  hostname = "" 
)

This function registers a manager in a project in the system configuration DB

Parameters:
managerInfo manager properties
project project name
hostname hostname
Returns:
0 if OK, -1 if errors
int fwInstallationDB_registerProjectManagers (  ) 

This function registers all managers of the local project in the System Configuration DB

Returns:
0 if OK, -1 if errors
int fwInstallationDB_registerProjectPaths (  ) 

This function registers all paths of the local project in the System Configuration DB

Returns:
0 if OK, -1 if errors
int fwInstallationDB_registerPvssBase ( string  host = "",
string  version = "",
string  os = "" 
)

This function registers a base PVSS version (i.e. a version of PVSS in a host) in the System Configuration DB

Parameters:
host hostname
version PVSS version name
os Operating System {WINDOWS, LINUX}
Returns:
0 if OK, -1 if errors
int fwInstallationDB_registerPvssManagerType ( dyn_mixed  managerTypeInfo  ) 

This function registers a manager type in the system configuration DB

Parameters:
managerTypeInfo Manager type properties as a dyn_mixed
Returns:
0 if OK, -1 if errors
int fwInstallationDB_registerPvssPatch ( string  patch,
string  version = "",
string  os = "" 
)

This function registers a PVSS patch in the System Configuration DB

Parameters:
patch patch name
version PVSS version name
os operating sytem type {WINDOWS, LINUX}
Returns:
0 if OK, -1 if errors
int fwInstallationDB_registerPvssSetup ( string  host = "",
string  version = "",
string  os = "",
dyn_string  patches = "" 
)

This function registers a PVSS setup (i.e. host + pvss base versio + list of patches) in the System Configuration DB

Parameters:
host hostname
version PVSS version
os operating system type
patches list of applied patches
Returns:
0 if OK, -1 if errors
int fwInstallationDB_registerPvssVersion ( string  version = "",
string  os = "" 
)

This function registers a PVSS version in the System Configuration DB

Parameters:
version PVSS version string, "" means the version of the local project
os Operating System, "" means the OS of the local project
Returns:
0 if OK, -1 if errors
int fwInstallationDB_registerReinstallation ( string  host,
string  project,
string  component,
string  version,
string  descFile,
int  restartProject,
int  overwriteFiles 
)

This function registers in the database a component for reinstallation in a project

Parameters:
host name of the host where the project runs
project name of the project where the compnent has to be reinstalled
component name of the component to be reinstalled
version version of the component
descFile Component description XML file
restartProject flag indicating whether the project has to be restarted after reinstallation
overwriteFiles flag indicating if the component files have to be restarted
Returns:
0 if OK, -1 if error
int fwInstallationDB_registerSystem ( dyn_mixed  systemProperties  ) 

This function registers a PVSS system in the System Configuration DB

Parameters:
systemProperties Information about the PVSS system as a dyn_mixed array
Returns:
0 if OK, -1 if errors
int fwInstallationDB_removeChildSystem ( string  systemName  ) 

This function removes a child from its parent in the system configuration DB

Parameters:
systemName Name of the child PVSS system to be removed
Returns:
0 if OK, -1 if errors
int fwInstallationDB_removeSystemConnection ( string  peer1Name,
string  peer2Name 
)

This function unregisters from the System Configuration DB the connection between two dist-peers

Parameters:
peer1Name Name of the first peer
peer2Name Name of the second peer
Returns:
0 if OK, -1 if errors
int fwInstallationDB_removeSystemHierarchy (  ) 

This function removes from the system configuration DB the system hierarchy tree

Returns:
0 if OK, -1 if errors
int fwInstallationDB_rollbackTransaction (  ) 

This function rolls back a DB transaction

Returns:
0 if OK, -1 if error
int fwInstallationDB_setCentrallyManaged ( int  centrallyManaged,
string  project = "",
string  hostname = "" 
)

This function sets the centrally managed property of a project in the System Configuration DB

Parameters:
centrallyManaged 1 if the project is centrally managed. 0 if locally managed
project project name
hostname hostname
Returns:
0 if OK, -1 if errors
int fwInstallationDB_setComponentProperties ( string  component,
string  version,
int  isSubComponent 
)

This function sets the isSubComonponent flag of a component in the system configuration DB

Parameters:
component name of the component
version version of the comoponent
isSubComponent 1 if the component is a subcomponent
Returns:
0 if OK, -1 if errors
int fwInstallationDB_setConnectionTimeout (  ) 

This function sets the idle DB connection timeout to the default value

Returns:
0 if OK, -1 if error
int fwInstallationDB_setHostProperties ( string  hostname,
dyn_mixed  hostInfo 
)

This function sets the properties of a host in the System Configuration DB

Parameters:
hostname Name of the host
hostInfo Host properties as a dyn_mixed array
Returns:
0 if OK, -1 if errors

int fwInstallationDB_setInitialized ( bool  value  ) 

This function sets the status of the DB connection initialization

Parameters:
value Initialization status
Returns:
0 if OK, -1 if error
int fwInstallationDB_setProjectProperties ( string  project,
string  hostname,
dyn_mixed  projectProperties 
)

This function sets the project properties in the system configuration DB

Parameters:
project project name
hostname hostname
projectProperties project properties as a dyn_mixed array
Returns:
0 if OK, -1 if errors
int fwInstallationDB_setPvssManagerProperties ( dyn_mixed  managerInfo,
string  project = "",
string  hostname = "" 
)

This function sets the properties of a manager in a project in the system configuration DB

Parameters:
managerInfo manager properties
project project name
hostname hostname
Returns:
0 if OK, -1 if errors
int fwInstallationDB_setSystemProperties ( dyn_mixed  systemProperties  ) 

This function sets the system properties in the system configuration DB

Parameters:
systemProperties PVSS system properties as a dyn_mixed array
Returns:
0 if OK, -1 if errors
int fwInstallationDB_setupConnection (  ) 

This function prompts the user to define the DB connection parameters

Returns:
0 if OK, -1 if error
int fwInstallationDB_setUseDB ( bool  useDB  ) 

This function sets the flag for the DB-agent of the installation tool to use System Configuration DB

Parameters:
useDB flag indicating whether the DB must be accessed or not
Returns:
0 if OK, -1 if errors
int fwInstallationDB_tableExists ( string  tableName,
bool &  tableExists 
)

This function checks if a DB table exists

Parameters:
tableName name of the table
tableExists true if the table exists, otherwise false
Returns:
0 if OK, -1 if error
int fwInstallationDB_unregisterCurrentProjectComponent ( string  component,
string  version,
string  project = "",
string  host = "" 
)

This function unregisters a component in a project from the System Configuration DB

Parameters:
component name of the component
version version of the component
project project name
host hostname
Returns:
0 if OK, -1 if errors
int fwInstallationDB_unregisterInstallationPath ( string  installationPath,
string  projectName = "",
string  computerName = "" 
)

This function unregisters a project path from the System Configuration DB

Parameters:
installationPath projec path to be unregistered
projectName project name
computerName hostname
Returns:
0 if OK, -1 if errors
int fwInstallationDB_unregisterPathMapping ( string  windowsPath,
string  linuxPath 
)

This function unregisters from the System Configuration DB a path mapping

Parameters:
windowsPath Windows path, e.g. P:
linuxPath Linux path, e.g. /afs/cern.ch
Returns:
0 if OK, -1 if errors
int fwInstallationDB_unregisterProjectReinstallation ( string  host,
string  project,
string  component,
string  version 
)

This function unregisters a particular component reinstallation for a given project

Parameters:
host name of the host where the project runs
project name of the project
component name of the component
version version of the component
Returns:
0 if OK, -1 if error
int fwInstallationDB_unregisterProjectReinstallations ( string  host,
string  project 
)

This function unregisters from the database all component reinstallations for a given project

Parameters:
host name of the host where the project runs
project name of the project
Returns:
0 if OK, -1 if error
int fwInstallationDB_unregisterSetupPvssPatch ( string  host,
string  version,
string  os,
string  patch 
)

This function unregisters a patch from a PVSS setup in the System Configuration DB

Parameters:
host hostname
version PVSS version name
os operating system type
patch patch name
Returns:
0 if OK, -1 if errors
int fwInstallationDB_viewExists ( string  viewName,
bool &  viewExists 
)

This function checks if a DB view exists

Parameters:
viewName name of the DB view
viewExists true if the view exists, otherwise false
Returns:
0 if OK, -1 if error

Variable Documentation

const string csFwInstallationDBLibVersion = "5.0.0"

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

 All Files Functions Variables