en-US/UniFiTooling-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Unifi5minutesApStats</command:name> <command:verb>Get</command:verb> <command:noun>Unifi5minutesApStats</command:noun> <maml:description> <maml:para>Get Access Point stats in 5 minute segments</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the stats in 5 minute segments for all or just one access points in a given UniFi site For convenience, we return the traffic Megabytes and not in bytes (as the UniFi does it). We also return real timestamps instead of the unix timestaps that the UniFi returns</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Unifi5minutesApStats</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Defaults to the past 12 hours. Make sure that the retention policy for 5 minutes stats is set to the correct value in the controller settings Ubiquiti announced this with the Controller version 5.5 - It will not work on older versions!</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-Unifi5minutesApStats</dev:code> <dev:remarks> <maml:para>Get the stats in 5 minute segments for all access points in the default site</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-Unifi5minutesApStats -Mac '78:8a:20:59:e6:88'</dev:code> <dev:remarks> <maml:para>Get the stats in 5 minute segments for a given (78:8a:20:59:e6:88) access point in the default site</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>(Get-Unifi5minutesApStats -Start '1548971935421' -End '1548975579019')</dev:code> <dev:remarks> <maml:para>Get the statistics for a given time period.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>(Get-Unifi5minutesApStats -Start '1548971935421')</dev:code> <dev:remarks> <maml:para>Get the statistics for the last 60 minutes (was the timestamp while the sample was created)</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-Unifi5minutesApStats -UnifiSite 'contoso' | Where-Object { $_.Traffic -ne '0.00' }</dev:code> <dev:remarks> <maml:para>Get the stats in 5 minute segments for all access points in the site 'contoso', if traffic is generated.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <dev:code>(Get-Unifi5minutesApStats -UnifiSite 'contoso')[-1]</dev:code> <dev:remarks> <maml:para>Get the last stats in 5 minute segments for all access points in the site 'contoso'</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Get-Unifi5minutesApStats.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertFrom-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Unifi5minutesClientStats</command:name> <command:verb>Get</command:verb> <command:noun>Unifi5minutesClientStats</command:noun> <maml:description> <maml:para>Get user/client statistics in 5 minute segments</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get user/client statistics in 5 minute segments for a given client</maml:para> <maml:para>For convenience, we return the a bit more then the API, e.g. everything in KB, MB, GB, and TB instead of just bytes We also return real timestamps instead of the unix timestaps in miliseconds that the UniFi returns</maml:para> <maml:para>Sample output: Time : 2/1/2019 3:45:00 PM rx_bytes : 105.0 rx_kb : 0.10 rx_mb : 0.00 rx_gb : 0.00 rx_tb : 0.00 rx_rate : 650000.0 rx_rate_mbps : 634.77 rx_retries : 0 rx_packets : 2.5 tx_bytes : 213.0 tx_kb : 0.21 tx_mb : 0.00 tx_gb : 0.00 tx_tb : 0.00 tx_rate : 650000.0 tx_rate_mbps : 634.77 tx_retries : 1 tx_packets : 4.5 Traffic_bytes : 318 Traffic_kb : 0.31 Traffic_mb : 0.00 Traffic_gb : 0.00 Traffic_tb : 0.00 Signal : -65 Signal_plain : -65.0</maml:para> <maml:para>In reality, we filter out all 0.00 values (e.g. tx_mb above) You can Filter for whatever parameter you like (e.g. with Select-Object)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Unifi5minutesClientStats</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address (required)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="attribs, UniFiAttributes"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>array containing attributes (strings) to be returned, defaults to rx_bytes and tx_bytes</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address (required)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="attribs, UniFiAttributes"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>array containing attributes (strings) to be returned, defaults to rx_bytes and tx_bytes</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Defaults to the past 12 hours. Make sure that the retention policy for 5 minutes stats is set to the correct value in the controller settings Ubiquiti announced this with the Controller version 5.8 - It will not work on older versions! Make sure that "Clients Historical Data" (Collect clients' historical data) has been enabled in the UniFi controller in "Settings/Maintenance"</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-Unifi5minutesClientStats -Mac '78:8a:20:59:e6:88'</dev:code> <dev:remarks> <maml:para>Get user/client statistics in 5 minute segments for a given (78:8a:20:59:e6:88) user/client in the default site</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>(Get-Unifi5minutesClientStats -Mac '78:8a:20:59:e6:88' -Start '1548971935421' -End '1548975579019')</dev:code> <dev:remarks> <maml:para>Get user/client statistics in 5 minute segments for a given (78:8a:20:59:e6:88) user/client in the default site for a given time period.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>(Get-Unifi5minutesClientStats -Mac '78:8a:20:59:e6:88' -Start '1548980058135')</dev:code> <dev:remarks> <maml:para>Get user/client statistics in 5 minute segments for a given (78:8a:20:59:e6:88) user/client in the default site for the last 60 minutes (was the timestamp while the sample was created)</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>(Get-Unifi5minutesClientStats -Mac '78:8a:20:59:e6:88' -UnifiSite 'contoso')[-1]</dev:code> <dev:remarks> <maml:para>Get user/client statistics in 5 minute segments for a given (78:8a:20:59:e6:88) user/client in the site 'contoso'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-Unifi5minutesClientStats -Mac '78:8a:20:59:e6:88' -Attributes 'rx_bytes', 'tx_bytes', 'signal', 'rx_rate', 'tx_rate', 'rx_retries', 'tx_retries', 'rx_packets', 'tx_packets')</dev:code> <dev:remarks> <maml:para>Get all Values from the API</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Get-Unifi5minutesClientStats.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertFrom-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Unifi5minutesGatewayStats</command:name> <command:verb>Get</command:verb> <command:noun>Unifi5minutesGatewayStats</command:noun> <maml:description> <maml:para>Get statistics in 5 minute segments for the USG</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get statistics in 5 minute segments for the USG (UniFi Secure Gateway)</maml:para> <maml:para>For convenience, we return the a bit more then the API, e.g. everything in KB, MB, GB, and TB instead of just bytes We also return real timestamps instead of the unix timestaps in miliseconds that the UniFi returns</maml:para> <maml:para>Sample output: Time : 2/1/2019 6:20:00 PM gateway : 78:8a:20:59:e6:88 mem : 33.00 cpu : 0.13 lan-rx_errors : 0 lan-rx_bytes : 1373037.08 lan-rx_kb : 1340.86 lan-rx_mb : 1.31 lan-rx_packets : 8410.58 lan-rx_dropped : 0 wan-rx_errors : 0 wan-rx_packets : 1413.88 wan-rx_dropped : 0 lan-tx_errors : 0 lan-tx_bytes : 1908328.2 lan-tx_kb : 1863.60 lan-tx_mb : 1.82 lan-tx_packets : 8597.439999999999 lan-tx_dropped : 0 wan-tx_errors : 0 wan-tx_bytes : 391328.44 wan-tx_kb : 382.16 wan-tx_mb : 0.37 wan-tx_packets : 979.14 wan-tx_dropped : 0</maml:para> <maml:para>You might filter out all the 0 values, we keep them to prevent any null pointer expetions!</maml:para> <maml:para>You can Filter for whatever parameter you like (e.g. with Select-Object)</maml:para> <maml:para>BUG: The loadavg_ attributes are not working at the moment. The UniFi SDN Controller does not return any values for them!</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Unifi5minutesGatewayStats</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="attribs, UniFiAttributes"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>array containing attributes (strings) to be returned, defaults to mem, cpu, and zime (Time is mandatory)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="attribs, UniFiAttributes"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>array containing attributes (strings) to be returned, defaults to mem, cpu, and zime (Time is mandatory)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Defaults to the past 12 hours. Make sure that the retention policy for 5 minutes stats is set to the correct value in the controller settings Ubiquiti announced this with the Controller version 5.8 - It will not work on older versions!</maml:para> <maml:para>A USG (UniFi Secure Gateway) is required on the site you querry!</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-Unifi5minutesGatewayStats</dev:code> <dev:remarks> <maml:para>Get statistics in 5 minute segments for the USG (UniFi Secure Gateway) in the default site</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>(Get-Unifi5minutesGatewayStats -Start '1548971935421' -End '1548975579019')</dev:code> <dev:remarks> <maml:para>Get statistics in 5 minute segments for the USG (UniFi Secure Gateway) in the default site for a given time period.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>(Get-Unifi5minutesGatewayStats -Start '1548980058135')</dev:code> <dev:remarks> <maml:para>Get statistics in 5 minute segments for the USG (UniFi Secure Gateway) in the default site for the last 60 minutes (was the timestamp while the sample was created)</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>(Get-Unifi5minutesGatewayStats -UnifiSite 'contoso')[-1]</dev:code> <dev:remarks> <maml:para>Get statistics in 5 minute segments for the USG (UniFi Secure Gateway) in the site 'contoso'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-Unifi5minutesGatewayStats -Attributes 'mem','cpu','loadavg_5','lan-rx_errors','wan-rx_errors','lan-tx_errors','wan-tx_errors','lan-rx_bytes','wan-rx_bytes','lan-tx_bytes','wan-tx_bytes','lan-rx_packets','wan-rx_packets','lan-tx_packets','wan-tx_packets','lan-rx_dropped','wan-rx_dropped','lan-tx_dropped','wan-tx_dropped')</dev:code> <dev:remarks> <maml:para>Get all Values from the API</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Get-Unifi5minutesGatewayStats.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertFrom-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Unifi5minutesSiteStats</command:name> <command:verb>Get</command:verb> <command:noun>Unifi5minutesSiteStats</command:noun> <maml:description> <maml:para>Get statistics in 5 minute segments for a complete Site</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get statistics in 5 minute segments for a complete UniFi Site</maml:para> <maml:para>For convenience, we return the a bit more then the API, e.g. everything in KB, MB, GB, and TB instead of just bytes</maml:para> <maml:para>We also return real timestamps instead of the unix timestaps in miliseconds that the UniFi returns</maml:para> <maml:para>Sample output: Time : 1/28/2019 8:00:00 AM wan-tx_bytes : 15674710.4243137 wan-tx_kb : 15307.33 wan-tx_mb : 14.95 wan-tx_gb : 0.01 wan-rx_bytes : 74608528.2870588 wan-rx_kb : 72859.89 wan-rx_mb : 71.15 wan-rx_gb : 0.07 wan_bytes : 90283238.7113726 wan_kb : 88167.23 wan_mb : 86.1 wan_gb : 0.08 wlan_bytes : 73033651.4499586 wlan_kb : 71321.93 wlan_mb : 69.65 wlan_gb : 0.07 Clients : 35 LAN_Clients : 30 WLAN_Clients : 5</maml:para> <maml:para>You might filter out all the 0 values, we keep them to prevent any null pointer expetions!</maml:para> <maml:para>You can Filter for whatever parameter you like (e.g. with Select-Object)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Unifi5minutesSiteStats</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="attribs, UniFiAttributes"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>array containing attributes (strings) to be returned, defaults are all</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="attribs, UniFiAttributes"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>array containing attributes (strings) to be returned, defaults are all</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Defaults to the past 12 hours</maml:para> <maml:para>"bytes" are no longer returned with controller version 4.9.1 and later</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-Unifi5minutesSiteStats</dev:code> <dev:remarks> <maml:para>Get statistics in 5 minute segments for a complete UniFi in the default site</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>(Get-Unifi5minutesSiteStats -Start '1548971935421' -End '1548975579019')</dev:code> <dev:remarks> <maml:para>Get statistics in 5 minute segments for a complete UniFi in the default site for a given time period.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>(Get-Unifi5minutesSiteStats -Start '1548980058135')</dev:code> <dev:remarks> <maml:para>Get statistics in 5 minute segments for a complete UniFi in the default site for the last 60 minutes (was the timestamp while the sample was created)</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>(Get-Unifi5minutesSiteStats -UnifiSite 'contoso')[-1]</dev:code> <dev:remarks> <maml:para>Get statistics in 5 minute segments for a complete UniFi in the site 'contoso'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-Unifi5minutesSiteStats -Attributes 'bytes','wan-tx_bytes','wan-rx_bytes','wlan_bytes','num_sta','lan-num_sta','wlan-num_sta')</dev:code> <dev:remarks> <maml:para>Get all Values from the API</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Get-Unifi5minutesSiteStats.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertFrom-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UnifiDailyApStats</command:name> <command:verb>Get</command:verb> <command:noun>UnifiDailyApStats</command:noun> <maml:description> <maml:para>Get daily stats Access Point stats</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get daily stats for all or just one access points in a given UniFi site For convenience, we return the traffic Megabytes and not in bytes (as the UniFi does it). We also return real timestamps instead of the unix timestaps that the UniFi returns</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiDailyApStats</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Defaults to the past 7 days (7*24 hours) UniFi controller older then 4.6.6 keeps the statistics only for 5 hours. And it depends on your controller settings (Setup in "Settings/Maintenance" in the "DATA RETENTION" Block)</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-UnifiDailyApStats</dev:code> <dev:remarks> <maml:para>Get daily stats for all or just one access points in the default site</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-UnifiDailyApStats -Mac '78:8a:20:59:e6:88'</dev:code> <dev:remarks> <maml:para>Get daily stats for a given (78:8a:20:59:e6:88) access point in the default site</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>(Get-UnifiDailyApStats -Start '1548971935421' -End '1548975579019')</dev:code> <dev:remarks> <maml:para>Get the statistics for a given time period.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-UnifiDailyApStats -UnifiSite 'contoso' | Where-Object { ($_.ConnectedClients -ne '0') -and ($_.Traffic -ne '0.00') }</dev:code> <dev:remarks> <maml:para>Get daily stats for all access points in the site 'contoso', results are filtered and display only if clients are connected and traffic is generated.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>(Get-UnifiDailyApStats -UnifiSite 'contoso')[-1]</dev:code> <dev:remarks> <maml:para>Get daily stats for all access points in the site 'contoso'</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Get-UnifiDailyApStats.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertFrom-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UnifiDailyClientStats</command:name> <command:verb>Get</command:verb> <command:noun>UnifiDailyClientStats</command:noun> <maml:description> <maml:para>Get daily user/client statistics for a given user/client</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get daily user/client statistics for a given user/client</maml:para> <maml:para>For convenience, we return the a bit more then the API, e.g. everything in KB, MB, GB, and TB instead of just bytes We also return real timestamps instead of the unix timestaps in miliseconds that the UniFi returns</maml:para> <maml:para>Sample output: Time : 2/1/2019 1:00:00 AM rx_bytes : 105.0 rx_kb : 0.10 rx_mb : 0.00 rx_gb : 0.00 rx_tb : 0.00 rx_rate : 650000.0 rx_rate_mbps : 634.77 rx_retries : 0 rx_packets : 2.5 tx_bytes : 213.0 tx_kb : 0.21 tx_mb : 0.00 tx_gb : 0.00 tx_tb : 0.00 tx_rate : 650000.0 tx_rate_mbps : 634.77 tx_retries : 1 tx_packets : 4.5 Traffic_bytes : 318 Traffic_kb : 0.31 Traffic_mb : 0.00 Traffic_gb : 0.00 Traffic_tb : 0.00 Signal : -65 Signal_plain : -65.0</maml:para> <maml:para>In reality, we filter out all 0.00 values (e.g. tx_mb above) You can Filter for whatever parameter you like (e.g. with Select-Object)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiDailyClientStats</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address (required)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="attribs, UniFiAttributes"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>array containing attributes (strings) to be returned, defaults to rx_bytes and tx_bytes</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address (required)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="attribs, UniFiAttributes"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>array containing attributes (strings) to be returned, defaults to rx_bytes and tx_bytes</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>defaults to the past week (7*24 hours) Ubiquiti announced this with the Controller version 5.8 - It will not work on older versions! Make sure that "Clients Historical Data" (Collect clients' historical data) has been enabled in the UniFi controller in "Settings/Maintenance"</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-UnifiDailyClientStats -Mac '78:8a:20:59:e6:88'</dev:code> <dev:remarks> <maml:para>Get daily user/client statistics for given (78:8a:20:59:e6:88) user/client in the default site</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>(Get-UnifiDailyClientStats -Mac '78:8a:20:59:e6:88' -Start '1548971935421' -End '1548975579019')</dev:code> <dev:remarks> <maml:para>Get daily user/client statistics for a given (78:8a:20:59:e6:88) user/client in the default site for a given time period.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>(Get-UnifiDailyClientStats -Mac '78:8a:20:59:e6:88' -Start '1548980058135')</dev:code> <dev:remarks> <maml:para>Get daily user/client statistics for a given (78:8a:20:59:e6:88) user/client in the default site for the last 60 minutes (was the timestamp while the sample was created)</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>(Get-UnifiDailyClientStats -Mac '78:8a:20:59:e6:88' -UnifiSite 'contoso')[-1]</dev:code> <dev:remarks> <maml:para>Get daily user/client statistics for a given (78:8a:20:59:e6:88) user/client in the site 'contoso'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-UnifiDailyClientStats -Mac '78:8a:20:59:e6:88' -Attributes 'rx_bytes', 'tx_bytes', 'signal', 'rx_rate', 'tx_rate', 'rx_retries', 'tx_retries', 'rx_packets', 'tx_packets')</dev:code> <dev:remarks> <maml:para>Get all Values from the API</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Get-UnifiDailyClientStats.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertFrom-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UnifiDailyGatewayStats</command:name> <command:verb>Get</command:verb> <command:noun>UnifiDailyGatewayStats</command:noun> <maml:description> <maml:para>Get daily statistics for the USG</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get daily statistics for the USG (UniFi Secure Gateway)</maml:para> <maml:para>For convenience, we return the a bit more then the API, e.g. everything in KB, MB, GB, and TB instead of just bytes We also return real timestamps instead of the unix timestaps in miliseconds that the UniFi returns</maml:para> <maml:para>Sample output: Time : 2/1/2019 1:00:00 AM mem : 33.23 cpu : 3.25 lan-rx_errors : 0 lan-rx_bytes : 1715484318.69231 lan-rx_kb : 1675277.65 lan-rx_mb : 1636.01 lan-rx_gb : 1.6 lan-rx_packets : 16370719.6153846 lan-rx_dropped : 125 wan-rx_errors : 0 wan-rx_packets : 20559905.0769231 wan-rx_dropped : 1214 lan-tx_errors : 0 lan-tx_bytes : 30648673319.6923 lan-tx_kb : 29930345.04 lan-tx_mb : 29228.85 lan-tx_gb : 28.54 lan-tx_tb : 0.03 lan-tx_packets : 25358762.6923077 lan-tx_dropped : 0 wan-tx_errors : 0 wan-tx_bytes : 1047615654 wan-tx_kb : 1023062.16 wan-tx_mb : 999.08 wan-tx_gb : 0.98 wan-tx_packets : 11374571.2307692 wan-tx_dropped : 0</maml:para> <maml:para>You might filter out all the 0 values, we keep them to prevent any null pointer expetions!</maml:para> <maml:para>You can Filter for whatever parameter you like (e.g. with Select-Object)</maml:para> <maml:para>BUG: The loadavg_ attributes are not working at the moment. The UniFi SDN Controller does not return any values for them!</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiDailyGatewayStats</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="attribs, UniFiAttributes"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>array containing attributes (strings) to be returned, defaults to mem, cpu, and zime (Time is mandatory)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="attribs, UniFiAttributes"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>array containing attributes (strings) to be returned, defaults to mem, cpu, and zime (Time is mandatory)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Defaults to the past year (52 7 24 hours)</maml:para> <maml:para>A USG (UniFi Secure Gateway) is required on the site you querry!</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-UnifiDailyGatewayStats</dev:code> <dev:remarks> <maml:para>Get daily statistics for the USG (UniFi Secure Gateway) in the default site</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>(Get-UnifiDailyGatewayStats -Start '1548971935421' -End '1548975579019')</dev:code> <dev:remarks> <maml:para>Get daily statistics for the USG (UniFi Secure Gateway) in the default site for a given time period.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>(Get-UnifiDailyGatewayStats -Start '1548980058135')</dev:code> <dev:remarks> <maml:para>Get daily statistics for the USG (UniFi Secure Gateway) in the default site for the last 60 minutes (was the timestamp while the sample was created)</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>(Get-UnifiDailyGatewayStats -UnifiSite 'contoso')[-1]</dev:code> <dev:remarks> <maml:para>Get daily statistics for the USG (UniFi Secure Gateway) in the site 'contoso'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-UnifiDailyGatewayStats -Attributes 'mem','cpu','loadavg_5','lan-rx_errors','wan-rx_errors','lan-tx_errors','wan-tx_errors','lan-rx_bytes','wan-rx_bytes','lan-tx_bytes','wan-tx_bytes','lan-rx_packets','wan-rx_packets','lan-tx_packets','wan-tx_packets','lan-rx_dropped','wan-rx_dropped','lan-tx_dropped','wan-tx_dropped')</dev:code> <dev:remarks> <maml:para>Get all Values from the API</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Get-UnifiDailyGatewayStats.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertFrom-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UnifiDailySiteStats</command:name> <command:verb>Get</command:verb> <command:noun>UnifiDailySiteStats</command:noun> <maml:description> <maml:para>Get daily statistics for a complete Site</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get daily statistics for a complete UniFi Site</maml:para> <maml:para>For convenience, we return the a bit more then the API, e.g. everything in KB, MB, GB, and TB instead of just bytes</maml:para> <maml:para>We also return real timestamps instead of the unix timestaps in miliseconds that the UniFi returns</maml:para> <maml:para>Sample output: Time : 1/28/2019 7:00:00 AM wan-tx_bytes : 5943900.402553191 wan-tx_kb : 5804.59 wan-tx_mb : 5.67 wan-tx_gb : 0.01 wan-rx_bytes : 33117387.3812766 wan-rx_kb : 32341.2 wan-rx_mb : 31.58 wan-rx_gb : 0.03 wan_bytes : 39061287.783829791 wan_kb : 38145.79 wan_mb : 37.25 wan_gb : 0.04 wlan_bytes : 7030900.205833333 wlan_kb : 6866.11 wlan_mb : 6.71 wlan_gb : 0.01 Clients : 33 LAN_Clients : 29 WLAN_Clients : 4</maml:para> <maml:para>You might filter out all the 0 values, we keep them to prevent any null pointer expetions!</maml:para> <maml:para>You can Filter for whatever parameter you like (e.g. with Select-Object)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiDailySiteStats</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="attribs, UniFiAttributes"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>array containing attributes (strings) to be returned, defaults are all</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="attribs, UniFiAttributes"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>array containing attributes (strings) to be returned, defaults are all</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Defaults to the past 7 days (52 7 24 hours)</maml:para> <maml:para>"bytes" are no longer returned with controller version 4.9.1 and later</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-UnifiDailySiteStats</dev:code> <dev:remarks> <maml:para>Get daily statistics for a complete UniFi for the default site</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>(Get-UnifiDailySiteStats -Start '1548971935421' -End '1548975579019')</dev:code> <dev:remarks> <maml:para>Get daily statistics for a complete UniFi for the default site for a given time period.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>(Get-UnifiDailySiteStats -Start '1548980058135')</dev:code> <dev:remarks> <maml:para>Get daily statistics for a complete UniFi for the default site for the last 60 minutes (was the timestamp while the sample was created)</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>(Get-UnifiDailySiteStats -UnifiSite 'contoso')[-1]</dev:code> <dev:remarks> <maml:para>Get daily statistics for a complete UniFi for the site 'contoso'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-UnifiDailySiteStats -Attributes 'bytes','wan-tx_bytes','wan-rx_bytes','wlan_bytes','num_sta','lan-num_sta','wlan-num_sta')</dev:code> <dev:remarks> <maml:para>Get all Values from the API</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Get-UnifiDailySiteStats.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertFrom-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UnifiFirewallGroupDetails</command:name> <command:verb>Get</command:verb> <command:noun>UnifiFirewallGroupDetails</command:noun> <maml:description> <maml:para>Get the details about one Firewall Group via the API of the UniFi Controller</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the details about one Firewall Group via the API of the UniFi Controller</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiFirewallGroupDetails</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="FirewallGroupId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID (_id) of the Firewall Group you would like to get detaild information about. Multiple values are supported.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-UnifiFirewallGroupDetails</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="FirewallGroupName"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The Name (not the _id) of the Firewall Group you would like to get detaild information about. Multiple values are supported.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="FirewallGroupId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID (_id) of the Firewall Group you would like to get detaild information about. Multiple values are supported.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="FirewallGroupName"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The Name (not the _id) of the Firewall Group you would like to get detaild information about. Multiple values are supported.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Initial Release with 1.0.7</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-UnifiFirewallGroupDetails -id 'ba7e58be13574ef4881a79c3'</dev:code> <dev:remarks> <maml:para>Get the details about the Firewall Group with ID ba7e58be13574ef4881a79c3 via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-UnifiFirewallGroupDetails -name 'MyExtDNS'</dev:code> <dev:remarks> <maml:para>Get the details about the Firewall Group MyExtDNS via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-UnifiFirewallGroupDetails -name 'MyExtDNS', 'MailHost'</dev:code> <dev:remarks> <maml:para>Get the details about the Firewall Groups MyExtDNS and MailHost via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-UnifiFirewallGroupDetails -id 'ba7e58be13574ef4881a79c3', '2437bdf7fdf04f1a96c0fd32'</dev:code> <dev:remarks> <maml:para>Get the details about the Firewall Groups with IDs ba7e58be13574ef4881a79c3 and 2437bdf7fdf04f1a96c0fd32 via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-UnifiFirewallGroupDetails -id 'ba7e58be13574ef4881a79c3' -UnifiSite 'Contoso'</dev:code> <dev:remarks> <maml:para>Get the details about the Firewall Groups with ID ba7e58be13574ef4881a79c3 on Site 'Contoso' via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <dev:code>Get-UnifiFirewallGroupDetails -name 'MailHost' -UnifiSite 'Contoso'</dev:code> <dev:remarks> <maml:para>Get the details about the Firewall Groups MailHost on Site 'Contoso' via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Get-UnifiFirewallGroupDetails.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/jhochwald/UniFiTooling/issues/10</maml:linkText> <maml:uri>https://github.com/jhochwald/UniFiTooling/issues/10</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UnifiFirewallGroups</command:name> <command:verb>Get</command:verb> <command:noun>UnifiFirewallGroups</command:noun> <maml:description> <maml:para>Get a List Firewall Groups via the API of the UniFi Controller</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a List Firewall Groups via the API of the Ubiquiti UniFi Controller</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiFirewallGroups</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Initial version of the Ubiquiti UniFi Controller automation function</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-UnifiFirewallGroups</dev:code> <dev:remarks> <maml:para>Get a List Firewall Groups via the API of the Ubiquiti UniFi Controller</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-UnifiFirewallGroups -UnifiSite 'Contoso'</dev:code> <dev:remarks> <maml:para>Get a List Firewall Groups on Site 'Contoso' via the API of the Ubiquiti UniFi Controller</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Get-UnifiFirewallGroups.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UnifiHourlyApStats</command:name> <command:verb>Get</command:verb> <command:noun>UnifiHourlyApStats</command:noun> <maml:description> <maml:para>Get hourly stats Access Point stats</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get hourly stats for all or just one access points in a given UniFi site For convenience, we return the traffic Megabytes and not in bytes (as the UniFi does it). We also return real timestamps instead of the unix timestaps that the UniFi returns</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiHourlyApStats</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Defaults to the past 7 days (7*24 hours) UniFi controller older then 4.6.6 keeps the statistics only for 5 hours. And it depends on your controller settings (Setup in "Settings/Maintenance" in the "DATA RETENTION" Block)</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-UnifiHourlyApStats</dev:code> <dev:remarks> <maml:para>Get hourly stats for all or just one access points in the default site</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-UnifiHourlyApStats -Mac '78:8a:20:59:e6:88'</dev:code> <dev:remarks> <maml:para>Get hourly stats for a given (78:8a:20:59:e6:88) access point in the default site</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>(Get-UnifiHourlyApStats -Start '1548971935421' -End '1548975579019')</dev:code> <dev:remarks> <maml:para>Get the statistics for a given time period.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>(Get-UnifiHourlyApStats -Start '1548971935421')</dev:code> <dev:remarks> <maml:para>Get hourly stats for the last 2 hours (was the timestamp while the sample was created)</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-UnifiHourlyApStats -UnifiSite 'contoso' | Where-Object { ($_.ConnectedClients -ne '0') -and ($_.Traffic -ne '0.00') }</dev:code> <dev:remarks> <maml:para>Get hourly stats for all access points in the site 'contoso', results are filtered and display only if clients are connected and traffic is generated.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <dev:code>(Get-UnifiHourlyApStats -UnifiSite 'contoso')[-1]</dev:code> <dev:remarks> <maml:para>Get hourly stats for all access points in the site 'contoso'</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Get-UnifiHourlyApStats.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertFrom-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UnifiHourlyClientStats</command:name> <command:verb>Get</command:verb> <command:noun>UnifiHourlyClientStats</command:noun> <maml:description> <maml:para>Get hourly user/client statistics for a given user/client</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get hourly user/client statistics for a given user/client</maml:para> <maml:para>For convenience, we return the a bit more then the API, e.g. everything in KB, MB, GB, and TB instead of just bytes We also return real timestamps instead of the unix timestaps in miliseconds that the UniFi returns</maml:para> <maml:para>Sample output: Time : 2/1/2019 4:00:00 PM rx_bytes : 105.0 rx_kb : 0.10 rx_mb : 0.00 rx_gb : 0.00 rx_tb : 0.00 rx_rate : 650000.0 rx_rate_mbps : 634.77 rx_retries : 0 rx_packets : 2.5 tx_bytes : 213.0 tx_kb : 0.21 tx_mb : 0.00 tx_gb : 0.00 tx_tb : 0.00 tx_rate : 650000.0 tx_rate_mbps : 634.77 tx_retries : 1 tx_packets : 4.5 Traffic_bytes : 318 Traffic_kb : 0.31 Traffic_mb : 0.00 Traffic_gb : 0.00 Traffic_tb : 0.00 Signal : -65 Signal_plain : -65.0</maml:para> <maml:para>In reality, we filter out all 0.00 values (e.g. tx_mb above) You can Filter for whatever parameter you like (e.g. with Select-Object)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiHourlyClientStats</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address (required)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="attribs, UniFiAttributes"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>array containing attributes (strings) to be returned, defaults to rx_bytes and tx_bytes</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address (required)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="attribs, UniFiAttributes"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>array containing attributes (strings) to be returned, defaults to rx_bytes and tx_bytes</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Defaults to the past week (7*24 hours)</maml:para> <maml:para>Ubiquiti announced this with the Controller version 5.8 - It will not work on older versions!</maml:para> <maml:para>Make sure that "Clients Historical Data" (Collect clients' historical data) has been enabled in the UniFi controller in "Settings/Maintenance"</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-UnifiHourlyClientStats -Mac '78:8a:20:59:e6:88'</dev:code> <dev:remarks> <maml:para>Get hourly user/client statistics for a given (78:8a:20:59:e6:88) user/client in the default site</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>(Get-UnifiHourlyClientStats -Mac '78:8a:20:59:e6:88' -Start '1548971935421' -End '1548975579019')</dev:code> <dev:remarks> <maml:para>Get hourly user/client statistics for a given (78:8a:20:59:e6:88) user/client in the default site for a given time period.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>(Get-UnifiHourlyClientStats -Mac '78:8a:20:59:e6:88' -Start '1548980058135')</dev:code> <dev:remarks> <maml:para>Get hourly user/client statistics for a given (78:8a:20:59:e6:88) user/client in the default site for the last 60 minutes (was the timestamp while the sample was created)</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>(Get-UnifiHourlyClientStats -Mac '78:8a:20:59:e6:88' -UnifiSite 'contoso')[-1]</dev:code> <dev:remarks> <maml:para>Get hourly user/client statistics for a given (78:8a:20:59:e6:88) user/client in the site 'contoso'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-UnifiHourlyClientStats -Mac '78:8a:20:59:e6:88' -Attributes 'rx_bytes', 'tx_bytes', 'signal', 'rx_rate', 'tx_rate', 'rx_retries', 'tx_retries', 'rx_packets', 'tx_packets')</dev:code> <dev:remarks> <maml:para>Get all Values from the API</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Get-UnifiHourlyClientStats.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertFrom-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UnifiHourlyGatewayStats</command:name> <command:verb>Get</command:verb> <command:noun>UnifiHourlyGatewayStats</command:noun> <maml:description> <maml:para>Get hourly statistics for the USG</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get hourly statistics for the USG (UniFi Secure Gateway)</maml:para> <maml:para>For convenience, we return the a bit more then the API, e.g. everything in KB, MB, GB, and TB instead of just bytes We also return real timestamps instead of the unix timestaps in miliseconds that the UniFi returns</maml:para> <maml:para>Sample output: Time : 2/1/2019 6:00:00 PM mem : 33.29 cpu : 3.07 lan-rx_errors : 0 lan-rx_bytes : 50242070.25 lan-rx_kb : 49064.52 lan-rx_mb : 47.91 lan-rx_gb : 0.05 lan-rx_packets : 298575.0 lan-rx_dropped : 0 wan-rx_errors : 0 wan-rx_packets : 64705.74999999999 wan-rx_dropped : 0 lan-tx_errors : 0 lan-tx_bytes : 82506381.25 lan-tx_kb : 80572.64 lan-tx_mb : 78.68 lan-tx_gb : 0.08 lan-tx_packets : 310632.50000000006 lan-tx_dropped : 0 wan-tx_errors : 0 wan-tx_bytes : 16211129 wan-tx_kb : 15831.18 wan-tx_mb : 15.46 wan-tx_gb : 0.02 wan-tx_packets : 42872.99999999999 wan-tx_dropped : 0</maml:para> <maml:para>You might filter out all the 0 values, we keep them to prevent any null pointer expetions!</maml:para> <maml:para>You can Filter for whatever parameter you like (e.g. with Select-Object)</maml:para> <maml:para>BUG: The loadavg_ attributes are not working at the moment. The UniFi SDN Controller does not return any values for them!</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiHourlyGatewayStats</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="attribs, UniFiAttributes"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>array containing attributes (strings) to be returned, defaults to mem, cpu, and zime (Time is mandatory)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="attribs, UniFiAttributes"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>array containing attributes (strings) to be returned, defaults to mem, cpu, and zime (Time is mandatory)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Defaults to the past week (7*24 hours)</maml:para> <maml:para>A USG (UniFi Secure Gateway) is required on the site you querry!</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-UnifiHourlyGatewayStats</dev:code> <dev:remarks> <maml:para>Get hourly statistics for the USG (UniFi Secure Gateway) in the default site</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>(Get-UnifiHourlyGatewayStats -Start '1548971935421' -End '1548975579019')</dev:code> <dev:remarks> <maml:para>Get hourly statistics for the USG (UniFi Secure Gateway) in the default site for a given time period.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>(Get-UnifiHourlyGatewayStats -Start '1548980058135')</dev:code> <dev:remarks> <maml:para>Get hourly statistics for the USG (UniFi Secure Gateway) in the default site for the last 60 minutes (was the timestamp while the sample was created)</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>(Get-UnifiHourlyGatewayStats -UnifiSite 'contoso')[-1]</dev:code> <dev:remarks> <maml:para>Get hourly statistics for the USG (UniFi Secure Gateway) in the site 'contoso'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-UnifiHourlyGatewayStats -Attributes 'mem','cpu','loadavg_5','lan-rx_errors','wan-rx_errors','lan-tx_errors','wan-tx_errors','lan-rx_bytes','wan-rx_bytes','lan-tx_bytes','wan-tx_bytes','lan-rx_packets','wan-rx_packets','lan-tx_packets','wan-tx_packets','lan-rx_dropped','wan-rx_dropped','lan-tx_dropped','wan-tx_dropped')</dev:code> <dev:remarks> <maml:para>Get all Values from the API</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Get-UnifiHourlyGatewayStats.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertFrom-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UnifiHourlySiteStats</command:name> <command:verb>Get</command:verb> <command:noun>UnifiHourlySiteStats</command:noun> <maml:description> <maml:para>Get horly statistics for a complete Site</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get horly statistics for a complete UniFi Site</maml:para> <maml:para>For convenience, we return the a bit more then the API, e.g. everything in KB, MB, GB, and TB instead of just bytes</maml:para> <maml:para>We also return real timestamps instead of the unix timestaps in miliseconds that the UniFi returns</maml:para> <maml:para>Sample output: Time : 1/28/2019 8:00:00 AM wan-tx_bytes : 15674710.4243137 wan-tx_kb : 15307.33 wan-tx_mb : 14.95 wan-tx_gb : 0.01 wan-rx_bytes : 74608528.2870588 wan-rx_kb : 72859.89 wan-rx_mb : 71.15 wan-rx_gb : 0.07 wan_bytes : 90283238.7113726 wan_kb : 88167.23 wan_mb : 86.1 wan_gb : 0.08 wlan_bytes : 73033651.4499586 wlan_kb : 71321.93 wlan_mb : 69.65 wlan_gb : 0.07 Clients : 35 LAN_Clients : 30 WLAN_Clients : 5</maml:para> <maml:para>You might filter out all the 0 values, we keep them to prevent any null pointer expetions!</maml:para> <maml:para>You can Filter for whatever parameter you like (e.g. with Select-Object)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiHourlySiteStats</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="attribs, UniFiAttributes"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>array containing attributes (strings) to be returned, defaults are all</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>ID of the client-device to be modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="Startpoint, StartTime"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Startpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="EndPoint, EndTime"> <maml:name>End</maml:name> <maml:Description> <maml:para>Endpoint in UniFi Unix timestamp in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="attribs, UniFiAttributes"> <maml:name>Attributes</maml:name> <maml:Description> <maml:para>array containing attributes (strings) to be returned, defaults are all</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Defaults to the past day (24 hours)</maml:para> <maml:para>"bytes" are no longer returned with controller version 4.9.1 and later</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-UnifiHourlySiteStats</dev:code> <dev:remarks> <maml:para>Get horly statistics for a complete UniFi for the default site</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>(Get-UnifiHourlySiteStats -Start '1548971935421' -End '1548975579019')</dev:code> <dev:remarks> <maml:para>Get horly statistics for a complete UniFi for the default site for a given time period.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>(Get-UnifiHourlySiteStats -Start '1548980058135')</dev:code> <dev:remarks> <maml:para>Get horly statistics for a complete UniFi for the default site for the last 60 minutes (was the timestamp while the sample was created)</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>(Get-UnifiHourlySiteStats -UnifiSite 'contoso')[-1]</dev:code> <dev:remarks> <maml:para>Get horly statistics for a complete UniFi for the site 'contoso'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-UnifiHourlySiteStats -Attributes 'bytes','wan-tx_bytes','wan-rx_bytes','wlan_bytes','num_sta','lan-num_sta','wlan-num_sta')</dev:code> <dev:remarks> <maml:para>Get all Values from the API</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Get-UnifiHourlySiteStats.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertFrom-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UnifiNetworkDetails</command:name> <command:verb>Get</command:verb> <command:noun>UnifiNetworkDetails</command:noun> <maml:description> <maml:para>Get the details about one network via the API of the UniFi Controller</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the details about one network via the API of the UniFi Controller</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiNetworkDetails</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="UnifiNetwork, UnifiNetworkId, NetworkId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID (network_id) of the network you would like to get detaild information about. Multiple values are supported.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-UnifiNetworkDetails</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="UnifiNetworkName, NetworkName"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The Name (not the ID/network_id) of the network you would like to get detaild information about. Multiple values are supported.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="UnifiNetwork, UnifiNetworkId, NetworkId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID (network_id) of the network you would like to get detaild information about. Multiple values are supported.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="UnifiNetworkName, NetworkName"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The Name (not the ID/network_id) of the network you would like to get detaild information about. Multiple values are supported.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>The parameter UnifiNetwork is now an Alias. If the UnifiNetwork parameter is used, it must(!) be the ID (network_id). This was necessary to make it a non breaking change.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-UnifiNetworkDetails -id 'ba7e58be13574ef4881a79c3'</dev:code> <dev:remarks> <maml:para>Get the details about the network with ID ba7e58be13574ef4881a79c3 via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-UnifiNetworkDetails -UnifiNetwork 'ba7e58be13574ef4881a79c3'</dev:code> <dev:remarks> <maml:para>Same as above, with the legacy parameter alias used.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-UnifiNetworkDetails -name 'JoshHome'</dev:code> <dev:remarks> <maml:para>Get the details about the network JoshHome via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-UnifiNetworkDetails -name 'JoshHome', 'JohnHome'</dev:code> <dev:remarks> <maml:para>Get the details about the networks JoshHome and JohnHome via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-UnifiNetworkDetails -id 'ba7e58be13574ef4881a79c3', '2437bdf7fdf04f1a96c0fd32'</dev:code> <dev:remarks> <maml:para>Get the details about the networks with IDs ba7e58be13574ef4881a79c3 and 2437bdf7fdf04f1a96c0fd32 via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <dev:code>Get-UnifiNetworkDetails -id 'ba7e58be13574ef4881a79c3' -UnifiSite 'Contoso'</dev:code> <dev:remarks> <maml:para>Get the details about the network with ID ba7e58be13574ef4881a79c3 on Site 'Contoso' via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 7 --------------------------</maml:title> <dev:code>Get-UnifiNetworkDetails -name 'JoshHome' -UnifiSite 'Contoso'</dev:code> <dev:remarks> <maml:para>Get the details about the network JoshHome on Site 'Contoso' via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Get-UnifiNetworkDetails.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UnifiNetworkList</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UnifiNetworkList</command:name> <command:verb>Get</command:verb> <command:noun>UnifiNetworkList</command:noun> <maml:description> <maml:para>Get a List Networks via the API of the UniFi Controller</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a List Networks via the API of the Ubiquiti UniFi Controller</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiNetworkList</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Initial version of the Ubiquiti UniFi Controller automation function</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-UnifiNetworkList</dev:code> <dev:remarks> <maml:para>Get a List Networks via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-UnifiNetworkList -UnifiSite 'Contoso'</dev:code> <dev:remarks> <maml:para>Get a List Networks on Site 'Contoso' via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Get-UnifiNetworkList.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UnifiSpeedTestResult</command:name> <command:verb>Get</command:verb> <command:noun>UnifiSpeedTestResult</command:noun> <maml:description> <maml:para>Get the UniFi Security Gateway (USG) Speed Test results</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the UniFi Security Gateway (USG) Speed Test results</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiSpeedTestResult</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Start"> <maml:name>StartDate</maml:name> <maml:Description> <maml:para>Start date (valid Date String) Default is now</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="hours"> <maml:name>Timeframe</maml:name> <maml:Description> <maml:para>Timeframe in hours, default is 24</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="none"> <maml:name>all</maml:name> <maml:Description> <maml:para>Get all existing Speed Test Results</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="none"> <maml:name>UniFiValues</maml:name> <maml:Description> <maml:para>Show results without modifications, like the UniFi Controller creates them</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="none"> <maml:name>last</maml:name> <maml:Description> <maml:para>Only test latest Speed Test Result will be displayed</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-UnifiSpeedTestResult</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Start"> <maml:name>StartDate</maml:name> <maml:Description> <maml:para>Start date (valid Date String) Default is now</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="none"> <maml:name>EndDate</maml:name> <maml:Description> <maml:para>End date (valid Date String), default is now minus 24 hours</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>(Get-Date)</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="none"> <maml:name>all</maml:name> <maml:Description> <maml:para>Get all existing Speed Test Results</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="none"> <maml:name>UniFiValues</maml:name> <maml:Description> <maml:para>Show results without modifications, like the UniFi Controller creates them</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="none"> <maml:name>last</maml:name> <maml:Description> <maml:para>Only test latest Speed Test Result will be displayed</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Start"> <maml:name>StartDate</maml:name> <maml:Description> <maml:para>Start date (valid Date String) Default is now</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="hours"> <maml:name>Timeframe</maml:name> <maml:Description> <maml:para>Timeframe in hours, default is 24</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="none"> <maml:name>EndDate</maml:name> <maml:Description> <maml:para>End date (valid Date String), default is now minus 24 hours</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>(Get-Date)</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="none"> <maml:name>all</maml:name> <maml:Description> <maml:para>Get all existing Speed Test Results</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="none"> <maml:name>UniFiValues</maml:name> <maml:Description> <maml:para>Show results without modifications, like the UniFi Controller creates them</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="none"> <maml:name>last</maml:name> <maml:Description> <maml:para>Only test latest Speed Test Result will be displayed</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Initial version that makes it more human readable. The filetring needs a few more tests</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-UnifiSpeedTestResult -last</dev:code> <dev:remarks> <maml:para>Only test latest Speed Test Result will be displayed</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-UnifiSpeedTestResult -all</dev:code> <dev:remarks> <maml:para>Get all the UniFi Security Gateway (USG) Speed Test results</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-UnifiSpeedTestResult -all | Sort-Object -Property time</dev:code> <dev:remarks> <maml:para>Get all the UniFi Security Gateway (USG) Speed Test results, sorted by date</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-UnifiSpeedTestResult | Select-Object -Property *</dev:code> <dev:remarks> <maml:para>Get the UniFi Security Gateway (USG) Speed Test results from the last 24 hours (default), returns all values</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-UnifiSpeedTestResult -UnifiSite 'Contoso'</dev:code> <dev:remarks> <maml:para>Get the UniFi Security Gateway (USG) Speed Test results from the last 24 hours (default)</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <dev:code>Get-UnifiSpeedTestResult -Timeframe 48</dev:code> <dev:remarks> <maml:para>Get the UniFi Security Gateway (USG) Speed Test results of the last 48 hours</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 7 --------------------------</maml:title> <dev:code>Get-UnifiSpeedTestResult -StartDate '1/16/2019 12:00 AM' -EndDate '1/16/2019 11:59:59 PM'</dev:code> <dev:remarks> <maml:para>Get the UniFi Security Gateway (USG) Speed Test results for a given time/date In the example, all results from 1/16/2019 (all day) will be returned</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Get-UnifiSpeedTestResult.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertFrom-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-UnixTimeStamp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-UniFiApiLogin</command:name> <command:verb>Invoke</command:verb> <command:noun>UniFiApiLogin</command:noun> <maml:description> <maml:para>Login to API of the UniFi Controller</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Login to API of the Ubiquiti UniFi Controller</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-UniFiApiLogin</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Initial version of the Ubiquiti UniFi Controller automation function</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Invoke-UniFiApiLogin</dev:code> <dev:remarks> <maml:para>Login to API of the Ubiquiti UniFi Controller</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Invoke-UniFiApiLogin.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiCredentials</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogout</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-UniFiApiLogout</command:name> <command:verb>Invoke</command:verb> <command:noun>UniFiApiLogout</command:noun> <maml:description> <maml:para>Logout from the API of the UniFi Controller</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Logout from the API of the Ubiquiti UniFi Controller</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-UniFiApiLogout</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Initial version of the Ubiquiti UniFi Controller automation function</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Invoke-UniFiApiLogout</dev:code> <dev:remarks> <maml:para>Logout from the API of the Ubiquiti UniFi Controller</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Invoke-UniFiApiLogout.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-UnifiAuthorizeGuest</command:name> <command:verb>Invoke</command:verb> <command:noun>UnifiAuthorizeGuest</command:noun> <maml:description> <maml:para>Authorize a client device via the API of the UniFi Controller</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Authorize a client device via the API of the Ubiquiti UniFi Controller</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-UnifiAuthorizeGuest</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="UniFiMinutes"> <maml:name>Minutes</maml:name> <maml:Description> <maml:para>Minutes (from now) until authorization expires, the default is 60 (1 hour)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="UniFiUp"> <maml:name>Up</maml:name> <maml:Description> <maml:para>Upload speed limit in Kilobit per second (kbit/s)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="none"> <maml:name>Down</maml:name> <maml:Description> <maml:para>Download speed limit in Kilobit per second (kbit/s)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="6" aliases="MBytes, UniFiLimit, UniFiMBytes"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Data transfer limit in megabytes (MB), upload and download will be combined. The default is unlimited</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="7" aliases="UniFiAccessPoint, ApMac, UniFiApMac, ap_mac"> <maml:name>AccessPoint</maml:name> <maml:Description> <maml:para>MAC address of the Access Point to which client is connected, should result in a much faster authorization</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="UniFiMinutes"> <maml:name>Minutes</maml:name> <maml:Description> <maml:para>Minutes (from now) until authorization expires, the default is 60 (1 hour)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="UniFiUp"> <maml:name>Up</maml:name> <maml:Description> <maml:para>Upload speed limit in Kilobit per second (kbit/s)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="none"> <maml:name>Down</maml:name> <maml:Description> <maml:para>Download speed limit in Kilobit per second (kbit/s)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="6" aliases="MBytes, UniFiLimit, UniFiMBytes"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Data transfer limit in megabytes (MB), upload and download will be combined. The default is unlimited</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="7" aliases="UniFiAccessPoint, ApMac, UniFiApMac, ap_mac"> <maml:name>AccessPoint</maml:name> <maml:Description> <maml:para>MAC address of the Access Point to which client is connected, should result in a much faster authorization</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Initial version of the Ubiquiti UniFi Controller automation function</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Invoke-UnifiAuthorizeGuest -Mac '84:3a:4b:cd:88:2D'</dev:code> <dev:remarks> <maml:para>Authorize a client device via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Invoke-UnifiAuthorizeGuest -Mac '84:3a:4b:cd:88:2D' -AccessPoint '788a2059c699'</dev:code> <dev:remarks> <maml:para>Authorize a client device via the API of the UniFi Controller, it used the AccessPoint with the Mac address 78:8a:20:59:c6:99 directly for a faster authorization</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Invoke-UnifiAuthorizeGuest -Mac '843a4bcd882D' -Minutes 180</dev:code> <dev:remarks> <maml:para>Authorize a client device for 180 minutes via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Invoke-UnifiAuthorizeGuest -Mac '843a4bcd882D' -Up 1024 -Down 2048</dev:code> <dev:remarks> <maml:para>Authorize a client device with a restriction of 1024 kbit/s upload rate and 2048 kbit/s download rate via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Invoke-UnifiAuthorizeGuest -Mac '843a4bcd882D' -Limit 102400</dev:code> <dev:remarks> <maml:para>Authorize a client device with a limitation of via 102400 megabytes of traffic (combined) the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <dev:code>Invoke-UnifiAuthorizeGuest '84-3a-4b-cd-88-2D' -UnifiSite 'Contoso'</dev:code> <dev:remarks> <maml:para>Authorize a client device on site 'Contoso' via the API of the UniFi Controller (The function will normalize the MAC Address for us)</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Invoke-UnifiAuthorizeGuest.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-UnifiBlockClient</command:name> <command:verb>Invoke</command:verb> <command:noun>UnifiBlockClient</command:noun> <maml:description> <maml:para>Block a client device via the API of the UniFi Controller</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Block a client device via the API of the Ubiquiti UniFi Controller</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-UnifiBlockClient</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Initial version of the Ubiquiti UniFi Controller automation function</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Invoke-UnifiBlockClient -Mac '84:3a:4b:cd:88:2D'</dev:code> <dev:remarks> <maml:para>Block a client device via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Invoke-UnifiBlockClient -Mac '84:3a:4b:cd:88:2D' -UnifiSite 'Contoso'</dev:code> <dev:remarks> <maml:para>Block a client device on Site 'Contoso' via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Invoke-UnifiBlockClient.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-UnifiForgetClient</command:name> <command:verb>Invoke</command:verb> <command:noun>UnifiForgetClient</command:noun> <maml:description> <maml:para>Forget one or more client devices via the API of the UniFi Controller</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Forget one or more client devices via the API of the Ubiquiti UniFi Controller</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-UnifiForgetClient</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Initial version of the Ubiquiti UniFi Controller automation function</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Invoke-UnifiForgetClient -Mac '84:3a:4b:cd:88:2D'</dev:code> <dev:remarks> <maml:para>Forget one or more client devices via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Invoke-UnifiForgetClient -Mac '84:3a:4b:cd:88:2D' -UnifiSite 'Contoso'</dev:code> <dev:remarks> <maml:para>Forget one or more client devices on Site 'Contoso' via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Invoke-UnifiForgetClient.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-UnifiReconnectClient</command:name> <command:verb>Invoke</command:verb> <command:noun>UnifiReconnectClient</command:noun> <maml:description> <maml:para>Reconnect a client device via the API of the UniFi Controller</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Reconnect a client device via the API of the Ubiquiti UniFi Controller</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-UnifiReconnectClient</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Initial version of the Ubiquiti UniFi Controller automation function</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Invoke-UnifiReconnectClient -Mac '84:3a:4b:cd:88:2D'</dev:code> <dev:remarks> <maml:para>Reconnect a client device via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Invoke-UnifiReconnectClient -Mac '84:3a:4b:cd:88:2D' -UnifiSite 'Contoso'</dev:code> <dev:remarks> <maml:para>Reconnect a client device on Site 'Contoso' via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Invoke-UnifiReconnectClient.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-UnifiUnauthorizeGuest</command:name> <command:verb>Invoke</command:verb> <command:noun>UnifiUnauthorizeGuest</command:noun> <maml:description> <maml:para>Unauthorize a client device via the API of the UniFi Controller</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Unauthorize a client device via the API of the Ubiquiti UniFi Controller</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-UnifiUnauthorizeGuest</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Initial version of the Ubiquiti UniFi Controller automation function</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Invoke-UnifiUnauthorizeGuest -Mac '84:3a:4b:cd:88:2D'</dev:code> <dev:remarks> <maml:para>Unauthorize a client device via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Invoke-UnifiUnauthorizeGuest -Mac '84:3a:4b:cd:88:2D' -UnifiSite 'Contoso'</dev:code> <dev:remarks> <maml:para>Unauthorize a client device on Site 'Contoso' via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Invoke-UnifiUnauthorizeGuest.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-UnifiUnblockClient</command:name> <command:verb>Invoke</command:verb> <command:noun>UnifiUnblockClient</command:noun> <maml:description> <maml:para>Unblock a client device via the API of the UniFi Controller</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Unblock a client device via the API of the Ubiquiti UniFi Controller</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-UnifiUnblockClient</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Initial version of the Ubiquiti UniFi Controller automation function</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Invoke-UnifiUnblockClient -Mac '84:3a:4b:cd:88:2D'</dev:code> <dev:remarks> <maml:para>Unblock a client device via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Invoke-UnifiUnblockClient -Mac '84:3a:4b:cd:88:2D' -UnifiSite 'Contoso'</dev:code> <dev:remarks> <maml:para>Unblock a client device on Site 'Contoso' via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Invoke-UnifiUnblockClient.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-UnifiClientDevice</command:name> <command:verb>New</command:verb> <command:noun>UnifiClientDevice</command:noun> <maml:description> <maml:para>Create a new user/client-device via the API of the UniFi Controller</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a new user/client-device via the API of the Ubiquiti UniFi Controller</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-UnifiClientDevice</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="UniFiGroup, ClientGroup, UserGroup"> <maml:name>Group</maml:name> <maml:Description> <maml:para>Value for the user group the new user/client-device should belong to which can be obtained from the output of XXX</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="UniFiName, ClientName, UserName"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name to be given to the new user/client-device (optional)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="UnifiNote, UserNote, ClientNote"> <maml:name>Note</maml:name> <maml:Description> <maml:para>Note to be applied to the new user/client-device (optional)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="UniFiMac, MacAddress"> <maml:name>Mac</maml:name> <maml:Description> <maml:para>Client MAC address</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="UniFiGroup, ClientGroup, UserGroup"> <maml:name>Group</maml:name> <maml:Description> <maml:para>Value for the user group the new user/client-device should belong to which can be obtained from the output of XXX</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="UniFiName, ClientName, UserName"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name to be given to the new user/client-device (optional)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="UnifiNote, UserNote, ClientNote"> <maml:name>Note</maml:name> <maml:Description> <maml:para>Note to be applied to the new user/client-device (optional)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Initial version of the Ubiquiti UniFi Controller automation function</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>New-UnifiClientDevice -Mac '84:3a:4b:cd:88:2D' -Group 'Value2'</dev:code> <dev:remarks> <maml:para>Create a new user/client-device</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>New-UnifiClientDevice -Mac '84:3a:4b:cd:88:2D' -Group 'Value2' -UnifiSite 'Contoso'</dev:code> <dev:remarks> <maml:para>Create a new user/client-device on Site 'Contoso'</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/New-UnifiClientDevice.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-UniFiConfig</command:name> <command:verb>New</command:verb> <command:noun>UniFiConfig</command:noun> <maml:description> <maml:para>Creates the UniFi config JSON file</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates the UniFi config JSON file. If no input is given it creates one with all the defaults.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-UniFiConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="enUniFiUsername"> <maml:name>UniFiUsername</maml:name> <maml:Description> <maml:para>The login of a UniFi User with admin rights</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Unfi.admin.user</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="enUniFiPassword"> <maml:name>UniFiPassword</maml:name> <maml:Description> <maml:para>The password for the user given above. It is clear text for now. I know... But the Ubiquiti UniFi Controller seems to understand plain text only.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MySuperSecretPassworHere</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="enUniFiProtocol"> <maml:name>UniFiProtocol</maml:name> <maml:Description> <maml:para>Valid is http and https. default is https Please note: http is untested and it might not even work!</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Https</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="enUniFiSelfSignedCert"> <maml:name>UniFiSelfSignedCert</maml:name> <maml:Description> <maml:para>If you use a self signed certificate and/or a certificate from an untrusted CA, you might want to use true here. Default is FALSE</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="enUniFiHostname"> <maml:name>UniFiHostname</maml:name> <maml:Description> <maml:para>The Ubiquiti UniFi Controller you want to use. You can use a Fully-Qualified Host Name (FQHN) or an IP address.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Unifi.contoso.com</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="6" aliases="enUniFiPort"> <maml:name>UniFiPort</maml:name> <maml:Description> <maml:para>The port number that you have configured on your Ubiquiti UniFi Controller. The default is 8443</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8443</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="7" aliases="enConfigPath, ConfigPath"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Where to safe the JSON config. Default is the directory where you call the function. e.g. .\UniFiConfig.json</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>.\UniFiConfig.json</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="8" aliases="none"> <maml:name>force</maml:name> <maml:Description> <maml:para>Replaces the contents of a file, even if the file is read-only. Without this parameter, read-only files are not changed.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="enUniFiUsername"> <maml:name>UniFiUsername</maml:name> <maml:Description> <maml:para>The login of a UniFi User with admin rights</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Unfi.admin.user</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="enUniFiPassword"> <maml:name>UniFiPassword</maml:name> <maml:Description> <maml:para>The password for the user given above. It is clear text for now. I know... But the Ubiquiti UniFi Controller seems to understand plain text only.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MySuperSecretPassworHere</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="enUniFiProtocol"> <maml:name>UniFiProtocol</maml:name> <maml:Description> <maml:para>Valid is http and https. default is https Please note: http is untested and it might not even work!</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Https</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="enUniFiSelfSignedCert"> <maml:name>UniFiSelfSignedCert</maml:name> <maml:Description> <maml:para>If you use a self signed certificate and/or a certificate from an untrusted CA, you might want to use true here. Default is FALSE</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="enUniFiHostname"> <maml:name>UniFiHostname</maml:name> <maml:Description> <maml:para>The Ubiquiti UniFi Controller you want to use. You can use a Fully-Qualified Host Name (FQHN) or an IP address.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Unifi.contoso.com</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="6" aliases="enUniFiPort"> <maml:name>UniFiPort</maml:name> <maml:Description> <maml:para>The port number that you have configured on your Ubiquiti UniFi Controller. The default is 8443</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8443</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="7" aliases="enConfigPath, ConfigPath"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Where to safe the JSON config. Default is the directory where you call the function. e.g. .\UniFiConfig.json</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>.\UniFiConfig.json</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="8" aliases="none"> <maml:name>force</maml:name> <maml:Description> <maml:para>Replaces the contents of a file, even if the file is read-only. Without this parameter, read-only files are not changed.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Just an helper function to create a JSON config</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>New-UniFiConfig</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>New-UniFiConfig -UniFiUsername 'unfi.admin.user' -UniFiPassword 'mySuperSecretPassworHere' -UniFiProtocol 'https' -UniFiSelfSignedCert $true -UniFiHostname 'unifi.contoso.com' -UniFiPort '8443' -Path '.\UniFiConfig.json'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>New-UniFiConfig -UniFiUsername 'unfi.admin.user' -UniFiPassword 'mySuperSecretPassworHere' -UniFiProtocol 'https' -UniFiSelfSignedCert $true -UniFiHostname 'unifi.contoso.com' -UniFiPort '8443' -Path '.\UniFiConfig.json' -force</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/New-UniFiConfig.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiCredentials</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-UnifiFirewallGroup</command:name> <command:verb>Set</command:verb> <command:noun>UnifiFirewallGroup</command:noun> <maml:description> <maml:para>Get a given Firewall Group via the API of the UniFi Controller</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a given Firewall Group via the API of the Ubiquiti UniFi Controller</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-UnifiFirewallGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="FirewallGroup"> <maml:name>UnfiFirewallGroup</maml:name> <maml:Description> <maml:para>Unfi Firewall Group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="CidrInput"> <maml:name>UnifiCidrInput</maml:name> <maml:Description> <maml:para>IPv4 or IPv6 input List (PSObject)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="FirewallGroup"> <maml:name>UnfiFirewallGroup</maml:name> <maml:Description> <maml:para>Unfi Firewall Group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="CidrInput"> <maml:name>UnifiCidrInput</maml:name> <maml:Description> <maml:para>IPv4 or IPv6 input List (PSObject)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Initial version of the Ubiquiti UniFi Controller automation function</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Set-UnifiFirewallGroup -UnfiFirewallGroup 'Value1' -UnifiCidrInput $value2</dev:code> <dev:remarks> <maml:para>Get a given Firewall Group via the API of the Ubiquiti UniFi Controller</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Set-UnifiFirewallGroup.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UnifiFirewallGroups</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UnifiFirewallGroupBody</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-UnifiNetworkDetails</command:name> <command:verb>Set</command:verb> <command:noun>UnifiNetworkDetails</command:noun> <maml:description> <maml:para>Modifies one network via the API of the UniFi Controller</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Modifies one network via the API of the UniFi Controller</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-UnifiNetworkDetails</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="UnifiNetworkId, NetworkId"> <maml:name>UnifiNetwork</maml:name> <maml:Description> <maml:para>The ID (network_id) of the network you would like to get detailed information about.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="Body"> <maml:name>UniFiBody</maml:name> <maml:Description> <maml:para>JSON formed Body for the Request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="UnifiNetworkId, NetworkId"> <maml:name>UnifiNetwork</maml:name> <maml:Description> <maml:para>The ID (network_id) of the network you would like to get detailed information about.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="Body"> <maml:name>UniFiBody</maml:name> <maml:Description> <maml:para>JSON formed Body for the Request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="Site"> <maml:name>UnifiSite</maml:name> <maml:Description> <maml:para>UniFi Site as configured. The default is: default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Initial version of the Ubiquiti UniFi Controller automation function</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Set-UnifiNetworkDetails -UnifiNetwork $value1</dev:code> <dev:remarks> <maml:para>Get the details about one network via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Set-UnifiNetworkDetails -UnifiNetwork $value1 -UnifiSite 'Contoso'</dev:code> <dev:remarks> <maml:para>Get the details about one network on Site 'Contoso' via the API of the UniFi Controller</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Enatec/UniFiTooling/raw/master/docs/Set-UnifiNetworkDetails.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-UniFiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-UniFiDefaultRequestHeader</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-UniFiApiLogin</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |