WakeOnLanCmdlets.dll-Help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Invoke-WakeOnLan --> <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"> <command:details> <command:name>Invoke-WakeOnLan</command:name> <command:verb>Invoke</command:verb> <command:noun>WakeOnLan</command:noun> <maml:description> <maml:para>Sends Wake-on-LAN (WOL) packets to target computers and monitors their wake-up status.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Invoke-WakeOnLan cmdlet sends WOL packets to specified target computers via proxy computers. It supports single-target, multiple-target, and hashtable-based input scenarios. The cmdlet also monitors the wake-up status of the targets and provides results. Users can choose between synchronous and asynchronous execution modes.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: SingleTarget --> <command:syntaxItem> <maml:name>Invoke-WakeOnLan</maml:name> <!-- Parameter: ComputerName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The name of the target computer. This parameter is required for the "SingleTarget" parameter set.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MacAddress --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MacAddress</maml:name> <maml:description> <maml:para>The MAC address of the target computer. This parameter is required for the "SingleTarget" parameter set.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProxyComputerName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProxyComputerName</maml:name> <maml:description> <maml:para>The name of the proxy computer that sends the WOL packet. This parameter is required for the "SingleTarget" parameter set.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Async --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Async</maml:name> <maml:description> <maml:para>Runs the WOL operation asynchronously.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credentials for authenticating with the proxy computer, if required.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaxPingAttempts --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxPingAttempts</maml:name> <maml:description> <maml:para>The maximum number of ping attempts for monitoring. Defaults to 5.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>The port used for sending WOL packets. Defaults to 9.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>9</dev:defaultValue> </command:parameter> <!-- Parameter: TimeoutInSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutInSeconds</maml:name> <maml:description> <maml:para>The timeout period for monitoring, in seconds. Defaults to 60 seconds.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <!-- Parameter: WriteHost --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WriteHost</maml:name> <maml:description> <maml:para>If specified, results are written to the host instead of the output pipeline.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: MultipleTargets --> <command:syntaxItem> <maml:name>Invoke-WakeOnLan</maml:name> <!-- Parameter: ProxyToTargets --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProxyToTargets</maml:name> <maml:description> <maml:para>A dictionary mapping proxy computer names to their associated target systems. This parameter is required for the "MultipleTargets" parameter set.</maml:para> </maml:description> <command:parameterValue required="true">Dictionary`2</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.Dictionary`2[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.Collections.Generic.List`1[[System.ValueTuple`2[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Async --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Async</maml:name> <maml:description> <maml:para>Runs the WOL operation asynchronously.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credentials for authenticating with the proxy computer, if required.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaxPingAttempts --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxPingAttempts</maml:name> <maml:description> <maml:para>The maximum number of ping attempts for monitoring. Defaults to 5.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>The port used for sending WOL packets. Defaults to 9.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>9</dev:defaultValue> </command:parameter> <!-- Parameter: TimeoutInSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutInSeconds</maml:name> <maml:description> <maml:para>The timeout period for monitoring, in seconds. Defaults to 60 seconds.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <!-- Parameter: WriteHost --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WriteHost</maml:name> <maml:description> <maml:para>If specified, results are written to the host instead of the output pipeline.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: HashtableTargets --> <command:syntaxItem> <maml:name>Invoke-WakeOnLan</maml:name> <!-- Parameter: HashtableTargets --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>HashtableTargets</maml:name> <maml:description> <maml:para>A hashtable mapping proxy computer names to target systems. Each target must include keys for "MacAddress" and "ComputerName".</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Async --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Async</maml:name> <maml:description> <maml:para>Runs the WOL operation asynchronously.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credentials for authenticating with the proxy computer, if required.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaxPingAttempts --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxPingAttempts</maml:name> <maml:description> <maml:para>The maximum number of ping attempts for monitoring. Defaults to 5.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>The port used for sending WOL packets. Defaults to 9.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>9</dev:defaultValue> </command:parameter> <!-- Parameter: TimeoutInSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutInSeconds</maml:name> <maml:description> <maml:para>The timeout period for monitoring, in seconds. Defaults to 60 seconds.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <!-- Parameter: WriteHost --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WriteHost</maml:name> <maml:description> <maml:para>If specified, results are written to the host instead of the output pipeline.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: MacAddress --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MacAddress</maml:name> <maml:description> <maml:para>The MAC address of the target computer. This parameter is required for the "SingleTarget" parameter set.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ComputerName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The name of the target computer. This parameter is required for the "SingleTarget" parameter set.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProxyComputerName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProxyComputerName</maml:name> <maml:description> <maml:para>The name of the proxy computer that sends the WOL packet. This parameter is required for the "SingleTarget" parameter set.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProxyToTargets --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProxyToTargets</maml:name> <maml:description> <maml:para>A dictionary mapping proxy computer names to their associated target systems. This parameter is required for the "MultipleTargets" parameter set.</maml:para> </maml:description> <command:parameterValue required="true">Dictionary`2</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.Dictionary`2[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.Collections.Generic.List`1[[System.ValueTuple`2[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HashtableTargets --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>HashtableTargets</maml:name> <maml:description> <maml:para>A hashtable mapping proxy computer names to target systems. Each target must include keys for "MacAddress" and "ComputerName".</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>The port used for sending WOL packets. Defaults to 9.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>9</dev:defaultValue> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credentials for authenticating with the proxy computer, if required.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaxPingAttempts --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxPingAttempts</maml:name> <maml:description> <maml:para>The maximum number of ping attempts for monitoring. Defaults to 5.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <!-- Parameter: TimeoutInSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutInSeconds</maml:name> <maml:description> <maml:para>The timeout period for monitoring, in seconds. Defaults to 60 seconds.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <!-- Parameter: Async --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Async</maml:name> <maml:description> <maml:para>Runs the WOL operation asynchronously.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: WriteHost --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WriteHost</maml:name> <maml:description> <maml:para>If specified, results are written to the host instead of the output pipeline.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Invoke-WakeOnLan -MacAddress "00:11:22:33:44:55" -ComputerName "TargetPC" -ProxyComputerName "ProxyPC"</dev:code> <dev:remarks> <maml:para>Sends a WOL packet to the target computer "TargetPC" via the proxy computer "ProxyPC".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>$targets = @{ "Proxy1" = @( @{ MacAddress = "00:11:22:33:44:55"; ComputerName = "Target1" }, @{ MacAddress = "66:77:88:99:AA:BB"; ComputerName = "Target2" } ) } Invoke-WakeOnLan -HashtableTargets $targets</dev:code> <dev:remarks> <maml:para>Sends WOL packets to the specified targets using the hashtable input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>$proxyToTargets = @{ "Proxy1" = @( (MacAddress = "00:11:22:33:44:55", ComputerName = "Target1"), (MacAddress = "66:77:88:99:AA:BB", ComputerName = "Target2") ) } Invoke-WakeOnLan -ProxyToTargets $proxyToTargets -Async</dev:code> <dev:remarks> <maml:para>Sends WOL packets asynchronously to the specified targets using the dictionary input.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-WakeOnLanData --> <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"> <command:details> <command:name>Get-WakeOnLanData</command:name> <command:verb>Get</command:verb> <command:noun>WakeOnLanData</command:noun> <maml:description> <maml:para>Retrieves Wake-on-LAN monitor logs or results.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-WakeOnLanData cmdlet retrieves either monitoring logs or Wake-on-LAN results, depending on the specified parameter set. It can optionally clear the retrieved data after retrieval.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: MonitorLog --> <command:syntaxItem> <maml:name>Get-WakeOnLanData</maml:name> <!-- Parameter: MonitorLog --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MonitorLog</maml:name> <maml:description> <maml:para>Retrieves monitoring logs from the monitoring cache.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ClearAfterRetrieval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ClearAfterRetrieval</maml:name> <maml:description> <maml:para>Clears the retrieved data from the respective cache after retrieval.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Results --> <command:syntaxItem> <maml:name>Get-WakeOnLanData</maml:name> <!-- Parameter: Results --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Results</maml:name> <maml:description> <maml:para>Retrieves Wake-on-LAN results from the result cache.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ClearAfterRetrieval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ClearAfterRetrieval</maml:name> <maml:description> <maml:para>Clears the retrieved data from the respective cache after retrieval.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: MonitorLog --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MonitorLog</maml:name> <maml:description> <maml:para>Retrieves monitoring logs from the monitoring cache.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Results --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Results</maml:name> <maml:description> <maml:para>Retrieves Wake-on-LAN results from the result cache.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ClearAfterRetrieval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ClearAfterRetrieval</maml:name> <maml:description> <maml:para>Clears the retrieved data from the respective cache after retrieval.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-WakeOnLanData -MonitorLog</dev:code> <dev:remarks> <maml:para>Retrieves all monitoring logs.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Get-WakeOnLanData -Results</dev:code> <dev:remarks> <maml:para>Retrieves all Wake-on-LAN results.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Get-WakeOnLanData -Results -ClearAfterRetrieval</dev:code> <dev:remarks> <maml:para>Retrieves all Wake-on-LAN results and clears them from the result cache.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> </helpItems> |