From f1026dabca33f058769a1ef617d63a0ba1c9a745 Mon Sep 17 00:00:00 2001 From: OCram85 Date: Thu, 21 Sep 2017 12:22:37 +0200 Subject: [PATCH] adds sources for optional modules --- README.md | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index ca7beb9..03cfa8c 100644 --- a/README.md +++ b/README.md @@ -5,18 +5,21 @@ 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. +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 sheduled tasks. +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) --------------------------------------- @@ -34,7 +37,7 @@ Manual Way * 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. @@ -59,12 +62,17 @@ $DCCreds = Get-CredentialStoreItem -RemoteHost 'dc01.myside.local' -Identifier ' 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. +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) Here are some basic examples: