Connect-PSUServer

Connects to a PowerShell Universal server.

SYNOPSIS

Connects to a PowerShell Universal server.

SYNTAX

AppToken

Connect-PSUServer [-ComputerName <String>] -AppToken <String> [-Scope <String>]
 [<CommonParameters>]

UseDefaultCredentials

Connect-PSUServer [-ComputerName <String>] [-UseDefaultCredentials] [-Scope <String>]
 [<CommonParameters>]

Credential

Connect-PSUServer [-ComputerName <String>] -Credential <PSCredential> [-Scope <String>]
 [<CommonParameters>]

DESCRIPTION

Connects to a PowerShell Universal server. When you connect using this cmdlet, you will no longer need to specify the -ComputerName and -AppToken parameters for each cmdlet that is accessing the PowerShell Universal Management API.

EXAMPLES

Example 1

PS C:\> Connect-PSUServer -ComputerName http://localhost:5000 -AppToken 'appToken123'

Connects to the PSU server listening on port 5000 of localhost using the app token appToken123.

PARAMETERS

-AppToken

The AppToken that is used for calling the PowerShell Universal Management API. You can also call Connect-PSUServer before calling this cmdlet to set the AppToken for the entire session.

Type: String
Parameter Sets: AppToken
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ComputerName

Specifies the computer name or URL that should be called when accessing the PowerShell Universal Management API. You can also use Connect-PSUServer before calling this cmdlet to set the computer name for the entire session.

Type: String
Parameter Sets: (All)
Aliases: Url

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UseDefaultCredentials

Use default credentials when connecting to the management API

Type: SwitchParameter
Parameter Sets: UseDefaultCredentials
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Credential

The user name and password to login with.

Type: PSCredential
Parameter Sets: Credential
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Scope

Process or runspace scope. Process scope will login for the entire process. Runspace scope only logs in for the current runspace. Process is default.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable, and -ProgressAction. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.Object

NOTES

RELATED LINKS