🔐 A simple credential manager to store and reuse multiple PSCredential objects.
Go to file
OCram85 f731d4773e adds build folder to ignore list 2017-09-21 10:58:56 +02:00
.vscode adds basic Build tasks 2017-09-21 08:42:30 +02:00
bin fix gitkeep filename 2017-08-16 13:36:28 +02:00
resources fix gitkeep filename 2017-08-16 13:36:28 +02:00
src typo fixed 2017-09-21 10:58:39 +02:00
tests adds Pester Tests for New-CredentialStoreItem 2017-08-21 10:21:03 +02:00
tools set constant debug module version string 2017-08-16 13:47:41 +02:00
.gitignore adds build folder to ignore list 2017-09-21 10:58:56 +02:00
LICENSE Initial commit 2017-07-27 13:40:00 +02:00
README.md adds basic readme file 2017-08-22 08:52:19 +02:00
appveyor.yml fix callsign in appveyor helper 2017-07-27 14:33:16 +02:00

README.md

AppVeyor Overall AppVeyor Master AppVeyor Dev Coveralls.io Download
Build status Build status Build status Coverage Status Download

General

The PSCredentialStore is an simple credential manager for PSCredentials. It stores multiple credential object in a simple json file. Either as private file in your profile or in shared mode in other locations.

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 sheduled tasks.

To get started read the about_PSCredentialStore page.

Installation

  • 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 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

Quick Start

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.

# 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:

# 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 the given remotehost in different ways. If you have already installed the underlying framework your can conntect to:

  • CiscoUcs - Establish a connection to a Cisco UCS fabric interconnect.
  • FTP - Establish a connection to a FTP host.
  • NetAppFAS - Establish a connection to a NetApp Clustered ONTAP filer.
  • VMware - Establish a connection to a VMware vCenter or ESXi host.

Here are some basic examples:

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