From b12d9ae063041d4ee8277ce96080a1034ed1ef96 Mon Sep 17 00:00:00 2001 From: OCram85 Date: Mon, 8 Apr 2019 12:37:18 +0200 Subject: [PATCH] remove old docs --- docs/Connect-To.md | 188 ----------------------------- docs/Disconnect-From.md | 132 -------------------- docs/Get-CredentialStore.md | 94 --------------- docs/Get-CredentialStoreItem.md | 124 ------------------- docs/New-CredentialStore.md | 124 ------------------- docs/New-CredentialStoreItem.md | 142 ---------------------- docs/PSCredentialStore.md | 46 ------- docs/Remove-CredentialStoreItem.md | 125 ------------------- docs/Set-CredentialStoreItem.md | 141 ---------------------- docs/Test-CSConnection.md | 82 ------------- docs/Test-CredentialStore.md | 90 -------------- docs/Test-CredentialStoreItem.md | 133 -------------------- docs/about_PSCredentialStore.md | 102 ---------------- 13 files changed, 1523 deletions(-) delete mode 100644 docs/Connect-To.md delete mode 100644 docs/Disconnect-From.md delete mode 100644 docs/Get-CredentialStore.md delete mode 100644 docs/Get-CredentialStoreItem.md delete mode 100644 docs/New-CredentialStore.md delete mode 100644 docs/New-CredentialStoreItem.md delete mode 100644 docs/PSCredentialStore.md delete mode 100644 docs/Remove-CredentialStoreItem.md delete mode 100644 docs/Set-CredentialStoreItem.md delete mode 100644 docs/Test-CSConnection.md delete mode 100644 docs/Test-CredentialStore.md delete mode 100644 docs/Test-CredentialStoreItem.md delete mode 100644 docs/about_PSCredentialStore.md diff --git a/docs/Connect-To.md b/docs/Connect-To.md deleted file mode 100644 index 96c0a5a..0000000 --- a/docs/Connect-To.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -online version: https://github.com/OCram85/PSCredentialStore -schema: 2.0.0 ---- - -# Connect-To - -## SYNOPSIS -Connects to the given host using the stored CredentialStoreItem. - -## SYNTAX - -### Private (Default) -``` -Connect-To -RemoteHost [-Identifier ] -Type [-Credentials ] - [] -``` - -### Shared -``` -Connect-To -RemoteHost [-Identifier ] -Type [-Credentials ] - [-Path ] [-Shared] [] -``` - -## DESCRIPTION -Establish a connection to the selected host using a stored CredentialStoreItem. - -## EXAMPLES - -### EXAMPLE 1 -``` -Connect-To -RemoteHost "ucs.myside.local" -Type CiscoUcs -``` - -### EXAMPLE 2 -``` -Connect-To -RemoteHost "ftp.myside.local" -Type FTP -``` - -### EXAMPLE 3 -``` -Connect-To -RemoteHost "fas.myside.local" -Type NetAppFAS -``` - -### EXAMPLE 4 -``` -Connect-To -RemoteHost "esx01.myside.local" -Type VMware -``` - -### EXAMPLE 5 -``` -Connect-To -RemoteHost "vCenter.myside.local" -Type CisServer -``` - -### EXAMPLE 6 -``` -Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTP -``` - -### EXAMPLE 7 -``` -Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS -``` - -## PARAMETERS - -### -Credentials -Use this parameter to bypass the stored credentials. -Without this parameter Connect-To tries to read the -needed credentials from the CredentialStore. -If you provide this parameter you skip this lookup behavior. -So you can use it to enable credentials without preparing any user interaction. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identifier -Defaults to "". -Specify a string, which separates two CredentialStoreItems for the -same hostname. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Define a custom path to a shared CredentialStore. - -```yaml -Type: String -Parameter Sets: Shared -Aliases: - -Required: False -Position: Named -Default value: "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteHost -Specify the host, for which you would like to change the credentials. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Shared -Switch to shared mode with this param. -This enforces the command to work with a shared CredentialStore which -can be decrypted across systems. - -```yaml -Type: SwitchParameter -Parameter Sets: Shared -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specify the host type of the target. -Currently implemented targets are: Possible connection values are: -CiscoUcs, FTP, NetAppFAS, VMware, CisServer, ExchangeHTTP, ExchangeHTTPS, SCP. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### [None] - -## OUTPUTS - -### [None] - -## NOTES -File Name : Connect-To.ps1 -Author : Marco Blessing - marco.blessing@googlemail.com -Requires : - -## RELATED LINKS - -[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) - diff --git a/docs/Disconnect-From.md b/docs/Disconnect-From.md deleted file mode 100644 index 9d2d322..0000000 --- a/docs/Disconnect-From.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -online version: https://github.com/OCram85/PSCredentialStore -schema: 2.0.0 ---- - -# Disconnect-From - -## SYNOPSIS -Terminates a session established with Connect-To using a CredentialStoreItem. - -## SYNTAX - -``` -Disconnect-From [-RemoteHost] [-Type] [-Force] [] -``` - -## DESCRIPTION -Terminates a session established with Connect-To using a CredentialStoreItem. - -## EXAMPLES - -### EXAMPLE 1 -``` -Disconnect-From -RemoteHost "ucs.myside.local" -Type CiscoUcs -``` - -### EXAMPLE 2 -``` -Disconnect-From -RemoteHost "ftp.myside.local" -Type FTP -``` - -### EXAMPLE 3 -``` -Disconnect-From -RemoteHost "fas.myside.local" -Type NetAppFAS -``` - -### EXAMPLE 4 -``` -Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware -``` - -### EXAMPLE 5 -``` -Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware -Force:$True -``` - -### EXAMPLE 6 -``` -Disconnect-From -RemoteHost "vcenter.myside.local" -Type CisServer -``` - -### EXAMPLE 7 -``` -Disconnect-From -RemoteHost "exchange01.myside.local" -Type ExchangeHTTP -``` - -### EXAMPLE 8 -``` -Disconnect-From -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS -``` - -## PARAMETERS - -### -Force -Force the disconnect, even if the disconnect would fail. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteHost -Specify the remote endpoint, whose session you would like to terminate. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specify the host type of the target. -Currently implemented targets are: CiscoUcs, FTP, NetAppFAS, VMware, -CisServer, ExchangeHTTP, ExchangeHTTPS, SCP. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### [None] - -## OUTPUTS - -### [None] - -## NOTES -File Name : Disconnect-From.ps1 -Author : Marco Blessing - marco.blessing@googlemail.com -Requires : - -## RELATED LINKS - -[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) - diff --git a/docs/Get-CredentialStore.md b/docs/Get-CredentialStore.md deleted file mode 100644 index 718c9af..0000000 --- a/docs/Get-CredentialStore.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -online version: https://github.com/OCram85/PSCredentialStore -schema: 2.0.0 ---- - -# Get-CredentialStore - -## SYNOPSIS -Reads the complete content of the credential store and returns it as a new object. - -## SYNTAX - -### Private (Default) -``` -Get-CredentialStore [] -``` - -### Shared -``` -Get-CredentialStore [-Path ] [-Shared] [] -``` - -## DESCRIPTION -The content is in a raw format. -It means there is no transformation to the different credential types. -You can not use the object properties to connect with remote host. -Therefore please use -Get-CredentialStoreItem. - -## EXAMPLES - -### EXAMPLE 1 -``` -$CSContent = Get-CredentialStore -Path "C:\TMP\mystore.json" -``` - -## PARAMETERS - -### -Path -Define a custom path to a shared CredentialStore. - -```yaml -Type: String -Parameter Sets: Shared -Aliases: - -Required: False -Position: Named -Default value: "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Shared -Switch to shared mode with this param. -This enforces the command to work with a shared CredentialStore which -can be decrypted across systems. - -```yaml -Type: SwitchParameter -Parameter Sets: Shared -Aliases: - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### [None] - -## OUTPUTS - -### [PSObject] Returns the credential store content as PSObject. - -## NOTES -\`\`\` -File Name : Get-CredentialStore.ps1 -Author : Marco Blessing - marco.blessing@googlemail.com -Requires : -\`\`\` - -## RELATED LINKS - -[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) - diff --git a/docs/Get-CredentialStoreItem.md b/docs/Get-CredentialStoreItem.md deleted file mode 100644 index eba717e..0000000 --- a/docs/Get-CredentialStoreItem.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -online version: https://github.com/OCram85/PSCredentialStore -schema: 2.0.0 ---- - -# Get-CredentialStoreItem - -## SYNOPSIS -Returns the Credential from a given remote host item. - -## SYNTAX - -### Private (Default) -``` -Get-CredentialStoreItem -RemoteHost [-Identifier ] [] -``` - -### Shared -``` -Get-CredentialStoreItem -RemoteHost [-Identifier ] [-Shared] [-Path ] - [] -``` - -## DESCRIPTION -Return the credential as PSCredential object. - -## EXAMPLES - -### EXAMPLE 1 -``` -$myCreds = Get-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" -``` - -## PARAMETERS - -### -Identifier -Provide a custom identifier to the given remote host key. -This enables you to store multiple credentials -for a single remote host entry. -For example ad/sys1, ftp/sys1, mssql/sys1 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Define a custom path to a shared CredentialStore. - -```yaml -Type: String -Parameter Sets: Shared -Aliases: - -Required: False -Position: Named -Default value: "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteHost -Specify the host, for which you would like to change the credentials. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Shared -Switch to shared mode with this param. -This enforces the command to work with a shared CredentialStore which -can be decrypted across systems. - -```yaml -Type: SwitchParameter -Parameter Sets: Shared -Aliases: - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### [None] - -## OUTPUTS - -### [System.Management.Automation.PSCredential] - -## NOTES -\`\`\` -File Name : Get-CredentialStoreItem.ps1 -Author : Marco Blessing - marco.blessing@googlemail.com -Requires : -\`\`\` - -## RELATED LINKS - -[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) - diff --git a/docs/New-CredentialStore.md b/docs/New-CredentialStore.md deleted file mode 100644 index eba717e..0000000 --- a/docs/New-CredentialStore.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -online version: https://github.com/OCram85/PSCredentialStore -schema: 2.0.0 ---- - -# Get-CredentialStoreItem - -## SYNOPSIS -Returns the Credential from a given remote host item. - -## SYNTAX - -### Private (Default) -``` -Get-CredentialStoreItem -RemoteHost [-Identifier ] [] -``` - -### Shared -``` -Get-CredentialStoreItem -RemoteHost [-Identifier ] [-Shared] [-Path ] - [] -``` - -## DESCRIPTION -Return the credential as PSCredential object. - -## EXAMPLES - -### EXAMPLE 1 -``` -$myCreds = Get-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" -``` - -## PARAMETERS - -### -Identifier -Provide a custom identifier to the given remote host key. -This enables you to store multiple credentials -for a single remote host entry. -For example ad/sys1, ftp/sys1, mssql/sys1 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Define a custom path to a shared CredentialStore. - -```yaml -Type: String -Parameter Sets: Shared -Aliases: - -Required: False -Position: Named -Default value: "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteHost -Specify the host, for which you would like to change the credentials. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Shared -Switch to shared mode with this param. -This enforces the command to work with a shared CredentialStore which -can be decrypted across systems. - -```yaml -Type: SwitchParameter -Parameter Sets: Shared -Aliases: - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### [None] - -## OUTPUTS - -### [System.Management.Automation.PSCredential] - -## NOTES -\`\`\` -File Name : Get-CredentialStoreItem.ps1 -Author : Marco Blessing - marco.blessing@googlemail.com -Requires : -\`\`\` - -## RELATED LINKS - -[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) - diff --git a/docs/New-CredentialStoreItem.md b/docs/New-CredentialStoreItem.md deleted file mode 100644 index 6b00dd3..0000000 --- a/docs/New-CredentialStoreItem.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -online version: https://github.com/OCram85/PSCredentialStore -schema: 2.0.0 ---- - -# New-CredentialStoreItem - -## SYNOPSIS -Adds a credential store item containing host, user and password to the given store. - -## SYNTAX - -### Private (Default) -``` -New-CredentialStoreItem -RemoteHost [-Identifier ] [-Credential ] - [] -``` - -### Shared -``` -New-CredentialStoreItem -RemoteHost [-Identifier ] [-Credential ] [-Shared] - [-Path ] [] -``` - -## DESCRIPTION -The credentials are stored without any relations to it's further use. -If you need to change an existing -item please use Set-CredentialStoreItem. -You need to decide afterwards, whether to use the credential for -a VIConnection, NetApp FAS or UCS Fabric Interconnect. - -## EXAMPLES - -### EXAMPLE 1 -``` -New-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" -``` - -## PARAMETERS - -### -Credential -You can provide credentials optionally as pre existing pscredential object. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Identifier -Provide a custom identifier to the given remote host key. -This enables you to store multiple credentials -for a single remote host entry. -For example ad/sys1, ftp/sys1, mssql/sys1 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Define the store in which you would like to add a new item. - -```yaml -Type: String -Parameter Sets: Shared -Aliases: - -Required: False -Position: Named -Default value: "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteHost -The identifier or rather name for the given credentials. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Shared -{{Fill Shared Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: Shared -Aliases: - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### [None] - -## OUTPUTS - -### [None] - -## NOTES -\`\`\` -File Name : New-CredentialStoreItem.ps1 -Author : Marco Blessing - marco.blessing@googlemail.com -Requires : -\`\`\` - -## RELATED LINKS - -[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) - diff --git a/docs/PSCredentialStore.md b/docs/PSCredentialStore.md deleted file mode 100644 index 6b840c0..0000000 --- a/docs/PSCredentialStore.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -Module Name: PSCredentialStore -Module Guid: 6800e192-9df8-4e30-b253-eb2c799bbe84 -Download Help Link: {{Please enter FwLink manually}} -Help Version: {{Please enter version of help manually (X.X.X.X) format}} -Locale: en-US ---- - -# PSCredentialStore Module -## Description -{{Manually Enter Description Here}} - -## PSCredentialStore Cmdlets -### [Connect-To](Connect-To.md) -Connects to the given host using the stored CredentialStoreItem. - -### [Disconnect-From](Disconnect-From.md) -Terminates a session established with Connect-To using a CredentialStoreItem. - -### [Get-CredentialStore](Get-CredentialStore.md) -Reads the complete content of the credential store and returns it as a new object. - -### [Get-CredentialStoreItem](Get-CredentialStoreItem.md) -Returns the Credential from a given remote host item. - -### [Get-CredentialStoreItem](Get-CredentialStoreItem.md) -Returns the Credential from a given remote host item. - -### [New-CredentialStoreItem](New-CredentialStoreItem.md) -Adds a credential store item containing host, user and password to the given store. - -### [Remove-CredentialStoreItem](Remove-CredentialStoreItem.md) -Remove the given credentials from the credential store. - -### [Set-CredentialStoreItem](Set-CredentialStoreItem.md) -Changes the credentials for the given remote host in the store. - -### [Test-CredentialStore](Test-CredentialStore.md) -Returns the credential store state. - -### [Test-CredentialStoreItem](Test-CredentialStoreItem.md) -Checks if the given RemoteHost identifier combination exists in the credential store. - -### [Test-CSConnection](Test-CSConnection.md) -Returns the connection state of a given type to the remote host. - diff --git a/docs/Remove-CredentialStoreItem.md b/docs/Remove-CredentialStoreItem.md deleted file mode 100644 index 2fa9bfa..0000000 --- a/docs/Remove-CredentialStoreItem.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -online version: https://github.com/OCram85/PSCredentialStore -schema: 2.0.0 ---- - -# Remove-CredentialStoreItem - -## SYNOPSIS -Remove the given credentials from the credential store. - -## SYNTAX - -### Private (Default) -``` -Remove-CredentialStoreItem -RemoteHost [-Identifier ] [] -``` - -### Shared -``` -Remove-CredentialStoreItem -RemoteHost [-Identifier ] [-Shared] [-Path ] - [] -``` - -## DESCRIPTION -Use this CMDLet to completely remove an credential store item. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" -``` - -Remove-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" -Identifier svc - -## PARAMETERS - -### -Identifier -Defaults to "". -Specify a string, which separates two CredentialStoreItems for the -same hostname. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Define the store in which your given host entry already exists. - -```yaml -Type: String -Parameter Sets: Shared -Aliases: - -Required: False -Position: Named -Default value: "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteHost -Specify the host you for which you would like to change the credentials. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Shared -Switch to shared mode with this param. -This enforces the command to work with a shared CredentialStore which -can be decrypted across systems. - -```yaml -Type: SwitchParameter -Parameter Sets: Shared -Aliases: - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### [None] - -## OUTPUTS - -### [None] - -## NOTES -\`\`\` -File Name : Remove-CredentialStoreItem.ps1 -Author : Marco Blessing - marco.blessing@googlemail.com -Requires : -\`\`\` - -## RELATED LINKS - -[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) - diff --git a/docs/Set-CredentialStoreItem.md b/docs/Set-CredentialStoreItem.md deleted file mode 100644 index da6d71e..0000000 --- a/docs/Set-CredentialStoreItem.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -online version: https://github.com/OCram85/PSCredentialStore -schema: 2.0.0 ---- - -# Set-CredentialStoreItem - -## SYNOPSIS -Changes the credentials for the given remote host in the store. - -## SYNTAX - -### Private (Default) -``` -Set-CredentialStoreItem -RemoteHost [-Identifier ] [-Credential ] - [] -``` - -### Shared -``` -Set-CredentialStoreItem -RemoteHost [-Identifier ] [-Credential ] [-Shared] - [-Path ] [] -``` - -## DESCRIPTION -{{Fill in the Description}} - -## EXAMPLES - -### EXAMPLE 1 -``` -Set-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" -``` - -Set-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" -Identifier svc - -## PARAMETERS - -### -Credential -{{Fill Credential Description}} - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Identifier -Defaults to "". -Specify a string, which separates two CredentialStoreItems for the -same hostname. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Define the store in which your given host entry already exists. - -```yaml -Type: String -Parameter Sets: Shared -Aliases: - -Required: False -Position: Named -Default value: "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteHost -Specify the host you for which you would like to change the credentials. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Shared -Switch to shared mode with this param. -This enforces the command to work with a shared CredentialStore which -can be decrypted across systems. - -```yaml -Type: SwitchParameter -Parameter Sets: Shared -Aliases: - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### [None] - -## OUTPUTS - -### [None] - -## NOTES -\`\`\` -File Name : Set-CredentialStoreItem.ps1 -Author : Marco Blessing - marco.blessing@googlemail.com -Requires : -\`\`\` - -## RELATED LINKS - -[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) - diff --git a/docs/Test-CSConnection.md b/docs/Test-CSConnection.md deleted file mode 100644 index da6e927..0000000 --- a/docs/Test-CSConnection.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -online version: https://github.com/OCram85/PSCredentialStore -schema: 2.0.0 ---- - -# Test-CSConnection - -## SYNOPSIS -Returns the connection state of a given type to the remote host. - -## SYNTAX - -``` -Test-CSConnection [-RemoteHost] [-Type] [] -``` - -## DESCRIPTION -Use this script to check a connection which was established with the \`Connect-To\` cmdlet. - -## EXAMPLES - -### EXAMPLE 1 -``` -.\Test-CMConnection -RemoteHost "r0-i01-vcr01.p0r.kivbf-cloud.net" -Type VMware -``` - -## PARAMETERS - -### -RemoteHost -Define the remote host you would like to check. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Define the connection type you would like to check. -See the \`Connect-To\` documentation -for valid type values. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### [None] - -## OUTPUTS - -### [Boolean] - -## NOTES -File Name : Test-CSConnection.ps1 -Author : Marco Blessing - marco.blessing@googlemail.com -Requires : - -## RELATED LINKS - -[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) - diff --git a/docs/Test-CredentialStore.md b/docs/Test-CredentialStore.md deleted file mode 100644 index f3d1170..0000000 --- a/docs/Test-CredentialStore.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -online version: https://github.com/OCram85/PSCredentialStore -schema: 2.0.0 ---- - -# Test-CredentialStore - -## SYNOPSIS -Returns the credential store state. - -## SYNTAX - -### Private (Default) -``` -Test-CredentialStore [] -``` - -### Shared -``` -Test-CredentialStore [-Path ] [-Shared] [] -``` - -## DESCRIPTION -Use this script to test your credential store. -For now it only checks if -the file exists. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -Path -Define a custom path to a shared CredentialStore. - -```yaml -Type: String -Parameter Sets: Shared -Aliases: - -Required: False -Position: Named -Default value: "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Shared -Switch to shared mode with this param. -This enforces the command to work with a shared CredentialStore which -can be decrypted across systems. - -```yaml -Type: SwitchParameter -Parameter Sets: Shared -Aliases: - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -\`\`\` -File Name : Test-CredentialStore.ps1 -Author : Marco Blessing - marco.blessing@googlemail.com -Requires : -\`\`\` - -## RELATED LINKS - -[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) - diff --git a/docs/Test-CredentialStoreItem.md b/docs/Test-CredentialStoreItem.md deleted file mode 100644 index abc9dff..0000000 --- a/docs/Test-CredentialStoreItem.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: PSCredentialStore-help.xml -Module Name: PSCredentialStore -online version: https://github.com/OCram85/PSCredentialStore -schema: 2.0.0 ---- - -# Test-CredentialStoreItem - -## SYNOPSIS -Checks if the given RemoteHost identifier combination exists in the credential store. - -## SYNTAX - -### Private (Default) -``` -Test-CredentialStoreItem -RemoteHost [-Identifier ] [] -``` - -### Shared -``` -Test-CredentialStoreItem [-Path ] -RemoteHost [-Identifier ] [-Shared] - [] -``` - -## DESCRIPTION -Use this cmdlet for basic checks with a single item. -Check the item first with this function before -you try to interact with it. - -## EXAMPLES - -### EXAMPLE 1 -``` -If (Test-CredentialStoreItem -RemoteHost "Default") { -``` - -Get-CredentialStoreItem -RemoteHost "Default" -} -Else { - Write-Warning ("The given Remote Host {0} does not exist in the credential Store!" -f $RemoteHost) -} - -## PARAMETERS - -### -Identifier -Adds an optional identifier to the given RemoteHost. -Makes it possible to store multiple credentials -for a single host. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Define a custom credential store you try to read from. -Without the \`-Path\` parameter -\`Test-CredentialStoreItem\` tries to read from the default private store. - -```yaml -Type: String -Parameter Sets: Shared -Aliases: - -Required: False -Position: Named -Default value: "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteHost -Specify the host, for which you would like to change the credentials. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Shared -Switch to shared mode with this param. -This enforces the command to work with a shared CredentialStore which -can be decrypted across systems. - -```yaml -Type: SwitchParameter -Parameter Sets: Shared -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### [None] - -## OUTPUTS - -### [None] - -## NOTES -\`\`\` -File Name : Test-CredentialStoreItem.ps1 -Author : Marco Blessing - marco.blessing@googlemail.com -Requires : -\`\`\` - -## RELATED LINKS - -[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) - diff --git a/docs/about_PSCredentialStore.md b/docs/about_PSCredentialStore.md deleted file mode 100644 index a4694ae..0000000 --- a/docs/about_PSCredentialStore.md +++ /dev/null @@ -1,102 +0,0 @@ -# PSCredentialStore -## about_PSCredentialStore - - -# SHORT DESCRIPTION -PSCredentialStore enables managing multiple PSCredential objects. - - -# LONG DESCRIPTION -The PSCredentialStore is an simple credential manager for PSCredentials. It stores multiple credential objects in a -simple json file. You can choose between a private and shared store. The private one exists in your profile and can -ony accessed by your account on the same machine. The shared store enables you to use different credentials for your -script without exposing them as plain text. - -**The shared store isn't 100% secure and I don't recommend using it in production!** - -PSCredentialStore was developed to simplify the delegation of complex powershell scripts. In this case you often -need to store credentials for non interactive usage like in scheduled tasks. - -To get started read the [about_PSCredentialStore](/src/en-US/about_PSCredential.help.txt) page. - - -## Installation - -## PowerShellGallery.com (Recommended Way) - -* Make sure you use PowerShell 4.0 or higher with `$PSVersionTable`. -* Use the builtin PackageManagement and install with: `Install-Module PSCredentialStore` -* Done. Start exploring the Module with `Import-Module PSCredentialStore ; Get-Command -Module PSCredentialStore` - -## Manual Way - -* Take a look at the [Latest Release](https://github.com/OCram85/PSCredentialStore/releases/latest) page. -* Download the `PSCredentialStore.zip`. -* Unpack the Zip and put it in your Powershell Module path. - * Don't forget to change the NTFS permission flag in the context menu. -* Start with `Import-Module PSCredentialStore` - -**1.** First we need a blank CredentialStore. You can decide between a *private* or *shared* store. The private -Credential Store can only be accessed with your profile on the machine you created it. -```powershell -# Private Credential Store -New-CredentialStore - -# Shared Credential Store -New-CredentialStore -Shared - -#Shared CredentialStore in custom Location -New-CredentialStore -Shared -Path 'C:\CredentialStore.json' -``` - -**2.** Now you can manage your CredentialStoreItems: -```powershell -# This will prompt for credentials and stores it in a private store -New-CredentialStoreItem -RemoteHost 'dc01.myside.local' -Identifier 'AD' - -# You can now use it in other scripts like this: -$DCCreds = Get-CredentialStoreItem -RemoteHost 'dc01.myside.local' -Identifier 'AD' -Invoke-Command -ComputerName 'dc01.myside.local' -Credential $DCCreds -ScripBlock {Get-Process} -``` - -The CredentialStore contains also a simple function to establish a connection with several systems or protocols. -If you have already installed the underlying framework your can connect to: - -* **CiscoUcs** - Establish a connection to a Cisco UCS fabric interconnect. - * Required Modules: [`Cisco.UCS.Core`, `Cisco.UCSManager`](https://software.cisco.com/download/release.html?i=!y&mdfid=286305108&softwareid=284574017&release=2.1.1) -* **FTP** - Establish a connection to a FTP host. - * Required Modules: [`WinSCP`](https://www.powershellgallery.com/packages/WinSCP) -* **NetAppFAS** - Establish a connection to a NetApp Clustered ONTAP filer. - * Required Modules: [`DataONTAP`](http://mysupport.netapp.com/tools/info/ECMLP2310788I.html?productID=61926) -* **VMware** - Establish a connection to a VMware vCenter or ESXi host. - * Required Modules: [`VMware.VimAutomation.Core`](https://www.powershellgallery.com/packages/VMware.PowerCLI) -* **CisServer** - Establish a connection to the CisServer Service on vCenter Host. - * Required Modules: [`VMware.VimAutomation.Cis.Core`](https://www.powershellgallery.com/packages/VMware.PowerCLI)) -* **ExchangeHTTP** - Establish a remote connection with an Exchange endpoint via http. - * Requires PowerShell remoting -* **ExchangeHTTPS** - Establish a remote connection with an Exchange endpoint via https. - * Requires PowerShell remoting -* **SCP** - Establish a SCP connection. - * Required Modules: [`WinSCP`](https://www.powershellgallery.com/packages/WinSCP) -# EXAMPLES - -```powershell -Connect-To -RemoteHost "ucs.myside.local" -Type CiscoUcs -Connect-To -RemoteHost "ftp.myside.local" -Type FTP -Connect-To -RemoteHost "fas.myside.local" -Type NetAppFAS -Connect-To -RemoteHost "esx01.myside.local" -Type VMware -Connect-To -RemoteHost "vcr.myside.local" -Type CisServer -``` -# NOTE - - -# TROUBLESHOOTING NOTE - - -# SEE ALSO - - -# KEYWORDS - -- Credential -- Store