Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

ServiceControllerHelpers

Contains tasks which allow to control NT services.

Functions and values

Function or valueDescription
checkRemoteServiceExists host name
Signature: host:string -> name:string -> bool
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

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
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

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
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

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
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

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
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

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
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

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.
friendlyName host name
Signature: host:string -> name:string -> string

Get friendly service name for displaying in logs

getRemoteService host name
Signature: host:string -> name:string -> ServiceController option
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Returns the first remote service with given name or None.

Parameters

  • host - The hostname of the remote machine.
  • name - The name of the service in question.
getRemoteServices host name
Signature: host:string -> name:string -> seq<ServiceController>
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Returns sequence of remote services with given name.

Parameters

  • host - The hostname of the remote machine.
  • name - The name of the services in question.
getRemoteServiceStatus host name
Signature: host:string -> name:string -> ServiceControllerStatus
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Returns status of the remote service with given name or fails when service is not found.

Parameters

  • host - The hostname of the remote machine.
  • name - The name of the service in question.
getService(name)
Signature: name:string -> ServiceController option
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Returns the first local service with given name or None.

Parameters

  • name - The name of the service in question.
getServices(name)
Signature: name:string -> seq<ServiceController>
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Returns sequence of local services with given name.

Parameters

  • name - The name of the services in question.
getServiceStatus(name)
Signature: name:string -> ServiceControllerStatus
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Returns status of the local service with given name or fails when service is not found.

Parameters

  • name - The name of the service in question.
isService name service
Signature: name:string -> service:ServiceController -> bool
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Returns whether the given service has the given name as display or service name.

Parameters

  • name - The name to check for.
  • service - The service in question.
localhost
Signature: string

Host value used for querying local services.

startRemoteService host name
Signature: host:string -> name:string -> unit
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

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
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

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
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

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
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Stops all local services with given name.

Parameters

  • name - The name of the services in question.