en-US/Unifi-PS-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>Connect-UnifiController</command:name> <command:verb>Connect</command:verb> <command:noun>UnifiController</command:noun> <maml:description> <maml:para>Connect to a Unifi Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Connect-UnifiController function connects to the Unifi Controller, specified with Set-UnifiAPIConfig, with the given credentials.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-UnifiController</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>PSCredential Object containing the username and password used to connect to the Unifi Controller.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>PSCredential Object containing the username and password used to connect to the Unifi Controller.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-UnifiAPIConfig -BaseUri unifi.contoso.com PS C:\> Connect-UnifiController -Credential (Get-Credential)</dev:code> <dev:remarks> <maml:para>This example configures the connection with Set-UnifiAPIConfig, then connects to the BaseUri configured.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Connect-UnifiController.md</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>Disconnect-UnifiController</command:name> <command:verb>Disconnect</command:verb> <command:noun>UnifiController</command:noun> <maml:description> <maml:para>Disconnects from the Unifi Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disconnect-UnifiController function disconnects from the connected Unifi Controller.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disconnect-UnifiController</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Disconnect-UnifiController</dev:code> <dev:remarks> <maml:para>This example disconnects from 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/derpenstiltskin/unifi-ps/blob/master/docs/Disconnect-UnifiController.md</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-UnifiAdminUsers</command:name> <command:verb>Get</command:verb> <command:noun>UnifiAdminUsers</command:noun> <maml:description> <maml:para>Retrieves Unifi Controller admin users.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiAdminUsers function retrieves administrative users from the Unifi Controller.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiAdminUsers</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiAdminUsers</dev:code> <dev:remarks> <maml:para>This example retrieves the administrative users.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiAdminUsers.md</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-UnifiController</command:name> <command:verb>Get</command:verb> <command:noun>UnifiController</command:noun> <maml:description> <maml:para>Retrieves server details from the Unifi Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiController function retrieves server details from the Unifi Controller. This function does not require an existing logged in connection to a Unifi Controller.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiController</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>BaseUri</maml:name> <maml:Description> <maml:para>The address of the Unifi Controller, not including protocol or port.</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="False" position="1" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>TCP port used to connect to the Unifi Controller.</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="3" aliases="none"> <maml:name>SkipCertificateCheck</maml:name> <maml:Description> <maml:para>If true, skips the certificate check when sending requests to the REST API, needed if using a self-signed certificate on Unifi Controller.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>BaseUri</maml:name> <maml:Description> <maml:para>The address of the Unifi Controller, not including protocol or port.</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="False" position="1" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>TCP port used to connect to the Unifi Controller.</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="3" aliases="none"> <maml:name>SkipCertificateCheck</maml:name> <maml:Description> <maml:para>If true, skips the certificate check when sending requests to the REST API, needed if using a self-signed certificate on Unifi Controller.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiController -BaseUri unifi.contoso.com -Port 8443 -Protocol "https" -SkipCertificateCheck $true</dev:code> <dev:remarks> <maml:para>This example queries the Unifi Controller to retrieve the server details.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiController.md</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-UnifiLoggedInUser</command:name> <command:verb>Get</command:verb> <command:noun>UnifiLoggedInUser</command:noun> <maml:description> <maml:para>Retrieves details about the currently logged in user from the Unifi Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiLoggedInUser function retrieves details about the currently logged in user from the Unifi Controller.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiLoggedInUser</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiLoggedInUser</dev:code> <dev:remarks> <maml:para>This example connects retrieves the details about the currently logged in user.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiLoggedInUser.md</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-UnifiSite</command:name> <command:verb>Get</command:verb> <command:noun>UnifiSite</command:noun> <maml:description> <maml:para>Retrieves Unifi Controller site details.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiSite function retrieves details about a Unifi Controller site, by providing the site name.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiSite</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve details for.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve details for.</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:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiSite -SiteName "Contoso"</dev:code> <dev:remarks> <maml:para>This example retrieves details for the site named "Contoso".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiSite.md</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-UnifiSiteClients</command:name> <command:verb>Get</command:verb> <command:noun>UnifiSiteClients</command:noun> <maml:description> <maml:para>Retrieves clients that have connected to the Unifi Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiSiteClients function retrieves the clients that have connected to the Unifi Controller.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiSiteClients</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve clients for.</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="1" aliases="none"> <maml:name>ActiveOnly</maml:name> <maml:Description> <maml:para>If true, the Unifi Controller will only list the clients that are currently active.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ActiveOnly</maml:name> <maml:Description> <maml:para>If true, the Unifi Controller will only list the clients that are currently active.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve clients for.</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:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiSiteClients -SiteName "Contoso" -ActiveOnly $true</dev:code> <dev:remarks> <maml:para>This example retrieves active clients connected to the Unifi Controller site named "Contoso".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiSiteClients.md</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-UnifiSiteCountryCodes</command:name> <command:verb>Get</command:verb> <command:noun>UnifiSiteCountryCodes</command:noun> <maml:description> <maml:para>Retrieves list of site country codes from the Unifi Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiSiteCountryCodes function retrieves a listing of country codes from the Unifi Controller for the specified site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiSiteCountryCodes</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve country codes for.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve country codes for.</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:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiSiteCountryCodes -SiteName "Contoso"</dev:code> <dev:remarks> <maml:para>This example retrieves country codes for the site named "Contoso".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiSiteCountryCodes.md</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-UnifiSiteDDNSConfig</command:name> <command:verb>Get</command:verb> <command:noun>UnifiSiteDDNSConfig</command:noun> <maml:description> <maml:para>Retrieves site dynamic DNS configuration from the Unifi Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiSiteDDNSConfig function retrieves the dynamic DNS configuration from the Unifi Controller for the specified site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiSiteDDNSConfig</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve dynamic DNS configuration for.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve dynamic DNS configuration for.</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:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiSiteDDNSConfig -SiteName "Contoso"</dev:code> <dev:remarks> <maml:para>This example retrieves the dynamic DNS configuration for the site named "Contoso".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiSiteDDNSConfig.md</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-UnifiSiteDDNSInfo</command:name> <command:verb>Get</command:verb> <command:noun>UnifiSiteDDNSInfo</command:noun> <maml:description> <maml:para>Retrieves site dynamic DNS information from the Unifi Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiSiteDDNSInfo function retrieves the dynamic DNS information from the Unifi Controller for the specified site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiSiteDDNSInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve dynamic DNS information for.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve dynamic DNS information for.</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:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiSiteDDNSInfo -SiteName "Contoso"</dev:code> <dev:remarks> <maml:para>This example retrieves the dynamic DNS information for the site named "Contoso".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiSiteDDNSInfo.md</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-UnifiSiteDevices</command:name> <command:verb>Get</command:verb> <command:noun>UnifiSiteDevices</command:noun> <maml:description> <maml:para>Retrieves Unifi Controller site devices.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiSiteDevices function retrieves a listing of devices from the Unifi Controller for a spcified site. The output can either be in a basic or detailed format.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiSiteDevices</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve devices for.</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="1" aliases="none"> <maml:name>Detailed</maml:name> <maml:Description> <maml:para>If true, returns a detailed view of devices.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Detailed</maml:name> <maml:Description> <maml:para>If true, returns a detailed view of devices.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve devices for.</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:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiSiteDevices -SiteName "Contoso"</dev:code> <dev:remarks> <maml:para>This example returns a simple view of devices in the site named "Contoso".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiSiteDevices.md</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-UnifiSiteEvents</command:name> <command:verb>Get</command:verb> <command:noun>UnifiSiteEvents</command:noun> <maml:description> <maml:para>Retrieves Unifi Controller site events.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiSiteEvents function retrieves the last 3000 events from a Unifi Controller for a specified site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiSiteEvents</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve site alarms for.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve site alarms for.</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:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiSiteEvents -SiteName "Contoso"</dev:code> <dev:remarks> <maml:para>This example retrieves the last 3000 events for the site named "Contoso".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiSiteEvents.md</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-UnifiSiteHealth</command:name> <command:verb>Get</command:verb> <command:noun>UnifiSiteHealth</command:noun> <maml:description> <maml:para>Retrieves site health from Unifi Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiSiteHealth function retrieves the health status from a Unifi Controller</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiSiteHealth</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve site health for.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve site health for.</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:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiSiteHealth -SiteName "Contoso"</dev:code> <dev:remarks> <maml:para>This example retrieves the health status for the site named "Contoso".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiSiteHealth.md</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-UnifiSitePortForwards</command:name> <command:verb>Get</command:verb> <command:noun>UnifiSitePortForwards</command:noun> <maml:description> <maml:para>Retrieves site port forwards from the Unifi Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiSitePortForwards function retrieves the port forwards from the Unifi Controller for the specified site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiSitePortForwards</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve port forwards for.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve port forwards for.</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:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiSitePortForwards -SiteName "Contoso"</dev:code> <dev:remarks> <maml:para>This example retrieves the port forwards for the site named "Contoso".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiSitePortForwards.md</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-UnifiSiteRadiusAccounts</command:name> <command:verb>Get</command:verb> <command:noun>UnifiSiteRadiusAccounts</command:noun> <maml:description> <maml:para>Retrieves RADIUS accounts from the Unifi Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiSiteRadiusAccounts function retrieves RADIUS accounts from the Unifi Controller for the specified site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiSiteRadiusAccounts</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve RADIUS accounts for.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve RADIUS accounts for.</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:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiSiteRadiusAccounts -SiteName "Contoso"</dev:code> <dev:remarks> <maml:para>This example retrieves RADIUS accounts for the site named "Contoso".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiSiteRadiusAccounts.md</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-UnifiSiteRadiusProfiles</command:name> <command:verb>Get</command:verb> <command:noun>UnifiSiteRadiusProfiles</command:noun> <maml:description> <maml:para>Retrieves RADIUS profiles from the Unifi Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiSiteRadiusProfiles function retrieves RADIUS profiles from the Unifi Controller for the specified site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiSiteRadiusProfiles</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve RADIUS profiles for.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve RADIUS profiles for.</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:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiSiteRadiusProfiles -SiteName "Contoso"</dev:code> <dev:remarks> <maml:para>This example retrieves RADIUS profiles for the site named "Contoso".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiSiteRadiusAccounts.md</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-UnifiSiteRFChannels</command:name> <command:verb>Get</command:verb> <command:noun>UnifiSiteRFChannels</command:noun> <maml:description> <maml:para>Retrieves site RF channels from Unifi Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiSiteRFChannels function retrieves the RF channels in use from the Unifi Controller for a specified site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiSiteRFChannels</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve RF channels in use for.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve RF channels in use for.</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:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiSiteRFChannels -SiteName "Contoso"</dev:code> <dev:remarks> <maml:para>This example retrieves the RF channels in use for the site named "Contoso".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiSiteRFChannels.md</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-UnifiSiteRogueAPs</command:name> <command:verb>Get</command:verb> <command:noun>UnifiSiteRogueAPs</command:noun> <maml:description> <maml:para>Retrieves detected rogue access points from the Unifi Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiSiteRogueAPs function retrieves detected rogue access points from the Unifi Controller for the specified site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiSiteRogueAPs</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve detected rogue access points for.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve detected rogue access points for.</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:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiSiteRogueAPs -SiteName "Contoso"</dev:code> <dev:remarks> <maml:para>This example retrieves a list of rogue access points detected for the site named "Contoso".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiSiteRogueAPs.md</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-UnifiSiteRoutes</command:name> <command:verb>Get</command:verb> <command:noun>UnifiSiteRoutes</command:noun> <maml:description> <maml:para>Retrieves all routes from the Unifi Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiSiteRoutes function retrieves all routes from the Unifi Controller for the specified site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiSiteRoutes</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve all routes for.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve all routes for.</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:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiSiteRoutes -SiteName "Contoso"</dev:code> <dev:remarks> <maml:para>This example retrieves all routes for the site named "Contoso".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiSiteRoutes.md</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-UnifiSites</command:name> <command:verb>Get</command:verb> <command:noun>UnifiSites</command:noun> <maml:description> <maml:para>Retrieves site listing from the Unifi Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiSites function retrieves a listing of sites and optionally their health from a Unifi Controller.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiSites</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ShowHealth</maml:name> <maml:Description> <maml:para>Option to show health details for the sites retrieved.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ShowHealth</maml:name> <maml:Description> <maml:para>Option to show health details for the sites retrieved.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiSites -ShowHealth $true</dev:code> <dev:remarks> <maml:para>This example retrieves a listing of sites including their health.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiSites.md</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-UnifiSiteSpectrumScan</command:name> <command:verb>Get</command:verb> <command:noun>UnifiSiteSpectrumScan</command:noun> <maml:description> <maml:para>Retrieves spectrum scan results from the Unifi Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiSiteSpectrumScan function retrieves spectrum scan results from the Unifi Controller for the specified site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiSiteSpectrumScan</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve spectrum scan results for.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve spectrum scan results for.</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:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiSiteSpectrumScan -SiteName "Contoso"</dev:code> <dev:remarks> <maml:para>This example retrieves spectrum scan results for the site named "Contoso".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiSiteSpectrumScan.md</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-UnifiSiteSwitchPortProfiles</command:name> <command:verb>Get</command:verb> <command:noun>UnifiSiteSwitchPortProfiles</command:noun> <maml:description> <maml:para>Retrieves switch port profiles from the Unifi Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiSiteSwitchPortProfiles function retrieves spectrum scan results from the Unifi Controller for the specified site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiSiteSwitchPortProfiles</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve switch port profiles for.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve switch port profiles for.</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:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiSiteSwitchPortProfiles -SiteName "Contoso"</dev:code> <dev:remarks> <maml:para>This example retrieves switch port profiles for the site named "Contoso".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiSiteSwitchPortProfiles.md</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-UnifiSiteTaggedMACs</command:name> <command:verb>Get</command:verb> <command:noun>UnifiSiteTaggedMACs</command:noun> <maml:description> <maml:para>Retrieves tagged MAC addresses from the Unifi Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiSiteTaggedMACs function retrieves tagged MAC addresses from the Unifi Controller for the specified site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiSiteTaggedMACs</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve tagged MACs for.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve tagged MACs for.</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:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiSiteTaggedMACs -SiteName "Contoso"</dev:code> <dev:remarks> <maml:para>This example retrieves tagged MACs for the site named "Contoso".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiSiteTaggedMACs.md</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-UnifiSiteUserFirewallGroups</command:name> <command:verb>Get</command:verb> <command:noun>UnifiSiteUserFirewallGroups</command:noun> <maml:description> <maml:para>Retrieves custom firewall groups from the Unifi Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiSiteUserFirewallGroups function retrieves custom firewall groups from the Unifi Controller for the specified site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiSiteUserFirewallGroups</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve custom firewall groups for.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve custom firewall groups for.</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:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiSiteUserFirewallGroups -SiteName "Contoso"</dev:code> <dev:remarks> <maml:para>This example retrieves custom firewall groups for the site named "Contoso".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiSiteUserFirewallGroups.md</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-UnifiSiteUserFirewallRules</command:name> <command:verb>Get</command:verb> <command:noun>UnifiSiteUserFirewallRules</command:noun> <maml:description> <maml:para>Retrieves custom firewall rules from the Unifi Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiSiteUserFirewallRules function retrieves custom firewall rules from the Unifi Controller for the specified site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiSiteUserFirewallRules</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve custom firewall rules for.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve custom firewall rules for.</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:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiSiteUserFirewallRules -SiteName "Contoso"</dev:code> <dev:remarks> <maml:para>This example retrieves custom firewall rules for the site named "Contoso".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiSiteUserFirewallRules.md</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-UnifiSiteUserRoutes</command:name> <command:verb>Get</command:verb> <command:noun>UnifiSiteUserRoutes</command:noun> <maml:description> <maml:para>Retrieves custom routes from the Unifi Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-UnifiSiteUserRoutes function retrieves custom routes from the Unifi Controller for the specified site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UnifiSiteUserRoutes</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve custom routes for.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SiteName</maml:name> <maml:Description> <maml:para>The name of the site in the Unifi Controller to retrieve custom routes for.</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:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-UnifiSiteUserRoutes -SiteName "Contoso"</dev:code> <dev:remarks> <maml:para>This example retrieves custom routes for the site named "Contoso".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Get-UnifiSiteUserRoutes.md</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>Remove-UnifiAPIConfig</command:name> <command:verb>Remove</command:verb> <command:noun>UnifiAPIConfig</command:noun> <maml:description> <maml:para>Removes variables configured by Set-UnifiAPIConfig.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-UnifiAPIConfig clears the configuration set by Set-UnifiAPIConfig by removing the variables.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-UnifiAPIConfig</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-UnifiAPIConfig</dev:code> <dev:remarks> <maml:para>This example removes the Unifi configuration.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Remove-UnifiAPIConfig.md</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-UnifiAPIConfig</command:name> <command:verb>Set</command:verb> <command:noun>UnifiAPIConfig</command:noun> <maml:description> <maml:para>Sets the Unifi API configuration for connecting to a Unifi Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-UnifiAPIConfig function sets the Unifi API configuration items for connecting to a Unifi Controller. When the module loads, default values for Port (8443), Protocol (https), and SkipCertificateCheck (false) are set.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-UnifiAPIConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>BaseUri</maml:name> <maml:Description> <maml:para>The address of the Unifi Controller, not including protocol or port.</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="1" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>TCP port used to connect to the Unifi Controller.</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="3" aliases="none"> <maml:name>SkipCertificateCheck</maml:name> <maml:Description> <maml:para>If true, skips the certificate check when sending requests to the REST API, needed if using a self-signed certificate on Unifi Controller.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Session</maml:name> <maml:Description> <maml:para>Web Request session created when connecting to the Unifi Controller.</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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>BaseUri</maml:name> <maml:Description> <maml:para>The address of the Unifi Controller, not including protocol or port.</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="1" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>TCP port used to connect to the Unifi Controller.</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="4" aliases="none"> <maml:name>Session</maml:name> <maml:Description> <maml:para>Web Request session created when connecting to the Unifi Controller.</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="False" position="3" aliases="none"> <maml:name>SkipCertificateCheck</maml:name> <maml:Description> <maml:para>If true, skips the certificate check when sending requests to the REST API, needed if using a self-signed certificate on Unifi Controller.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-UnifiAPIConfig -BaseUri "unifi.contoso.com" -Port "8443" -Protocol "https" -SkipCertificateCheck $true</dev:code> <dev:remarks> <maml:para>This example sets the API configuration values for BaseUri, Port, Protocol, and SkipCertificateCheck.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/derpenstiltskin/unifi-ps/blob/master/docs/Set-UnifiAPIConfig.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |