Visit Platform at http://www.platform.com

Main Page   Modules   Alphabetical List   Compound List   File List   Compound Members   File Members  

Soam Admin API


Functions

int soam__sdAuthenticate (struct soam__sdAuthenticateResponse &resp)
 For internal use only.

int soam__sdRegisterApp (xsd__boolean force, struct xsd__base64Binary *appProfile, struct soam__sdRegisterAppResponse &resp)
 Register a new application or update an existing one.

int soam__sdRegisterAppUpdate (xsd__boolean force, xsd__boolean stopWorkload, xsd__boolean fragment, struct xsd__base64Binary *appProfile, struct soam__sdRegisterAppResponse &resp)
 For internal use only.

int soam__sdUpdatePackage (struct soam__AppNameVector *appNameList, char *packageName, char *consumerId, xsd__boolean workload, int ssmTimeout, struct soam__sdUpdatePackageResponse &resp)
 For internal use only.

int soam__sdUnregisterApp (char *appName, xsd__boolean saveHist, struct soam__sdUnregisterAppResponse &resp)
 Unregister an existing application.

int soam__sdEnableApp (char *appName, struct soam__sdEnableAppResponse &resp)
 Enable an existing application.

int soam__sdDisableApp (char *appName, xsd__boolean saveWorkload, struct soam__sdDisableAppResponse &resp)
 Disable an existing application.

int soam__sdViewApp (char *appName, char *consumerId, char *filter, xsd__boolean detail, struct soam__sdViewAppResponse &resp)
 Get details of registered applications.

int soam__sdViewAllApp (char *consumerId, char *filter, struct soam__sdViewAllAppResponse &resp)
 For internal use only.

int soam__sdViewSession (char *appName, soam__SessionID sessionId, char *filter, int maxCap, struct soam__sdViewSessionResponse &resp)
 Get detailed information about sessions.

int soam__sdModSession (char *appName, soam__SessionID sessionId, char *filter, char *modStr, struct soam__sdModSessionResponse &resp)
 Modify the attributes of a session or a group of sessions.

int soam__sdTerminateSession (char *appName, soam__SessionID sessionId, char *comment, char *filter, struct soam__sdTerminateSessionResponse &resp)
 Terminate a session or a group of sessions.

int soam__sdStopSession (char *appName, soam__SessionID sessionId, char *comment, char *filter, struct soam__sdStopSessionResponse &resp)
 Suspend a session or a group of sessions.

int soam__sdResumeSession (char *appName, soam__SessionID sessionId, char *comment, char *filter, struct soam__sdResumeSessionResponse &resp)
 Resume a suspended session or a group of sessions.

int soam__sdViewTask (char *appName, soam__SessionID sessionId, soam__TaskID taskId, char *filter, int maxCap, struct soam__sdViewTaskResponse &resp)
 Get detailed information about tasks.

int soam__sdTerminateTask (char *appName, soam__SessionID sessionId, struct soam__TaskIDVector *taskIdList, char *comment, char *filter, struct soam__sdTerminateTaskResponse &resp)
 Terminate a task or a group of tasks.

int soam__sdShutDown (xsd__boolean force, char *consumer, char *filter, struct soam__sdShutDownResponse &resp)
 For internal use only.

int soam__sdSetLogLevel (char *appName, char *loggerName, int logLevel, struct soam__sdSetLogLevelResponse &resp)
 Dynamicaly change the logging level of the Symphony components.

int soam__sdQueryApp (struct xsd__base64Binary *appProfile, char *xmlQuery, struct soam__sdQueryAppResponse &resp)
 For internal use only.

int soam__sdUpdateApp (struct xsd__base64Binary *appProfile, char *xmlQuery, char *newValue, struct soam__sdUpdateAppResponse &resp)
 For internal use only.

int soam__sdReregisterApp (struct soam__AppNameVector *appNameList, struct soam__sdReregisterAppResponse &resp)
 For internal use only.


Detailed Description

List of the Soam Admin Operations

Function Documentation

int soam__sdAuthenticate struct soam__sdAuthenticateResponse   resp
 

For internal use only.

int soam__sdDisableApp char *    appName,
xsd__boolean    saveWorkload,
struct soam__sdDisableAppResponse   resp
 

Disable an existing application.

Parameters:
appName  [IN] -- The name of the application to be disabled
saveWorkload  [IN] -- A flag indicating whether the outstanding workload (sessions and tasks) will be persisted or not to be continued when the application is enabled again
Returns:
an error if the application doesn't exist or it cannot be disabled.

int soam__sdEnableApp char *    appName,
struct soam__sdEnableAppResponse   resp
 

Enable an existing application.

Parameters:
appName  [IN] -- The name of the application to be enabled
Returns:
an error if the application doesn't exist or it cannot be enabled.

int soam__sdModSession char *    appName,
soam__SessionID    sessionId,
char *    filter,
char *    modStr,
struct soam__sdModSessionResponse   resp
 

Modify the attributes of a session or a group of sessions.

Parameters:
appName  [IN] -- The name of the application. It is required to identify the session to be modified.
sessionId  [IN] -- If specified, sdModSession will modify the specified session.
filter  [IN] -- If specified, sdModSession will modify all the sessions with the state or the session tag specified in the filter.
The format of the filter is: sessionTag="session tag" or state="state name" <AND/OR state="state name"> . The "state name" can be "open", "closed", "suspended", "aborted"
modStr  [IN] -- Modification string can be priority=value or sessionTag="value"
Returns:
An error if the specified sessions cannot be modified as requested.
Please not that the call will not return an error if there are no sessions matching the criteria provided in the filter There is no checking for validity of the parameter names in the filter. Non-existing parameters will be ignored.

int soam__sdQueryApp struct xsd__base64Binary   appProfile,
char *    xmlQuery,
struct soam__sdQueryAppResponse   resp
 

For internal use only.

int soam__sdRegisterApp xsd__boolean    force,
struct xsd__base64Binary   appProfile,
struct soam__sdRegisterAppResponse   resp
 

Register a new application or update an existing one.

Parameters:
force  [IN] -- A flag indicating whether an existing application with the same name should be replaced with the new one or not If not specified the default value used is false
appProfile  [IN] -- The application profile of the application to be registered
Returns:
an error if registration fails.

int soam__sdRegisterAppUpdate xsd__boolean    force,
xsd__boolean    stopWorkload,
xsd__boolean    fragment,
struct xsd__base64Binary   appProfile,
struct soam__sdRegisterAppResponse   resp
 

For internal use only.

int soam__sdReregisterApp struct soam__AppNameVector   appNameList,
struct soam__sdReregisterAppResponse   resp
 

For internal use only.

int soam__sdResumeSession char *    appName,
soam__SessionID    sessionId,
char *    comment,
char *    filter,
struct soam__sdResumeSessionResponse   resp
 

Resume a suspended session or a group of sessions.

Parameters:
appName  [IN] -- The name of the application. It is required to identify the session to be resumed.
sessionId  [IN] -- If specified, sdResumeSession will resume the specified session.
filter  [IN] -- If specified, sdResumeSession will resume all the sessions with the session tag specified in the filter.
The format of the filter is: sessionTag="session tag"
comment  [IN] -- a string to be saved in the session attribute as a comment related to this operation
Returns:
An error if the specified sessions cannot be resumed.
Please not that the call will not return an error if there are no sessions matching the criteria provided in the filter.
There is no checking for validity of the parameter names in the filter. Non-existing parameters will be ignored.

int soam__sdSetLogLevel char *    appName,
char *    loggerName,
int    logLevel,
struct soam__sdSetLogLevelResponse   resp
 

Dynamicaly change the logging level of the Symphony components.

Parameters:
appName  [IN] -- The name of the application
loggerName  [IN] -- One of the following strings:
workload - Change log level for sessions and tasks
sd_all - Change log level for Session Director
ssm_all - Change log level for Session Manager
sim_all - Change log level for Service Instance Manager
log4j_logger - Logger class as defined in xxx.log4j.properties file. For example, for SSM, ssm.log4j.properties.
logLevel  [IN] -- Can be one of the following values:
7 - LOG_ALL
5 - LOG_DEBUG
3 - LOG_INFO
2 - LOG_WARN
1 - LOG_ERROR
0 - LOG_FATAL
Returns:
an error if an invalid logger name or log level is provided.

int soam__sdShutDown xsd__boolean    force,
char *    consumer,
char *    filter,
struct soam__sdShutDownResponse   resp
 

For internal use only.

int soam__sdStopSession char *    appName,
soam__SessionID    sessionId,
char *    comment,
char *    filter,
struct soam__sdStopSessionResponse   resp
 

Suspend a session or a group of sessions.

Parameters:
appName  [IN] -- The name of the application. It is required to identify the session to be suspended.
sessionId  [IN] -- If specified, sdStopSession will suspend the specified session.
filter  [IN] -- If specified, sdStopSession will suspend all the sessions with the session tag specified in the filter.
The format of the filter is: sessionTag="session tag"
comment  [IN] -- a string to be saved in the session attribute as a comment related to this operation
Returns:
Anerror if the specified sessions cannot be suspended.
Please not that the call will not return an error if there are no sessions matching the criteria provided in the filter There is no checking for validity of the parameter names in the filter. Non-existing parameters will be ignored.

int soam__sdTerminateSession char *    appName,
soam__SessionID    sessionId,
char *    comment,
char *    filter,
struct soam__sdTerminateSessionResponse   resp
 

Terminate a session or a group of sessions.

Parameters:
appName  [IN] -- The name of the application. It is required to identify the session to be terminated.
sessionId  [IN] -- If specified, sdTerminateSession will terminate the specified session.
filter  [IN] -- If specified, sdTerminateSession will terminate all the sessions with the session tag specified in the filter.
The format of the filter is: sessionTag="session tag"
comment  [IN] -- a string to be saved in the session attribute as a comment related to this operation
Returns:
An error if the specified sessions cannot be terminated.
Please not that the call will not return an error if there are no sessions matching the criteria provided in the filter There is no checking for validity of the parameter names in the filter. Non-existing parameters will be ignored.

int soam__sdTerminateTask char *    appName,
soam__SessionID    sessionId,
struct soam__TaskIDVector   taskIdList,
char *    comment,
char *    filter,
struct soam__sdTerminateTaskResponse   resp
 

Terminate a task or a group of tasks.

Parameters:
appName  [IN] -- The name of the application. It is required to identify the task to be terminated.
sessionId  [IN] -- The ID of the session. It is required to identify the task to be terminated.
taskIdList  [IN] -- If specified, sdTerminateTask will terminate the specified tasks.
filter  [IN] -- If specified, sdTerminateTask will terminate all the tasks with the task tag sepcified in the fileter.
The format of the filter is: taskTag="task tag"
comment  [IN] -- a string to be saved in the task attribute as a comment related to this operation
Returns:
An error if the specified tasks cannot be terminated.
Please not that the call will not return an error if there are no tasks matching the criteria provided in the filter There is no checking for validity of the parameter names in the fileter. Non-existing parameters will be ignored.

int soam__sdUnregisterApp char *    appName,
xsd__boolean    saveHist,
struct soam__sdUnregisterAppResponse   resp
 

Unregister an existing application.

Parameters:
appName  [IN] -- The name of the application to be removed from Symphony
saveHist  [IN] -- A flag indicating whether the system should preserve or not the history of the removed application
Returns:
an error if the application doesn't exist or it cannot be removed.

