PSPasswordGen

1.0.3

PSPasswordGen-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-RandomPassword</command:name>
      <command:verb>Get</command:verb>
      <command:noun>RandomPassword</command:noun>
      <maml:description>
        <maml:para>Generate some random passwords.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Generate some random passwords.</maml:para>
      <maml:para>The password will be generated based on the following rules:</maml:para>
      <maml:para>- The password constists of ASCII characters except white space and control characters.</maml:para>
      <maml:para>- The password contains at least 1 character from each of 4 categories: numerals, upper case letters, lower case letters and symbols.</maml:para>
      <maml:para>- If the "-No&lt;category name&gt;" option is specified, the corresponding rule is relaxed.</maml:para>
      <maml:para>- If The password length is too short to meet the rules for categories, some rules will be ignored.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-RandomPassword</maml:name>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
          <maml:name>Length</maml:name>
          <maml:description>
            <maml:para>Password length.(default: 12)</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>12</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">
          <maml:name>Count</maml:name>
          <maml:description>
            <maml:para>The count of password.(default: 20)</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>20</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none">
          <maml:name>ExcludeChars</maml:name>
          <maml:description>
            <maml:para>Specify the custom characters to be excluded.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">Char[]</command:parameterValue>
          <dev:type>
            <maml:name>Char[]</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>@()</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>NoNumerals</maml:name>
          <maml:description>
            <maml:para>Exclude numerals from password.</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>NoLowerCase</maml:name>
          <maml:description>
            <maml:para>Exclude lower case letters from password.</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>NoUpperCase</maml:name>
          <maml:description>
            <maml:para>Exclude upper case letters from password.</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>NoSymbols</maml:name>
          <maml:description>
            <maml:para>Exclude symbol characters from password.</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>NoAmbiguous</maml:name>
          <maml:description>
            <maml:para>Exclude "ambiguous" characters from password.</maml:para>
            <maml:para>The "ambiguous" are following characters:</maml:para>
            <maml:para>B 8 G 6 I 1 l 0 O Q D S 5 Z 2</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>NoVowels</maml:name>
          <maml:description>
            <maml:para>Exclude vowel characters from password.</maml:para>
            <maml:para>Vowels are following characters:</maml:para>
            <maml:para>0 1 a e i o u y A E I O U Y</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>NoMetaCharacters</maml:name>
          <maml:description>
            <maml:para>Exclude meta characters in shells from password.</maml:para>
            <maml:para>The targets are following characters:</maml:para>
            <maml:para>! " # $ % &amp; ' ( ) * , - ; &lt; = &gt; ? @ [ \ ] ^ ` { | } ~</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>NoNeedToEscape</maml:name>
          <maml:description>
            <maml:para>Exclude characters that need to be escaped when enclosed in single/double quotation marks in shells from password.</maml:para>
            <maml:para>The targets are following characters:</maml:para>
            <maml:para>! " $ % ' - \ `</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>Length</maml:name>
        <maml:description>
          <maml:para>Password length.(default: 12)</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>12</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">
        <maml:name>Count</maml:name>
        <maml:description>
          <maml:para>The count of password.(default: 20)</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>20</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>NoNumerals</maml:name>
        <maml:description>
          <maml:para>Exclude numerals from password.</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>NoLowerCase</maml:name>
        <maml:description>
          <maml:para>Exclude lower case letters from password.</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>NoUpperCase</maml:name>
        <maml:description>
          <maml:para>Exclude upper case letters from password.</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>NoSymbols</maml:name>
        <maml:description>
          <maml:para>Exclude symbol characters from password.</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>NoAmbiguous</maml:name>
        <maml:description>
          <maml:para>Exclude "ambiguous" characters from password.</maml:para>
          <maml:para>The "ambiguous" are following characters:</maml:para>
          <maml:para>B 8 G 6 I 1 l 0 O Q D S 5 Z 2</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>NoVowels</maml:name>
        <maml:description>
          <maml:para>Exclude vowel characters from password.</maml:para>
          <maml:para>Vowels are following characters:</maml:para>
          <maml:para>0 1 a e i o u y A E I O U Y</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>NoMetaCharacters</maml:name>
        <maml:description>
          <maml:para>Exclude meta characters in shells from password.</maml:para>
          <maml:para>The targets are following characters:</maml:para>
          <maml:para>! " # $ % &amp; ' ( ) * , - ; &lt; = &gt; ? @ [ \ ] ^ ` { | } ~</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>NoNeedToEscape</maml:name>
        <maml:description>
          <maml:para>Exclude characters that need to be escaped when enclosed in single/double quotation marks in shells from password.</maml:para>
          <maml:para>The targets are following characters:</maml:para>
          <maml:para>! " $ % ' - \ `</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>False</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none">
        <maml:name>ExcludeChars</maml:name>
        <maml:description>
          <maml:para>Specify the custom characters to be excluded.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">Char[]</command:parameterValue>
        <dev:type>
          <maml:name>Char[]</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>@()</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>Array of System.String</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>Generate-Password</dev:code>
        <dev:remarks>
          <maml:para>20 passwords will be generated. Each password length is 12 characters.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>
        <dev:code>Generate-Password -Length 20 -Count 1</dev:code>
        <dev:remarks>
          <maml:para>1 password will be generated. The length of the password is 20 characters.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title>
        <dev:code>Generate-Password -NoSymbols -ExcludeChars "Qwerty"</dev:code>
        <dev:remarks>
          <maml:para>20 passwords will be generated. The length of each password is 12 characters.</maml:para>
          <maml:para>Generated passwords do not contains the symbols and "Q", "w", "e", "r", "t", "y".</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Repository: https://www.powershellgallery.com/packages/PSPasswordGen</maml:linkText>
        <maml:uri></maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Project: https://github.com/telitas/PSPasswordGen</maml:linkText>
        <maml:uri></maml:uri>
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
</helpItems>