T4S4  18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
CONFIGURATION::MANAGER::LicenseServer Namespace 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...
 

Detailed Description

Commands to edit the license servers configuration of a BGS.

Function Documentation

◆ addServer()

CONFIGURATION::MANAGER::LicenseServer::addServer   ServerConfiguration  

Adds a new configuration to the list of license servers.

Parameters
ServerConfigurationcomplete new license server configuration dict
Returns
nothing
1 set newServer [dict create SERVER "another.license.address" PORT 28000]

References getServerList(), and setServerList().

◆ checkServerConfiguration()

CONFIGURATION::MANAGER::LicenseServer::checkServerConfiguration   ServerConfiguration  

Checks if the license server configuration provides all required keys.

Parameters
ServerConfigurationlicense server configuration dict to check
Returns
nothing or an error if a key is missing

Referenced by setServerList().

◆ getHost()

CONFIGURATION::MANAGER::LicenseServer::getHost   ServerIndex  

Returns the host name of a license server in the BGS configuration.

Parameters
ServerIndexindex (starting with 0) of the requested license server in the list
Returns
host name of the license server configured at the given index

References getServer(), and validateServerIndex().

Referenced by getHostName().

◆ getHostName()

CONFIGURATION::MANAGER::LicenseServer::getHostName

Returns the host name of the license server in the BGS configuration.

Deprecated:
Use CONFIGURATION::MANAGER::LicenseServer::getHost instead. This function returns the host name of the first entry in the license server list.
Returns
host name of the license server

References getHost().

◆ getPort()

CONFIGURATION::MANAGER::LicenseServer::getPort   ServerIndex  

Returns the port number of a license server in the BGS configuration.

Parameters
ServerIndexindex (starting with 0) of the requested license server in the list
Returns
port number of the license server

References getServer(), and validateServerIndex().

Referenced by getPortNumber().

◆ getPortNumber()

CONFIGURATION::MANAGER::LicenseServer::getPortNumber

Returns the port number of the license server in the BGS configuration.

Deprecated:
Use CONFIGURATION::MANAGER::LicenseServer::getPort instead. This function returns the port of the first entry in the license server list.
Returns
port number of the license server

References getPort().

◆ getServer()

CONFIGURATION::MANAGER::LicenseServer::getServer   ServerIndex  

Returns the configuration a license server.

Parameters
ServerIndexindex (starting with 0) of the requested license server in the list
Returns
configuration dict of this license server

References getServerList(), and validateServerIndex().

Referenced by getHost(), getPort(), setHost(), and setPort().

◆ getServerList()

CONFIGURATION::MANAGER::LicenseServer::getServerList

Returns the list of license servers configured.

Returns
list of license server configurations

References CONFIGURATION::MANAGER::Util::getConfigKey().

Referenced by addServer(), getServer(), removeServer(), updateServer(), and validateServerIndex().

◆ isUsingFailoverMode()

CONFIGURATION::MANAGER::LicenseServer::isUsingFailoverMode

Returns information whether failover or multiple license server mode is used.

Returns
true if failover mode is used, false if multiple license server mode is used

References CONFIGURATION::MANAGER::Util::getConfigKey().

◆ removeServer()

CONFIGURATION::MANAGER::LicenseServer::removeServer   ServerIndex  

Removes a license server configuration from the list.

Parameters
ServerIndexindex (starting with 0) of the license server to be removed
Returns
nothing

References getServerList(), setServerList(), and validateServerIndex().

◆ setHost()

CONFIGURATION::MANAGER::LicenseServer::setHost   ServerIndex HostName  

Sets the host name of a license server in the BGS configuration.

Parameters
ServerIndexindex (starting with 0) of the license server being edited in the list
HostNamenew host name of the license server
Returns
nothing

References getServer(), updateServer(), and validateServerIndex().

Referenced by setHostName().

◆ setHostName()

CONFIGURATION::MANAGER::LicenseServer::setHostName   HostName  

Sets the host name of the license server in the BGS configuration.

Deprecated:
Use CONFIGURATION::MANAGER::LicenseServer::setHost instead. This function sets the host name of the first entry in the license server list.
Parameters
HostNamehost name of the license server
Returns
nothing

References rcwd(), and setHost().

◆ setPort()

CONFIGURATION::MANAGER::LicenseServer::setPort   ServerIndex PortNumber  

Sets the port number of a license server in the BGS configuration.

Parameters
ServerIndexindex (starting with 0) of the license server being edited in the list
PortNumbernew port number of the license server
Returns
nothing

References getServer(), updateServer(), and validateServerIndex().

Referenced by setPortNumber().

◆ setPortNumber()

CONFIGURATION::MANAGER::LicenseServer::setPortNumber   PortNumber  

Sets the port number of the license server in the BGS configuration.

Deprecated:
Use CONFIGURATION::MANAGER::LicenseServer::setPort instead. This function sets the port of the first entry in the license server list.
Parameters
PortNumberport number of the license server
Returns
nothing

References rcwd(), and setPort().

◆ setServerList()

CONFIGURATION::MANAGER::LicenseServer::setServerList   ListOfServerConfigurations  

Sets the list of configured license servers.

Parameters
ListOfServerConfigurationslist of license server configuration dicts
Returns
nothing
1 set server1 [dict create SERVER "first.license.address" PORT 28000]
2 set server2 [dict create SERVER "second.license.address" PORT 29000]
3 set myList [list $server1 $server2]

References checkServerConfiguration(), and CONFIGURATION::MANAGER::Util::setConfigKey().

Referenced by addServer(), removeServer(), and updateServer().

◆ updateServer()

CONFIGURATION::MANAGER::LicenseServer::updateServer   ServerIndex ServerConfiguration  

Updates the configuration a license server with new data.

Parameters
ServerIndexindex (starting with 0) of the license server to be edited
ServerConfigurationcomplete new configuration dict of this server
Returns
nothing
1 set newServer [dict create SERVER "another.license.address" PORT 28000]

References getServerList(), setServerList(), and validateServerIndex().

Referenced by setHost(), and setPort().

◆ useFailoverMode()

CONFIGURATION::MANAGER::LicenseServer::useFailoverMode   activateFailoverMode  

Turns the failover mode for license servers on or off.

Parameters
activateFailoverModetrue to activate the failover mode, false to use the multiple license servers mode
Returns
nothing
1 set server [dict create SERVER "first.license.address" PORT 28000]
2 set backup1 [dict create SERVER "second.license.address" PORT 29000]
3 set backup2 [dict create SERVER "third.license.address" PORT 28000]
4 set myTriadeList [list $server $backup1 $backup2]

References CONFIGURATION::MANAGER::Util::setConfigKey().

◆ validateServerIndex()

CONFIGURATION::MANAGER::LicenseServer::validateServerIndex   ServerIndex  

Checks if the provided index is valid.

Parameters
ServerIndexindex number to check
Returns
nothing in case of a valid index number, otherwise an error will be raised

References getServerList().

Referenced by getHost(), getPort(), getServer(), removeServer(), setHost(), setPort(), and updateServer().