service.restart

Restart the service specified by service.

DEPRECATED: this method is scheduled to be removed in v26.04.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: service

service

Type: string

Name of the service to restart.
Parameter 2: options

options

Type: object

Options for controlling the restart operation behavior.

 No Additional Properties

Ha Propagate

Type: boolean Default: true

Whether to propagate the service operation to the HA peer in a high-availability setup.

Silent

Type: boolean Default: true

Return false instead of an error if the operation fails.

Timeout

Default: 120

Maximum time in seconds to wait for the service operation to complete. null for no timeout.

Type: integer
Type: null

Result

Type: boolean

The service is running after the restart.


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