en-us/WindowsUtils.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Expand-Cabinet --> <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>Expand-Cabinet</command:name> <command:verb>Expand</command:verb> <command:noun>Cabinet</command:noun> <maml:description> <maml:para>Extracts files from a cabinet file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet extracts files from one or multiple cabinet files.</maml:para> <maml:para>It also manages automatically files that spans through multiple cabinet files.</maml:para> <maml:para>The Cmdlet creates the same folder structure from within the cabinet, relatively to the destination.</maml:para> <maml:para>If a file with the same name already exists it's overwritten by default.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: byPath --> <command:syntaxItem> <maml:name>Expand-Cabinet</maml:name> <!-- Parameter: Path --> <command:parameter required="false" globbing="true" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The object path.</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: Destination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The destination folder.</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> </command:syntaxItem> <!-- Parameter set: byLiteral --> <command:syntaxItem> <maml:name>Expand-Cabinet</maml:name> <!-- Parameter: Destination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The destination folder.</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: LiteralPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="PSPath"> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>Provider-aware file system object path.</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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Path --> <command:parameter required="false" globbing="true" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The object path.</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: LiteralPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="PSPath"> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>Provider-aware file system object path.</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> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="PSPath"> <maml:name>PSPath</maml:name> <maml:description> <maml:para>Provider-aware file system object path.</maml:para> <maml:para>This is an alias of the LiteralPath parameter.</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: Destination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The destination folder.</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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The object path.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Provider-aware file system object path.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Expand-Cabinet -Path "$env:SystemDrive\Path\To\Cabinet.cab" -Destination "$env:SystemDrive\Path\To\Destination"</dev:code> <dev:remarks> <maml:para>Extracts files from 'Cabinet.cab' to the 'Destination' folder.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Get-ChildItem -Path 'C:\CabinetSource\MultipleCab*' | Expand-Cabinet -Destination 'C:\Path\To\Destination'</dev:code> <dev:remarks> <maml:para>Extract files from all cabinet files from 'C:\CabinetSource' that matches 'MultipleCab*'.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-Cabinet --> <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>New-Cabinet</command:name> <command:verb>New</command:verb> <command:noun>Cabinet</command:noun> <maml:description> <maml:para>Creates a new cabinet file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet creates a new cabinet based on the input path.</maml:para> <maml:para>If the path is a directory it looks recursively for all files.</maml:para> <maml:para>You can use the 'MaxCabSize'(Kb) parameter if you want to split in multiple cabs, and the 'NamePrefix' to chose a prefix name.</maml:para> <maml:para>Important! Cabinet files accepts only files smaller than 2Gb, and the maximum size for a cabinet file is 2Gb.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-Cabinet</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the files to be compressed.</maml:para> <maml:para>It can be a path to a file, or a directory.</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: Destination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Destination</maml:name> <maml:description> <maml:para>A path to the destination. It needs to be a path to a valid folder.</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: CompressionType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CompressionType</maml:name> <maml:description> <maml:para>The compression algorithm. The higher the compression level, the longer it takes to compress all files.</maml:para> <maml:para>From lower to higher: None, MSZip, LZXLow, LZXHigh.</maml:para> <maml:para>Possible values: None, MSZip, LZXLow, LZXHigh</maml:para> </maml:description> <command:parameterValue required="true">CabinetCompressionType</command:parameterValue> <dev:type> <maml:name>WindowsUtils.CabinetCompressionType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MSZip</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">MSZip</command:parameterValue> <command:parameterValue required="false" variableLength="false">LZXLow</command:parameterValue> <command:parameterValue required="false" variableLength="false">LZXHigh</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MaxCabSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxCabSize</maml:name> <maml:description> <maml:para>The maximum cabinet size in kilobytes. This size will determine if files are going to span over multiple cabs.</maml:para> <maml:para>The maximum supported cabinet size, and the default is 2Gb.</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>2097151</dev:defaultValue> </command:parameter> <!-- Parameter: NamePrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NamePrefix</maml:name> <maml:description> <maml:para>A name prefix. The cabinet will be created in the format 'Prefix01.cab'</maml:para> <maml:para>If the files span through multiple cabs, the count is incremented. 'Prefix01.cab', 'Prefix02.cab'...</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Cabinet</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the files to be compressed.</maml:para> <maml:para>It can be a path to a file, or a directory.</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: Destination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Destination</maml:name> <maml:description> <maml:para>A path to the destination. It needs to be a path to a valid folder.</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: NamePrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NamePrefix</maml:name> <maml:description> <maml:para>A name prefix. The cabinet will be created in the format 'Prefix01.cab'</maml:para> <maml:para>If the files span through multiple cabs, the count is incremented. 'Prefix01.cab', 'Prefix02.cab'...</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Cabinet</dev:defaultValue> </command:parameter> <!-- Parameter: MaxCabSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxCabSize</maml:name> <maml:description> <maml:para>The maximum cabinet size in kilobytes. This size will determine if files are going to span over multiple cabs.</maml:para> <maml:para>The maximum supported cabinet size, and the default is 2Gb.</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>2097151</dev:defaultValue> </command:parameter> <!-- Parameter: CompressionType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CompressionType</maml:name> <maml:description> <maml:para>The compression algorithm. The higher the compression level, the longer it takes to compress all files.</maml:para> <maml:para>From lower to higher: None, MSZip, LZXLow, LZXHigh.</maml:para> <maml:para>Possible values: None, MSZip, LZXLow, LZXHigh</maml:para> </maml:description> <command:parameterValue required="true">CabinetCompressionType</command:parameterValue> <dev:type> <maml:name>WindowsUtils.CabinetCompressionType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MSZip</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">MSZip</command:parameterValue> <command:parameterValue required="false" variableLength="false">LZXLow</command:parameterValue> <command:parameterValue required="false" variableLength="false">LZXHigh</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>New-Cabinet -Path 'C:\Path\To\Files' -Destination 'C:\Path\To\Destination'</dev:code> <dev:remarks> <maml:para>Compresses all files in 'C:\Path\To\Files'.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>New-Cabinet 'C:\Path\To\Files' 'C:\Path\To\Destination' -MaxCabSize 20000 -NamePrefix 'CoolCab'</dev:code> <dev:remarks> <maml:para>Compress all files in 'C:\Path\To\Files' with a max cab size of 20Mb and a prefix name of 'CoolCab'</maml:para> <maml:para>If the size exceeds 20Mb, files will span over multiple cabs, following the pattern 'CoolCab01.cab', 'CoolCab02.cab'...</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Send-Click --> <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>Send-Click</command:name> <command:verb>Send</command:verb> <command:noun>Click</command:noun> <maml:description> <maml:para>Sends a click.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>When called, this cmdlet sends a click on the current desktop.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Send-Click</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Get-ComputerSession --> <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-ComputerSession</command:name> <command:verb>Get</command:verb> <command:noun>ComputerSession</command:noun> <maml:description> <maml:para>Returns the user sessions on the local or remote computer.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet returns the sessions on the local or remote computer.</maml:para> <maml:para>By default, only brings sessions that has an user name assigned.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ComputerSession</maml:name> <!-- Parameter: ComputerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name.</maml:para> <maml:para>If no computer name is informed, it returns sessions on the current computer.</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: ActiveOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActiveOnly</maml:name> <maml:description> <maml:para>When called, this Cmdlet returns only active sessions.</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: IncludeSystemSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSystemSession</maml:name> <maml:description> <maml:para>When called, this Cmdlet includes sessions without an user name assigned.</maml:para> <maml:para>Sessions without user name are marked as 'System'.</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: ComputerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name.</maml:para> <maml:para>If no computer name is informed, it returns sessions on the current computer.</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: ActiveOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActiveOnly</maml:name> <maml:description> <maml:para>When called, this Cmdlet returns only active sessions.</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: IncludeSystemSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSystemSession</maml:name> <maml:description> <maml:para>When called, this Cmdlet includes sessions without an user name assigned.</maml:para> <maml:para>Sessions without user name are marked as 'System'.</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> <!-- OutputType: ComputerSession --> <command:returnValue> <dev:type> <maml:name>WindowsUtils.ComputerSession</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-ErrorString --> <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-ErrorString</command:name> <command:verb>Get</command:verb> <command:noun>ErrorString</command:noun> <maml:description> <maml:para>Returns the error message for a system error code.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet uses FormatMessage to return the message text for a given 'Win32' system error.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ErrorString</maml:name> <!-- Parameter: ErrorCode --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ErrorCode</maml:name> <maml:description> <maml:para>The error code.</maml:para> <maml:para>This value will be passed to the 'FormatMessage' function, with the system message parameter..</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>0</dev:defaultValue> </command:parameter> <!-- Parameter: Source --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Source</maml:name> <maml:description> <maml:para>Possible values: SystemError, NtError, FdiError</maml:para> </maml:description> <command:parameterValue required="true">ErrorType</command:parameterValue> <dev:type> <maml:name>WindowsUtils.ErrorType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemError</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SystemError</command:parameterValue> <command:parameterValue required="false" variableLength="false">NtError</command:parameterValue> <command:parameterValue required="false" variableLength="false">FdiError</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ErrorCode --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ErrorCode</maml:name> <maml:description> <maml:para>The error code.</maml:para> <maml:para>This value will be passed to the 'FormatMessage' function, with the system message parameter..</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>0</dev:defaultValue> </command:parameter> <!-- Parameter: Source --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Source</maml:name> <maml:description> <maml:para>Possible values: SystemError, NtError, FdiError</maml:para> </maml:description> <command:parameterValue required="true">ErrorType</command:parameterValue> <dev:type> <maml:name>WindowsUtils.ErrorType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemError</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SystemError</command:parameterValue> <command:parameterValue required="false" variableLength="false">NtError</command:parameterValue> <command:parameterValue required="false" variableLength="false">FdiError</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The error code.</maml:para> <maml:para>This value will be passed to the 'FormatMessage' function, with the system message parameter..</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Get-ErrorString -ErrorCode 5</dev:code> <dev:remarks> <maml:para>Returning the message for a given error code.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>[System.Runtime.InteropServices.Marshal]::GetLastWin32Error() | Get-ErrorString</dev:code> <dev:remarks> <maml:para>Calling GetLastWin32Error and providing it to the Cmdlet to get the message string.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-LabProcedure --> <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>Start-LabProcedure</command:name> <command:verb>Start</command:verb> <command:noun>LabProcedure</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Start-LabProcedure</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Get-LastWin32Error --> <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-LastWin32Error</command:name> <command:verb>Get</command:verb> <command:noun>LastWin32Error</command:noun> <maml:description> <maml:para>Returns the last 'Win32' system error message.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet gets the last error thrown by the system, and returns the message string.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-LastWin32Error</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-MsiProperties --> <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-MsiProperties</command:name> <command:verb>Get</command:verb> <command:noun>MsiProperties</command:noun> <maml:description> <maml:para>Returns the installer properties from a MSI file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet returns the installer properties from the installer database.</maml:para> <maml:para>Besides standard information, like Product Code, it brings vendor-specific information.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: byPath --> <command:syntaxItem> <maml:name>Get-MsiProperties</maml:name> <!-- Parameter: Path --> <command:parameter required="false" globbing="true" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The object path.</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> </command:syntaxItem> <!-- Parameter set: byLiteral --> <command:syntaxItem> <maml:name>Get-MsiProperties</maml:name> <!-- Parameter: LiteralPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="PSPath"> <maml:name>LiteralPath</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Path --> <command:parameter required="false" globbing="true" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The object path.</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: LiteralPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="PSPath"> <maml:name>LiteralPath</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="PSPath"> <maml:name>PSPath</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>This is an alias of the LiteralPath parameter.</maml:para> </maml:description> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The object path.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: PSObject --> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Close-NetworkFile --> <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>Close-NetworkFile</command:name> <command:verb>Close</command:verb> <command:noun>NetworkFile</command:noun> <maml:description> <maml:para>Closes a network file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet closes a file opened remotely on the current or remote computer.</maml:para> <maml:para>It was inspired by 'psfile.exe' from Sysinternals.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: withFileId --> <command:syntaxItem> <maml:name>Close-NetworkFile</maml:name> <!-- Parameter: ComputerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name. If not present, the current computer is used.</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: FileId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>FileId</maml:name> <maml:description> <maml:para>One or more file IDs.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Used to skip confirmation.</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: withInputObject --> <command:syntaxItem> <maml:name>Close-NetworkFile</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The result from 'Get-NetworkFile'.</maml:para> </maml:description> <command:parameterValue required="true">NetworkFileInfo[]</command:parameterValue> <dev:type> <maml:name>WindowsUtils.NetworkFileInfo[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Used to skip confirmation.</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: ComputerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name. If not present, the current computer is used.</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: FileId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>FileId</maml:name> <maml:description> <maml:para>One or more file IDs.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The result from 'Get-NetworkFile'.</maml:para> </maml:description> <command:parameterValue required="true">NetworkFileInfo[]</command:parameterValue> <dev:type> <maml:name>WindowsUtils.NetworkFileInfo[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Used to skip confirmation.</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:inputType> <dev:type> <maml:name>WindowsUtils.NetworkFileInfo[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The result from 'Get-NetworkFile'.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Close-NetworkFile -ComputerName 'SUPERSERVER' -FileId 222</dev:code> <dev:remarks> <maml:para>Closes file ID 222 on computer 'SUPERSERVER'.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>closenetfile 'SUPERSERVER' 100, 102, 111 -Force</dev:code> <dev:remarks> <maml:para>Closes file IDs 100, 102 and 111 on computer 'SUPERSERVER' without prompting for confirmation.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Get-NetworkFile 'SUPERSERVER' -BasePath "$env:windir\MySuperPath" | Close-NetworkFile</dev:code> <dev:remarks> <maml:para>Closes all files that starts with "$env:windir\MySuperPath" on computer 'SUPERSERVER'.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-NetworkFile --> <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-NetworkFile</command:name> <command:verb>Get</command:verb> <command:noun>NetworkFile</command:noun> <maml:description> <maml:para>Returns files opened by remote sessions.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet returns files opened in a server remotely by a user session.</maml:para> <maml:para>It was inspired by 'psfile.exe' from Sysinternals.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-NetworkFile</maml:name> <!-- Parameter: ComputerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name. If not present, the current computer is used.</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: BasePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BasePath</maml:name> <maml:description> <maml:para>A path prefix filter for the results.</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: IncludeConnectionName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeConnectionName</maml:name> <maml:description> <maml:para>Includes the session connection name. This implies a cost because a call to 'NtSessionEnum' is made.</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: UserConnectionFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserConnectionFilter</maml:name> <maml:description> <maml:para>An user name or connection name filter.</maml:para> <maml:para>For user name, input the user name, for connection name, input the connection name prepended by two back slashes '\\'.</maml:para> <maml:para>For more information, see documentation for 'NetFileEnum'.</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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ComputerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name. If not present, the current computer is used.</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: BasePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BasePath</maml:name> <maml:description> <maml:para>A path prefix filter for the results.</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: UserConnectionFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserConnectionFilter</maml:name> <maml:description> <maml:para>An user name or connection name filter.</maml:para> <maml:para>For user name, input the user name, for connection name, input the connection name prepended by two back slashes '\\'.</maml:para> <maml:para>For more information, see documentation for 'NetFileEnum'.</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: IncludeConnectionName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeConnectionName</maml:name> <maml:description> <maml:para>Includes the session connection name. This implies a cost because a call to 'NtSessionEnum' is made.</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> <!-- OutputType: NetworkFileInfo --> <command:returnValue> <dev:type> <maml:name>WindowsUtils.NetworkFileInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Get-NetworkFile -ComputerName SUPERSERVER</dev:code> <dev:remarks> <maml:para>Returns open remotely opened files on computer 'SUPERSERVER'.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>psfile SUPERSERVER -UserConnectionFilter 'francisco.nabas'</dev:code> <dev:remarks> <maml:para>Returns files opened remotely on computer 'SUPERSERVER' by user 'francisco.nabas'.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>getnetfile 'SUPERSERVER' -IncludeConnectionName</dev:code> <dev:remarks> <maml:para>Returns files opened remotely on computer 'SUPERSERVER' and includes the origin session name.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Get-NetworkFile -UserConnectionFilter \\10.1.1.15</dev:code> <dev:remarks> <maml:para>Returns files opened remotely on the current computer filtered by session connection name '10.1.1.15'.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-ObjectHandle --> <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-ObjectHandle</command:name> <command:verb>Get</command:verb> <command:noun>ObjectHandle</command:noun> <maml:description> <maml:para>Returns all processes that have a handle to a file or directory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet return all processes that have a handle to a file or directory.</maml:para> <maml:para>This is particularly useful when a process is preventing a file from being read, modified or deleted.</maml:para> <maml:para>Although working in a different way, this Cmdlet was designed to mimic handle.exe, from Sysinternals suite.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: byPath --> <command:syntaxItem> <maml:name>Get-ObjectHandle</maml:name> <!-- Parameter: Path --> <command:parameter required="false" globbing="true" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The object path.</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: CloseHandle --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CloseHandle</maml:name> <maml:description> <maml:para>Closes all handles to the object(s).</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: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses confirmation for 'CloseHandle'.</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: byLiteral --> <command:syntaxItem> <maml:name>Get-ObjectHandle</maml:name> <!-- Parameter: LiteralPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="PSPath"> <maml:name>LiteralPath</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CloseHandle --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CloseHandle</maml:name> <maml:description> <maml:para>Closes all handles to the object(s).</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: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses confirmation for 'CloseHandle'.</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: Path --> <command:parameter required="false" globbing="true" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The object path.</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: LiteralPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="PSPath"> <maml:name>LiteralPath</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="PSPath"> <maml:name>PSPath</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>This is an alias of the LiteralPath parameter.</maml:para> </maml:description> </command:parameter> <!-- Parameter: CloseHandle --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CloseHandle</maml:name> <maml:description> <maml:para>Closes all handles to the object(s).</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: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses confirmation for 'CloseHandle'.</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:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The object path.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ObjectHandle --> <command:returnValue> <dev:type> <maml:name>WindowsUtils.ObjectHandle</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Get-ObjectHandle -Path "$env:windir\System32\kernel32.dll", "$env:windir\System32\ntdll.dll"</dev:code> <dev:remarks> <maml:para>Returning processes that have open handles to a list of files.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Get-ObjectHandle $env:TEMP\*.tmp</dev:code> <dev:remarks> <maml:para>Listing all .tmp files on the temp folder, and listing the processes with open handles to those files.</maml:para> <maml:para>The Cmdlet lists the processes related to the files queried to make it easier identify processes when querying a list of files.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Test-Port --> <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>Test-Port</command:name> <command:verb>Test</command:verb> <command:noun>Port</command:noun> <maml:description> <maml:para>Test if a TCP or UDP port is open.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet tests if TCP or UPD ports are opened in a given destination.</maml:para> <maml:para>Attention! Testing UDP can return false positives due the nature of the protocol. If the server doesn't refuse the connection we consider the port open.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Test-Port</maml:name> <!-- Parameter: ComputerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>One or more destination.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>localhost</dev:defaultValue> </command:parameter> <!-- Parameter: TcpPort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TcpPort</maml:name> <maml:description> <maml:para>One or more TCP ports.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The test timeout, in 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>2</dev:defaultValue> </command:parameter> <!-- Parameter: UdpPort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UdpPort</maml:name> <maml:description> <maml:para>One or more UDP ports.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ComputerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>One or more destination.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>localhost</dev:defaultValue> </command:parameter> <!-- Parameter: TcpPort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TcpPort</maml:name> <maml:description> <maml:para>One or more TCP ports.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UdpPort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UdpPort</maml:name> <maml:description> <maml:para>One or more UDP ports.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The test timeout, in 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>2</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Test-Port -ComputerName 'google.com'</dev:code> <dev:remarks> <maml:para>Tests if the TCP port '80' is opened at 'google.com'.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>testport 'SUPERSERVER.contoso.com' -UdpPort 69</dev:code> <dev:remarks> <maml:para>Tests if the UDP port '69' is opened at 'SUPERSERVER.contoso.com'.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>testport 'SUPERSERVER.contoso.com' -TcpPort 80, 443 -UdpPort 67, 68, 69</dev:code> <dev:remarks> <maml:para>Tests if the TCP ports 80, 443, and UDP ports 67, 68, and 69 are opened at 'SUPERSERVER.contoso.com'.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-ProcessAsUser --> <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>Start-ProcessAsUser</command:name> <command:verb>Start</command:verb> <command:noun>ProcessAsUser</command:noun> </command:details> <command:syntax> <!-- Parameter set: withUserName --> <command:syntaxItem> <maml:name>Start-ProcessAsUser</maml:name> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CommandLine --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>CommandLine</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: withCredentials --> <command:syntaxItem> <maml:name>Start-ProcessAsUser</maml:name> <!-- Parameter: CommandLine --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>CommandLine</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CommandLine --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>CommandLine</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Get-ProcessModule --> <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-ProcessModule</command:name> <command:verb>Get</command:verb> <command:noun>ProcessModule</command:noun> <maml:description> <maml:para>List processes modules.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet lists modules loaded into processes.</maml:para> <maml:para>You can list specific processes, or all processes. You can also include module version information.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: byName --> <command:syntaxItem> <maml:name>Get-ProcessModule</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>One or more process friendly names.</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: IncludeVersionInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeVersionInfo</maml:name> <maml:description> <maml:para>Include module file version information.</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: byProcessId --> <command:syntaxItem> <maml:name>Get-ProcessModule</maml:name> <!-- Parameter: IncludeVersionInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeVersionInfo</maml:name> <maml:description> <maml:para>Include module file version information.</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: ProcessId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProcessId</maml:name> <maml:description> <maml:para>One or more process IDs.</maml:para> </maml:description> <command:parameterValue required="true">uint[]</command:parameterValue> <dev:type> <maml:name>System.UInt32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>One or more process friendly names.</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: ProcessId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProcessId</maml:name> <maml:description> <maml:para>One or more process IDs.</maml:para> </maml:description> <command:parameterValue required="true">uint[]</command:parameterValue> <dev:type> <maml:name>System.UInt32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeVersionInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeVersionInfo</maml:name> <maml:description> <maml:para>Include module file version information.</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> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Get-ProcessModule -Name 'explorer'</dev:code> <dev:remarks> <maml:para>Gets loaded modules for the explorer process.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>listdlls -ProcessId 666, 667 -IncludeVersionInfo</dev:code> <dev:remarks> <maml:para>Gets loaded modules for processes ID 666 and 667, including module version info.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>listdlls</dev:code> <dev:remarks> <maml:para>Gets loaded modules for all processes.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Send-RemoteMessage --> <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>Send-RemoteMessage</command:name> <command:verb>Send</command:verb> <command:noun>RemoteMessage</command:noun> <maml:description> <maml:para>Sends a message to sessions on local or remote computers.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Invoke-RemoteMessage cmdlet sends a MessageBox-Style message to sessions on local or remote computers.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: WithWait --> <command:syntaxItem> <maml:name>Send-RemoteMessage</maml:name> <!-- Parameter: Title --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Title</maml:name> <maml:description> <maml:para>The message box title.</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: Message --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Message</maml:name> <maml:description> <maml:para>The message text.</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: Timeout --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The timeout, in seconds, to wait for a response.</maml:para> <maml:para>If the timeout expires, the cmdlet returns 'Timeout'. The message is not closed.</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>0</dev:defaultValue> </command:parameter> <!-- Parameter: ComputerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name to send the message.</maml:para> <maml:para>If not specified, sends the message to the local host.</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: SessionId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>The session(s) to receive the message.</maml:para> <maml:para>If not specified, sends the message to all sessions.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Style --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Style</maml:name> <maml:description> <maml:para>A list of MessageBox style enum objects.</maml:para> <maml:para>To obtaining a list of available options, call 'Get-RemoteMessageOptions', or see definition for the MessageBox function.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MB_OK</dev:defaultValue> </command:parameter> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If called, waits for the user response in the specified 'Timeout'.</maml:para> <maml:para>If not, the Cmdlet returns 'AsyncReturn'.</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: NoWait --> <command:syntaxItem> <maml:name>Send-RemoteMessage</maml:name> <!-- Parameter: Title --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Title</maml:name> <maml:description> <maml:para>The message box title.</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: Message --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Message</maml:name> <maml:description> <maml:para>The message text.</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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name to send the message.</maml:para> <maml:para>If not specified, sends the message to the local host.</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: SessionId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>The session(s) to receive the message.</maml:para> <maml:para>If not specified, sends the message to all sessions.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Style --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Style</maml:name> <maml:description> <maml:para>A list of MessageBox style enum objects.</maml:para> <maml:para>To obtaining a list of available options, call 'Get-RemoteMessageOptions', or see definition for the MessageBox function.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MB_OK</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The timeout, in seconds, to wait for a response.</maml:para> <maml:para>If the timeout expires, the cmdlet returns 'Timeout'. The message is not closed.</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>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Title --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Title</maml:name> <maml:description> <maml:para>The message box title.</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: Message --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Message</maml:name> <maml:description> <maml:para>The message text.</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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name to send the message.</maml:para> <maml:para>If not specified, sends the message to the local host.</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: SessionId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>The session(s) to receive the message.</maml:para> <maml:para>If not specified, sends the message to all sessions.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Style --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Style</maml:name> <maml:description> <maml:para>A list of MessageBox style enum objects.</maml:para> <maml:para>To obtaining a list of available options, call 'Get-RemoteMessageOptions', or see definition for the MessageBox function.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MB_OK</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The timeout, in seconds, to wait for a response.</maml:para> <maml:para>If the timeout expires, the cmdlet returns 'Timeout'. The message is not closed.</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>0</dev:defaultValue> </command:parameter> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If called, waits for the user response in the specified 'Timeout'.</maml:para> <maml:para>If not, the Cmdlet returns 'AsyncReturn'.</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> <!-- OutputType: MessageResponse --> <command:returnValue> <dev:type> <maml:name>WindowsUtils.MessageResponse</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-RemoteMessageOptions --> <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-RemoteMessageOptions</command:name> <command:verb>Get</command:verb> <command:noun>RemoteMessageOptions</command:noun> <maml:description> <maml:para>Retrieves the options to be used with Invoke-RemoteMessage.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet returns a list of options available to be used with the parameter 'Style', from Invoke-RemoteMessage.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-RemoteMessageOptions</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: MessageBoxOption[] --> <command:returnValue> <dev:type> <maml:name>WindowsUtils.MessageBoxOption[]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-ResourceMessageTable --> <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-ResourceMessageTable</command:name> <command:verb>Get</command:verb> <command:noun>ResourceMessageTable</command:noun> <maml:description> <maml:para>Returns the message table stored in a file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet lists all messages, and their index from a resource message table.</maml:para> <maml:para>These message tables are stored into files, like DLL or EXE.</maml:para> <maml:para>I.E.: on kernel32.dll are stored the Win32 system error messages.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ResourceMessageTable</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the file containing the message table.</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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the file containing the message table.</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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The path to the file containing the message table.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ResourceMessageTable --> <command:returnValue> <dev:type> <maml:name>WindowsUtils.ResourceMessageTable</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Remove-Service --> <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>Remove-Service</command:name> <command:verb>Remove</command:verb> <command:noun>Service</command:noun> <maml:description> <maml:para>Deletes a service from the local or remote computer.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes (deletes) a specified service from the local or remote computer.</maml:para> <maml:para>If the service is running, and you don't use 'Stop', it will be marked to deletion.</maml:para> <maml:para>If the service have dependents, and 'Stop' is not used, it will be marked for deletion.</maml:para> <maml:para>If the service have dependents, and you use 'Stop', it will stop all dependent services.</maml:para> <maml:para></maml:para> <maml:para>Attention!</maml:para> <maml:para>The act of deleting a service is ultimately marking it for deletion.</maml:para> <maml:para>A service is only permanently deleted when it's stopped and there are no more open handles to it.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: WithServiceController --> <command:syntaxItem> <maml:name>Remove-Service</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The service controller input object.</maml:para> </maml:description> <command:parameterValue required="true">ServiceController</command:parameterValue> <dev:type> <maml:name>System.ServiceProcess.ServiceController</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ComputerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name to remove the service from.</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: NoWait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoWait</maml:name> <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: Stop --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Stop</maml:name> <maml:description> <maml:para>Stops the service and any dependents.</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: WithServiceName --> <command:syntaxItem> <maml:name>Remove-Service</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The service name.</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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name to remove the service from.</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: NoWait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoWait</maml:name> <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: Stop --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Stop</maml:name> <maml:description> <maml:para>Stops the service and any dependents.</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: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The service controller input object.</maml:para> </maml:description> <command:parameterValue required="true">ServiceController</command:parameterValue> <dev:type> <maml:name>System.ServiceProcess.ServiceController</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The service name.</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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name to remove the service from.</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: Stop --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Stop</maml:name> <maml:description> <maml:para>Stops the service and any dependents.</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: NoWait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoWait</maml:name> <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:inputType> <dev:type> <maml:name>System.ServiceProcess.ServiceController</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The service controller input object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Remove-Service -Name 'MyCoolService'</dev:code> <dev:remarks> <maml:para>Removes the service 'MyCoolService'.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Remove-Service -Name 'MyCoolService' -Stop -Force</dev:code> <dev:remarks> <maml:para>Stops the service, and its dependents, and remove it. 'Force' skips confirmation.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-ServiceAccessRule --> <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>New-ServiceAccessRule</command:name> <command:verb>New</command:verb> <command:noun>ServiceAccessRule</command:noun> <maml:description> <maml:para>Creates a new service access rule object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates a new service access rule object to modify service security attributes.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-ServiceAccessRule</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The identity to be associated to the new access rule.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Rights --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Rights</maml:name> <maml:description> <maml:para>A bitwise OR flag of one or more service rights.</maml:para> <maml:para>Possible values: QueryConfig, ChangeConfig, QueryStatus, EnumerateDependents, Start, Stop, PauseContinue, Interrogate, UserDefinedControl, AllAccess, Delete, ReadControl, WriteDac, WriteOwner, GenericRead, GenericWrite, GenericExecute</maml:para> </maml:description> <command:parameterValue required="true">ServiceRights</command:parameterValue> <dev:type> <maml:name>WindowsUtils.Services.ServiceRights</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">QueryConfig</command:parameterValue> <command:parameterValue required="false" variableLength="false">ChangeConfig</command:parameterValue> <command:parameterValue required="false" variableLength="false">QueryStatus</command:parameterValue> <command:parameterValue required="false" variableLength="false">EnumerateDependents</command:parameterValue> <command:parameterValue required="false" variableLength="false">Start</command:parameterValue> <command:parameterValue required="false" variableLength="false">Stop</command:parameterValue> <command:parameterValue required="false" variableLength="false">PauseContinue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Interrogate</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserDefinedControl</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllAccess</command:parameterValue> <command:parameterValue required="false" variableLength="false">Delete</command:parameterValue> <command:parameterValue required="false" variableLength="false">ReadControl</command:parameterValue> <command:parameterValue required="false" variableLength="false">WriteDac</command:parameterValue> <command:parameterValue required="false" variableLength="false">WriteOwner</command:parameterValue> <command:parameterValue required="false" variableLength="false">GenericRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">GenericWrite</command:parameterValue> <command:parameterValue required="false" variableLength="false">GenericExecute</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of the new access rule.</maml:para> <maml:para>Possible values: Allow, Deny</maml:para> </maml:description> <command:parameterValue required="true">AccessControlType</command:parameterValue> <dev:type> <maml:name>System.Security.AccessControl.AccessControlType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Allow</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Allow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Deny</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: InheritanceFlags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InheritanceFlags</maml:name> <maml:description> <maml:para>The inheritance flags to be associated with the new access rule.</maml:para> <maml:para>Possible values: None, ContainerInherit, ObjectInherit</maml:para> </maml:description> <command:parameterValue required="true">InheritanceFlags</command:parameterValue> <dev:type> <maml:name>System.Security.AccessControl.InheritanceFlags</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">ContainerInherit</command:parameterValue> <command:parameterValue required="false" variableLength="false">ObjectInherit</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Inherited --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Inherited</maml:name> <maml:description> <maml:para>Called if the new access rule is inherited.</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: PropagationFlags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PropagationFlags</maml:name> <maml:description> <maml:para>The propagation flags to be associated with the new access rule.</maml:para> <maml:para>Possible values: None, NoPropagateInherit, InheritOnly</maml:para> </maml:description> <command:parameterValue required="true">PropagationFlags</command:parameterValue> <dev:type> <maml:name>System.Security.AccessControl.PropagationFlags</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">NoPropagateInherit</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritOnly</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The identity to be associated to the new access rule.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Rights --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Rights</maml:name> <maml:description> <maml:para>A bitwise OR flag of one or more service rights.</maml:para> <maml:para>Possible values: QueryConfig, ChangeConfig, QueryStatus, EnumerateDependents, Start, Stop, PauseContinue, Interrogate, UserDefinedControl, AllAccess, Delete, ReadControl, WriteDac, WriteOwner, GenericRead, GenericWrite, GenericExecute</maml:para> </maml:description> <command:parameterValue required="true">ServiceRights</command:parameterValue> <dev:type> <maml:name>WindowsUtils.Services.ServiceRights</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">QueryConfig</command:parameterValue> <command:parameterValue required="false" variableLength="false">ChangeConfig</command:parameterValue> <command:parameterValue required="false" variableLength="false">QueryStatus</command:parameterValue> <command:parameterValue required="false" variableLength="false">EnumerateDependents</command:parameterValue> <command:parameterValue required="false" variableLength="false">Start</command:parameterValue> <command:parameterValue required="false" variableLength="false">Stop</command:parameterValue> <command:parameterValue required="false" variableLength="false">PauseContinue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Interrogate</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserDefinedControl</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllAccess</command:parameterValue> <command:parameterValue required="false" variableLength="false">Delete</command:parameterValue> <command:parameterValue required="false" variableLength="false">ReadControl</command:parameterValue> <command:parameterValue required="false" variableLength="false">WriteDac</command:parameterValue> <command:parameterValue required="false" variableLength="false">WriteOwner</command:parameterValue> <command:parameterValue required="false" variableLength="false">GenericRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">GenericWrite</command:parameterValue> <command:parameterValue required="false" variableLength="false">GenericExecute</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of the new access rule.</maml:para> <maml:para>Possible values: Allow, Deny</maml:para> </maml:description> <command:parameterValue required="true">AccessControlType</command:parameterValue> <dev:type> <maml:name>System.Security.AccessControl.AccessControlType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Allow</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Allow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Deny</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: InheritanceFlags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InheritanceFlags</maml:name> <maml:description> <maml:para>The inheritance flags to be associated with the new access rule.</maml:para> <maml:para>Possible values: None, ContainerInherit, ObjectInherit</maml:para> </maml:description> <command:parameterValue required="true">InheritanceFlags</command:parameterValue> <dev:type> <maml:name>System.Security.AccessControl.InheritanceFlags</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">ContainerInherit</command:parameterValue> <command:parameterValue required="false" variableLength="false">ObjectInherit</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: PropagationFlags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PropagationFlags</maml:name> <maml:description> <maml:para>The propagation flags to be associated with the new access rule.</maml:para> <maml:para>Possible values: None, NoPropagateInherit, InheritOnly</maml:para> </maml:description> <command:parameterValue required="true">PropagationFlags</command:parameterValue> <dev:type> <maml:name>System.Security.AccessControl.PropagationFlags</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">NoPropagateInherit</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritOnly</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Inherited --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Inherited</maml:name> <maml:description> <maml:para>Called if the new access rule is inherited.</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> <!-- OutputType: ServiceAccessRule --> <command:returnValue> <dev:type> <maml:name>WindowsUtils.AccessControl.ServiceAccessRule</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>New-ServiceAccessRule -Identity 'DOMAIN\YourUser' -Rights 'AllAccess' -Type 'Allow'</dev:code> <dev:remarks> <maml:para>Creates a new service access rule with all access allowed for user 'DOMAIN\YourUser'.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> $serviceAccessRuleSplat = @{ Identity = [System.Security.Principal.NTAccount]'DOMAIN\YourUser Rights = [WindowsUtils.Engine.ServiceRights]::GenericRead -bor [WindowsUtils.Engine.ServiceRights]::EnumerateDependents Type = [System.Security.AccessControl.AccessControlType]::Deny InheritanceFlags = [System.Security.AccessControl.InheritanceFlags]::ContainerInherit PropagationFlags = [System.Security.AccessControl.PropagationFlags]::InheritOnly Inherited = $true } New-ServiceAccessRule @serviceAccessRuleSplat</dev:code> <dev:remarks> <maml:para>Creates a new service access rule with the defined parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-ServiceAuditRule --> <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>New-ServiceAuditRule</command:name> <command:verb>New</command:verb> <command:noun>ServiceAuditRule</command:noun> <maml:description> <maml:para>Creates a new service audit rule object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates a new service audit rule object to modify service security attributes.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-ServiceAuditRule</maml:name> <!-- Parameter: Flags --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Flags</maml:name> <maml:description> <maml:para>The type of the new audit rule.</maml:para> <maml:para>Possible values: None, Success, Failure</maml:para> </maml:description> <command:parameterValue required="true">AuditFlags</command:parameterValue> <dev:type> <maml:name>System.Security.AccessControl.AuditFlags</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Success</command:parameterValue> <command:parameterValue required="false" variableLength="false">Failure</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The identity to be associated to the new audit rule.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Rights --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Rights</maml:name> <maml:description> <maml:para>A bitwise OR flag of one or more service rights.</maml:para> <maml:para>Possible values: QueryConfig, ChangeConfig, QueryStatus, EnumerateDependents, Start, Stop, PauseContinue, Interrogate, UserDefinedControl, AllAccess, Delete, ReadControl, WriteDac, WriteOwner, GenericRead, GenericWrite, GenericExecute</maml:para> </maml:description> <command:parameterValue required="true">ServiceRights</command:parameterValue> <dev:type> <maml:name>WindowsUtils.Services.ServiceRights</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">QueryConfig</command:parameterValue> <command:parameterValue required="false" variableLength="false">ChangeConfig</command:parameterValue> <command:parameterValue required="false" variableLength="false">QueryStatus</command:parameterValue> <command:parameterValue required="false" variableLength="false">EnumerateDependents</command:parameterValue> <command:parameterValue required="false" variableLength="false">Start</command:parameterValue> <command:parameterValue required="false" variableLength="false">Stop</command:parameterValue> <command:parameterValue required="false" variableLength="false">PauseContinue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Interrogate</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserDefinedControl</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllAccess</command:parameterValue> <command:parameterValue required="false" variableLength="false">Delete</command:parameterValue> <command:parameterValue required="false" variableLength="false">ReadControl</command:parameterValue> <command:parameterValue required="false" variableLength="false">WriteDac</command:parameterValue> <command:parameterValue required="false" variableLength="false">WriteOwner</command:parameterValue> <command:parameterValue required="false" variableLength="false">GenericRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">GenericWrite</command:parameterValue> <command:parameterValue required="false" variableLength="false">GenericExecute</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: InheritanceFlags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InheritanceFlags</maml:name> <maml:description> <maml:para>The inheritance flags to be associated with the new audit rule.</maml:para> <maml:para>Possible values: None, ContainerInherit, ObjectInherit</maml:para> </maml:description> <command:parameterValue required="true">InheritanceFlags</command:parameterValue> <dev:type> <maml:name>System.Security.AccessControl.InheritanceFlags</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">ContainerInherit</command:parameterValue> <command:parameterValue required="false" variableLength="false">ObjectInherit</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Inherited --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Inherited</maml:name> <maml:description> <maml:para>Called if the new audit rule is inherited.</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: PropagationFlags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PropagationFlags</maml:name> <maml:description> <maml:para>The propagation flags to be associated with the new audit rule.</maml:para> <maml:para>Possible values: None, NoPropagateInherit, InheritOnly</maml:para> </maml:description> <command:parameterValue required="true">PropagationFlags</command:parameterValue> <dev:type> <maml:name>System.Security.AccessControl.PropagationFlags</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">NoPropagateInherit</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritOnly</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The identity to be associated to the new audit rule.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Rights --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Rights</maml:name> <maml:description> <maml:para>A bitwise OR flag of one or more service rights.</maml:para> <maml:para>Possible values: QueryConfig, ChangeConfig, QueryStatus, EnumerateDependents, Start, Stop, PauseContinue, Interrogate, UserDefinedControl, AllAccess, Delete, ReadControl, WriteDac, WriteOwner, GenericRead, GenericWrite, GenericExecute</maml:para> </maml:description> <command:parameterValue required="true">ServiceRights</command:parameterValue> <dev:type> <maml:name>WindowsUtils.Services.ServiceRights</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">QueryConfig</command:parameterValue> <command:parameterValue required="false" variableLength="false">ChangeConfig</command:parameterValue> <command:parameterValue required="false" variableLength="false">QueryStatus</command:parameterValue> <command:parameterValue required="false" variableLength="false">EnumerateDependents</command:parameterValue> <command:parameterValue required="false" variableLength="false">Start</command:parameterValue> <command:parameterValue required="false" variableLength="false">Stop</command:parameterValue> <command:parameterValue required="false" variableLength="false">PauseContinue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Interrogate</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserDefinedControl</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllAccess</command:parameterValue> <command:parameterValue required="false" variableLength="false">Delete</command:parameterValue> <command:parameterValue required="false" variableLength="false">ReadControl</command:parameterValue> <command:parameterValue required="false" variableLength="false">WriteDac</command:parameterValue> <command:parameterValue required="false" variableLength="false">WriteOwner</command:parameterValue> <command:parameterValue required="false" variableLength="false">GenericRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">GenericWrite</command:parameterValue> <command:parameterValue required="false" variableLength="false">GenericExecute</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Flags --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Flags</maml:name> <maml:description> <maml:para>The type of the new audit rule.</maml:para> <maml:para>Possible values: None, Success, Failure</maml:para> </maml:description> <command:parameterValue required="true">AuditFlags</command:parameterValue> <dev:type> <maml:name>System.Security.AccessControl.AuditFlags</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Success</command:parameterValue> <command:parameterValue required="false" variableLength="false">Failure</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: InheritanceFlags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InheritanceFlags</maml:name> <maml:description> <maml:para>The inheritance flags to be associated with the new audit rule.</maml:para> <maml:para>Possible values: None, ContainerInherit, ObjectInherit</maml:para> </maml:description> <command:parameterValue required="true">InheritanceFlags</command:parameterValue> <dev:type> <maml:name>System.Security.AccessControl.InheritanceFlags</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">ContainerInherit</command:parameterValue> <command:parameterValue required="false" variableLength="false">ObjectInherit</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: PropagationFlags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PropagationFlags</maml:name> <maml:description> <maml:para>The propagation flags to be associated with the new audit rule.</maml:para> <maml:para>Possible values: None, NoPropagateInherit, InheritOnly</maml:para> </maml:description> <command:parameterValue required="true">PropagationFlags</command:parameterValue> <dev:type> <maml:name>System.Security.AccessControl.PropagationFlags</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">NoPropagateInherit</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritOnly</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Inherited --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Inherited</maml:name> <maml:description> <maml:para>Called if the new audit rule is inherited.</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> <!-- OutputType: ServiceAuditRule --> <command:returnValue> <dev:type> <maml:name>WindowsUtils.AccessControl.ServiceAuditRule</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>New-ServiceAuditRule -Identity 'DOMAIN\YourUser' -Rights 'AllAccess' -Flags 'Failure'</dev:code> <dev:remarks> <maml:para>Creates a new service audit rule for all access and failure for 'DOMAIN\YourUser'.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> $serviceAuditRuleSplat = @{ Identity = [System.Security.Principal.NTAccount]'DOMAIN\YourUser Rights = [WindowsUtils.Engine.ServiceRights]::GenericRead -bor [WindowsUtils.Engine.ServiceRights]::EnumerateDependents Flags = [System.Security.AccessControl.AuditFlags]::Success InheritanceFlags = [System.Security.AccessControl.InheritanceFlags]::ContainerInherit PropagationFlags = [System.Security.AccessControl.PropagationFlags]::InheritOnly Inherited = $true } New-ServiceAuditRule @serviceAuditRuleSplat</dev:code> <dev:remarks> <maml:para>Creates a new service audit rule with the defined parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-ServiceSecurity --> <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-ServiceSecurity</command:name> <command:verb>Get</command:verb> <command:noun>ServiceSecurity</command:noun> <maml:description> <maml:para>Gets the service security attributes.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the service security attributes.</maml:para> <maml:para>The attributes retrieved are Owner, Group, DACL, and SACL, if used with the 'Audit' parameter.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: WithServiceName --> <command:syntaxItem> <maml:name>Get-ServiceSecurity</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The service(s) name.</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: Audit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Audit</maml:name> <maml:description> <maml:para>Includes SACL to the result.</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: WithDisplayName --> <command:syntaxItem> <maml:name>Get-ServiceSecurity</maml:name> <!-- Parameter: DisplayName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The service(s) display name.</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: Audit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Audit</maml:name> <maml:description> <maml:para>Includes SACL to the result.</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: WithServiceController --> <command:syntaxItem> <maml:name>Get-ServiceSecurity</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The service controller input object.</maml:para> </maml:description> <command:parameterValue required="true">ServiceController</command:parameterValue> <dev:type> <maml:name>System.ServiceProcess.ServiceController</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Audit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Audit</maml:name> <maml:description> <maml:para>Includes SACL to the result.</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: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The service(s) name.</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: DisplayName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The service(s) display name.</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: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The service controller input object.</maml:para> </maml:description> <command:parameterValue required="true">ServiceController</command:parameterValue> <dev:type> <maml:name>System.ServiceProcess.ServiceController</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Audit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Audit</maml:name> <maml:description> <maml:para>Includes SACL to the result.</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:inputType> <dev:type> <maml:name>System.ServiceProcess.ServiceController</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The service controller input object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ServiceSecurity --> <command:returnValue> <dev:type> <maml:name>WindowsUtils.AccessControl.ServiceSecurity</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Get-ServiceSecurity -Name 'MyCoolService'</dev:code> <dev:remarks> <maml:para>Gets the security attributes from the service 'MyCoolService'.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Get-ServiceSecurity -Name 'MyCoolService' -Audit</dev:code> <dev:remarks> <maml:para>Gets the security attributes from the service 'MyCoolService', including System Access Control List (SACL).</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Get-Service -Name 'MyCoolService' | Get-ServiceSecurity</dev:code> <dev:remarks> <maml:para>Gets the security attributes from the service 'MyCoolService', from 'Get-Service'.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-ServiceSecurity --> <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>Set-ServiceSecurity</command:name> <command:verb>Set</command:verb> <command:noun>ServiceSecurity</command:noun> <maml:description> <maml:para>Set the service object security.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet sets the service object security. You first retrieve the service security calling 'Get-ServiceSecurity', modifies the ACL, and pass it as input object to this cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByNameAndSecurityObject --> <command:syntaxItem> <maml:name>Set-ServiceSecurity</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The service name.</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: SecurityObject --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="AclObject"> <maml:name>SecurityObject</maml:name> <maml:description> <maml:para>The service security object to set.</maml:para> </maml:description> <command:parameterValue required="true">ServiceSecurity</command:parameterValue> <dev:type> <maml:name>WindowsUtils.AccessControl.ServiceSecurity</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ComputerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name. If empty, looks for the service in the current machine.</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: SetSacl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetSacl</maml:name> <maml:description> <maml:para>True to modify audit rules (SACL).</maml:para> <maml:para>Attention! If this parameter is called, and the security object,</maml:para> <maml:para>or SDDL audit rules are empty it will erase the service's audit rules.</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: ByNameAndSddl --> <command:syntaxItem> <maml:name>Set-ServiceSecurity</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The service name.</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: Sddl --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Sddl</maml:name> <maml:description> <maml:para>The service security object to 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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name. If empty, looks for the service in the current machine.</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: SetSacl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetSacl</maml:name> <maml:description> <maml:para>True to modify audit rules (SACL).</maml:para> <maml:para>Attention! If this parameter is called, and the security object,</maml:para> <maml:para>or SDDL audit rules are empty it will erase the service's audit rules.</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: ByDisplayNameAndSecurityObject --> <command:syntaxItem> <maml:name>Set-ServiceSecurity</maml:name> <!-- Parameter: DisplayName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The service display name.</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: SecurityObject --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="AclObject"> <maml:name>SecurityObject</maml:name> <maml:description> <maml:para>The service security object to set.</maml:para> </maml:description> <command:parameterValue required="true">ServiceSecurity</command:parameterValue> <dev:type> <maml:name>WindowsUtils.AccessControl.ServiceSecurity</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ComputerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name. If empty, looks for the service in the current machine.</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: SetSacl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetSacl</maml:name> <maml:description> <maml:para>True to modify audit rules (SACL).</maml:para> <maml:para>Attention! If this parameter is called, and the security object,</maml:para> <maml:para>or SDDL audit rules are empty it will erase the service's audit rules.</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: ByDisplayNameAndSddl --> <command:syntaxItem> <maml:name>Set-ServiceSecurity</maml:name> <!-- Parameter: DisplayName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The service display name.</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: Sddl --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Sddl</maml:name> <maml:description> <maml:para>The service security object to 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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name. If empty, looks for the service in the current machine.</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: SetSacl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetSacl</maml:name> <maml:description> <maml:para>True to modify audit rules (SACL).</maml:para> <maml:para>Attention! If this parameter is called, and the security object,</maml:para> <maml:para>or SDDL audit rules are empty it will erase the service's audit rules.</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: ByInputObjectAndSecurityObject --> <command:syntaxItem> <maml:name>Set-ServiceSecurity</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The service controller object.</maml:para> </maml:description> <command:parameterValue required="true">ServiceController</command:parameterValue> <dev:type> <maml:name>System.ServiceProcess.ServiceController</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SecurityObject --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="AclObject"> <maml:name>SecurityObject</maml:name> <maml:description> <maml:para>The service security object to set.</maml:para> </maml:description> <command:parameterValue required="true">ServiceSecurity</command:parameterValue> <dev:type> <maml:name>WindowsUtils.AccessControl.ServiceSecurity</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ComputerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name. If empty, looks for the service in the current machine.</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: SetSacl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetSacl</maml:name> <maml:description> <maml:para>True to modify audit rules (SACL).</maml:para> <maml:para>Attention! If this parameter is called, and the security object,</maml:para> <maml:para>or SDDL audit rules are empty it will erase the service's audit rules.</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: ByInputObjectAndSddl --> <command:syntaxItem> <maml:name>Set-ServiceSecurity</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The service controller object.</maml:para> </maml:description> <command:parameterValue required="true">ServiceController</command:parameterValue> <dev:type> <maml:name>System.ServiceProcess.ServiceController</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Sddl --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Sddl</maml:name> <maml:description> <maml:para>The service security object to 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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name. If empty, looks for the service in the current machine.</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: SetSacl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetSacl</maml:name> <maml:description> <maml:para>True to modify audit rules (SACL).</maml:para> <maml:para>Attention! If this parameter is called, and the security object,</maml:para> <maml:para>or SDDL audit rules are empty it will erase the service's audit rules.</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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The service name.</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: DisplayName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The service display name.</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: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The service controller object.</maml:para> </maml:description> <command:parameterValue required="true">ServiceController</command:parameterValue> <dev:type> <maml:name>System.ServiceProcess.ServiceController</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ComputerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name. If empty, looks for the service in the current machine.</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: SecurityObject --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="AclObject"> <maml:name>SecurityObject</maml:name> <maml:description> <maml:para>The service security object to set.</maml:para> </maml:description> <command:parameterValue required="true">ServiceSecurity</command:parameterValue> <dev:type> <maml:name>WindowsUtils.AccessControl.ServiceSecurity</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="AclObject"> <maml:name>AclObject</maml:name> <maml:description> <maml:para>The service security object to set.</maml:para> <maml:para>This is an alias of the SecurityObject parameter.</maml:para> </maml:description> <command:parameterValue required="true">ServiceSecurity</command:parameterValue> <dev:type> <maml:name>WindowsUtils.AccessControl.ServiceSecurity</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Sddl --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Sddl</maml:name> <maml:description> <maml:para>The service security object to 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: SetSacl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetSacl</maml:name> <maml:description> <maml:para>True to modify audit rules (SACL).</maml:para> <maml:para>Attention! If this parameter is called, and the security object,</maml:para> <maml:para>or SDDL audit rules are empty it will erase the service's audit rules.</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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The service name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.ServiceProcess.ServiceController</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The service controller object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> $serviceSecurity = Get-ServiceSecurity -Name 'MyCoolService' $serviceSecurity.SetOwner([System.Security.Principal.NTAccount]'User') $serviceSecurity.AddAccessRule((New-ServiceAccessRule -Identity 'User' -Rights 'AllAccess' -Type 'Allow')) Set-ServiceSecurity -Name 'MyCoolService' -SecurityObject $serviceSecurity</dev:code> <dev:remarks> <maml:para>Changes the owner, adds an access rule, and sets the service security attributes.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> $serviceSecurity = Get-ServiceSecurity -Name 'MyCoolService' -Audit $serviceSecurity.AddAuditRule((New-ServiceAuditRule -Identity 'User' -Rights 'AllAccess' -Flags 'Success')) Set-ServiceSecurity -Name 'MyCoolService' -AclObject $serviceSecurity</dev:code> <dev:remarks> <maml:para>Changes the service audit rules.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Disconnect-Session --> <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>Disconnect-Session</command:name> <command:verb>Disconnect</command:verb> <command:noun>Session</command:noun> <maml:description> <maml:para>Logs off an interactive session on the local or remote computer.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet disconnects, or logs off, an interactive session on the local or remote computer.</maml:para> <maml:para>You can retrieve the SessionId with Get-ComputerSession, and use this Cmdled to logoff users.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: WithComputerName --> <command:syntaxItem> <maml:name>Disconnect-Session</maml:name> <!-- Parameter: ComputerName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name to disconnect a session.</maml:para> <maml:para>If not informed, it disconnects the session from the local computer.</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: SessionId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>The session id to disconnect.</maml:para> </maml:description> <command:parameterValue required="true">uint</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If called, the Cmdlet waits the logoff process to finish before returning.</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: NoComputerName --> <command:syntaxItem> <maml:name>Disconnect-Session</maml:name> <!-- Parameter: SessionId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>The session id to disconnect.</maml:para> </maml:description> <command:parameterValue required="true">uint</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If called, the Cmdlet waits the logoff process to finish before returning.</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: ComputerName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name to disconnect a session.</maml:para> <maml:para>If not informed, it disconnects the session from the local computer.</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: SessionId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>The session id to disconnect.</maml:para> </maml:description> <command:parameterValue required="true">uint</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If called, the Cmdlet waits the logoff process to finish before returning.</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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The computer name to disconnect a session.</maml:para> <maml:para>If not informed, it disconnects the session from the local computer.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The session id to disconnect.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Disconnect-Session -SessionId 3</dev:code> <dev:remarks> <maml:para>Disconnects a session with a given session id.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Get-ComputerSession -ComputerName 'MYAWESOMEPC.contoso.com' | Where-Object { $PSItem.UserName -eq 'CONTOSO\user.name' } | Disconnect-Session -ComputerName 'MYAWESOMEPC.contoso.com' -SessionId $PSItem.SessionId </dev:code> <dev:remarks> <maml:para>Gets the session from a specific user on a remote computer, and loggs it off.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-Tcping --> <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>Start-Tcping</command:name> <command:verb>Start</command:verb> <command:noun>Tcping</command:noun> <maml:description> <maml:para>"Pings" a destination using TCP.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet measures network statistics when trying to connect with a server with TCP.</maml:para> <maml:para>It was designed to be familiar with tools like 'ping.exe' and 'tcping.exe'.</maml:para> <maml:para>The parameters have aliases that mimics those programs.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Start-Tcping</maml:name> <!-- Parameter: Destination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The destination.</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: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="p"> <maml:name>Port</maml:name> <maml:description> <maml:para>The port.</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>80</dev:defaultValue> </command:parameter> <!-- Parameter: Append --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Append</maml:name> <maml:description> <maml:para>Append to the file instead of overwriting it.</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: Continuous --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="t"> <maml:name>Continuous</maml:name> <maml:description> <maml:para>Probe continuously.</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: Count --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="n"> <maml:name>Count</maml:name> <maml:description> <maml:para>The number of tests to perform.</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>4</dev:defaultValue> </command:parameter> <!-- Parameter: FailedThreshold --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="g"> <maml:name>FailedThreshold</maml:name> <maml:description> <maml:para>The number of failed attempts before aborting.</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>4</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeJitter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="j"> <maml:name>IncludeJitter</maml:name> <maml:description> <maml:para>Include jitter.</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: Interval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="i"> <maml:name>Interval</maml:name> <maml:description> <maml:para>The interval between each probe, in 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>1</dev:defaultValue> </command:parameter> <!-- Parameter: OutputFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="o"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>The path to a file to store the output.</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: PrintFqdn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="fqdn"> <maml:name>PrintFqdn</maml:name> <maml:description> <maml:para>Attempts to resolve the ip to a FQDN and print in the output.</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: Single --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="s"> <maml:name>Single</maml:name> <maml:description> <maml:para>Sends only a single probe. Does not print statistics.</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: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="w"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The timeout while trying to connect, in 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>2</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Destination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The destination.</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: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="p"> <maml:name>Port</maml:name> <maml:description> <maml:para>The port.</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>80</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="p"> <maml:name>p</maml:name> <maml:description> <maml:para>The port.</maml:para> <maml:para>This is an alias of the Port parameter.</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>80</dev:defaultValue> </command:parameter> <!-- Parameter: Count --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="n"> <maml:name>Count</maml:name> <maml:description> <maml:para>The number of tests to perform.</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>4</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="n"> <maml:name>n</maml:name> <maml:description> <maml:para>The number of tests to perform.</maml:para> <maml:para>This is an alias of the Count parameter.</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>4</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="w"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The timeout while trying to connect, in 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>2</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="w"> <maml:name>w</maml:name> <maml:description> <maml:para>The timeout while trying to connect, in seconds.</maml:para> <maml:para>This is an alias of the Timeout parameter.</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>2</dev:defaultValue> </command:parameter> <!-- Parameter: Interval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="i"> <maml:name>Interval</maml:name> <maml:description> <maml:para>The interval between each probe, in 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>1</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="i"> <maml:name>i</maml:name> <maml:description> <maml:para>The interval between each probe, in seconds.</maml:para> <maml:para>This is an alias of the Interval parameter.</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>1</dev:defaultValue> </command:parameter> <!-- Parameter: FailedThreshold --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="g"> <maml:name>FailedThreshold</maml:name> <maml:description> <maml:para>The number of failed attempts before aborting.</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>4</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="g"> <maml:name>g</maml:name> <maml:description> <maml:para>The number of failed attempts before aborting.</maml:para> <maml:para>This is an alias of the FailedThreshold parameter.</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>4</dev:defaultValue> </command:parameter> <!-- Parameter: Continuous --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="t"> <maml:name>Continuous</maml:name> <maml:description> <maml:para>Probe continuously.</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:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="t"> <maml:name>t</maml:name> <maml:description> <maml:para>Probe continuously.</maml:para> <maml:para>This is an alias of the Continuous parameter.</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: IncludeJitter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="j"> <maml:name>IncludeJitter</maml:name> <maml:description> <maml:para>Include jitter.</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:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="j"> <maml:name>j</maml:name> <maml:description> <maml:para>Include jitter.</maml:para> <maml:para>This is an alias of the IncludeJitter parameter.</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: PrintFqdn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="fqdn"> <maml:name>PrintFqdn</maml:name> <maml:description> <maml:para>Attempts to resolve the ip to a FQDN and print in the output.</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:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="fqdn"> <maml:name>fqdn</maml:name> <maml:description> <maml:para>Attempts to resolve the ip to a FQDN and print in the output.</maml:para> <maml:para>This is an alias of the PrintFqdn parameter.</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: Single --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="s"> <maml:name>Single</maml:name> <maml:description> <maml:para>Sends only a single probe. Does not print statistics.</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:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="s"> <maml:name>s</maml:name> <maml:description> <maml:para>Sends only a single probe. Does not print statistics.</maml:para> <maml:para>This is an alias of the Single parameter.</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: OutputFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="o"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>The path to a file to store the output.</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> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="o"> <maml:name>o</maml:name> <maml:description> <maml:para>The path to a file to store the output.</maml:para> <maml:para>This is an alias of the OutputFile parameter.</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: Append --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Append</maml:name> <maml:description> <maml:para>Append to the file instead of overwriting it.</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> <!-- OutputType: TcpingProbeInfo --> <command:returnValue> <dev:type> <maml:name>WindowsUtils.TcpingProbeInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: TcpingStatistics --> <command:returnValue> <dev:type> <maml:name>WindowsUtils.TcpingStatistics</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Start-Tcping -Destination 'learn.microsoft.com' -Port 443</dev:code> <dev:remarks> <maml:para>Measure statistics with 'learn.microsoft.com' as destination on port 443.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Start-Tcping 'learn.microsoft.com' -Continuous -IncludeJitter</dev:code> <dev:remarks> <maml:para>Measure RTT and jitter with 'learn.microsoft.com' as destination on port 80.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Start-Tcping 'learn.microsoft.com' -n 10 -j -o 'C:\SuperTcpTest.txt'</dev:code> <dev:remarks> <maml:para>Measure statistics to 'learn.microsoft.com' on port 80, with jitter and saving the output in a file.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Start-Tcping 'learn.microsoft.com', 'google.com' -p 80, 443 -s</dev:code> <dev:remarks> <maml:para>Measure statistics to 'learn.microsoft.com' and 'google.com' on port 80 and 443, with a single probe.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> </helpItems> |