Skip to content

Get-UnifiSession

SYNOPSIS

Create a new session with the Unifi API

SYNTAX

Get-UnifiSession [-Url] <String> [-Credential] <PSCredential> [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

Create a new session with the Unifi API

EXAMPLES

EXAMPLE 1

$Credential = $(Get-SecureCredential -Name 'Unifi' -VaultName 'MyVault')
PS>$Url = "https://unifi.domain.com:8443"
PS>Get-UnifiSession -Url $Url -Credential $Credential

PARAMETERS

-Url

Target URL to the UNIFI controller

Type: String
Parameter Sets: (All)
Aliases:

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

-Credential

PSCredential for the UNIFI controller

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES