OCram85/PSCredentialStore
OCram85/PSCredentialStore
1
0
Fork 1
Code Issues 1 Pull Requests 2 Releases 26 Activity

update docs

Browse Source
This commit is contained in:
OCram85 2018-03-06 15:08:08 +01:00
parent 0235aa5c91
commit b6cfa5e580
12 changed files with 170 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
docs/Connect-To.md
View File

@ -29,32 +29,42 @@ Establish a connection to the selected host using a stored CredentialStoreItem.
## EXAMPLES ## EXAMPLES
### -------------------------- EXAMPLE 1 -------------------------- ### EXAMPLE 1
``` ```
Connect-To -RemoteHost "ucs.myside.local" -Type CiscoUcs Connect-To -RemoteHost "ucs.myside.local" -Type CiscoUcs
``` ```
### -------------------------- EXAMPLE 2 -------------------------- ### EXAMPLE 2
``` ```
Connect-To -RemoteHost "ftp.myside.local" -Type FTP Connect-To -RemoteHost "ftp.myside.local" -Type FTP
``` ```
### -------------------------- EXAMPLE 3 -------------------------- ### EXAMPLE 3
``` ```
Connect-To -RemoteHost "fas.myside.local" -Type NetAppFAS Connect-To -RemoteHost "fas.myside.local" -Type NetAppFAS
``` ```
### -------------------------- EXAMPLE 4 -------------------------- ### EXAMPLE 4
``` ```
Connect-To -RemoteHost "esx01.myside.local" -Type VMware Connect-To -RemoteHost "esx01.myside.local" -Type VMware
``` ```
### -------------------------- EXAMPLE 5 -------------------------- ### EXAMPLE 5
``` ```
Connect-To -RemoteHost "vCenter.myside.local" -Type CisServer Connect-To -RemoteHost "vCenter.myside.local" -Type CisServer
``` ```
### -------------------------- EXAMPLE 6 -------------------------- ### EXAMPLE 6
```
Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTP
```
### EXAMPLE 7
```
Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS
```
### EXAMPLE 8
``` ```
$MyCreds = Get-Credential $MyCreds = Get-Credential
``` ```
@ -71,7 +81,7 @@ Specify the host, for which you would like to change the credentials.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: Named Position: Named
@ -88,7 +98,7 @@ same hostname.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@ -105,11 +115,14 @@ Currently implemented targets are:
- NetAppFAS Establish a connection to a NetApp Clustered ONTAP filer. - NetAppFAS Establish a connection to a NetApp Clustered ONTAP filer.
- VMware Establish a connection to a VMware vCenter or ESXi host. - VMware Establish a connection to a VMware vCenter or ESXi host.
- CisServer Establish a connection to a Vmware CisServer. - CisServer Establish a connection to a Vmware CisServer.
- ExchangeHTTP Start a new remote session to the given Exchange server via insecure http.
- Exchange HTTPS Start a new remote session to the given exchange server with the secure https endpoint.
- SCP Establish a SCP connection.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: Named Position: Named
@ -128,7 +141,7 @@ So you can use it to enable credentials without preparing any user interaction.
```yaml ```yaml
Type: PSCredential Type: PSCredential
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@ -143,7 +156,7 @@ Define a custom path to a shared CredentialStore.
```yaml ```yaml
Type: String Type: String
Parameter Sets: Shared Parameter Sets: Shared
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@ -160,7 +173,7 @@ can be decrypted across systems.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: Shared Parameter Sets: Shared
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@ -181,11 +194,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
### [None] ### [None]
## NOTES ## NOTES
\`\`\`
File Name : Connect-To.ps1 File Name : Connect-To.ps1
Author : Marco Blessing - marco.blessing@googlemail.com Author : Marco Blessing - marco.blessing@googlemail.com
Requires : Requires :
\`\`\`
## RELATED LINKS ## RELATED LINKS

33
docs/Disconnect-From.md
View File

@ -21,36 +21,46 @@ Terminates a session established with Connect-To using a CredentialStoreItem.
## EXAMPLES ## EXAMPLES
### -------------------------- EXAMPLE 1 -------------------------- ### EXAMPLE 1
``` ```
Disconnect-From -RemoteHost "ucs.myside.local" -Type CiscoUcs Disconnect-From -RemoteHost "ucs.myside.local" -Type CiscoUcs
``` ```
### -------------------------- EXAMPLE 2 -------------------------- ### EXAMPLE 2
``` ```
Disconnect-From -RemoteHost "ftp.myside.local" -Type FTP Disconnect-From -RemoteHost "ftp.myside.local" -Type FTP
``` ```
### -------------------------- EXAMPLE 3 -------------------------- ### EXAMPLE 3
``` ```
Disconnect-From -RemoteHost "fas.myside.local" -Type NetAppFAS Disconnect-From -RemoteHost "fas.myside.local" -Type NetAppFAS
``` ```
### -------------------------- EXAMPLE 4 -------------------------- ### EXAMPLE 4
``` ```
Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware
``` ```
### -------------------------- EXAMPLE 5 -------------------------- ### EXAMPLE 5
``` ```
Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware -Force:$True Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware -Force:$True
``` ```
### -------------------------- EXAMPLE 6 -------------------------- ### EXAMPLE 6
``` ```
Disconnect-From -RemoteHost "vcenter.myside.local" -Type CisServer 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 ## PARAMETERS
### -RemoteHost ### -RemoteHost
@ -59,7 +69,7 @@ Specify the remote endpoint, whose session you would like to terminate.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: 1 Position: 1
@ -76,11 +86,14 @@ Currently implemented targets are:
- NetAppFAS Terminates the connection from a NetApp Clustered ONTAP filer. - NetAppFAS Terminates the connection from a NetApp Clustered ONTAP filer.
- VMware Terminates the connection from a VMware vCenter or ESXi host. - VMware Terminates the connection from a VMware vCenter or ESXi host.
- CisServer Terminates the connection from a Vmware CisServer. - CisServer Terminates the connection from a Vmware CisServer.
- ExchangeHTTP Remove the existing remote session to the given Exchange server
- ExchangeHTTPS Remove the existing remote session to the given Exchange server
- SCP Terminates the existing SCP session.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: 2 Position: 2
@ -95,7 +108,7 @@ Force the disconnect, even if the disconnect would fail.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@ -116,11 +129,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
### [None] ### [None]
## NOTES ## NOTES
\`\`\`
File Name : Disconnect-From.ps1 File Name : Disconnect-From.ps1
Author : Marco Blessing - marco.blessing@googlemail.com Author : Marco Blessing - marco.blessing@googlemail.com
Requires : Requires :
\`\`\`
## RELATED LINKS ## RELATED LINKS

6
docs/Get-CredentialStore.md
View File

@ -31,7 +31,7 @@ Get-CredentialStoreItem.
## EXAMPLES ## EXAMPLES
### -------------------------- EXAMPLE 1 -------------------------- ### EXAMPLE 1
``` ```
$CSContent = Get-CredentialStore -Path "C:\TMP\mystore.json" $CSContent = Get-CredentialStore -Path "C:\TMP\mystore.json"
``` ```
@ -44,7 +44,7 @@ Define a custom path to a shared CredentialStore.
```yaml ```yaml
Type: String Type: String
Parameter Sets: Shared Parameter Sets: Shared
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@ -61,7 +61,7 @@ can be decrypted across systems.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: Shared Parameter Sets: Shared
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named

10
docs/Get-CredentialStoreItem.md
View File

@ -28,7 +28,7 @@ Return the credential as PSCredential object.
## EXAMPLES ## EXAMPLES
### -------------------------- EXAMPLE 1 -------------------------- ### EXAMPLE 1
``` ```
$myCreds = Get-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" $myCreds = Get-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local"
``` ```
@ -41,7 +41,7 @@ Define a custom path to a shared CredentialStore.
```yaml ```yaml
Type: String Type: String
Parameter Sets: Shared Parameter Sets: Shared
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@ -56,7 +56,7 @@ Specify the host, for which you would like to change the credentials.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: Named Position: Named
@ -74,7 +74,7 @@ For example ad/sys1, ftp/sys1, mssql/sys1
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@ -91,7 +91,7 @@ can be decrypted across systems.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: Shared Parameter Sets: Shared
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named

10
docs/New-CredentialStore.md
View File

@ -28,7 +28,7 @@ Return the credential as PSCredential object.
## EXAMPLES ## EXAMPLES
### -------------------------- EXAMPLE 1 -------------------------- ### EXAMPLE 1
``` ```
$myCreds = Get-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" $myCreds = Get-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local"
``` ```
@ -41,7 +41,7 @@ Define a custom path to a shared CredentialStore.
```yaml ```yaml
Type: String Type: String
Parameter Sets: Shared Parameter Sets: Shared
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@ -56,7 +56,7 @@ Specify the host, for which you would like to change the credentials.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: Named Position: Named
@ -74,7 +74,7 @@ For example ad/sys1, ftp/sys1, mssql/sys1
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@ -91,7 +91,7 @@ can be decrypted across systems.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: Shared Parameter Sets: Shared
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named

12
docs/New-CredentialStoreItem.md
View File

@ -33,7 +33,7 @@ a VIConnection, NetApp FAS or UCS Fabric Interconnect.
## EXAMPLES ## EXAMPLES
### -------------------------- EXAMPLE 1 -------------------------- ### EXAMPLE 1
``` ```
New-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" New-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local"
``` ```
@ -46,7 +46,7 @@ Define the store in which you would like to add a new item.
```yaml ```yaml
Type: String Type: String
Parameter Sets: Shared Parameter Sets: Shared
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@ -61,7 +61,7 @@ The identifier or rather name for the given credentials.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: Named Position: Named
@ -79,7 +79,7 @@ For example ad/sys1, ftp/sys1, mssql/sys1
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@ -94,7 +94,7 @@ You can provide credentials optionally as pre existing pscredential object.
```yaml ```yaml
Type: PSCredential Type: PSCredential
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@ -109,7 +109,7 @@ Accept wildcard characters: False
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: Shared Parameter Sets: Shared
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named

5
docs/PSCredentialStore.md
View File

@ -8,7 +8,7 @@ Locale: en-US
# PSCredentialStore Module # PSCredentialStore Module
## Description ## Description
PSCredentialStore enables managing multiple PSCredential objects. {{Manually Enter Description Here}}
## PSCredentialStore Cmdlets ## PSCredentialStore Cmdlets
### [Connect-To](Connect-To.md) ### [Connect-To](Connect-To.md)
@ -41,3 +41,6 @@ Returns the credential store state.
### [Test-CredentialStoreItem](Test-CredentialStoreItem.md) ### [Test-CredentialStoreItem](Test-CredentialStoreItem.md)
Checks if the given RemoteHost identifier combination exists in the credential store. 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.

10
docs/Remove-CredentialStoreItem.md
View File

@ -28,7 +28,7 @@ Use this CMDLet to completely remove an credential store item.
## EXAMPLES ## EXAMPLES
### -------------------------- EXAMPLE 1 -------------------------- ### EXAMPLE 1
``` ```
Remove-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" Remove-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local"
``` ```
@ -43,7 +43,7 @@ Define the store in which your given host entry already exists.
```yaml ```yaml
Type: String Type: String
Parameter Sets: Shared Parameter Sets: Shared
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@ -58,7 +58,7 @@ Specify the host you for which you would like to change the credentials.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: Named Position: Named
@ -75,7 +75,7 @@ same hostname.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@ -92,7 +92,7 @@ can be decrypted across systems.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: Shared Parameter Sets: Shared
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named

10
docs/Set-CredentialStoreItem.md
View File

@ -28,7 +28,7 @@ Set-CredentialStoreItem [-Path <String>] -RemoteHost <String> [-Identifier <Stri
## EXAMPLES ## EXAMPLES
### -------------------------- EXAMPLE 1 -------------------------- ### EXAMPLE 1
``` ```
Set-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" Set-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local"
``` ```
@ -43,7 +43,7 @@ Define the store in which your given host entry already exists.
```yaml ```yaml
Type: String Type: String
Parameter Sets: Shared Parameter Sets: Shared
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@ -58,7 +58,7 @@ Specify the host you for which you would like to change the credentials.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: Named Position: Named
@ -75,7 +75,7 @@ same hostname.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@ -92,7 +92,7 @@ can be decrypted across systems.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: Shared Parameter Sets: Shared
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named

82
docs/Test-CSConnection.md Normal file
View File

@ -0,0 +1,82 @@
---
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] <String> [-Type] <String> [<CommonParameters>]
```
## 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)

