Skip to content
This repository has been archived by the owner on Apr 3, 2020. It is now read-only.

Get UnifiNetworkDetails

Joerg Hochwald edited this page Jan 14, 2019 · 25 revisions

external help file: UniFiTooling-help.xml Module Name: UniFiTooling online version: https://github.com/jhochwald/UniFiTooling/raw/master/docs/Get-UnifiNetworkDetails.md schema: 2.0.0

Get-UnifiNetworkDetails

SYNOPSIS

Get the details about one network via the API of the UniFi Controller

SYNTAX

Get-UnifiNetworkDetails [-UnifiNetwork] <String> [[-UnifiSite] <String>] [<CommonParameters>]

DESCRIPTION

Get the details about one network via the API of the UniFi Controller

EXAMPLES

EXAMPLE 1

Get-UnifiNetworkDetails -UnifiNetwork $value1

Get the details about one network via the API of the UniFi Controller

EXAMPLE 2

Get-UnifiNetworkDetails -UnifiNetwork $value1 -UnifiSite 'Contoso'

Get the details about one network on Site 'Contoso' via the API of the UniFi Controller

PARAMETERS

-UnifiNetwork

The ID (network_id) of the network you would like to get detaild information about.

Type: String
Parameter Sets: (All)
Aliases: UnifiNetworkId, NetworkId

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-UnifiSite

UniFi Site as configured. The default is: default

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

Required: False
Position: 3
Default value: Default
Accept pipeline input: True (ByPropertyName, ByValue)
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 (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

System.Management.Automation.PSObject

NOTES

Initial version of the Ubiquiti UniFi Controller automation function

RELATED LINKS

Get-UniFiConfig

Set-UniFiDefaultRequestHeader

Set-UniFiDefaultRequestHeader