-
Notifications
You must be signed in to change notification settings - Fork 4
New UnifiClientDevice
external help file: UniFiTooling-help.xml HelpVersion: 1.1.0 Locale: en-US Module Guid: 7fff91a0-02eb-4df2-84d5-c7d3cd7f7a5d Module Name: UniFiTooling online version: https://github.com/Enatec/UniFiTooling/raw/master/docs/New-UnifiClientDevice.md schema: 2.0.0
It creates a new user/client via API on the UniFi SDN Controller.
New-UnifiClientDevice [[-UnifiSite] <String>] [-Mac] <String> [-Group] <String> [[-Name] <String>]
[[-Note] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
It creates a new user/client via Ubiquiti (UBNT) UniFi RESTful API on the UniFi SDN Controller.
New-UnifiClientDevice -Mac '84:3a:4b:cd:88:2D' -Group 'Value2'
Create a new user/client-device
New-UnifiClientDevice -Mac '84:3a:4b:cd:88:2D' -Group 'Value2' -UnifiSite 'Contoso'
Create a new user/client-device on Site 'Contoso'
UniFi Site as configured. The default is: default
Type: String
Parameter Sets: (All)
Aliases: Site
Required: False
Position: 1
Default value: Default
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseClient MAC address
Type: String
Parameter Sets: (All)
Aliases: UniFiMac, MacAddress
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseValue for the user group the new user/client-device should belong to which can be obtained from the output of XXX
Type: String
Parameter Sets: (All)
Aliases: UniFiGroup, ClientGroup, UserGroup
Required: True
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseName to be given to the new user/client-device (optional)
Type: String
Parameter Sets: (All)
Aliases: UniFiName, ClientName, UserName
Required: False
Position: 4
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseNote to be applied to the new user/client-device (optional)
Type: String
Parameter Sets: (All)
Aliases: UnifiNote, UserNote, ClientNote
Required: False
Position: 5
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis 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).
Initial version of the Ubiquiti UniFi Controller automation function