![]() |
T4S4
18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API 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... | |
Commands to edit the server instances configuration.
CONFIGURATION::MANAGER::ServerInstance::addInstance | InstanceConfiguration | ||
Adds a new server instance to the list of server instances.
InstanceConfiguration | list containing all required settings (key value pairs) for the instance configuration |
References checkInstanceConfiguration(), getInstanceList(), isInstalled(), and setInstanceList().
CONFIGURATION::MANAGER::ServerInstance::checkInstanceConfiguration | InstanceConfiguration | ||
Checks if a instance configuration defines all required settings.
InstanceConfiguration | list containing all required settings (key value pairs) for the instance configuration |
Referenced by addInstance(), setInstanceList(), and updateInstance().
CONFIGURATION::MANAGER::ServerInstance::disableProxy4Instance | InstanceId ProxyName | ||
Disables a certain proxy for a certain server instance.
InstanceId | ID of the server instance the proxy should be disabled for |
ProxyName | proxy name to be disabled |
References getInstance(), and updateInstance().
CONFIGURATION::MANAGER::ServerInstance::enableProxy4Instance | InstanceId ProxyName | ||
Enables a certain proxy for a certain server instance.
InstanceId | ID of the server instance the proxy should be enabled for |
ProxyName | proxy name to be enabled |
References getInstance(), and updateInstance().
CONFIGURATION::MANAGER::ServerInstance::getInstance | InstanceId | ||
Returns the settings of a server instance.
InstanceId | ID of the instance to be received |
References getInstanceList().
Referenced by disableProxy4Instance(), enableProxy4Instance(), setPortNumber(), and updateInstance().
CONFIGURATION::MANAGER::ServerInstance::getInstanceList |
Returns a list of all configured server instances including their attributes.
none |
References CONFIGURATION::MANAGER::Util::getConfigKey().
Referenced by addInstance(), getInstance(), isInstalled(), removeInstance(), and updateInstance().
CONFIGURATION::MANAGER::ServerInstance::isInstalled | InstanceId | ||
Checks if a certain server instance id and hence instance is already existing.
InstanceId | ID of the server instance to be checked |
References getInstanceList().
Referenced by addInstance(), removeInstance(), and updateInstance().
CONFIGURATION::MANAGER::ServerInstance::removeInstance | InstanceId | ||
Removes an existing server instance.
InstanceId | ID of the server instance to be removed |
References getInstanceList(), isInstalled(), and setInstanceList().
CONFIGURATION::MANAGER::ServerInstance::setInstanceList | ListOfInstanceConfigurations | ||
Sets a the list of server instances. Any existing list will be overwritten.
ListOfInstanceConfigurations | list containing all required settings (key value pairs) for the instance configuration |
References checkInstanceConfiguration(), and CONFIGURATION::MANAGER::Util::setConfigKey().
Referenced by addInstance(), removeInstance(), and updateInstance().
CONFIGURATION::MANAGER::ServerInstance::setPortNumber | InstanceId PortNumber | ||
Sets the port number of a certain server instance.
InstanceId | ID of the server instance to be edited |
PortNumber | new port number for this server instance |
References getInstance(), and updateInstance().
CONFIGURATION::MANAGER::ServerInstance::updateInstance | InstanceConfiguration | ||
Replaces or updates an existing server instance.
InstanceConfiguration | list containing all required settings (key value pairs) for the instance configuration |
References checkInstanceConfiguration(), getInstance(), getInstanceList(), isInstalled(), and setInstanceList().
Referenced by disableProxy4Instance(), enableProxy4Instance(), and setPortNumber().