TestimoX

API Reference

Command

Initialize-TestimoXService

Namespace TestimoX.PowerShell
Outputs
TestimoX.Services.ServiceActionResult TestimoX.Services.ServiceConfigDeployment TestimoX.Services.ServiceInstallResult TestimoX.Services.ServiceUninstallResult

Unified installer/manager for the TestimoX Windows Service.

Remarks

Performs install, uninstall, config apply, and optional restart in one cmdlet. Keeps surface area small so the module doesn't duplicate built-in PowerShell service cmdlets.

Examples

Authored help example

Example 1: Install the service (LocalSystem) and auto-generate config if missing

PS>


Initialize-TestimoXService -Install -ServicePath C:\Apps\TestimoX.Service.exe

Example 2: Install with explicit config and domain account

PS>


Initialize-TestimoXService -Install -ServicePath C:\Apps\TestimoX.Service.exe -ConfigPath C:\Configs\service.json -Account 'DOMAIN\svc-testimo' -Credential (Get-Credential)

Example 3: Apply new config and restart service

PS>


Initialize-TestimoXService -Apply -Name TestimoX -ConfigPath C:\Configs\service.json -Restart

Example 4: Uninstall

PS>


Initialize-TestimoXService -Uninstall -ServicePath C:\Apps\TestimoX.Service.exe

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Initialize-TestimoXService -Install -ServicePath <string> [-Account <string>] -ConfigPath <string> [-Credential <PSCredential>] [-Description <string>] [-DisplayName <string>] [-Name <string>] [<CommonParameters>]
#
Parameter set: By Install

Parameters

Install SwitchParameter requiredposition: namedpipeline: false
Install the service.
ServicePath string requiredposition: namedpipeline: falsealiases: UninstallServicePath
Path to TestimoX.Service.exe to install, uninstall, or run once.
Account string optionalposition: namedpipeline: false
Logon account. Use 'LocalSystem', 'LocalService', 'NetworkService', or 'DOMAIN\\User'.
ConfigPath string requiredposition: namedpipeline: falsealiases: ApplyConfigPath
Path to service.json to deploy during install or apply.
Credential PSCredential optionalposition: namedpipeline: false
Credential for the specified domain account (ignored for built-in accounts).
Description string optionalposition: namedpipeline: false
Windows service description.
DisplayName string optionalposition: namedpipeline: false
Windows service display name. Defaults to the resolved service name when not provided.
Name string optionalposition: namedpipeline: false
Windows service name (defaults to TestimoX).

Outputs

TestimoX.Services.ServiceActionResult, TestimoX.Services.ServiceConfigDeployment, TestimoX.Services.ServiceInstallResult, TestimoX.Services.ServiceUninstallResult

Initialize-TestimoXService -ServicePath <string> -Uninstall [-Name <string>] [<CommonParameters>]
#
Parameter set: By Uninstall

Parameters

ServicePath string requiredposition: namedpipeline: falsealiases: UninstallServicePath
Path to TestimoX.Service.exe to install, uninstall, or run once.
Uninstall SwitchParameter requiredposition: namedpipeline: false
Uninstall the service.
Name string optionalposition: namedpipeline: false
Windows service name (defaults to TestimoX).

Outputs

TestimoX.Services.ServiceActionResult, TestimoX.Services.ServiceConfigDeployment, TestimoX.Services.ServiceInstallResult, TestimoX.Services.ServiceUninstallResult

Initialize-TestimoXService -RunNow [-Name <string>] [-RunNowConfigPath <string>] -ServicePath <string> [<CommonParameters>]
#
Parameter set: By RunNow

Parameters

RunNow SwitchParameter requiredposition: namedpipeline: false
Run the service workload once (without installing).
Name string optionalposition: namedpipeline: false
Windows service name (defaults to TestimoX).
RunNowConfigPath string optionalposition: namedpipeline: false
Optional config path to run once; defaults to deployed service.json.
ServicePath string requiredposition: namedpipeline: falsealiases: UninstallServicePath
Path to TestimoX.Service.exe to install, uninstall, or run once.

Outputs

TestimoX.Services.ServiceActionResult, TestimoX.Services.ServiceConfigDeployment, TestimoX.Services.ServiceInstallResult, TestimoX.Services.ServiceUninstallResult

Initialize-TestimoXService -Apply -ConfigPath <string> [-Name <string>] -Restart [<CommonParameters>]
#
Parameter set: By Apply

Parameters

Apply SwitchParameter requiredposition: namedpipeline: false
Apply a new configuration to service folder (validates JSON before copying).
ConfigPath string requiredposition: namedpipeline: falsealiases: ApplyConfigPath
Path to service.json to deploy during install or apply.
Name string optionalposition: namedpipeline: false
Windows service name (defaults to TestimoX).
Restart SwitchParameter requiredposition: namedpipeline: falsealiases: DoRestart
Restart the service after applying the configuration.

Outputs

TestimoX.Services.ServiceActionResult, TestimoX.Services.ServiceConfigDeployment, TestimoX.Services.ServiceInstallResult, TestimoX.Services.ServiceUninstallResult

Initialize-TestimoXService -Restart [-Name <string>] [<CommonParameters>]
#
Parameter set: Set 5

Parameters

Restart SwitchParameter requiredposition: namedpipeline: falsealiases: DoRestart
Restart the service after applying the configuration.
Name string optionalposition: namedpipeline: false
Windows service name (defaults to TestimoX).

Outputs

TestimoX.Services.ServiceActionResult, TestimoX.Services.ServiceConfigDeployment, TestimoX.Services.ServiceInstallResult, TestimoX.Services.ServiceUninstallResult