docs/PSCredentialStore.md

@@ -0,0 +1,43 @@
+---
+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
+PSCredentialStore enables managing multiple PSCredential objects.
+
+## 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.
+

docs/about_PSCredentialStore.md

@@ -0,0 +1,94 @@
+# 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)
+
+# 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
+```
+
+# NOTE
+
+
+# TROUBLESHOOTING NOTE
+
+
+# SEE ALSO
+
+
+# KEYWORDS
+
+- Credential
+- Store