Skip to content

Get-UnifiSite

SYNOPSIS

List all Sites registered with UniFi

SYNTAX

Get-UnifiSite [-Url] <String> [-WebSession] <WebRequestSession> [[-SiteDesc] <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

List all Sites registered with UniFi

EXAMPLES

EXAMPLE 1

$Credential = $(Get-SecureCredential -Name 'Unifi' -VaultName 'MyVault')
PS>$Url = "https://unifi.domain.com:8443"
PS>$session = Get-UnifiSession -Url $Url -Credential $Credential
PS>Get-UnifiSite -Url $Url -WebSession $session -SiteDesc 'MySite'
PS>Remove-UnifiSession -Url $Url -WebSession $session -Confirm:$false

PARAMETERS

-Url

UniFi URL

Type: String
Parameter Sets: (All)
Aliases:

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

-WebSession

Target WebSession

Type: WebRequestSession
Parameter Sets: (All)
Aliases:

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

-SiteDesc

Target SiteDesc. Returns all when not specified

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
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