Service Host Command-Line Options
Use the Command-Line Configure (CLC) /servicehost major command to access all sub-commands for the Cherwell Service Host and its microservices: Automation Processes, E-mail and Event Monitor, Mail Delivery, Scheduling, and System Event Processing. Use sub-commands to configure, start, stop, and uninstall the Service Host.
In the following examples, square brackets (example: [Common]) denote placeholder variables for customer data. Replace these variables, including the brackets, with your own values.
/servicehost
To configure options for multiple leaders at a time, use the /servicehost /configureleaders subcommand.
Example:
/servicehost -servicehostapleaderpause=false -connection="[Common]Cherwell" -connectionuserid=CSDAdmin -connectionpassword=CSDAdmin
| Sub-command | Description |
|---|---|
|
/servicehostlogtologserver |
If true, Service Host will log to the log server (Splunk). Accepted values: {true | false} |
|
/servicehostlogserverloglevel |
The minimum log level at which logs will be sent to the log server (Splunk). Accepted values: {fatal | error | warning | info | stats | debug} |
|
/servicehostlogtoeventlog |
If true, Service Host will log to the event log. Accepted values: {true | false} |
|
/servicehostlogeventloglevel |
The minimum log level at which logs will be sent to the event log. Accepted values: {fatal | error | warning | info | stats | debug} |
|
/servicehostlogtofile |
If true, Service Host will log to the file system log. Accepted values: {true | false} |
|
/servicehostlogfileloglevel |
The minimum log level at which logs will be sent to the file system log. Accepted values: {fatal | error | warning | info | stats | debug} |
|
/servicehostlogfilepath |
The path to the file system logs. Accepted values: string |
|
/servicehostlogmaxfilesizeinmb |
Maximum log file size in MB. Accepted values: integer |
|
/servicehostlogmaxfilesbeforerollover |
Maximum number of log files before files roll over. Accepted values: integer |
|
/servicehostuserid |
Service Host User ID setting. Accepted values: string |
|
/servicehostpassword |
Service Host password setting. Accepted values: string |
|
/servicehostconnection |
Service Host connection setting. Accepted values: string |
|
/servicehostusewindowslogin |
If true, Service Host will use a Windows login. Accepted values: {true | false} |
|
/servicehostusedefaultroleofuser |
If true, Service Host will use the default role of the User. Accepted values: {true | false} |
|
/servicehostapleaderenable |
If true, the Automation Process Service Leader is enabled. Accepted values: {true | false} Default: True |
|
/servicehostapleaderheartbeatinterval |
The AAutomation Process Service heartbeat interval in seconds. Accepted values: integer Default: 30 |
|
/servicehostapleaderwaittime |
The amount of wait time in seconds for the Automation Process Service Leader to check the system for work. Accepted values: integer Default: 15 |
|
/servicehostapleaderblockstoprocess |
The number of blocks of work for an Automation Process Service leader to process per interval. Accepted values: integer Default: 100 |
|
/servicehostapleaderscheduleditemspullcount |
The number of items for the Automation Process Service to pull per block. Accepted values: integer Default: 100 |
|
/servicehostapleaderpause |
If true, Automation Process Service is paused. Accepted values: {true | false} Default: False |
|
/servicehostedleaderenable |
If true, the Mail Delivery Services Leader is enabled. Accepted values: {true | false} Default: True |
|
/servicehostedleaderheartbeatinterval |
The Mail Delivery Services heartbeat interval in seconds. Accepted values: integer Default: 30 |
|
/servicehostedleaderwaittime |
The amount of wait time in seconds for the Mail Delivery Services Leader to check the system for work. Accepted values: integer Default: 15 |
| /servicehostedleaderpause |
If true, the Mail Delivery Services is paused. Accepted values: {true | false} Default: False |
|
/servicehosteeleaderenable |
If true, the Email and Event Monitor Service Leader is enabled. Accepted values: {true | false} Default: True |
|
/servicehosteeleaderheartbeatinterval |
The Email and Event Monitor Service heartbeat interval in seconds. Accepted values: integer Default: 30 |
|
/servicehosteeleaderwaittime |
The amount of wait time in seconds for the Email and Event Monitor Service Leader to check the system for work. Accepted values: integer Default: 15 |
|
/servicehosteeleaderemailitemspullcount |
The number of items for theEmail and Event Monitor Service to process per pull. Accepted values: integer Default: 100 |
|
/servicehosteeleaderpause |
If true, the Email and Event Monitor Service is paused. Accepted values: {true | false} Default: False |
|
/servicehostssleaderenable |
If true, the Scheduling Service Leader is enabled. Accepted values: {true | false} Default: True |
|
/servicehostssleadergroup |
The group that this Scheduling Service will work on exclusively. Accepted values: string |
|
/servicehostssleaderheartbeatinterval |
The Scheduling Service heartbeat interval in seconds. Accepted values: integer Default: 30 |
|
/servicehostssleaderwaittime |
The amount of wait time in seconds for the Scheduling Service Leader to check the system for work. Accepted values: integer Default: 15 |
|
/servicehostssleaderpause |
If true, the Scheduling Service is paused. Accepted values: {true | false} Default: True |
|
/servicehostwhleaderenable |
If true, the System Event Processing Service Leader is enabled. Accepted values: {true | false} Default: True |
|
/servicehostwhleaderheartbeatinterval |
The System Event Processing Service heartbeat interval in seconds. Accepted values: integer Default: 30 |
|
/servicehostwhleaderwaittime |
The amount of wait time in seconds for the System Event Processing Service Leader to check the system for work. Accepted values: integer Default: 15 |
|
/servicehostwhleaderpause |
If true, the System Event Processing Service is paused. Accepted values: {true | false} Default: True |
/configureleaders
The purpose of this command is to configure service and logging settings for all the Service Host microservices: Automation Processes, E-mail Delivery, E-mail and Event Monitor, Scheduling, and Webhooks.
The /leaders option specifies which leaders all provided configuration options apply to. If a configuration option is not provided, that setting is ignored for all specified leaders.
Example:
# Disable Email Delivery and Email and Event Monitoring /servicehost /configureleaders /leaders=emaildeliver,emailevent /leaderenable=false # Enable file logging for all leaders /servicehost /configureleaders /leaders=all /logtofile=true /fileloglevel=debug # Set Automated Process Scheduled items pull count and Email and Event items pull count to 50 # Note: Even with /leaders=all, the leader-specific option only aplies to applicable leaders /servicehost /configureleaders /leaders=all /itempullcount=50 # Set the number of blocks of work for an automated process leader to process per interval to 600 /servicehost /configureleaders /leader=automatedprocess /leaderblockstoprocess=600
| Option | Description |
|---|---|
| /leaders |
Determines which leaders to configure. "All" configures all leaders. Multiple leaders can be separated by comma or pipe "|". Required: True Accepted values: [All|AutomatedProcess|EmailDelivery|EmailEvent|Schedule|Webhook] |
| /logtologserver |
Determines whether leaders will write logs to the log server. Accepted values: [True | False] Default: False |
| /logserverloglevel |
The minimum log level at which logs will be sent to the log server. Accepted values: [Fatal | Error | Warning | Info | Stats | Debug] Default: Debug |
| /logtoeventlog |
Determines whether leaders will log to the log server. Accepted values: [True | False] Default: True |
| /logeventloglevel |
The minimum log level at which logs will be sent to the event log. Accepted values: [Fatal | Error | Warning | Info | Stats | Debug] Default: Warning |
| /logtofile |
Determines whether leaders will log to the file system log. Accepted values: [ True | False] Default: True |
| /logfileloglevel |
The minimum log level at which logs will be sent to the file system log. Accepted values: [Fatal | Error | Warning | Info | Stats | Debug] Default: Debug |
| /logfilepath |
The path to the file system logs. Accepted values: [String] Default: C:/Logs/csm_log.txt |
| /logmaxfilesizeinmb |
The maximum log file size in MB. Accepted values: [Integer] Default: 10 |
| /logmaxfilesbeforerollover |
The maximum number of log filess before files roll over. Accepted values: [Integer] Default: 20 |
| /logtosumologic |
Determines whether the leaders will log to Sumo Logic. Accepted values: [ True | False] Default: False |
| /sumologicloglevel |
The minimum log level at which logs will be sent to Sumo Logic. Accepted values: [Fatal | Error | Warning | Info | Stats | Debug] Default: Warning |
| /leaderenable |
Determines whether the leaders are enabled. Accepted values: [bool] Default: True |
| /leadermaxworkers |
The maximimum number of workers for leaders. Accepted values: [Integer] Default: 5 |
| /leaderheartbeatinterval |
The leader's heartbeat interval in seconds. Accepted values: [Integer] Default: 30 |
| /leaderwaittime |
The amount of time in seconds for the leaders to wait before checking the system for work. Accepted values: [Integer] Default: 15 |
| /leaderitemspullcount |
The number of items for the leaders to pull per block. This applies to Automated Process and E-mail and Event Monitoring. Accepted values: [Integer] Default: 100 |
| /leaderblockstoprocess |
The number of blocks of work for a leader to process per interval. This applies to Automated Process. Accepted values: [Integer] Default: 100 |
| /leadergroup |
The group that the leaders will work on exclusively. This applies to Schedule. Accepted values: [String] |
/servicehostinstall
Use the /servicehostinstall sub-command to install the Cherwell Service Host Windows service.
Example:
/servicehost /servicehostinstall /servicehostinstallaccount=LocalService
Example:
/servicehost /servicehostinstall /servicehostinstalluserid=Bob /servicehostinstallpassword=1234 /servicehostinstallaccount=NetworkService
| Option | Description |
|---|---|
|
/servicehostinstalluserid |
User ID the service will log on as. Optional as long as /servicehostinstallaccount has a valid value. Accepted values: string |
|
/servicehostinstallpassword |
Password that the service will log on with. Optional as long as /servicehostinstallaccount has a valid value. Accepted values: string |
|
/servicehostinstallaccount |
Account the service will log on as. Optional as long as /servicehostinstalluserid and /servicehostinstallpassword have valid values. If no /servicehostinstallaccount or /servicehostinstalluserid or /servicehostinstallpassword values are provided, then LocalService is used. Accepted values: [LocalService | LocalSystem | NetworkService] Default: LocalSystem |
|
/servicehostinstallautostart |
Set the service to auto start during installation. Accepted values: {true | false} Default: False |
/servicehoststart
Use the /servicehoststart sub-command to start the Cherwell Service Host Windows service. There are no options for this sub-command.
Example:
/servicehost /servicehoststart
/servicehoststop
Use the /servicehoststop sub-command to stop the Cherwell Service Host Windows service. There are no options for this sub-command.
Example:
/servicehost /servicehoststop
/servicehostuninstall
Use the /servicehostuninstall sub-command to uninstall the Cherwell Service Host Windows service. There are no options for this sub-command.
Example:
/servicehost /servicehostuninstall