en-US/CorkScrew-help.xml
|
<?xml version="1.0" encoding="utf-8"?> <helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CsConfiguration</command:name> <command:verb>Get</command:verb> <command:noun>CsConfiguration</command:noun> <maml:description> <maml:para>{{Fill in the Synopsis}}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Fill in the Description}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CsConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <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-GeoCoding</command:name> <command:verb>Get</command:verb> <command:noun>GeoCoding</command:noun> <maml:description> <maml:para>{{Fill in the Synopsis}}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Fill in the Description}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-GeoCoding</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Address</maml:name> <maml:Description> <maml:para>{{Fill Address Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Address</maml:name> <maml:Description> <maml:para>{{Fill Address Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <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-GithubRepo</command:name> <command:verb>Get</command:verb> <command:noun>GithubRepo</command:noun> <maml:description> <maml:para>{{Fill in the Synopsis}}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Fill in the Description}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-GithubRepo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Owner</maml:name> <maml:Description> <maml:para>{{Fill Owner Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Repository</maml:name> <maml:Description> <maml:para>{{Fill Repository Description}}</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>Credential</maml:name> <maml:Description> <maml:para>{{Fill Credential Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Release</maml:name> <maml:Description> <maml:para>{{Fill Release Description}}</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>TargetPath</maml:name> <maml:Description> <maml:para>{{Fill TargetPath Description}}</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>Branch</maml:name> <maml:Description> <maml:para>{{Fill Branch Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>{{Fill Credential Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Owner</maml:name> <maml:Description> <maml:para>{{Fill Owner Description}}</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>Release</maml:name> <maml:Description> <maml:para>{{Fill Release Description}}</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="1" aliases="none"> <maml:name>Repository</maml:name> <maml:Description> <maml:para>{{Fill Repository Description}}</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>TargetPath</maml:name> <maml:Description> <maml:para>{{Fill TargetPath Description}}</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>Branch</maml:name> <maml:Description> <maml:para>{{Fill Branch Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <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-Ninite</command:name> <command:verb>Get</command:verb> <command:noun>Ninite</command:noun> <maml:description> <maml:para>Downloads and executes a Ninite installer for the selected applications.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-NiniteInstaller queries the ninite.com website and provides a list of available applications. If valid application names are given, it then downloads and executes the installer for those applications.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Ninite</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Apps</maml:name> <maml:Description> <maml:para>Comma separated list of applications to install</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">.net4.7.2</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">7zip</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">aimp</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">air</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">audacity</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">avast</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">avg</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">avira</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">blender</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">cccp</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">cdburnerxp</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">chrome</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">classicstart</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">cutepdf</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">discord</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">dropbox</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">eclipse</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">essentials</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">evernote</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">everything</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">faststone</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">filezilla</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">firefox</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">foobar</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">foxit</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">gimp</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">glary</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">gom</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">googlebackupandsync</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">googleearth</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">greenshot</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">handbrake</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">imgburn</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">infrarecorder</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">inkscape</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">irfanview</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">itunes</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">java8</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">jdk8</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">jdkx11</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">jdkx8</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">keepass2</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">klitecodecs</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">krita</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">launchy</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">libreoffice</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">malwarebytes</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">mediamonkey</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">musicbee</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">notepadplusplus</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">nvda</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">onedrive</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">openoffice</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">operaChromium</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">paint.net</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">pdfcreator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">peazip</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">pidgin</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">putty</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">python</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">qbittorrent</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">realvnc</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">revo</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">sharex</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">shockwave</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">silverlight</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">skype</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">spotify</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">spybot2</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">steam</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">sugarsync</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">sumatrapdf</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">super</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">teamviewer14</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">teracopy</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">thunderbird</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">trillian</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">vlc</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">vscode</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">winamp</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">windirstat</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">winmerge</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">winrar</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">winscp</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">xnview</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Apps</maml:name> <maml:Description> <maml:para>Comma separated list of applications to install</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-Ninite -Apps firefox,7zip</dev:code> <dev:remarks> <maml:para>Downloads and installs firefox and 7zip.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew/blob/master/docs/Get-Ninite.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/LockstepGroup/CorkScrew</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://www.powershellgallery.com/packages/CorkScrew</maml:linkText> <maml:uri>https://www.powershellgallery.com/packages/CorkScrew</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Ninite</maml:linkText> <maml:uri>https://ninite.com</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-OsVersion</command:name> <command:verb>Get</command:verb> <command:noun>OsVersion</command:noun> <maml:description> <maml:para>{{Fill in the Synopsis}}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Fill in the Description}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-OsVersion</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ComputerName</maml:name> <maml:Description> <maml:para>{{Fill ComputerName Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ComputerName</maml:name> <maml:Description> <maml:para>{{Fill ComputerName Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <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>Group-ObjectByIpAddress</command:name> <command:verb>Group</command:verb> <command:noun>ObjectByIpAddress</command:noun> <maml:description> <maml:para>{{Fill in the Synopsis}}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Fill in the Description}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Group-ObjectByIpAddress</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="IpAddress"> <maml:name>Property</maml:name> <maml:Description> <maml:para>{{Fill Property Description}}</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 (ByValue)" position="named" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>{{Fill InputObject Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>{{Fill InputObject Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="IpAddress"> <maml:name>Property</maml:name> <maml:Description> <maml:para>{{Fill Property Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <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-ElevatedProcess</command:name> <command:verb>Invoke</command:verb> <command:noun>ElevatedProcess</command:noun> <maml:description> <maml:para>Starts a process with elevated privileges on a Windows system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Starts a process with elevated privileges on a Windows system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-ElevatedProcess</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ProcessName</maml:name> <maml:Description> <maml:para>{{Fill ProcessName Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Arguments</maml:name> <maml:Description> <maml:para>{{Fill Arguments Description}}</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="none"> <maml:name>WorkingDirectory</maml:name> <maml:Description> <maml:para>{{Fill WorkingDirectory Description}}</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>NoWait</maml:name> <maml:Description> <maml:para>{{Fill NoWait Description}}</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="1" aliases="none"> <maml:name>Arguments</maml:name> <maml:Description> <maml:para>{{Fill Arguments Description}}</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>NoWait</maml:name> <maml:Description> <maml:para>{{Fill NoWait Description}}</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="0" aliases="none"> <maml:name>ProcessName</maml:name> <maml:Description> <maml:para>{{Fill ProcessName Description}}</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="none"> <maml:name>WorkingDirectory</maml:name> <maml:Description> <maml:para>{{Fill WorkingDirectory Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Invoke-ElevatedProcess</dev:code> <dev:remarks> <maml:para>Creates instance of current PowerShell host process with elevated priveleges.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Invoke-ElevatedProcess -ProcessName</dev:code> <dev:remarks> <maml:para>Creates instance of current PowerShell host process with elevated priveleges.</maml:para> </dev:remarks> </command:example> </command:examples> <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-FuriousIp</command:name> <command:verb>Invoke</command:verb> <command:noun>FuriousIp</command:noun> <maml:description> <maml:para>Pings things in a furiously fast fashion.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses .net ping and runspaces to ping a given network range very quickly. Optionally does a reverse lookup as well.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-FuriousIp</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Network</maml:name> <maml:Description> <maml:para>Network in any of the following formats: 192.168.10.10-192.168.11.10 192.168.10.20-255 192.168.*.2 192.168.10.0/24 192.168.10.0 255.255.255.0</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>SubnetMask</maml:name> <maml:Description> <maml:para>Subnet Mask for desired Network</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>Limit</maml:name> <maml:Description> <maml:para>Number of concurrent threads to use</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PingDelay</maml:name> <maml:Description> <maml:para>Time to wait for ping response in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ReverseLookup</maml:name> <maml:Description> <maml:para>Specify if reverse lookup is desired</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="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Number of concurrent threads to use</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Network</maml:name> <maml:Description> <maml:para>Network in any of the following formats: 192.168.10.10-192.168.11.10 192.168.10.20-255 192.168.*.2 192.168.10.0/24 192.168.10.0 255.255.255.0</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>PingDelay</maml:name> <maml:Description> <maml:para>Time to wait for ping response in milliseconds</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ReverseLookup</maml:name> <maml:Description> <maml:para>Specify if reverse lookup is desired</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="1" aliases="none"> <maml:name>SubnetMask</maml:name> <maml:Description> <maml:para>Subnet Mask for desired Network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Net.IPAddress</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Invoke-FuriousIp 10.88.64.0/29 Name State Hostname ---- ----- -------- 10.88.64.1 True 10.88.64.2 False 10.88.64.3 False 10.88.64.4 False 10.88.64.5 False 10.88.64.6 False</dev:code> <dev:remarks> <maml:para>Pings all address in 10.88.64.0/29 network.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Invoke-FuriousIp 10.88.64.0/29 -ReverseLookup Name State Hostname ---- ----- -------- 10.88.64.1 True core.example.com 10.88.64.2 False 10.88.64.3 False 10.88.64.4 False 10.88.64.5 False 10.88.64.6 False</dev:code> <dev:remarks> <maml:para>Pings all address in 10.88.64.0/29 network and performs a reverse lookup for each.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew/blob/master/docs/Invoke-FuriousIp.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/LockstepGroup/CorkScrew</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://www.powershellgallery.com/packages/CorkScrew</maml:linkText> <maml:uri>https://www.powershellgallery.com/packages/CorkScrew</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-NotepadPlusPlus</command:name> <command:verb>Invoke</command:verb> <command:noun>NotepadPlusPlus</command:noun> <maml:description> <maml:para>Just a quick shortcut to NotepadPlusPlus, alias npp.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Just a quick shortcut to NotepadPlusPlus, alias npp.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-NotepadPlusPlus</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Path to desired file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Path to desired file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> npp</dev:code> <dev:remarks> <maml:para>Opens NotepadPlusPlus.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> npp todo.txt</dev:code> <dev:remarks> <maml:para>Opens todo.txt file in NotepadPlusPlus.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew/blob/master/docs/Invoke-NotepadPlusPlus.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/LockstepGroup/CorkScrew</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://www.powershellgallery.com/packages/CorkScrew</maml:linkText> <maml:uri>https://www.powershellgallery.com/packages/CorkScrew</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-CsConfiguration</command:name> <command:verb>New</command:verb> <command:noun>CsConfiguration</command:noun> <maml:description> <maml:para>{{Fill in the Synopsis}}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Fill in the Description}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-CsConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ExamplePath</maml:name> <maml:Description> <maml:para>{{Fill ExamplePath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-CsConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>HashTable</maml:name> <maml:Description> <maml:para>{{Fill HashTable Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ExamplePath</maml:name> <maml:Description> <maml:para>{{Fill ExamplePath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>HashTable</maml:name> <maml:Description> <maml:para>{{Fill HashTable Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-EncryptedString</command:name> <command:verb>New</command:verb> <command:noun>EncryptedString</command:noun> <maml:description> <maml:para>Encrypts a string using an Aes key.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Encrypts a string using an AES key. Key can be generated by New-EncryptionKey</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-EncryptedString</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>PlainTextString</maml:name> <maml:Description> <maml:para>String to be encrypted</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="Key"> <maml:name>AesKey</maml:name> <maml:Description> <maml:para>Byte Array to be used as Aes Key</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="Key"> <maml:name>AesKey</maml:name> <maml:Description> <maml:para>Byte Array to be used as Aes Key</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>PlainTextString</maml:name> <maml:Description> <maml:para>String to be encrypted</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $Key = New-EncryptionKey PS C:\> $EncryptedString = New-EncryptedString -PlainTextString 'my secret' -AesKey $Key PS C:\> $EncryptedString 76492d1116743f0423413b16050a5345MgB8AHUAbwBwAGwAaABtAEUAUQBzADgAawBaAGYAOABZAFkASQArADIAbgBXAGcAPQA9AHwANAA0ADIAYgA2ADYAYgBjADMAYwBkADcAZgA3ADMAZgA5ADEAYwAyADAAZAA3ADUAOABlADQAZQA4ADUANAAwAGQAMwA0ADYAYgAwADYAZgBmADYANQBmADYAOAAwADcAMQBiADAAYgAwAGYAOQA2ADMANwA0ADAANgBhAGQAZgA=</dev:code> <dev:remarks> <maml:para>Creates a new encryption key and encryps the string 'my secret'.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew/blob/master/docs/New-EncryptedString.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/LockstepGroup/CorkScrew</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://www.powershellgallery.com/packages/CorkScrew</maml:linkText> <maml:uri>https://www.powershellgallery.com/packages/CorkScrew</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-EncryptionKey</command:name> <command:verb>New</command:verb> <command:noun>EncryptionKey</command:noun> <maml:description> <maml:para>Generates Byte Array that can be used as an AES key for encrypting SecureStrings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Generates Byte Array that can be used as an AES key for encrypting SecureStrings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-EncryptionKey</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Size</maml:name> <maml:Description> <maml:para>Desired size of array in 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Size</maml:name> <maml:Description> <maml:para>Desired size of array in 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Array</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-EncryptionKey</dev:code> <dev:remarks> <maml:para>Returns a 32 byte array.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-EncryptionKey -Size 64</dev:code> <dev:remarks> <maml:para>Returns a 64 byte array.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew/blob/master/docs/New-EncryptionKey.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/LockstepGroup/CorkScrew</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://www.powershellgallery.com/packages/CorkScrew</maml:linkText> <maml:uri>https://www.powershellgallery.com/packages/CorkScrew</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-PsModule</command:name> <command:verb>New</command:verb> <command:noun>PsModule</command:noun> <maml:description> <maml:para>{{Fill in the Synopsis}}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Fill in the Description}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-PsModule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</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>Force</maml:name> <maml:Description> <maml:para>{{Fill Force Description}}</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>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</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>SecureNuGetApiKey</maml:name> <maml:Description> <maml:para>{{Fill SecureNuGetApiKey Description}}</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>SecureSlackApiKey</maml:name> <maml:Description> <maml:para>{{Fill SecureSlackApiKey Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>{{Fill Force Description}}</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="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</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>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</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>SecureNuGetApiKey</maml:name> <maml:Description> <maml:para>{{Fill SecureNuGetApiKey Description}}</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>SecureSlackApiKey</maml:name> <maml:Description> <maml:para>{{Fill SecureSlackApiKey Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew/blob/master/docs/New-PsModule.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/LockstepGroup/CorkScrew</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://www.powershellgallery.com/packages/CorkScrew</maml:linkText> <maml:uri>https://www.powershellgallery.com/packages/CorkScrew</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>Send-CsLoggerMessage</command:name> <command:verb>Send</command:verb> <command:noun>CsLoggerMessage</command:noun> <maml:description> <maml:para>Sends a log message to active CsLogger instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sends a log message to active CsLogger instance.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-CsLoggerMessage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>Desired message for the log</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Application</maml:name> <maml:Description> <maml:para>The Name of the application that is sending the log</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Severity</maml:name> <maml:Description> <maml:para>Severity level of the log</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Emergency</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Alert</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Critical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Notice</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Informational</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Debug</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Facility</maml:name> <maml:Description> <maml:para>The log source facililty</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">kern</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">user</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">mail</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">daemon</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">auth</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">syslog</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">lpr</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">news</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">uucp</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">clock</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">authpriv</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ftp</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ntp</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">logaudit</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">logalert</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">cron</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">local0</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">local1</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">local2</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">local3</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">local4</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">local5</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">local6</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">local7</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Application</maml:name> <maml:Description> <maml:para>The Name of the application that is sending the log</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Facility</maml:name> <maml:Description> <maml:para>The log source facililty</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>Desired message for the log</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Severity</maml:name> <maml:Description> <maml:para>Severity level of the log</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>> Start-CsLogger > Send-CsLoggerMessage -Message "My log message" -Application "My Cool App" -Severity "Emergency" -Facility "user" > Stop-CsLogger</dev:code> <dev:remarks> <maml:para>Starts a CsLogger instance. Sends the message "My log message" from Application "My Cool App" with a Severity of "Emergency" and Facility of "user". Stops CsLogger instance.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew/blob/master/docs/cmdlets/Send-CsLoggerMessage.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/LockstepGroup/CorkScrew</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://www.powershellgallery.com/packages/CorkScrew</maml:linkText> <maml:uri>https://www.powershellgallery.com/packages/CorkScrew</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-CsLogger</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew/blob/master/docs/cmdlets/Start-CsLogger.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-CsLogger</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew/blob/master/docs/cmdlets/Stop-CsLogger.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>Send-LogDnaMessage</command:name> <command:verb>Send</command:verb> <command:noun>LogDnaMessage</command:noun> <maml:description> <maml:para>Sends a log message to LogDna using the ingest Api.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Fill in the Description}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-LogDnaMessage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ApiKey</maml:name> <maml:Description> <maml:para>{{Fill ApiKey Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>{{Fill Message Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Application</maml:name> <maml:Description> <maml:para>{{Fill Application Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Level</maml:name> <maml:Description> <maml:para>{{Fill Level Description}}</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">CRITICAL</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DEBUG</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EMERGENCY</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ERROR</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FATAL</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">INFO</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SEVERE</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TRACE</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WARN</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>{{Fill Environment Description}}</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="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: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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ApiKey</maml:name> <maml:Description> <maml:para>{{Fill ApiKey Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Application</maml:name> <maml:Description> <maml:para>{{Fill Application Description}}</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="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:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>{{Fill Environment Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Level</maml:name> <maml:Description> <maml:para>{{Fill Level Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>{{Fill Message Description}}</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <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>Send-SyslogMessage</command:name> <command:verb>Send</command:verb> <command:noun>SyslogMessage</command:noun> <maml:description> <maml:para>{{Fill in the Synopsis}}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Fill in the Description}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-SyslogMessage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>{{Fill Server Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>{{Fill Message Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Application</maml:name> <maml:Description> <maml:para>{{Fill Application Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Severity</maml:name> <maml:Description> <maml:para>{{Fill Severity Description}}</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Emergency</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Alert</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Critical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Notice</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Informational</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Debug</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Facility</maml:name> <maml:Description> <maml:para>{{Fill Facility Description}}</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">kern</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">user</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">mail</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">daemon</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">auth</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">syslog</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">lpr</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">news</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">uucp</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">clock</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">authpriv</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ftp</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ntp</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">logaudit</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">logalert</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">cron</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">local0</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">local1</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">local2</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">local3</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">local4</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">local5</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">local6</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">local7</command:parameterValue> </command:parameterValueGroup> <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="5" aliases="none"> <maml:name>Hostname</maml:name> <maml:Description> <maml:para>{{Fill Hostname Description}}</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="6" aliases="none"> <maml:name>Timestamp</maml:name> <maml:Description> <maml:para>{{Fill Timestamp Description}}</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="7" aliases="none"> <maml:name>UDPPort</maml:name> <maml:Description> <maml:para>{{Fill UDPPort Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="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: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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Application</maml:name> <maml:Description> <maml:para>{{Fill Application Description}}</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="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:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Facility</maml:name> <maml:Description> <maml:para>{{Fill Facility Description}}</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="5" aliases="none"> <maml:name>Hostname</maml:name> <maml:Description> <maml:para>{{Fill Hostname Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>{{Fill Message Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>{{Fill Server Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Severity</maml:name> <maml:Description> <maml:para>{{Fill Severity Description}}</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="6" aliases="none"> <maml:name>Timestamp</maml:name> <maml:Description> <maml:para>{{Fill Timestamp Description}}</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="7" aliases="none"> <maml:name>UDPPort</maml:name> <maml:Description> <maml:para>{{Fill UDPPort Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <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-CsLogger</command:name> <command:verb>Start</command:verb> <command:noun>CsLogger</command:noun> <maml:description> <maml:para>Starts background log collector.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>CsLogger is a special runspace designed to receive logs and send them to a syslog server as fast as it can while the rest of your script gets on with it's job. Originally it was designed to circumvent a log server who's time precision only went as low as a second. This meant that logs that showed up out of order, with the same second in the timestamp, stayed out of order. Reading and sending these logs 1 second at a time fixed the issue. You can use DelayMilliseconds to customize this effect.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-CsLogger</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SyslogServer</maml:name> <maml:Description> <maml:para>Destination SyslogServer</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>SyslogPort</maml:name> <maml:Description> <maml:para>UDP Port for SyslogServer</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>DelayMilliseconds</maml:name> <maml:Description> <maml:para>Delay in Milliseconds between sending logs to SyslogServer</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>DelayMilliseconds</maml:name> <maml:Description> <maml:para>Delay in Milliseconds between sending logs to SyslogServer</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>SyslogPort</maml:name> <maml:Description> <maml:para>UDP Port for SyslogServer</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SyslogServer</maml:name> <maml:Description> <maml:para>Destination SyslogServer</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>>Start-CsLogger</dev:code> <dev:remarks> <maml:para>Starts a CsLogger runspace with default delay of 1000 Milliseconds, $global:SyslogServer, and $global:SyslogPort settings.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>>Start-CsLogger -SyslogServer 'syslog.example.com' -SyslogPort 999 -DelayMilliseconds 5</dev:code> <dev:remarks> <maml:para>Starts a CsLogger runspace with delay of 5 Milliseconds, sending logs to syslog.exampl.com over port 999.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew/blob/master/docs/cmdlets/Start-CsLogger.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/LockstepGroup/CorkScrew</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://www.powershellgallery.com/packages/CorkScrew</maml:linkText> <maml:uri>https://www.powershellgallery.com/packages/CorkScrew</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Send-CsLoggerMessage</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew/blob/master/docs/cmdlets/Send-CsLoggerMessage.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-CsLogger</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew/blob/master/docs/cmdlets/Stop-CsLogger.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>Stop-CsLogger</command:name> <command:verb>Stop</command:verb> <command:noun>CsLogger</command:noun> <maml:description> <maml:para>Stops an instance of CsLogger.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Stops an instance of CsLogger.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-CsLogger</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>>Stop-CsLogger</dev:code> <dev:remarks> <maml:para>Stops active CsLogger instance.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew/blob/master/docs/cmdlets/Stop-CsLogger.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/LockstepGroup/CorkScrew</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://www.powershellgallery.com/packages/CorkScrew</maml:linkText> <maml:uri>https://www.powershellgallery.com/packages/CorkScrew</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-CsLogger</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew/blob/master/docs/cmdlets/Start-CsLogger.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Send-CsLoggerMessage</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew/blob/master/docs/cmdlets/Send-CsLoggerMessage.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>Test-UserElevation</command:name> <command:verb>Test</command:verb> <command:noun>UserElevation</command:noun> <maml:description> <maml:para>{{Fill in the Synopsis}}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Fill in the Description}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-UserElevation</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <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>Write-CustomLog</command:name> <command:verb>Write</command:verb> <command:noun>CustomLog</command:noun> <maml:description> <maml:para>Creates a customized Log Message.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a customized Log Message based on the desired Verbosity level. Verbosity is set with the global variable $global:Verbosity. If the Write-CustomLog Verbosity Threshold is lower than $global:Verbosity, then Message will be written to the Verbose Stream and optionally to LogFile. LogFile defaults to $global:Logfile. The intended usage is to set Verbosity and LogFile at the top of whatever script you use this in.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Write-CustomLog</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>LogLevel</maml:name> <maml:Description> <maml:para>{{Fill LogLevel Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>String to log</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="none"> <maml:name>LogFile</maml:name> <maml:Description> <maml:para>LogFile to write to.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>TimeStampFormat</maml:name> <maml:Description> <maml:para>Custom TimeStamp format</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>CsLogger</maml:name> <maml:Description> <maml:para>{{Fill CsLogger Description}}</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>IsError</maml:name> <maml:Description> <maml:para>{{Fill IsError Description}}</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>LogHeader</maml:name> <maml:Description> <maml:para>Changes the format of the LogMessage so it's easy to see the start of a section of logs</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>SyslogApplication</maml:name> <maml:Description> <maml:para>{{Fill SyslogApplication Description}}</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>SyslogPort</maml:name> <maml:Description> <maml:para>{{Fill SyslogPort Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SyslogServer</maml:name> <maml:Description> <maml:para>{{Fill SyslogServer Description}}</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>LogDnaApiKey</maml:name> <maml:Description> <maml:para>{{Fill LogDnaApiKey Description}}</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>LogDnaEnvironment</maml:name> <maml:Description> <maml:para>{{Fill LogDnaEnvironment Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CsLogger</maml:name> <maml:Description> <maml:para>{{Fill CsLogger Description}}</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>IsError</maml:name> <maml:Description> <maml:para>{{Fill IsError Description}}</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="2" aliases="none"> <maml:name>LogFile</maml:name> <maml:Description> <maml:para>LogFile to write to.</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>LogHeader</maml:name> <maml:Description> <maml:para>Changes the format of the LogMessage so it's easy to see the start of a section of logs</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="0" aliases="none"> <maml:name>LogLevel</maml:name> <maml:Description> <maml:para>{{Fill LogLevel Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>String to log</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>SyslogApplication</maml:name> <maml:Description> <maml:para>{{Fill SyslogApplication Description}}</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>SyslogPort</maml:name> <maml:Description> <maml:para>{{Fill SyslogPort Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SyslogServer</maml:name> <maml:Description> <maml:para>{{Fill SyslogServer Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>TimeStampFormat</maml:name> <maml:Description> <maml:para>Custom TimeStamp format</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>LogDnaApiKey</maml:name> <maml:Description> <maml:para>{{Fill LogDnaApiKey Description}}</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>LogDnaEnvironment</maml:name> <maml:Description> <maml:para>{{Fill LogDnaEnvironment Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Write-CustomLog 1 "Special Log Message"</dev:code> <dev:remarks> <maml:para>If $Global:Verbosity is higher than 1, write formatted log message to Verbose Stream. Also write to LogFile if set globally.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Write-CustomLog 1 "This is a Log header" -LogHeader</dev:code> <dev:remarks> <maml:para>If $Global:Verbosity is higher than 1, write formatted log header message to Verbose Stream. Also write to LogFile if set globally.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew/blob/master/docs/Write-CustomLog.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/LockstepGroup/CorkScrew</maml:linkText> <maml:uri>https://github.com/LockstepGroup/CorkScrew</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://www.powershellgallery.com/packages/CorkScrew</maml:linkText> <maml:uri>https://www.powershellgallery.com/packages/CorkScrew</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |