CredentialManager

1.0

CredentialManager.dll-Help.xml

                                <?xml version="1.0" encoding="utf-8" ?>

<helpItems xmlns="http://msh" schema="maml">

  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

    <command:details>

      <command:name>Get-StoredCredential</command:name>

      <command:verb>Get</command:verb>

      <command:noun>StoredCredential</command:noun>

      <maml:description>

        <maml:para>Will output credentials from the Windows Credential Manager as either PScredential or Credential objects</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Will output all credentials available in the Windows credential manager or one with a specified Traget and type.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Get-StoredCredential</maml:name>

        <command:parameter required="false" position="named">

          <maml:name>Target</maml:name>

          <maml:description>

            <maml:para>Specify the name of the target for the credential required.</maml:para>

          </maml:description>

          <command:parameterValue>String</command:parameterValue>

        </command:parameter>

        <command:parameter required="false" position="named">

          <maml:name>Type</maml:name>

          <maml:description>

            <maml:para>The type of credential that should be retrieved</maml:para>

          </maml:description>

          <command:parameterValue>CRED_TYPE</command:parameterValue>

        </command:parameter>

        <command:parameter required="false" position="named">

          <maml:name>AsPsCredential</maml:name>

          <maml:description>

            <maml:para>Selects if output objects should be PSCredential ($true) or Credential ($false)</maml:para>

          </maml:description>

          <command:parameterValue>BOOL</command:parameterValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>PSCredential</maml:name>

          <maml:uri />

          <maml:description>

            <maml:para>PSCredential Object</maml:para>

          </maml:description>

        </dev:type>

      </command:returnValue>

      <command:returnValue>

        <dev:type>

          <maml:name>Credential</maml:name>

          <maml:uri />

          <maml:description>

            <maml:para>Credential Object</maml:para>

          </maml:description>

        </dev:type>

      </command:returnValue>

    </command:returnValues>

    <command:examples>

      <command:example>

        <maml:title>------------------------ EXAMPLE 1 ------------------------</maml:title>

        <maml:introduction>

          <maml:para></maml:para>

        </maml:introduction>

        <dev:code>Get-StoredCredential -Target "Server01"</dev:code>

        <dev:remarks>

          <maml:para>This will return a single PSCredential object with the stored credentials for Server01</maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>------------------------ EXAMPLE 2 ------------------------</maml:title>

        <maml:introduction>

          <maml:para></maml:para>

        </maml:introduction>

        <dev:code>Get-StoredCredential -AsPsCredential $false</dev:code>

        <dev:remarks>

          <maml:para>This will return Credential objects for all available credentials</maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>------------------------ EXAMPLE 3 ------------------------</maml:title>

        <maml:introduction>

          <maml:para></maml:para>

        </maml:introduction>

        <dev:code>Get-StoredCredential -Target "Server01" -Type GENERIC</dev:code>

        <dev:remarks>

          <maml:para>This will return a single PSCredential object with the stored credentials for Server01 which is of the GENERIC type</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

  </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">

    <command:details>

    <command:name>New-StoredCredential</command:name>

  <command:verb>New</command:verb>

  <command:noun>StoredCredential</command:noun>

  <maml:description>

    <maml:para>Wil create a new credential in the Windows Credential Store</maml:para>

  </maml:description>

  </command:details>

  <maml:description>

    <maml:para>Will create a new credential with the specified details in the Windows credential store</maml:para>

  </maml:description>

  <command:syntax>

    <command:syntaxItem>

      <maml:name>New-StoredCredential</maml:name>

      <command:parameter required="false" position="named">

        <maml:name>Target</maml:name>

        <maml:description>

          <maml:para>Specify the name of the target for the new credential.</maml:para>

        </maml:description>

        <command:parameterValue>String</command:parameterValue>

      </command:parameter>

      <command:parameter required="false" position="named">

        <maml:name>Type</maml:name>

        <maml:description>

          <maml:para>The type of credential to create</maml:para>

        </maml:description>

        <command:parameterValue>CRED_TYPE</command:parameterValue>

      </command:parameter>

      <command:parameter required="false" position="named">

        <maml:name>Username</maml:name>

        <maml:description>

          <maml:para>The username for the target machine to store in the credential</maml:para>

        </maml:description>

        <command:parameterValue>String</command:parameterValue>

      </command:parameter>

      <command:parameter required="false" position="named">

        <maml:name>Password</maml:name>

        <maml:description>

          <maml:para>The Password for the target machine to store in the credential</maml:para>

        </maml:description>

        <command:parameterValue>String</command:parameterValue>

      </command:parameter>

      <command:parameter required="false" position="named">

        <maml:name>Persist</maml:name>

        <maml:description>

          <maml:para>The persistance for the credential to be created with, options are SESSION, LOCAL_MACHINE or ENTERPRISE</maml:para>

        </maml:description>

        <command:parameterValue>String</command:parameterValue>

      </command:parameter>

    </command:syntaxItem>

  </command:syntax>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>Credential</maml:name>

          <maml:uri />

          <maml:description>

            <maml:para>Credential Object</maml:para>

          </maml:description>

        </dev:type>

      </command:returnValue>

    </command:returnValues>

  <command:examples>

    <command:example>

      <maml:title>------------------------ EXAMPLE 1 ------------------------</maml:title>

      <maml:introduction>

        <maml:para></maml:para>

      </maml:introduction>

      <dev:code>New-StoredCredential -Target "Server01" -Username User01 -Pasword Password1 -Type GENERIC -Persist LOCAL_MACHINE</dev:code>

      <dev:remarks>

        <maml:para>Create a Generic credential for use with Server01 stored permanantly on the local machine</maml:para>

      </dev:remarks>

    </command:example>

    <command:example>

      <maml:title>------------------------ EXAMPLE 2 ------------------------</maml:title>

      <maml:introduction>

        <maml:para></maml:para>

      </maml:introduction>

      <dev:code>New-StoredCredential</dev:code>

      <dev:remarks>

        <maml:para>Create a new credential for the local machine with the logged on users name, and a randomly generated password, Type will be GENERIC and Persistance will be SESSION</maml:para>

      </dev:remarks>

    </command:example>

  </command:examples>

  </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">

    <command:details>

      <command:name>Remove-StoredCredential</command:name>

      <command:verb>Remove</command:verb>

      <command:noun>StoredCredential</command:noun>

      <maml:description>

        <maml:para>Wil remove a credential in the Windows Credential Store</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Wil remove the specified credential from the Windowws Credential Store</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>New-StoredCredential</maml:name>

        <command:parameter required="true" position="named">

          <maml:name>Target</maml:name>

          <maml:description>

            <maml:para>Specify the name of the target for the credential to be removed.</maml:para>

          </maml:description>

          <command:parameterValue>String</command:parameterValue>

        </command:parameter>

        <command:parameter required="false" position="named">

          <maml:name>Type</maml:name>

          <maml:description>

            <maml:para>The type of credential to remove</maml:para>

          </maml:description>

          <command:parameterValue>CRED_TYPE</command:parameterValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:examples>

      <command:example>

        <maml:title>------------------------ EXAMPLE 1 ------------------------</maml:title>

        <maml:introduction>

          <maml:para></maml:para>

        </maml:introduction>

        <dev:code>Remove-StoredCredential -Target "Server01" -Type GENERIC</dev:code>

        <dev:remarks>

          <maml:para>Remove the credential for Server01 that is of the Type GENERIC</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

  </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">

    <command:details>

      <command:name>Get-StrongPassword</command:name>

      <command:verb>Get</command:verb>

      <command:noun>StrongPassword</command:noun>

      <maml:description>

        <maml:para>Will generate a random strong password.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Will generate a random strong pasword with special characters</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Get-StrongPassword</maml:name>

        <command:parameter required="false" position="named">

          <maml:name>Length</maml:name>

          <maml:description>

            <maml:para>The length in characters to make the new password</maml:para>

          </maml:description>

          <command:parameterValue>int</command:parameterValue>

        </command:parameter>

        <command:parameter required="false" position="named">

          <maml:name>NumberOfSpecialCharacters</maml:name>

          <maml:description>

            <maml:para>The number of special characters to include in the password</maml:para>

          </maml:description>

          <command:parameterValue>int</command:parameterValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:examples>

      <command:example>

        <maml:title>------------------------ EXAMPLE 1 ------------------------</maml:title>

        <maml:introduction>

          <maml:para></maml:para>

        </maml:introduction>

        <dev:code>Get-StrongPassword -Length 15 -NumberOfSpecialCharacters 5</dev:code>

        <dev:remarks>

          <maml:para>Will generate a password 15 characters long including 5 special characters (non-alphanumeric)</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

  </command:command>

</helpItems>