TeamcenterKnowledge

Maintenance utilities > Dispatcher

dispatcher_util

Allows you to list, delete or resubmit dispatcher requests. You must have permissions to manage dispatcher requests. For more information, see Create a dispatcher client access rule. The Dispatcher-client-proxy-user used by Dispatcher Client has all the permissions required to manage dispatcher requests. Syntax dispatcher_util [-u=user-id {-p=password | -pf=password-file} -g=group] -a=list | delete | resubmit [-force] [-export=file:file path] [-taskid=dispatcher task ID | file:file path] [-provider=provider name] [-service=service name] [-priority=priority number] [-state=dispatcher state] [-h] Arguments -u Specifies the user ID. This is generally a user with administration privileges. Note If Security Services single sign-on (SSO) is enabled for your server, the -u and -p arguments are authenticated externally through SSO rather than being authenticated against the Teamcenter database. If you do not supply these arguments, the utility attempts to join an existing SSO session. If no session is found, you are prompted to enter a user ID and password. -p Specifies the password. This argument is mutually exclusive with the -pf argument. -pf Specifies the password file. For more information about managing password files, see Manage password files. This argument is mutually exclusive with the -p argument. -g Specifies the group associated with the user. If used without a value, the user's default group is assumed. -a Performs the list, delete or resubmit actions. Choose from the following action values: list: Lists dispatcher requests. delete: Deletes dispatcher requests. resubmit: Resubmits dispatcher requests. -force Forces an action without any prompts. -export Exports the information in a file. -taskid Specifies the task ID of the dispatcher request. -provider Specifies the name of the dispatcher provider, for example, Siemens. -service Specifies the service name, for example, tozipfile. -priority Specifies the dispatcher priority. Accepted values are 1, 2, or 3 corresponding to low, medium and high priority. -state Specifies the dispatcher state. -h Displays help for this utility. Environment As specified in Setting up a Teamcenter command-line environment. Files As specified in Log files produced by Teamcenter. Restrictions None. Examples List all high priority dispatcher requests. dispatcher_util -u=Dispatcher-client-proxy-user -p=password -a=list -priority=3 Delete all dispatcher requests in the INITIAL state. dispatcher_util -u=Dispatcher-client-proxy-user -p=password -a=delete -state=INITIAL Resubmit all tozipfile dispatcher requests. dispatcher_util -u=Dispatcher-client-proxy-user -p=password -a=resubmit -service=tozipfile Related Topics Dispatcher ─ Deployment and Administration

Source: https://docs.sw.siemens.com/documentation/external/PL20251212545240207/en-US/tc_help/utilities_reference/mna1737253705286/rot1737253706352/xid453655.html · retrieved Fri Jul 31 2026 00:00:00 GMT+0000 (Coordinated Universal Time)