6
docs/Test-CredentialStore.md
View File

@ -30,7 +30,7 @@ the file exists.
## EXAMPLES ## EXAMPLES
### Example 1 ### Example 1
``` ```powershell
PS C:\> {{ Add example code here }} PS C:\> {{ Add example code here }}
``` ```
@ -44,7 +44,7 @@ Define a custom path to a shared CredentialStore.
```yaml ```yaml
Type: String Type: String
Parameter Sets: Shared Parameter Sets: Shared
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@ -61,7 +61,7 @@ can be decrypted across systems.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: Shared Parameter Sets: Shared
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named

10
docs/Test-CredentialStoreItem.md
View File

@ -30,7 +30,7 @@ you try to interact with it.
## EXAMPLES ## EXAMPLES
### -------------------------- EXAMPLE 1 -------------------------- ### EXAMPLE 1
``` ```
If (Test-CredentialStoreItem -RemoteHost "Default") { If (Test-CredentialStoreItem -RemoteHost "Default") {
``` ```
@ -51,7 +51,7 @@ Without the \`-Path\` parameter
```yaml ```yaml
Type: String Type: String
Parameter Sets: Shared Parameter Sets: Shared
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@ -66,7 +66,7 @@ Specify the host, for which you would like to change the credentials.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: Named Position: Named
@ -83,7 +83,7 @@ for a single host.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@ -100,7 +100,7 @@ can be decrypted across systems.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: Shared Parameter Sets: Shared
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named