TUN.CredentialManager

3.0.2

TUN.CredentialManager.xml

                                <?xml version="1.0"?>

<doc>

    <assembly>

        <name>TUN.CredentialManager</name>

    </assembly>

    <members>

        <member name="T:PSCredentialManager.Cmdlet.GetStoredCredential">

            <summary>

            <para type="synopsis">Gets stored credentials from the Windows Credential Store/Vault</para>

            <para type="description">Gets stored credentials from the Windows Credential Store/Vault and returns as either a PSCredential object or as a Credential Object</para>

            </summary>

            <example>

            <code>PS C:\> Get-StoredCredential -Target Server01</code>

            <para>Returns credentials for Server01 as a PSCredential object</para>

            <para>UserName                      Password</para>

            <para>--------                      --------</para>

            <para>test-user System.Security.SecureString</para>

            </example>

            <example>

            <code>PS C:\> Get-StoredCredential -Target Server01 -AsCredentialObject</code>

            <para>Returns credentials for Server01 as a Credential object</para>

            <para>Flags          : 0</para>

            <para>Type           : GENERIC</para>

            <para>TargetName     : server01</para>

            <para>Comment        : </para>

            <para>LastWritten    : 23/04/2016 10:01:37</para>

            <para>PaswordSize    : 18</para>

            <para>Password       : Password1</para>

            <para>SecurePassword : </para>

            <para>Persist        : ENTERPRISE</para>

            <para>AttributeCount : 0</para>

            <para>Attributes     : 0</para>

            <para>TargetAlias    : </para>

            <para>UserName       : test-user</para>

            </example>

            <para type="link" uri="https://github.com/davotronic5000/PowerShell_Credential_Manager/wiki/Get-StoredCredential">Online Version</para>

        </member>

        <member name="F:PSCredentialManager.Cmdlet.GetStoredCredential.Target">

            <summary>

            <para type="description">The command will only return credentials with the specified target</para>

            </summary>

        </member>

        <member name="F:PSCredentialManager.Cmdlet.GetStoredCredential.Type">

            <summary>

            <para type="description">Specifies the type of credential to return, possible values are [Generic, DomainPassword, DomainCertificate, DomainVisiblePassword, GenericCertificate, DomainExtended, Maximum, MaximumEx]</para>

            </summary>

        </member>

        <member name="F:PSCredentialManager.Cmdlet.GetStoredCredential.ExcludeClearPassword">

            <summary>

            <para type="description">Switch to not fill the property Password with the clear password and PasswordSize with the unicode size of the clear password</para>

            </summary>

        </member>

        <member name="F:PSCredentialManager.Cmdlet.GetStoredCredential.IncludeSecurePassword">

            <summary>

            <para type="description">Switch to fill the property SecurePassword with the password as SecureString, may need more time for execution</para>

            </summary>

        </member>

        <member name="F:PSCredentialManager.Cmdlet.GetStoredCredential.AsCredentialObject">

            <summary>

            <para type="description">Switch to return the credentials as Credential objects instead of the default PSObject</para>

            </summary>

        </member>

        <member name="T:PSCredentialManager.Cmdlet.NewStoredCredential">

            <summary>

            <para type="synopsis">Create a new credential in the Windows Credential Store/Vault</para>

            <para type="description">Create a new credential in the Windows Credential Store/Vault</para>

            </summary>

            <example>

            <code>PS C:\> New-StoredCredential -Target server01 -UserName test-user -Password Password1</code>

            <para>creates a credential for server01 with the username test-user and password Password1</para>

            <para>Flags          : 0</para>

            <para>Type           : GENERIC</para>

            <para>TargetName     : server01</para>

            <para>Comment        : Updated by: Dave on: 23/04/2016</para>

            <para>LastWritten    : 23/04/2016 10:48:56</para>

            <para>PaswordSize    : 18</para>

            <para>Password       : Password1</para>

            <para>SecurePassword : </para>

            <para>Persist        : SESSION</para>

            <para>AttributeCount : 0</para>

            <para>Attributes     : 0</para>

            <para>TargetAlias    : </para>

            <para>UserName       : test-user</para>

            </example>

            <example>

            <code>PS C:\> Get-Credential -UserName test-user -Message "Password please" | New-StoredCredential -Target Server01</code>

            <para>Creates a credential for Server01 with the username and password provided in the PSCredential object from Get-Credential</para>

            </example>

            <para type="link" uri="https://github.com/davotronic5000/PowerShell_Credential_Manager/wiki/New-StoredCredential">Online Version</para>

        </member>

        <member name="F:PSCredentialManager.Cmdlet.NewStoredCredential.Target">

            <summary>

            <para type="description">Specifies the target of the credentials being added.</para>

            </summary>

        </member>

        <member name="F:PSCredentialManager.Cmdlet.NewStoredCredential.UserName">

            <summary>

            <para type="description">specified the username to be used for the credentials, cannot be used in conjunction with Credentials parameter.</para>

            </summary>

        </member>

        <member name="F:PSCredentialManager.Cmdlet.NewStoredCredential.Password">

            <summary>

            <para type="description">Specifies the password in plain text, cannot be used in conjunction with SecurePassword or Credential parameters.</para>

            </summary>

        </member>

        <member name="F:PSCredentialManager.Cmdlet.NewStoredCredential.SecurePassword">

            <summary>

            <para type="description">Specifies the password as a secure string, cannot be used in conjunction with Password or Credential parameters.</para>

            </summary>

        </member>

        <member name="F:PSCredentialManager.Cmdlet.NewStoredCredential.Comment">

            <summary>

            <para type="description">Provides a comment to identify the credentials in the store</para>

            <para type="description"></para>

            </summary>

        </member>

        <member name="F:PSCredentialManager.Cmdlet.NewStoredCredential.Type">

            <summary>

            <para type="description">Type of credential to store, possible values are [Generic, DomainPassword, DomainCertificate, DomainVisiblePassword, GenericCertificate, DomainExtended, Maximum, MaximumEx]</para>

            </summary>

        </member>

        <member name="F:PSCredentialManager.Cmdlet.NewStoredCredential.Persist">

            <summary>

            <para type="description">sets the persistence settings of the credential, possible values are [Session, LocalMachine, Enterprise]</para>

            </summary>

        </member>

        <member name="F:PSCredentialManager.Cmdlet.NewStoredCredential.Credentials">

            <summary>

            <para type="description"></para>

            </summary>

        </member>

        <member name="M:PSCredentialManager.Cmdlet.NewStoredCredential.BeginProcessing">

            <summary>

            <para type="description"></para>

            </summary>

        </member>

        <member name="T:PSCredentialManager.Cmdlet.RemoveStoredCredential">

            <summary>

            <para type="synopsis">Deletes a credentials from the Windows Credential Store/Vault</para>

            <para type="description">Deletes a credentials from the Windows Credential Store/Vault</para>

            </summary>

            <example>

            <code>PS C:\> Remove-StoredCredential -Target Server01 -Type GENERIC</code>

            <para>Deletes a generic credential with the target Server01</para>

            </example>

            <para type="link" uri="https://github.com/davotronic5000/PowerShell_Credential_Manager/wiki/Remove-StoredCredential">Online Version</para>

        </member>

        <member name="F:PSCredentialManager.Cmdlet.RemoveStoredCredential.Target">

            <summary>

            <para type="description">specifies a target to identitfy the credential to be deleted</para>

            </summary>

        </member>

        <member name="F:PSCredentialManager.Cmdlet.RemoveStoredCredential.Type">

            <summary>

            <para type="description">Specifies the type of credential to be deleted, possible values are [Generic, DomainPassword, DomainCertificate, DomainVisiblePassword, GenericCertificate, DomainExtended, Maximum, MaximumEx]</para>

            </summary>

        </member>

        <member name="T:PSCredentialManager.Cmdlet.GetStrongPassword">

            <summary>

            <para type="synopsis">Generates a strong password</para>

            <para type="description">Generates a strong password based on the parameters provided</para>

            </summary>

            <example>

            <code>PS C:\> Get-StrongPassword</code>

            <para>Generates a password 10 characters long with 3 special characters</para>

            <para>QTJ(T?wwe)</para>

            </example>

            <example>

            <code>PS C:\> Get-StrongPassword  -Length 20 -NumberOfSpecialCharacters 5</code>

            <para>Generates a password 20 characters long with 5 special characters</para>

            <para>zPN&gt;C%.f/(l1aGq)n3Ze</para>

            </example>

            <list type="alertSet">

            <item>

            <description>This cmdlet does not do a lot currently, it only really generates a password based on System.Web.Security.Membership.GeneratePassword().</description>

            </item>

            </list>

            <para type="link" uri="https://github.com/davotronic5000/PowerShell_Credential_Manager/wiki/Get-StrongPassword">Online Version</para>

        </member>

        <member name="F:PSCredentialManager.Cmdlet.GetStrongPassword.Length">

            <summary>

            <para type="description">Length in Characters for the generated password to be.</para>

            </summary>

        </member>

        <member name="F:PSCredentialManager.Cmdlet.GetStrongPassword.NumberOfSpecialCharacters">

            <summary>

            <para type="description">Number of special characters to include in the password, must be less than the length of the password</para>

            </summary>

        </member>

    </members>

</doc>