Connect-TSTMGMTServer

Connecting to the Management Platform using PowerShell.

Written by David

Last published at: November 9th, 2022

Connect to a ThinScale Management Platform


SYNTAX

Connect-TSTMGMTServer

[[-Uri] <string>] [-Username <string>] [-Password <string>] [-Domain <string>]

Connect-TSTMGMTServer

        Connect-TSTMGMTServer [[-Uri] <string>] -Credentials <pscredential>     


DESCRIPTION

Connect to a ThinScale Management instance


EXAMPLES

1. Connect to an instance, supplying a PSCredential object via the pipeline

        Get-Credential | Connect-TSTMGMTServer -Uri https://server.domain.local

2. Connect to an instance passing credentials on the command line

        Connect-TSTMGMTServer -Uri https://server.domain.local -Username 'Administrator' -Password 'secretpassword'

PARAMETERS


-Uri

The URI of the ThinScale Management instance. If not specified the value of the environment variable %THINSCALE_URI% will be used if it exists

Type: String
Required: No
Accept Pipeline Input: No


-Username

The username used to connect to the ThinScale Management instance. If not specified the value of the environment variable %THINSCALE_USERNAME% will be used if it exists

Type: String
Required: No
Accept Pipeline Input: No


-Password

The password associated with the username used to connect to the ThinScale Management instance. If not specified the value of the environment variable %THINSCALE_PASSWORD% will be used if it exists

Type: String
Required: No
Accept Pipeline Input: No


-Domain

The domain associated with the domain user account to connect to the ThinScale Management instance. If not specified the value of the environment variable %THINSCALE_DOMAIN% will be used if it exists, not required for local ThinScale Management users

Type: String
Required: No
Accept Pipeline Input: No


-Credential

A PSCredential object containing the username and password used to connect to the ThinScale Management Instance

Type: System.Management.Automation.PSCredential
Required: Yes
Accept Pipeline Input: Yes


-Timeout

The time allowed in milliseconds for the call to complete before it is deemed to have timed out and is aborted

Type: Int32
Required: No
Accept Pipeline Input: No


INPUTS

System.Management.Automation.PSCredential


OUTPUTS

System.Guid