Connect-TestimoXService

Namespace TestimoX.PowerShell

Outputs

TestimoX.PowerShell.ServiceConnectionInfo

Connects to a TestimoX Service Management API and stores the session for subsequent commands.

Remarks

When connected, Get-/Set-/Invoke-TestimoXService cmdlets call the REST API instead of managing the service locally. Use -Url pointing to a configured management prefix and provide the API key.

Examples

Authored help example

Example 1: Connect to local API with API key

PS>


Connect-TestimoXService -Url 'http://127.0.0.1:7809/' -ApiKey (Get-Content C:\secret.txt -Raw)

Subsequent Get-/Set-/Invoke-TestimoXService calls will use this session.

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

Connect-TestimoXService [-ApiKey <string>] [-SaveForDays <int>] [-Url <string>] [-UseSaved] [<CommonParameters>]

Parameters

ApiKey string optionalposition: namedpipeline: false: API key used to authenticate with the Management API. Prompted if omitted.
SaveForDays int optionalposition: namedpipeline: false: Persist the session for this many days (0 = do not save).
Url string optionalposition: namedpipeline: false: Base URL of the management API (e.g., http://127.0.0.1:7809/).
UseSaved SwitchParameter optionalposition: namedpipeline: false: Reuse a previously saved session (base URL and API key) if available.

Outputs

TestimoX.PowerShell.ServiceConnectionInfo