int soam__sdUpdateApp struct xsd__base64Binary   appProfile,
char *    xmlQuery,
char *    newValue,
struct soam__sdUpdateAppResponse   resp
 

For internal use only.

int soam__sdUpdatePackage struct soam__AppNameVector   appNameList,
char *    packageName,
char *    consumerId,
xsd__boolean    workload,
int    ssmTimeout,
struct soam__sdUpdatePackageResponse   resp
 

For internal use only.

int soam__sdViewAllApp char *    consumerId,
char *    filter,
struct soam__sdViewAllAppResponse   resp
 

For internal use only.

int soam__sdViewApp char *    appName,
char *    consumerId,
char *    filter,
xsd__boolean    detail,
struct soam__sdViewAppResponse   resp
 

Get details of registered applications.

Parameters:
appName  [IN] -- The name of the application.
If not specified sdViewApp will return a list of all registered applications without detailed information.
If specified sdViewApp will return detailed information about the specified application.
consumerId  [IN] -- If specified, sdViewApp will return the list of applications registered for the specified consumer.
filter  [IN] -- If specified, sdViewApp returns the list of applications in the state specified in the filter.
The format of the filter is: state="state name" <OR state="state name"> . The "state name" can be "enabled" or "disabled"
Returns:
an error if provided a wrong appName or consumerId. Please not that the call will not return an error if there are no tasks matching the criteria provided in the filter. The returned list will be empty.
There is no checking for validity of the parameter names in the filter. Non-existing parameters will be ignored.

int soam__sdViewSession char *    appName,
soam__SessionID    sessionId,
char *    filter,
int    maxCap,
struct soam__sdViewSessionResponse   resp
 

Get detailed information about sessions.

Parameters:
appName  [IN] -- The name of the application. It is a mandatory parameter, sdViewSession will return detailed information of sessions on the specified application.
sessionId  [IN] -- If specified, sdViewSession will return the detailed information of the specified session.
filter  [IN] -- If specified, sdViewSession returns the list of sessions with the state or the tag specified in the filter.
The format of the filter is: sessionTag="session tag" or state="state name" <AND/OR state="state name"> . The "state name" can be "open", "closed", "suspended", "aborted"
maxCap  [IN] -- the maximum number of sessions to be returned in the list
Returns:
an error if provided an invalid appName or sessionId. Please not that the call will not return an error if there are no tasks matching the criteria provided in the filter. The returned list will be empty.
There is no checking for validity of the parameter names in the filter. Non-existing parameters will be ignored.

int soam__sdViewTask char *    appName,
soam__SessionID    sessionId,
soam__TaskID    taskId,
char *    filter,
int    maxCap,
struct soam__sdViewTaskResponse   resp
 

Get detailed information about tasks.

Parameters:
appName  [IN] -- The name of the application. It is a mandatory parameter, sdViewTask will return detailed information of tasks on the specified application.
sessionId  [IN] -- The session id. It is mandatory, sdViewTask will return the detailed information of the tasks in the specified session.
taskId  [IN] -- If specified, sdViewTask will return the detailed information of the specified task.
filter  [IN] -- If specified, sdViewTask returns the list of tasks with the state or the tag specified in the filter.
The format of the filter is: taskTag="session tag" or state="state name" <AND/OR state="state name"> . The "state name" can be "pending", "running", "done", "error", "canceled"
maxCap  [IN] -- the maximum number of sessions to be returned in the list
Returns:
an error if there are no tasks specified by the appName, sessionId and taskId. Please not that the call will not return an error if there are no tasks matching the criteria provided in the filter.
There is no checking for validity of the parameter names in the filter. Non-existing parameters will be ignored.


     
Date Modified: 3 Nov 2008
Platform Support: support@platform.com
Platform Information Development: doc@platform.com

Platform Computing. Accelerating Intelligence(TM).
Copyright © 2001-2008 Platform Computing Corporation. All rights reserved.