en-US/Omnicit-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Compare-ObjectProperty</command:name> <command:verb>Compare</command:verb> <command:noun>ObjectProperty</command:noun> <maml:description> <maml:para>The Compare-ObjectProperty function compares two sets of objects and it's properties.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Compare-ObjectProperty function compares two sets of objects and it's properties. One set of objects is the "reference set" and the other set is the "difference set."</maml:para> <maml:para>The result will indicate if each property from the reference set is equal to each property of the difference set.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Compare-ObjectProperty</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>ReferenceObject</maml:name> <maml:Description> <maml:para>Specifies an object used as a reference for comparison.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>DifferenceObject</maml:name> <maml:Description> <maml:para>Specifies the object that are compared to the reference objects.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>ReferenceObject</maml:name> <maml:Description> <maml:para>Specifies an object used as a reference for comparison.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>DifferenceObject</maml:name> <maml:Description> <maml:para>Specifies the object that are compared to the reference objects.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$Ref = Get-ADUser -Identity 'Roger Johnsson' -Properties *</dev:code> <dev:remarks> <maml:para>$Dif = Get-ADUser -Identity 'John Rogersson' -Properties * Compare-ObjectProperty -ReferenceObject $Ref -DifferenceObject $Dif</maml:para> <maml:para>This example returns all properties for both the reference object and the difference object with a true respectively false if the properties is equal. The original property for both reference object and the difference object is also returned.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Omnicit/Omnicit/blob/master/docs/en-US/Compare-ObjectProperty.md</maml:linkText> <maml:uri>https://github.com/Omnicit/Omnicit/blob/master/docs/en-US/Compare-ObjectProperty.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>ConvertFrom-CanonicalName</command:name> <command:verb>ConvertFrom</command:verb> <command:noun>CanonicalName</command:noun> <maml:description> <maml:para>Convert a CanonicalName string to a DistinguishedName string.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The ConvertFrom-CanonicalName converts one or more strings in form of a CanonicalName into DistinguishedName strings. Common usage when working in Exchange and comparing objects in Active Directory.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>ConvertFrom-CanonicalName</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="CN"> <maml:name>CanonicalName</maml:name> <maml:Description> <maml:para>Specifies the CanonicalName string to be converted to a DistinguishedName string.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CanonicalName[]</command:parameterValue> <dev:type> <maml:name>CanonicalName[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganizationalUnit</maml:name> <maml:Description> <maml:para>Specifies that the object is an OrganizationalUnit (OU=) instead of an Person (CN=). Will automatically be an OrganizationalUnit if the CanonicalName string ends with a slash '/'</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="CN"> <maml:name>CanonicalName</maml:name> <maml:Description> <maml:para>Specifies the CanonicalName string to be converted to a DistinguishedName string.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CanonicalName[]</command:parameterValue> <dev:type> <maml:name>CanonicalName[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganizationalUnit</maml:name> <maml:Description> <maml:para>Specifies that the object is an OrganizationalUnit (OU=) instead of an Person (CN=). Will automatically be an OrganizationalUnit if the CanonicalName string ends with a slash '/'</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DistinguishedName</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>ConvertFrom-CanonicalName -CanonicalName 'Contoso.com/Department/Users/Roger Johnsson'</dev:code> <dev:remarks> <maml:para>CN=Roger Johnsson,OU=Users,OU=Department,DC=Contoso,DC=com</maml:para> <maml:para>This example returns the converted CanonicalName in form of a DistinguishedName.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>ConvertFrom-CanonicalName -CanonicalName 'Contoso.com/Department/Users' -OrganizationalUnit</dev:code> <dev:remarks> <maml:para>OU=Users,OU=Department,DC=Contoso,DC=com</maml:para> <maml:para>This example returns the converted CanonicalName in form of a DistinguishedName. In this case the last object after slash '/' is an OrganizationalUnit.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>ConvertFrom-CanonicalName -CanonicalName 'Contoso.com/Department/Users/Roger Johnsson', 'Contoso.com/Tier1/Users/Bill T Admin'</dev:code> <dev:remarks> <maml:para>CN=Roger Johnsson,OU=Users,OU=Department,DC=Contoso,DC=com CN=Bill T Admin,OU=Users,OU=Tier1,DC=Contoso,DC=com</maml:para> <maml:para>This example returns each CanonicalName converted in form of a DistinguishedName.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Omnicit/Omnicit/blob/master/docs/en-US/ConvertFrom-CanonicalName.md</maml:linkText> <maml:uri>https://github.com/Omnicit/Omnicit/blob/master/docs/en-US/ConvertFrom-CanonicalName.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>ConvertFrom-DistinguishedName</command:name> <command:verb>ConvertFrom</command:verb> <command:noun>DistinguishedName</command:noun> <maml:description> <maml:para>Convert a DistinguishedName string to a CanonicalName string.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The ConvertFrom-DistinguishedName converts one or more strings in form of a DistinguishedName into CanonicalName strings. Common usage when working in Exchange and comparing objects in Active Directory.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>ConvertFrom-DistinguishedName</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="DN"> <maml:name>DistinguishedName</maml:name> <maml:Description> <maml:para>Specifies one or more Distinguished Names to be converted to Canonical Names.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DistinguishedName[]</command:parameterValue> <dev:type> <maml:name>DistinguishedName[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="DN"> <maml:name>DistinguishedName</maml:name> <maml:Description> <maml:para>Specifies one or more Distinguished Names to be converted to Canonical Names.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DistinguishedName[]</command:parameterValue> <dev:type> <maml:name>DistinguishedName[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CanonicalName</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>ConvertFrom-DistinguishedName -DistinguishedName 'CN=Roger Johnsson,OU=Users,OU=Department,DC=Contoso,DC=com'</dev:code> <dev:remarks> <maml:para>Contoso.com/Department/Users/Roger Johnsson</maml:para> <maml:para>This example returns the converted DistinguishedName in form of a CanonicalName.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>ConvertFrom-DistinguishedName -DistinguishedName 'CN=Roger Johnsson,OU=Users,OU=Department,DC=Contoso,DC=com', 'CN=Bill T Admin,OU=Users,OU=Tier1,DC=Contoso,DC=com'</dev:code> <dev:remarks> <maml:para>Contoso.com/Department/Users/Roger Johnsson Contoso.com/Tier1/Users/Bill T Admin</maml:para> <maml:para>This example returns each DistinguishedName converted in form of a CanonicalName.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Omnicit/Omnicit/blob/master/docs/en-US/ConvertFrom-DistinguishedName.md</maml:linkText> <maml:uri>https://github.com/Omnicit/Omnicit/blob/master/docs/en-US/ConvertFrom-DistinguishedName.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>ConvertTo-MailNormalization</command:name> <command:verb>ConvertTo</command:verb> <command:noun>MailNormalization</command:noun> <maml:description> <maml:para>Convert a string for Mail Normalization.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Converts accented, diacritics and most European chars to the corresponding a-z char. Effectively and fast converts a string to a normalized mail string using [Text.NormalizationForm]::FormD and [Text.Encoding]::GetEncoding('ISO-8859-8'). Function created to support legacy email providers that does not support e-mail address internationalization (EAI). Integers will remain intact.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>ConvertTo-MailNormalization</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="String"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>Specifies the string to be converted to Mail Normalization.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="String"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>Specifies the string to be converted to Mail Normalization.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Credits to Johan Åkerlund for the Convert-DiacriticCharacters function.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>ConvertTo-MailNormalization -InputObject 'ûüåäöÅÄÖÆÈÉÊËÐÑØçł'</dev:code> <dev:remarks> <maml:para>uuaaoAAOAEEEEDNOcl</maml:para> <maml:para>This example returns a string with the converted Mail Normalization value.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Omnicit/Omnicit/blob/master/docs/en-US/ConvertTo-MailNormalization.md</maml:linkText> <maml:uri>https://github.com/Omnicit/Omnicit/blob/master/docs/en-US/ConvertTo-MailNormalization.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>ConvertTo-TitleCase</command:name> <command:verb>ConvertTo</command:verb> <command:noun>TitleCase</command:noun> <maml:description> <maml:para>The ConvertTo-TitleCase function converts a specified string to title case.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The ConvertTo-TitleCase function converts a specified string to title case using the Method in (Get-Culture).TextInfo All input strings will be converted to lowercase, because uppercase are considered to be acronyms.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>ConvertTo-TitleCase</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>Specifies one or more objects to be convert to title case strings.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>Specifies one or more objects to be convert to title case strings.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>ConvertTo-TitleCase -InputObject 'roger johnsson'</dev:code> <dev:remarks> <maml:para>Roger Johnsson</maml:para> <maml:para>This example returns the string 'Roger Johnsson' which has capitalized the R and J chars.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>'roger johnsson', 'JOHN ROGERSSON' | ConvertTo-TitleCase</dev:code> <dev:remarks> <maml:para>Roger Johnsson John Rogersson</maml:para> <maml:para>This example returns the strings 'Roger Johnsson' and 'John Rogersson' which has capitalized the R and J chars.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Omnicit/Omnicit/blob/master/docs/en-US/ConvertTo-TitleCase.md</maml:linkText> <maml:uri>https://github.com/Omnicit/Omnicit/blob/master/docs/en-US/ConvertTo-TitleCase.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ClipboardArray</command:name> <command:verb>Get</command:verb> <command:noun>ClipboardArray</command:noun> <maml:description> <maml:para>Paste an array of objects from the clipboard (CTRL+V)</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Paste an array of objects from the clipboard (CTRL+V) to the variable $ClipboardArray (global scope). Using the parameter, AsType, can specify what every object should be tried to be converted to. If conversion fails every object as a type string. The order for the data type conversion is: [DateTime], [Int32], [Int64], [Boolean], [Char], [Byte], [Decimal], [Double], [Int16], [SByte], [Single], [UInt16], [UInt32], [UInt64], [String]</maml:para> <maml:para>Default an empty string will close the loop from importing any more data, default behavior of Read-Host. To change that behavior a specified [System.String] combination can be used with the -BreakString parameter to include empty lines as valid input data.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ClipboardArray</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="B"> <maml:name>BreakString</maml:name> <maml:Description> <maml:para>Specifies the a single char or a string that will break the input loop. Default value is empty string '' Quote and some other special chars ("''`´""''''"!) is not permitted as input.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="D"> <maml:name>AsType</maml:name> <maml:Description> <maml:para>Specifies the TypeAccelerator of the clipboard that each input will be converted to. The acceptable values for this parameter are: - DateTime</maml:para> <maml:para>- Int32</maml:para> <maml:para>- Int64</maml:para> <maml:para>- Boolean</maml:para> <maml:para>- Char</maml:para> <maml:para>- Byte</maml:para> <maml:para>- Decimal</maml:para> <maml:para>- Double</maml:para> <maml:para>- Int16</maml:para> <maml:para>- SByte</maml:para> <maml:para>- Single</maml:para> <maml:para>- UInt16</maml:para> <maml:para>- UInt32</maml:para> <maml:para>- UInt64</maml:para> <maml:para>- String</maml:para> <maml:para>- All</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">DateTime</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Int32</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Int64</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Boolean</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Char</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Byte</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Decimal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Double</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Int16</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SByte</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Single</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UInt16</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UInt32</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UInt64</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">String</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">TypeAccelerators[]</command:parameterValue> <dev:type> <maml:name>TypeAccelerators[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>String</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="B"> <maml:name>BreakString</maml:name> <maml:Description> <maml:para>Specifies the a single char or a string that will break the input loop. Default value is empty string '' Quote and some other special chars ("''`´""''''"!) is not permitted as input.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="D"> <maml:name>AsType</maml:name> <maml:Description> <maml:para>Specifies the TypeAccelerator of the clipboard that each input will be converted to. The acceptable values for this parameter are: - DateTime</maml:para> <maml:para>- Int32</maml:para> <maml:para>- Int64</maml:para> <maml:para>- Boolean</maml:para> <maml:para>- Char</maml:para> <maml:para>- Byte</maml:para> <maml:para>- Decimal</maml:para> <maml:para>- Double</maml:para> <maml:para>- Int16</maml:para> <maml:para>- SByte</maml:para> <maml:para>- Single</maml:para> <maml:para>- UInt16</maml:para> <maml:para>- UInt32</maml:para> <maml:para>- UInt64</maml:para> <maml:para>- String</maml:para> <maml:para>- All</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TypeAccelerators[]</command:parameterValue> <dev:type> <maml:name>TypeAccelerators[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>String</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-ClipboardArray</dev:code> <dev:remarks> <maml:para>No.[0]: Some data No.[1]: to No.[2]: paste No.[3]: into No.[4]: the function No.[5]:</maml:para> <maml:para>Empty line will close the loop from importing anything more. The input to will be saved to the variable ClipboardArray. Each item in the array will be of the data type [System.String].</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-ClipboardArray -AsType Int32</dev:code> <dev:remarks> <maml:para>No.[0]: Some data No.[1]: 20170101 No.[2]: 123 No.[3]: into No.[4]: 876 function No.[5]:</maml:para> <maml:para>Empty line will close the loop from importing anything more. The input to will be saved to the variable ClipboardArray. This example will try to convert every object in the pasted array to an System.Int32. If its not possible it will default back to System.String. Array object [1] and [2] is the only objects that will be converted to a System.Int32 type accelerator.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-ClipboardArray -AsType All</dev:code> <dev:remarks> <maml:para>No.[0]: Some data No.[1]: 2017-01-01 No.[2]: 2147483647 No.[3]: 2147483648 No.[4]: TRUE No.[5]:</maml:para> <maml:para>Empty line will close the loop from importing anything more. The input to will be saved to the variable ClipboardArray. This example will try to convert every object in the pasted array to all available data types. If no conversion succeeded it will default back to System.String. The order for the data type conversion is [System.DateTime], [System.Int32], [System.Int64], [System.Boolean], [System.String]. Array object [0] is a String, object [1] is a DateTime, object [2] is an Int32, object [3] is an Int64 and object [4] is a Boolean.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-ClipboardArray -BreakString '?'</dev:code> <dev:remarks> <maml:para>No.[0]: Some data No.[1]: 2017-01-01 No.[2]: 2147483647 No.[3]: 2147483648 No.[4]: TRUE No.[5]: No.[6]: ?</maml:para> <maml:para>The question mark will close the loop from importing anything more. The input to will be saved to the variable ClipboardArray. This example will not convert any objects in the array, all objects default to System.String. The BreakString parameter can be used when the input contains empty rows to not break the loop.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-ClipboardArray -BreakString '?' -AsType All</dev:code> <dev:remarks> <maml:para>No.[0]: Some data No.[1]: 2017-01-01 No.[2]: 2147483647 No.[3]: 2147483648 No.[4]: TRUE No.[5]: No.[6]: ?</maml:para> <maml:para>$ClipboardArray | foreach {$_.Gettype()} IsPublic IsSerial Name BaseType -------- -------- ---- -------- True True String System.Object True True DateTime System.ValueType True True Int32 System.ValueType True True Int64 System.ValueType True True Boolean System.ValueType True True String System.Object</maml:para> <maml:para>The exclamation mark will close the loop from importing anything more. The input to will be saved to the variable ClipboardArray. This example will try to convert every object in the array to all available data types. If no conversion succeeded it will default back to System.String. The order for the data type conversion is [System.DateTime], [System.Int32], [System.Int64], [System.Boolean], [System.String]. Array object [0] is a String, object [1] is a DateTime, object [2] is an Int32, object [3] is an Int64, object [4] is a Boolean and object [5] is a String. The BreakString parameter can be used when the input contains empty rows to not break the loop.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Omnicit/Omnicit/blob/master/docs/en-US/Get-ClipboardArray.md</maml:linkText> <maml:uri>https://github.com/Omnicit/Omnicit/blob/master/docs/en-US/Get-ClipboardArray.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-FolderSize</command:name> <command:verb>Get</command:verb> <command:noun>FolderSize</command:noun> <maml:description> <maml:para>Get folder size using Robocopy.exe and displays the output in a PSObject table.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function uses Robocopy.exe to calculate the size used for the select path. You can specify if you want to display files older than a specific date using the MinFileData parameter. If you experience that the function Get-FolderSize (Robocopy) takes time to execute you can increase the threads used by Robocopy with the RobocopyThreadCount parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FolderSize</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies the path to the source directory to measure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Current path</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="MinDate"> <maml:name>MinFileAgeDate</maml:name> <maml:Description> <maml:para>Specifies the minimum file age (exclude files newer than N date).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>BytePrecision</maml:name> <maml:Description> <maml:para>Specifies number of fractional digits, and rounds midpoint values to the nearest even number when converting bytes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>RobocopyThreadCount</maml:name> <maml:Description> <maml:para>Number of threads used for Robocopy.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>16</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-FolderSize</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies the path to the source directory to measure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Current path</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="MaxDate"> <maml:name>MaxFileAgeDate</maml:name> <maml:Description> <maml:para>Specifies the maximum file age (to exclude files older than N date).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>BytePrecision</maml:name> <maml:Description> <maml:para>Specifies number of fractional digits, and rounds midpoint values to the nearest even number when converting bytes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>RobocopyThreadCount</maml:name> <maml:Description> <maml:para>Number of threads used for Robocopy.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>16</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specifies the path to the source directory to measure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Current path</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="MinDate"> <maml:name>MinFileAgeDate</maml:name> <maml:Description> <maml:para>Specifies the minimum file age (exclude files newer than N date).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="MaxDate"> <maml:name>MaxFileAgeDate</maml:name> <maml:Description> <maml:para>Specifies the maximum file age (to exclude files older than N date).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>BytePrecision</maml:name> <maml:Description> <maml:para>Specifies number of fractional digits, and rounds midpoint values to the nearest even number when converting bytes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>RobocopyThreadCount</maml:name> <maml:Description> <maml:para>Number of threads used for Robocopy.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>16</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-FolderSize</dev:code> <dev:remarks> <maml:para>Path TotalBytes TotalMBytes TotalGBytes FilesCount DirCount TimeElapsed ---- ---------- ----------- ----------- ---------- -------- ----------- C:\Windows 18512797867 17655,18 17,24 144492 34036 00:00:12.2813478</maml:para> <maml:para>This example returns a PSObject with the total folder size for the current location, which in this case in C:\Windows.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-FolderSize -Path \\contoso.com\NETLOGON</dev:code> <dev:remarks> <maml:para>Path TotalBytes TotalMBytes TotalGBytes FilesCount DirCount TimeElapsed ---- ---------- ----------- ----------- ---------- -------- ----------- \\contoso.com\NETLOGON 1019904 0,97 0,00 1 2 00:00:00.0157300</maml:para> <maml:para>This example returns a PSObject with the total folder size for the specified location path \\contoso.com\NETLOGON.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-FolderSize -Path \\contoso.net\NETLOGON -BytePrecision 4</dev:code> <dev:remarks> <maml:para>Path TotalBytes TotalMBytes TotalGBytes FilesCount DirCount TimeElapsed ---- ---------- ----------- ----------- ---------- -------- ----------- \\contoso.com\NETLOGON 1019904 0,9727 0,0009 1 2 00:00:00.0155598</maml:para> <maml:para>This example returns a PSObject with the total folder size, with for decimals, for the specified location path \\contoso.com\NETLOGON.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-FolderSize -Path C:\Windows -MinFileAgeDate 2019-06-01</dev:code> <dev:remarks> <maml:para>Path TotalBytes TotalMBytes TotalGBytes FilesCount DirCount TimeElapsed ---- ---------- ----------- ----------- ---------- -------- ----------- C:\Windows 11448807458 10918,43 10,66 101354 34036 00:00:24.1594950</maml:para> <maml:para>This example returns a PSObject with the total folder size for the specified location path C:\Windows and excludes files newer than 2019-06-01.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Get-FolderSize -Path C:\Windows -MaxFileAgeDate 2019-06-01</dev:code> <dev:remarks> <maml:para>Path TotalBytes TotalMBytes TotalGBytes FilesCount DirCount TimeElapsed ---- ---------- ----------- ----------- ---------- -------- ----------- C:\Windows 7063990409 6736,75 6,58 43138 34036 00:00:10.2498128</maml:para> <maml:para>This example returns a PSObject with the total folder size for the specified location path C:\Windows and excludes files older than 2019-06-01.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <dev:code>Get-FolderSize -Path C:\Windows -MaxFileAgeDate 2019-06-01 | Select-Object -Property *</dev:code> <dev:remarks> <maml:para>Path : C:\Windows TotalBytes : 7065038985 TotalMBytes : 6737,75 TotalGBytes : 6,58 FilesCount : 43138 DirCount : 34036 BytesFailed : 0 DirFailed : 0 FileFailed : 0 TimeElapsed : 00:00:10.0465934 StartedTime : 2019-09-05 22:28:33 EndedTime : 2019-09-05 22:28:43 DateFilter : Maximum file age "2019-06-01". TotalBytesNoDate : 18474790494 TotalMBytesNoDate : 17618,93 TotalGBytesNoDate : 17,21 DirCountNoDate : 34057 FileCountNoDate : 144414</maml:para> <maml:para>This example returns a PSObject with all available properties extracted from the specified location path C:\Windows and excludes files older than 2019-06-01.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Omnicit/Omnicit/blob/master/docs/en-US/Get-FolderSize.md</maml:linkText> <maml:uri>https://github.com/Omnicit/Omnicit/blob/master/docs/en-US/Get-FolderSize.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Parameter</command:name> <command:verb>Get</command:verb> <command:noun>Parameter</command:noun> <maml:description> <maml:para>Enumerates the parameters of one or more commands</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Lists all the parameters of a command, by ParameterSet, including their aliases, type, position, mandatory, etc.</maml:para> <maml:para>By default, formats the output to tables grouped by command and parameter set.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Parameter</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="Name"> <maml:name>CommandName</maml:name> <maml:Description> <maml:para>The name of the command to get parameters for.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>ParameterName</maml:name> <maml:Description> <maml:para>The parameter name to filter by (allows Wilcards).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ModuleName</maml:name> <maml:Description> <maml:para>The name of the module which contains the command (this is for scoping).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipProviderParameters</maml:name> <maml:Description> <maml:para>Skip testing for Provider parameters (will be much faster)</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces including the CommonParameters in the output</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-Parameter</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="Name"> <maml:name>CommandName</maml:name> <maml:Description> <maml:para>The name of the command to get parameters for.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SetName</maml:name> <maml:Description> <maml:para>The ParameterSet name to filter by (allows wildcards).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ModuleName</maml:name> <maml:Description> <maml:para>The name of the module which contains the command (this is for scoping).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipProviderParameters</maml:name> <maml:Description> <maml:para>Skip testing for Provider parameters (will be much faster)</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces including the CommonParameters in the output</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="Name"> <maml:name>CommandName</maml:name> <maml:Description> <maml:para>The name of the command to get parameters for.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>ParameterName</maml:name> <maml:Description> <maml:para>The parameter name to filter by (allows Wilcards).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SetName</maml:name> <maml:Description> <maml:para>The ParameterSet name to filter by (allows wildcards).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ModuleName</maml:name> <maml:Description> <maml:para>The name of the module which contains the command (this is for scoping).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipProviderParameters</maml:name> <maml:Description> <maml:para>Skip testing for Provider parameters (will be much faster)</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces including the CommonParameters in the output</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>With many thanks to Joel Bennett, Jason Archer, Shay Levy, Hal Rottenberg, Oisin Grehan</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-Parameter -CommandName Select-XML</dev:code> <dev:remarks> <maml:para>Command: Microsoft.PowerShell.Utility/Select-Xml Set: Xml *</maml:para> <maml:para>Name Aliases Position Mandatory Pipeline ByName Provider Type ---- ------- -------- --------- -------- ------ -------- ---- Namespace {Na*} Named False False False All Hashtable Xml {Node, Xm*} 1 True True True All XmlNode[] XPath {XP*} 0 True False False All String</maml:para> <maml:para></maml:para> <maml:para> Command: Microsoft.PowerShell.Utility/Select-Xml Set: Path</maml:para> <maml:para>Name Aliases Position Mandatory Pipeline ByName Provider Type ---- ------- -------- --------- -------- ------ -------- ---- Namespace {Na*} Named False False False All Hashtable Path {Pa*} 1 True False True All String[] XPath {XP*} 0 True False False All String ...</maml:para> <maml:para>This example returns a PSObject which displays the parameters sorted by the Parameter Sets for the cmdlet Select-XML.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-Command Select-Xml | Get-Parameter</dev:code> <dev:remarks> <maml:para>Command: Microsoft.PowerShell.Utility/Select-Xml Set: Xml *</maml:para> <maml:para>Name Aliases Position Mandatory Pipeline ByName Provider Type ---- ------- -------- --------- -------- ------ -------- ---- Namespace {Na*} Named False False False All Hashtable Xml {Node, Xm*} 1 True True True All XmlNode[] XPath {XP*} 0 True False False All String</maml:para> <maml:para></maml:para> <maml:para> Command: Microsoft.PowerShell.Utility/Select-Xml Set: Path</maml:para> <maml:para>Name Aliases Position Mandatory Pipeline ByName Provider Type ---- ------- -------- --------- -------- ------ -------- ---- Namespace {Na*} Named False False False All Hashtable Path {Pa*} 1 True False True All String[] XPath {XP*} 0 True False False All String ...</maml:para> <maml:para>This example returns a PSObject which displays the parameters sorted by the Parameter Sets for the cmdlet Select-XML.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-Parameter -CommandName Select-Xml -SetName Path</dev:code> <dev:remarks> <maml:para>Command: Microsoft.PowerShell.Utility/Select-Xml Set: Path</maml:para> <maml:para></maml:para> <maml:para>Name Aliases Position Mandatory Pipeline ByName Provider Type ---- ------- -------- --------- -------- ------ -------- ---- Namespace {Na*} Named False False False All Hashtable Path {Pa*} 1 True False True All String[] XPath {XP*} 0 True False False All String</maml:para> <maml:para>This example returns a PSObject which displays the parameters filtered by the Parameter Set 'Path' for the cmdlet Select-XML.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/Omnicit/Omnicit/blob/master/docs/en-US/Get-FolderSize.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-WanIPAddress</command:name> <command:verb>Get</command:verb> <command:noun>WanIPAddress</command:noun> <maml:description> <maml:para>The Get-WanIPAddress function retrieves the current external IP address.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-WanIPAddress function retrieves the current external IP address using ifconfig.co as the API provider.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-WanIPAddress</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-WanIPAddress</dev:code> <dev:remarks> <maml:para>IP Address Country City Hostname ISP ---------- ------- ---- -------- --- 123.45.67.89 Sweden Gothenburg h-123-45.A56.priv.contoso.com Contso.com</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Omnicit/Omnicit/blob/master/docs/en-US/Get-WanIPAddress.md</maml:linkText> <maml:uri>https://github.com/Omnicit/Omnicit/blob/master/docs/en-US/Get-WanIPAddress.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-ModuleUpdate</command:name> <command:verb>Invoke</command:verb> <command:noun>ModuleUpdate</command:noun> <maml:description> <maml:para>Update one, several or all installed modules if an update is available from a repository location.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Invoke-ModuleUpdate for installed modules that have a repository location, for example from PowerShell Gallery. The function, without the Update parameter, returns the current and the latest version available for each installed module with a repository location. If there is any existing installed versions for each module that current version number will be displayed under Multiple versions. When the Update parameter is issued the function will update the named modules.</maml:para> <maml:para>The script is based on the "Check-ModuleUpdate.ps1" from Jeffery Hicks* to check for available updates for installed PowerShell modules. *Credit: http://jdhitsolutions.com/blog/powershell/5441/check-for-module-updates/</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-ModuleUpdate</maml:name> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies names or name patterns of modules that this function gets. Wildcard characters are permitted.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Update</maml:name> <maml:Description> <maml:para>Switch parameter to invoke the 'Update-Module' cmdlet for the targeted modules. The default behavior without this switch is that the function will only list the current and available versions.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Switch parameter forces the update of each specified module, regardless of the current version of the module installed. Using the 'Force' parameter without using 'Update' parameter does not perform anything extra.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies names or name patterns of modules that this function gets. Wildcard characters are permitted.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Update</maml:name> <maml:Description> <maml:para>Switch parameter to invoke the 'Update-Module' cmdlet for the targeted modules. The default behavior without this switch is that the function will only list the current and available versions.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Switch parameter forces the update of each specified module, regardless of the current version of the module installed. Using the 'Force' parameter without using 'Update' parameter does not perform anything extra.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Invoke-ModuleUpdate</dev:code> <dev:remarks> <maml:para>Name Current Version Online Version Multiple Versions ---- --------------- -------------- ----------------- SpeculationControl 1.0.0 1.0.8 False AzureAD 2.0.0.131 2.0.1.10 {2.0.0.115} AzureADPreview 2.0.0.154 2.0.1.11 {2.0.0.137} ISESteroids 2.7.1.7 2.7.1.7 {2.6.3.30} MicrosoftTeams 0.9.1 0.9.3 False NTFSSecurity 4.2.3 4.2.3 False Office365Connect 1.5.0 1.5.0 False ... ... ... ...</maml:para> <maml:para>This example returns the current and the latest version available for all installed modules that have a repository location.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Invoke-ModuleUpdate -Update</dev:code> <dev:remarks> <maml:para>Name Current Version Online Version Multiple Versions ---- --------------- -------------- ----------------- SpeculationControl 1.0.8 1.0.8 {1.0.0} AzureAD 2.0.1.10 2.0.1.10 {2.0.0.131, 2.0.0.115} AzureADPreview 2.0.1.11 2.0.1.11 {2.0.0.137, 2.0.0.154} ISESteroids 2.7.1.7 2.7.1.7 {2.6.3.30} MicrosoftTeams 0.9.3 0.9.3 {0.9.1} NTFSSecurity 4.2.3 4.2.3 False Office365Connect 1.5.0 1.5.0 False ... ... ... ...</maml:para> <maml:para>This example installs the latest version available for all installed modules that have a repository location.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Invoke-ModuleUpdate -Name 'AzureAD', 'PSScriptAnalyzer' -Update -Force</dev:code> <dev:remarks> <maml:para>Name Current Version Online Version Multiple Versions ---- --------------- -------------- ----------------- AzureAD 2.0.1.10 2.0.1.10 {2.0.0.131, 2.0.0.115} PSScriptAnalyzer 1.17.1 1.17.1 {1.17.0}</maml:para> <maml:para>This example will force install the latest version available for the AzureAD and PSScriptAnalyzer modules.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Omnicit/Omnicit/blob/master/docs/en-US/Invoke-ModuleUpdate.md</maml:linkText> <maml:uri>https://github.com/Omnicit/Omnicit/blob/master/docs/en-US/Invoke-ModuleUpdate.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-Mstsc</command:name> <command:verb>Start</command:verb> <command:noun>Mstsc</command:noun> <maml:description> <maml:para>Start a Mstsc process using predefined arguments from parameters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Start-Mstsc function starts a mstsc.exe process with arguments defined from the parameters. Built in check to validate that the current system is Windows. Shadow parameters are not yet implemented. Default port is defined as 3389.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-Mstsc</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="Server, IPAddress, Target, Node, Client"> <maml:name>ComputerName</maml:name> <maml:Description> <maml:para>Specifies the remote PC or Server to which you want to connect.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="Console"> <maml:name>Admin</maml:name> <maml:Description> <maml:para>Connects you to the console session for administering a remote PC.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>Specifies the port of the remote PC to which you want to connect. Default value is 3389.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3389</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FullScreen</maml:name> <maml:Description> <maml:para>Starts Remote Desktop in full-screen mode.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Prompt</maml:name> <maml:Description> <maml:para>Prompts you for your credentials when you connect to the remote PC.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Public</maml:name> <maml:Description> <maml:para>Runs Remote Desktop in public mode.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-Mstsc</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="Server, IPAddress, Target, Node, Client"> <maml:name>ComputerName</maml:name> <maml:Description> <maml:para>Specifies the remote PC or Server to which you want to connect.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="Console"> <maml:name>Admin</maml:name> <maml:Description> <maml:para>Connects you to the console session for administering a remote PC.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>Specifies the port of the remote PC to which you want to connect. Default value is 3389.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3389</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="w"> <maml:name>Width</maml:name> <maml:Description> <maml:para>Specifies the width of the Remote Desktop window.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="h"> <maml:name>Height</maml:name> <maml:Description> <maml:para>Specifies the height of the Remote Desktop window.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Prompt</maml:name> <maml:Description> <maml:para>Prompts you for your credentials when you connect to the remote PC.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Public</maml:name> <maml:Description> <maml:para>Runs Remote Desktop in public mode.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-Mstsc</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="Server, IPAddress, Target, Node, Client"> <maml:name>ComputerName</maml:name> <maml:Description> <maml:para>Specifies the remote PC or Server to which you want to connect.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="Console"> <maml:name>Admin</maml:name> <maml:Description> <maml:para>Connects you to the console session for administering a remote PC.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>Specifies the port of the remote PC to which you want to connect. Default value is 3389.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3389</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Span</maml:name> <maml:Description> <maml:para>Matches the remote desktop width and height with the local virtual desktop, spanning across multiple monitors, if necessary. To span across monitors, the monitors must be arranged to form a rectangle.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Prompt</maml:name> <maml:Description> <maml:para>Prompts you for your credentials when you connect to the remote PC.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Public</maml:name> <maml:Description> <maml:para>Runs Remote Desktop in public mode.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-Mstsc</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="Server, IPAddress, Target, Node, Client"> <maml:name>ComputerName</maml:name> <maml:Description> <maml:para>Specifies the remote PC or Server to which you want to connect.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="Console"> <maml:name>Admin</maml:name> <maml:Description> <maml:para>Connects you to the console session for administering a remote PC.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>Specifies the port of the remote PC to which you want to connect. Default value is 3389.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3389</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="multimon"> <maml:name>MultiMonitor</maml:name> <maml:Description> <maml:para>Configures the Remote Desktop Services session monitor layout to be identical to the current client-side configuration.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Prompt</maml:name> <maml:Description> <maml:para>Prompts you for your credentials when you connect to the remote PC.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Public</maml:name> <maml:Description> <maml:para>Runs Remote Desktop in public mode.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-Mstsc</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="Server, IPAddress, Target, Node, Client"> <maml:name>ComputerName</maml:name> <maml:Description> <maml:para>Specifies the remote PC or Server to which you want to connect.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="Console"> <maml:name>Admin</maml:name> <maml:Description> <maml:para>Connects you to the console session for administering a remote PC.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>Specifies the port of the remote PC to which you want to connect. Default value is 3389.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3389</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Prompt</maml:name> <maml:Description> <maml:para>Prompts you for your credentials when you connect to the remote PC.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Public</maml:name> <maml:Description> <maml:para>Runs Remote Desktop in public mode.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RestrictedAdmin</maml:name> <maml:Description> <maml:para>Connects you to the remote PC in Restricted Administration mode. In this mode, credentials won't be sent to the remote PC, which can protect you if you connect to a PC that has been compromised. However, connections made from the remote PC might not be authenticated by other PCs, which might impact application functionality and compatibility. This parameter implies the admin parameter.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-Mstsc</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="Server, IPAddress, Target, Node, Client"> <maml:name>ComputerName</maml:name> <maml:Description> <maml:para>Specifies the remote PC or Server to which you want to connect.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="Console"> <maml:name>Admin</maml:name> <maml:Description> <maml:para>Connects you to the console session for administering a remote PC.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>Specifies the port of the remote PC to which you want to connect. Default value is 3389.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3389</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Prompt</maml:name> <maml:Description> <maml:para>Prompts you for your credentials when you connect to the remote PC.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Public</maml:name> <maml:Description> <maml:para>Runs Remote Desktop in public mode.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RemoteGuard</maml:name> <maml:Description> <maml:para>Connects your device to a remote device using Remote Guard. Remote Guard prevents credentials from being sent to the remote PC, which can help protect your credentials if you connect to a remote PC that has been compromised. Unlike Restricted Administration mode, Remote Guard also supports connections made from the remote PC by redirecting all requests back to your device.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="Server, IPAddress, Target, Node, Client"> <maml:name>ComputerName</maml:name> <maml:Description> <maml:para>Specifies the remote PC or Server to which you want to connect.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="Console"> <maml:name>Admin</maml:name> <maml:Description> <maml:para>Connects you to the console session for administering a remote PC.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>Specifies the port of the remote PC to which you want to connect. Default value is 3389.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3389</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FullScreen</maml:name> <maml:Description> <maml:para>Starts Remote Desktop in full-screen mode.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="w"> <maml:name>Width</maml:name> <maml:Description> <maml:para>Specifies the width of the Remote Desktop window.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="h"> <maml:name>Height</maml:name> <maml:Description> <maml:para>Specifies the height of the Remote Desktop window.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Span</maml:name> <maml:Description> <maml:para>Matches the remote desktop width and height with the local virtual desktop, spanning across multiple monitors, if necessary. To span across monitors, the monitors must be arranged to form a rectangle.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="multimon"> <maml:name>MultiMonitor</maml:name> <maml:Description> <maml:para>Configures the Remote Desktop Services session monitor layout to be identical to the current client-side configuration.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Prompt</maml:name> <maml:Description> <maml:para>Prompts you for your credentials when you connect to the remote PC.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Public</maml:name> <maml:Description> <maml:para>Runs Remote Desktop in public mode.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RestrictedAdmin</maml:name> <maml:Description> <maml:para>Connects you to the remote PC in Restricted Administration mode. In this mode, credentials won't be sent to the remote PC, which can protect you if you connect to a PC that has been compromised. However, connections made from the remote PC might not be authenticated by other PCs, which might impact application functionality and compatibility. This parameter implies the admin parameter.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RemoteGuard</maml:name> <maml:Description> <maml:para>Connects your device to a remote device using Remote Guard. Remote Guard prevents credentials from being sent to the remote PC, which can help protect your credentials if you connect to a remote PC that has been compromised. Unlike Restricted Administration mode, Remote Guard also supports connections made from the remote PC by redirecting all requests back to your device.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Start-Mstsc -ComputerName Server01</dev:code> <dev:remarks> <maml:para>Starts mstsc.exe with the arguments /v:Server01:3389</maml:para> <maml:para>Connects to Server01 using the default RDP port 3389.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Start-Mstsc -ComputerName Server01 -Admin</dev:code> <dev:remarks> <maml:para>Starts mstsc.exe with the arguments /v:Server01:3389 /admin</maml:para> <maml:para>Connects to the console on Server01 using the default RDP port 3389.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Start-Mstsc -ComputerName Server01 -Admin -Port 9876</dev:code> <dev:remarks> <maml:para>Starts mstsc.exe with the arguments /v:Server01:9876 /admin</maml:para> <maml:para>Connects to the console on Server01 using port 9876.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Start-Mstsc -ComputerName Server01 -Admin -Port 9876 -FullScreen</dev:code> <dev:remarks> <maml:para>Starts mstsc.exe with the arguments /v:Server01:9876 /admin /f</maml:para> <maml:para>Connects to the console on Server01 using port 9876 with full-screen.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Start-Mstsc -ComputerName Server01 -Admin -Port 9876 -FullScreen -Prompt</dev:code> <dev:remarks> <maml:para>Starts mstsc.exe with the arguments /v:Server01:9876 /admin /f /prompt</maml:para> <maml:para>Connects to the console on Server01 using port 9876 with full-screen and prompt for credentials.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <dev:code>Start-Mstsc -ComputerName Server01 -Admin -Port 9876 -FullScreen -Prompt -Public</dev:code> <dev:remarks> <maml:para>Starts mstsc.exe with the arguments /v:Server01:9876 /admin /f /prompt /public</maml:para> <maml:para>Connects to the console on Server01 using port 9876 with full-screen, prompt for credentials and run RDP in public mode.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 7 --------------------------</maml:title> <dev:code>Start-Mstsc -ComputerName Server01 -RestrictedAdmin</dev:code> <dev:remarks> <maml:para>Starts mstsc.exe with the arguments /v:Server01:3389 /restrictedAdmin</maml:para> <maml:para>Connects to Server01 using the default RDP port 3389 with Restricted Admin.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 8 --------------------------</maml:title> <dev:code>Start-Mstsc -ComputerName Server01 -RemoteGuard</dev:code> <dev:remarks> <maml:para>Starts mstsc.exe with the arguments /v:Server01:3389 /remoteGuard</maml:para> <maml:para>Connects to Server01 using the default RDP port 3389 with Remote Guard.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/Omnicit/Omnicit/blob/master/docs/en-US/Start-Mstsc.md</maml:linkText> <maml:uri>https://github.com/Omnicit/Omnicit/blob/master/docs/en-US/Start-Mstsc.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |