T4S4  18.1 C7177 A20283
Teamcenter Gateway for SAP S/4HANA API Reference
CONFIGURATION::MANAGER::ServerInstance Namespace Reference

Commands to edit the server instances configuration. More...

Functions

 addInstance InstanceConfiguration
 Adds a new server instance to the list of server instances. More...
 
 checkInstanceConfiguration InstanceConfiguration
 Checks if a instance configuration defines all required settings. More...
 
 disableProxy4Instance InstanceId ProxyName
 Disables a certain proxy for a certain server instance. More...
 
 enableProxy4Instance InstanceId ProxyName
 Enables a certain proxy for a certain server instance. More...
 
 getInstance InstanceId
 Returns the settings of a server instance. More...
 
 getInstanceList
 Returns a list of all configured server instances including their attributes. More...
 
 isInstalled InstanceId
 Checks if a certain server instance id and hence instance is already existing. More...
 
 removeInstance InstanceId
 Removes an existing server instance. More...
 
 setInstanceList ListOfInstanceConfigurations
 Sets a the list of server instances. Any existing list will be overwritten. More...
 
 setPortNumber InstanceId PortNumber
 Sets the port number of a certain server instance. More...
 
 updateInstance InstanceConfiguration
 Replaces or updates an existing server instance. More...
 

Detailed Description

Commands to edit the server instances configuration.

Function Documentation

◆ addInstance()

CONFIGURATION::MANAGER::ServerInstance::addInstance   InstanceConfiguration  

Adds a new server instance to the list of server instances.

Parameters
InstanceConfigurationlist containing all required settings (key value pairs) for the instance configuration
Returns
nothing
1 set myInstance [dict create IDSTR myInstance \
2  PORT 11330 \
3  IBIND ANY \
4  IPSTACK IP64 \
5  APPPROTO HTTP \
6  HTTPROOT "" \
7  FUNCTIONBIND {::PXML::dirinfo ::PXML::perfticker} \
8  CRYPTTYPE PLAIN \
9  SERVERCERT "" \
10  CLIENTCERT "" \
11  SSLTYPE "" \
12  SSLCIPHER "" \
13  HTTPBAUTH ON \
14 ]

References checkInstanceConfiguration(), getInstanceList(), isInstalled(), and setInstanceList().

◆ checkInstanceConfiguration()

CONFIGURATION::MANAGER::ServerInstance::checkInstanceConfiguration   InstanceConfiguration  

Checks if a instance configuration defines all required settings.

Parameters
InstanceConfigurationlist containing all required settings (key value pairs) for the instance configuration
Returns
raises an error if a key value pair is missing, otherwise nothing
1 set myIncompleteInstance [dict create IDSTR incompleteInstance PORT 11340]
3  puts "An error was raised: $::errorInfo"
4 }

Referenced by addInstance(), setInstanceList(), and updateInstance().

◆ disableProxy4Instance()

CONFIGURATION::MANAGER::ServerInstance::disableProxy4Instance   InstanceId ProxyName  

Disables a certain proxy for a certain server instance.

Parameters
InstanceIdID of the server instance the proxy should be disabled for
ProxyNameproxy name to be disabled
Returns
nothing

References getInstance(), and updateInstance().

◆ enableProxy4Instance()

CONFIGURATION::MANAGER::ServerInstance::enableProxy4Instance   InstanceId ProxyName  

Enables a certain proxy for a certain server instance.

Parameters
InstanceIdID of the server instance the proxy should be enabled for
ProxyNameproxy name to be enabled
Returns
nothing

References getInstance(), and updateInstance().

◆ getInstance()

CONFIGURATION::MANAGER::ServerInstance::getInstance   InstanceId  

Returns the settings of a server instance.

Parameters
InstanceIdID of the instance to be received
Returns
list of settings for the given server instance
1 foreach {key value} [::CONFIGURATION::MANAGER::ServerInstance::getInstance APPS_SSL] {
2  puts "$key is set to $value"
3 }

References getInstanceList().

Referenced by disableProxy4Instance(), enableProxy4Instance(), setPortNumber(), and updateInstance().

◆ getInstanceList()

CONFIGURATION::MANAGER::ServerInstance::getInstanceList

Returns a list of all configured server instances including their attributes.

Parameters
none
Returns
list of server instances
2  puts "instance ID and port: [dict get $instance IDSTR] [dict get $instance PORT]"
3 }

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

Referenced by addInstance(), getInstance(), isInstalled(), removeInstance(), and updateInstance().

◆ isInstalled()

CONFIGURATION::MANAGER::ServerInstance::isInstalled   InstanceId  

Checks if a certain server instance id and hence instance is already existing.

Parameters
InstanceIdID of the server instance to be checked
Returns
true if it is already existing, false otherwise
2  puts "Admin UI server instance is missing!"
3 }

References getInstanceList().

Referenced by addInstance(), removeInstance(), and updateInstance().

◆ removeInstance()

CONFIGURATION::MANAGER::ServerInstance::removeInstance   InstanceId  

Removes an existing server instance.

Parameters
InstanceIdID of the server instance to be removed
Returns
nothing

References getInstanceList(), isInstalled(), and setInstanceList().

◆ setInstanceList()

CONFIGURATION::MANAGER::ServerInstance::setInstanceList   ListOfInstanceConfigurations  

Sets a the list of server instances. Any existing list will be overwritten.

Parameters
ListOfInstanceConfigurationslist containing all required settings (key value pairs) for the instance configuration
Returns
nothing
2 set myInstance [dict create IDSTR myInstance \
3  PORT 11330 \
4  IBIND ANY \
5  IPSTACK IP64 \
6  APPPROTO HTTP \
7  HTTPROOT "" \
8  FUNCTIONBIND {::PXML::dirinfo ::PXML::perfticker} \
9  CRYPTTYPE PLAIN \
10  SERVERCERT "" \
11  CLIENTCERT "" \
12  SSLTYPE "" \
13  SSLCIPHER "" \
14  HTTPBAUTH ON \
15 ]
16 set extendedInstances [lappend existingInstances $myInstance]

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

Referenced by addInstance(), removeInstance(), and updateInstance().

◆ setPortNumber()

CONFIGURATION::MANAGER::ServerInstance::setPortNumber   InstanceId PortNumber  

Sets the port number of a certain server instance.

Parameters
InstanceIdID of the server instance to be edited
PortNumbernew port number for this server instance
Returns
nothing

References getInstance(), and updateInstance().

◆ updateInstance()

CONFIGURATION::MANAGER::ServerInstance::updateInstance   InstanceConfiguration  

Replaces or updates an existing server instance.

Parameters
InstanceConfigurationlist containing all required settings (key value pairs) for the instance configuration
Returns
nothing
1 set myUpdatedInstance [dict create IDSTR myInstance \
2  PORT 11330 \
3  IBIND ANY \
4  IPSTACK IP64 \
5  APPPROTO HTTP \
6  HTTPROOT "" \
7  FUNCTIONBIND {::PXML::dirinfo ::PXML::perfticker} \
8  CRYPTTYPE SSL \
9  SERVERCERT "C:/my/path/to/cert.pem" \
10  CLIENTCERT "" \
11  SSLTYPE TLSv1 \
12  SSLCIPHER "AES256-SHA" \
13  HTTPBAUTH ON \
14 ]

References checkInstanceConfiguration(), getInstance(), getInstanceList(), isInstalled(), and setInstanceList().

Referenced by disableProxy4Instance(), enableProxy4Instance(), and setPortNumber().