Note: This API documentation is for FAKE version 4. The migration API documentation can be found here. The API documentation for the new fake 5 modules can be found here

ServiceControllerHelpers

Contains tasks which allow to control NT services.

Functions and values

Function or valueDescription
checkRemoteServiceExists host name
Signature: host:string -> name:string -> bool

Returns whether a remote service with the given name exists.

Parameters

  • host - The hostname of the remote machine.
  • name - The name of the service in question.
checkServiceExists(name)
Signature: name:string -> bool

Returns whether a local service with the given name exists.

Parameters

  • name - The name of the service in question.
ensureRemoteServiceHasStarted(...)
Signature: host:string -> name:string -> timeout:TimeSpan -> unit

Waits until the remote service with the given name has been started or fails after given timeout

Parameters

  • host - The hostname of the remote machine.
  • name - The name of the service in question.
  • timeout - The timespan to time out after.
ensureRemoteServiceHasStopped(...)
Signature: host:string -> name:string -> timeout:TimeSpan -> unit

Waits until the remote service with the given name has been stopped or fails after given timeout

Parameters

  • host - The hostname of the remote machine.
  • name - The name of the service in question.
  • timeout - The timespan to time out after.
ensureServiceHasStarted name timeout
Signature: name:string -> timeout:TimeSpan -> unit

Waits until the local service with the given name has been started or fails after given timeout

Parameters

  • name - The name of the service in question.
  • timeout - The timespan to time out after.
ensureServiceHasStopped name timeout
Signature: name:string -> timeout:TimeSpan -> unit

Waits until the local service with the given name has been stopped or fails after given timeout

Parameters

  • name - The name of the service in question.
  • timeout - The timespan to time out after.
startRemoteService host name
Signature: host:string -> name:string -> unit

Starts all remote services with given name.

Parameters

  • host - The hostname of the remote machine.
  • name - The name of the services in question.
startService(name)
Signature: name:string -> unit

Starts all local services with given name.

Parameters

  • name - The name of the services in question.
stopRemoteService host name
Signature: host:string -> name:string -> unit

Stops all services with given name.

Parameters

  • host - The hostname of the remote machine.
  • name - The name of the services in question.
stopService(name)
Signature: name:string -> unit

Stops all local services with given name.

Parameters

  • name - The name of the services in question.