service.control

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: verb

verb

Type: enum (of string)

Must be one of:

• "START"
• "STOP"
• "RESTART"
• "RELOAD"

Parameter 2: service

service

Type: string

Parameter 3: options

options

Type: object
No Additional Properties

ha_propagate

Ha Propagate

Type: boolean Default: true

silent

Silent

Type: boolean Default: true

Return false instead of an error if the operation fails.

timeout

Timeout

Default: 120

Any of

• Option 1
• Option 2

Type: integer

Type: null

Return value

Result

Type: boolean

For "START", "RESTART", "RELOAD", it will indicate whether the service is running after performing the operation.
For "STOP", it will indicate whether the service was successfully stopped.

Required roles: SERVICE_WRITE | SHARING_FTP_WRITE | SHARING_ISCSI_WRITE | SHARING_NFS_WRITE | SHARING_SMB_WRITE