![]() |
T4S4
18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
|
Commands to edit the license servers configuration of a BGS. More...
Functions | |
addServer ServerConfiguration | |
Adds a new configuration to the list of license servers. More... | |
checkServerConfiguration ServerConfiguration | |
Checks if the license server configuration provides all required keys. More... | |
getHost ServerIndex | |
Returns the host name of a license server in the BGS configuration. More... | |
getHostName | |
Returns the host name of the license server in the BGS configuration. More... | |
getPort ServerIndex | |
Returns the port number of a license server in the BGS configuration. More... | |
getPortNumber | |
Returns the port number of the license server in the BGS configuration. More... | |
getServer ServerIndex | |
Returns the configuration a license server. More... | |
getServerList | |
Returns the list of license servers configured. More... | |
isUsingFailoverMode | |
Returns information whether failover or multiple license server mode is used. More... | |
removeServer ServerIndex | |
Removes a license server configuration from the list. More... | |
setHost ServerIndex HostName | |
Sets the host name of a license server in the BGS configuration. More... | |
setHostName HostName | |
Sets the host name of the license server in the BGS configuration. More... | |
setPort ServerIndex PortNumber | |
Sets the port number of a license server in the BGS configuration. More... | |
setPortNumber PortNumber | |
Sets the port number of the license server in the BGS configuration. More... | |
setServerList ListOfServerConfigurations | |
Sets the list of configured license servers. More... | |
updateServer ServerIndex ServerConfiguration | |
Updates the configuration a license server with new data. More... | |
useFailoverMode activateFailoverMode | |
Turns the failover mode for license servers on or off. More... | |
validateServerIndex ServerIndex | |
Checks if the provided index is valid. More... | |
Commands to edit the license servers configuration of a BGS.
CONFIGURATION::MANAGER::LicenseServer::addServer | ServerConfiguration | ||
Adds a new configuration to the list of license servers.
ServerConfiguration | complete new license server configuration dict |
References getServerList(), and setServerList().
CONFIGURATION::MANAGER::LicenseServer::checkServerConfiguration | ServerConfiguration | ||
Checks if the license server configuration provides all required keys.
ServerConfiguration | license server configuration dict to check |
Referenced by setServerList().
CONFIGURATION::MANAGER::LicenseServer::getHost | ServerIndex | ||
Returns the host name of a license server in the BGS configuration.
ServerIndex | index (starting with 0) of the requested license server in the list |
References getServer(), and validateServerIndex().
Referenced by getHostName().
CONFIGURATION::MANAGER::LicenseServer::getHostName |
Returns the host name of the license server in the BGS configuration.
References getHost().
CONFIGURATION::MANAGER::LicenseServer::getPort | ServerIndex | ||
Returns the port number of a license server in the BGS configuration.
ServerIndex | index (starting with 0) of the requested license server in the list |
References getServer(), and validateServerIndex().
Referenced by getPortNumber().
CONFIGURATION::MANAGER::LicenseServer::getPortNumber |
Returns the port number of the license server in the BGS configuration.
References getPort().
CONFIGURATION::MANAGER::LicenseServer::getServer | ServerIndex | ||
Returns the configuration a license server.
ServerIndex | index (starting with 0) of the requested license server in the list |
References getServerList(), and validateServerIndex().
Referenced by getHost(), getPort(), setHost(), and setPort().
CONFIGURATION::MANAGER::LicenseServer::getServerList |
Returns the list of license servers configured.
References CONFIGURATION::MANAGER::Util::getConfigKey().
Referenced by addServer(), getServer(), removeServer(), updateServer(), and validateServerIndex().
CONFIGURATION::MANAGER::LicenseServer::isUsingFailoverMode |
Returns information whether failover or multiple license server mode is used.
References CONFIGURATION::MANAGER::Util::getConfigKey().
CONFIGURATION::MANAGER::LicenseServer::removeServer | ServerIndex | ||
Removes a license server configuration from the list.
ServerIndex | index (starting with 0) of the license server to be removed |
References getServerList(), setServerList(), and validateServerIndex().
CONFIGURATION::MANAGER::LicenseServer::setHost | ServerIndex HostName | ||
Sets the host name of a license server in the BGS configuration.
ServerIndex | index (starting with 0) of the license server being edited in the list |
HostName | new host name of the license server |
References getServer(), updateServer(), and validateServerIndex().
Referenced by setHostName().
CONFIGURATION::MANAGER::LicenseServer::setHostName | HostName | ||
Sets the host name of the license server in the BGS configuration.
HostName | host name of the license server |
CONFIGURATION::MANAGER::LicenseServer::setPort | ServerIndex PortNumber | ||
Sets the port number of a license server in the BGS configuration.
ServerIndex | index (starting with 0) of the license server being edited in the list |
PortNumber | new port number of the license server |
References getServer(), updateServer(), and validateServerIndex().
Referenced by setPortNumber().
CONFIGURATION::MANAGER::LicenseServer::setPortNumber | PortNumber | ||
Sets the port number of the license server in the BGS configuration.
PortNumber | port number of the license server |
CONFIGURATION::MANAGER::LicenseServer::setServerList | ListOfServerConfigurations | ||
Sets the list of configured license servers.
ListOfServerConfigurations | list of license server configuration dicts |
References checkServerConfiguration(), and CONFIGURATION::MANAGER::Util::setConfigKey().
Referenced by addServer(), removeServer(), and updateServer().
CONFIGURATION::MANAGER::LicenseServer::updateServer | ServerIndex ServerConfiguration | ||
Updates the configuration a license server with new data.
ServerIndex | index (starting with 0) of the license server to be edited |
ServerConfiguration | complete new configuration dict of this server |
References getServerList(), setServerList(), and validateServerIndex().
CONFIGURATION::MANAGER::LicenseServer::useFailoverMode | activateFailoverMode | ||
Turns the failover mode for license servers on or off.
activateFailoverMode | true to activate the failover mode, false to use the multiple license servers mode |
References CONFIGURATION::MANAGER::Util::setConfigKey().
CONFIGURATION::MANAGER::LicenseServer::validateServerIndex | ServerIndex | ||
Checks if the provided index is valid.
ServerIndex | index number to check |
References getServerList().
Referenced by getHost(), getPort(), getServer(), removeServer(), setHost(), setPort(), and updateServer().