update docs

2022-07-13 08:26:50 +02:00
parent e899ff79a7
commit 1b1d4412ea
18 changed files with 159 additions and 155 deletions
--- a/docs/Connect-To.md
+++ b/docs/Connect-To.md
@ -1,3 +1,9 @@
+---
+external help file: PSCredentialStore-help.xml
+Module Name: PSCredentialStore
+schema: 2.0.0
+---
+
 # Connect-To

 ## SYNOPSIS
@ -22,37 +28,37 @@ Establish a connection to the selected host using a stored CredentialStoreItem.

 ## EXAMPLES

-### BEISPIEL 1
+### EXAMPLE 1
 ```
 Connect-To -RemoteHost "ucs.myside.local" -Type CiscoUcs
 ```

-### BEISPIEL 2
+### EXAMPLE 2
 ```
 Connect-To -RemoteHost "ftp.myside.local" -Type FTP
 ```

-### BEISPIEL 3
+### EXAMPLE 3
 ```
 Connect-To -RemoteHost "fas.myside.local" -Type NetAppFAS
 ```

-### BEISPIEL 4
+### EXAMPLE 4
 ```
 Connect-To -RemoteHost "esx01.myside.local" -Type VMware
 ```

-### BEISPIEL 5
+### EXAMPLE 5
 ```
 Connect-To -RemoteHost "vCenter.myside.local" -Type CisServer
 ```

-### BEISPIEL 6
+### EXAMPLE 6
 ```
 Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTP
 ```

-### BEISPIEL 7
+### EXAMPLE 7
 ```
 Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS
 ```
@ -184,11 +190,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

 ### [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)
-
--- a/docs/Disconnect-From.md
+++ b/docs/Disconnect-From.md
@ -1,3 +1,9 @@
+---
+external help file: PSCredentialStore-help.xml
+Module Name: PSCredentialStore
+schema: 2.0.0
+---
+
 # Disconnect-From

 ## SYNOPSIS
@ -14,42 +20,42 @@ Terminates a session established with Connect-To using a CredentialStoreItem.

 ## EXAMPLES

-### BEISPIEL 1
+### EXAMPLE 1
 ```
 Disconnect-From -RemoteHost "ucs.myside.local" -Type CiscoUcs
 ```

-### BEISPIEL 2
+### EXAMPLE 2
 ```
 Disconnect-From -RemoteHost "ftp.myside.local" -Type FTP
 ```

-### BEISPIEL 3
+### EXAMPLE 3
 ```
 Disconnect-From -RemoteHost "fas.myside.local" -Type NetAppFAS
 ```

-### BEISPIEL 4
+### EXAMPLE 4
 ```
 Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware
 ```

-### BEISPIEL 5
+### EXAMPLE 5
 ```
 Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware -Force:$True
 ```

-### BEISPIEL 6
+### EXAMPLE 6
 ```
 Disconnect-From -RemoteHost "vcenter.myside.local" -Type CisServer
 ```

-### BEISPIEL 7
+### EXAMPLE 7
 ```
 Disconnect-From -RemoteHost "exchange01.myside.local" -Type ExchangeHTTP
 ```

-### BEISPIEL 8
+### EXAMPLE 8
 ```
 Disconnect-From -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS
 ```
@ -113,11 +119,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

 ### [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)
-
--- a/docs/Get-CSCertificate.md
+++ b/docs/Get-CSCertificate.md
@ -1,3 +1,9 @@
+---
+external help file: PSCredentialStore-help.xml
+Module Name: PSCredentialStore
+schema: 2.0.0
+---
+
 # Get-CSCertificate

 ## SYNOPSIS
@ -14,7 +20,7 @@ Use this function to get the available pfx certificate respecting the config hie

 ## EXAMPLES

-### BEISPIEL 1
+### EXAMPLE 1
 ```
 Get-CSCertificate -Type 'Shared' -Thumbprint '12334456'
 ```
@ -61,11 +67,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

 ### [System.Security.Cryptography.X509Certificates.X509Certificate2]
 ## NOTES
- File Name   : Get-CSCertificate.ps1
- Author      : Marco Blessing - marco.blessing@googlemail.com
- Requires    :

 ## RELATED LINKS
-
-[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore)
-
--- a/docs/Get-CredentialStore.md
+++ b/docs/Get-CredentialStore.md
@ -1,3 +1,9 @@
+---
+external help file: PSCredentialStore-help.xml
+Module Name: PSCredentialStore
+schema: 2.0.0
+---
+
 # Get-CredentialStore

 ## SYNOPSIS
@ -24,7 +30,7 @@ Get-CredentialStoreItem.

 ## EXAMPLES

-### BEISPIEL 1
+### EXAMPLE 1
 ```
 $CSContent = Get-CredentialStore -Path "C:\TMP\mystore.json"
 ```
@ -73,11 +79,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

 ### [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)
-
--- a/docs/Get-CredentialStoreItem.md
+++ b/docs/Get-CredentialStoreItem.md
@ -1,3 +1,9 @@
+---
+external help file: PSCredentialStore-help.xml
+Module Name: PSCredentialStore
+schema: 2.0.0
+---
+
 # Get-CredentialStoreItem

 ## SYNOPSIS
@ -21,7 +27,7 @@ Return the credential as PSCredential object.

 ## EXAMPLES

-### BEISPIEL 1
+### EXAMPLE 1
 ```
 $myCreds = Get-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local"
 ```
@ -103,11 +109,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

 ### [System.Management.Automation.PSCredential]
 ## NOTES
- File Name   : Get-CredentialStoreItem.ps1
- Author      : Messing - marco.blessing@googlemail.com
- Requires    :

 ## RELATED LINKS
-
-[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore)
-
--- a/docs/Import-CSCertificate.md
+++ b/docs/Import-CSCertificate.md
@ -1,3 +1,9 @@
+---
+external help file: PSCredentialStore-help.xml
+Module Name: PSCredentialStore
+schema: 2.0.0
+---
+
 # Import-CSCertificate

 ## SYNOPSIS
@ -15,7 +21,7 @@ private and shared credential stores.

 ## EXAMPLES

-### BEISPIEL 1
+### EXAMPLE 1
 ```
 Import-CSCertificate -Type 'Private' -Path (Join-Path -Path $Env:APPDATA -ChildItem 'PfxCertificate.pfx')
 ```
@ -62,11 +68,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

 ### [None]
 ## NOTES
- File Name   : Import-CSCertificate.ps1
- Author      : Marco Blessing - marco.blessing@googlemail.com
- Requires    :

 ## RELATED LINKS
-
-[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore)
-
--- a/docs/New-CSCertAttribute.md
+++ b/docs/New-CSCertAttribute.md
@ -1,3 +1,9 @@
+---
+external help file: PSCredentialStore-help.xml
+Module Name: PSCredentialStore
+schema: 2.0.0
+---
+
 # New-CSCertAttribute

 ## SYNOPSIS
@ -15,7 +21,7 @@ Defines the certificate related properties for an upcoming New-PfxCertificate ex

 ## EXAMPLES

-### BEISPIEL 1
+### EXAMPLE 1
 ```
 New-CSCertAttribute -Country 'DE' -State 'BW' -City 'Karlsruhe' -Organization 'AwesomeIT' -OrganizationalUnitName '' -CommonName 'MyPrivateCert'
 ```
@ -137,11 +143,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

 ### [PSCredentialStore.Certificate.CSRDetails]
 ## NOTES
- File Name   : New-CSCertAttribute.ps1
- Author      : Marco Blessing - marco.blessing@googlemail.com
- Requires    :

 ## RELATED LINKS
-
-[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore)
-
--- a/docs/New-CSCertificate.md
+++ b/docs/New-CSCertificate.md
@ -1,3 +1,9 @@
+---
+external help file: PSCredentialStore-help.xml
+Module Name: PSCredentialStore
+schema: 2.0.0
+---
+
 # New-CSCertificate

 ## SYNOPSIS
@ -15,7 +21,7 @@ Use this function to create a custom self signed certificate used by the PSCrede

 ## EXAMPLES

-### BEISPIEL 1
+### EXAMPLE 1
 ```
 New-CSCertificate -CRTAttribute $CRTAttribute -KeyName './myprivate.key' -CertName './mycert.pfx'
 ```
@ -110,11 +116,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

 ### [None]
 ## NOTES
- File Name   : New-CSCertificate.ps1
- Author      : Marco Blessing - marco.blessing@googlemail.com
- Requires    :

 ## RELATED LINKS
-
-[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore)
-
--- a/docs/New-CredentialStore.md
+++ b/docs/New-CredentialStore.md
@ -1,3 +1,9 @@
+---
+external help file: PSCredentialStore-help.xml
+Module Name: PSCredentialStore
+schema: 2.0.0
+---
+
 # New-CredentialStore

 ## SYNOPSIS
@ -23,33 +29,29 @@ save new credentials with New-CredentialStoreItem.

 ## EXAMPLES

-### BEISPIEL 1
+### EXAMPLE 1
 ```
 New-CredentialStore
+# Creates a new private CredentialStore
 ```

-# Creates a new private CredentialStore
-
-### BEISPIEL 2
+### EXAMPLE 2
 ```
 New-CredentialStore -Force
+# Resets an existing private CredentialStore
 ```

-# Resets an existing private CredentialStore
-
-### BEISPIEL 3
+### EXAMPLE 3
 ```
 New-CredentialStore -Shared
+# Creates a new shared CredentialStore
 ```

-# Creates a new shared CredentialStore
-
-### BEISPIEL 4
+### EXAMPLE 4
 ```
 New-CredentialStore -Shared -Path "C:\TMP\CredentialStore.json"
-```
-
 # Creates a new shared CredentialStore in the given location.
+```

 ## PARAMETERS

@ -196,11 +198,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ### ['PSCredentialStore.Store'] Returns the recently created CredentialStore object if the -PassThru parameter
 ### was given.
 ## NOTES
- File Name   : New-CredentialStore.ps1
- Author      : Marco Blessing - marco.blessing@googlemail.com
- Requires    :

 ## RELATED LINKS
-
-[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore)
-
--- a/docs/New-CredentialStoreItem.md
+++ b/docs/New-CredentialStoreItem.md
@ -1,3 +1,9 @@
+---
+external help file: PSCredentialStore-help.xml
+Module Name: PSCredentialStore
+schema: 2.0.0
+---
+
 # New-CredentialStoreItem

 ## SYNOPSIS
@ -26,7 +32,7 @@ a VIConnection, NetApp FAS or UCS Fabric Interconnect.

 ## EXAMPLES

-### BEISPIEL 1
+### EXAMPLE 1
 ```
 New-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local"
 ```
@ -123,11 +129,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

 ### [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)
-
--- a/docs/PSCredentialStore.md
+++ b/docs/PSCredentialStore.md
@ -1,6 +1,14 @@
+---
+Module Name: PSCredentialStore
+Module Guid: 6800e192-9df8-4e30-b253-eb2c799bbe84 6800e192-9df8-4e30-b253-eb2c799bbe84
+Download Help Link: {{ Update Download Link }}
+Help Version: {{ Please enter version of help manually (X.X.X.X) format }}
+Locale: en-US
+---
+
 # PSCredentialStore Module
 ## Description
-[about_PSCredentialStore](about_PSCredentialStore.md)
+{{ Fill in the Description }}

 ## PSCredentialStore Cmdlets
 ### [Connect-To](Connect-To.md)
@ -21,8 +29,8 @@ Returns the current used valid PfX certificate.
 ### [Import-CSCertificate](Import-CSCertificate.md)
 Imports a linked certificate to the valid store location.

-### [Import-CSCertificate](Import-CSCertificate.md)
-Imports a linked certificate to the valid store location.
+### [New-CredentialStore](New-CredentialStore.md)
+Creates a new credential store File

 ### [New-CredentialStoreItem](New-CredentialStoreItem.md)
 Adds a credential store item containing host, user and password to the given store.
--- a/docs/Remove-CredentialStoreItem.md
+++ b/docs/Remove-CredentialStoreItem.md
@ -1,3 +1,9 @@
+---
+external help file: PSCredentialStore-help.xml
+Module Name: PSCredentialStore
+schema: 2.0.0
+---
+
 # Remove-CredentialStoreItem

 ## SYNOPSIS
@ -21,22 +27,22 @@ Use this CMDLet to completely remove an credential store item.

 ## EXAMPLES

-### BEISPIEL 1
+### EXAMPLE 1
 ```
 Remove-CredentialStoreItem -RemoteHost "esx01.myside.local"
 ```

-### BEISPIEL 2
+### EXAMPLE 2
 ```
 Remove-CredentialStoreItem -Shared -RemoteHost "esx01.myside.local"
 ```

-### BEISPIEL 3
+### EXAMPLE 3
 ```
 Remove-CredentialStoreItem -Shared -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local"
 ```

-### BEISPIEL 4
+### EXAMPLE 4
 ```
 Remove-CredentialStoreItem -RemoteHost "esx01.myside.local" -Identifier svc
 ```
@ -117,11 +123,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

 ### [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)
-
--- a/docs/Set-CredentialStoreItem.md
+++ b/docs/Set-CredentialStoreItem.md
@ -1,3 +1,9 @@
+---
+external help file: PSCredentialStore-help.xml
+Module Name: PSCredentialStore
+schema: 2.0.0
+---
+
 # Set-CredentialStoreItem

 ## SYNOPSIS
@ -22,12 +28,12 @@ Use this function to update your already stored RemoteHost items.

 ## EXAMPLES

-### BEISPIEL 1
+### EXAMPLE 1
 ```
 Set-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local"
 ```

-### BEISPIEL 2
+### EXAMPLE 2
 ```
 Set-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" -Identifier svc
 ```
@ -123,11 +129,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

 ### [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)
-
--- a/docs/Test-CSCertificate.md
+++ b/docs/Test-CSCertificate.md
@ -1,3 +1,9 @@
+---
+external help file: PSCredentialStore-help.xml
+Module Name: PSCredentialStore
+schema: 2.0.0
+---
+
 # Test-CSCertificate

 ## SYNOPSIS
@ -14,7 +20,7 @@ Test-CSCertificate should be an easy high level test for the linked certificate.

 ## EXAMPLES

-### BEISPIEL 1
+### EXAMPLE 1
 ```
 Test-CSCertificate -Type 'Shared'
 ```
@ -46,11 +52,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

 ### [bool]
 ## NOTES
- File Name   : Test-CSCertificate.ps1
- Author      : Marco Blessing - marco.blessing@googlemail.com
- Requires    :

 ## RELATED LINKS
-
-[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore)
-
--- a/docs/Test-CSConnection.md
+++ b/docs/Test-CSConnection.md
@ -1,3 +1,9 @@
+---
+external help file: PSCredentialStore-help.xml
+Module Name: PSCredentialStore
+schema: 2.0.0
+---
+
 # Test-CSConnection

 ## SYNOPSIS
@ -14,7 +20,7 @@ Use this script to check a connection which was established with the \`Connect-T

 ## EXAMPLES

-### BEISPIEL 1
+### EXAMPLE 1
 ```
 Test-CMConnection -RemoteHost "vcr01.internal.net" -Type VMware
 ```
@ -63,11 +69,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

 ### [bool]
 ## 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)
-
--- a/docs/Test-CredentialStore.md
+++ b/docs/Test-CredentialStore.md
@ -1,3 +1,9 @@
+---
+external help file: PSCredentialStore-help.xml
+Module Name: PSCredentialStore
+schema: 2.0.0
+---
+
 # Test-CredentialStore

 ## SYNOPSIS
@ -22,7 +28,7 @@ the file exists.

 ## EXAMPLES

-### BEISPIEL 1
+### EXAMPLE 1
 ```
 Test-CredentialStore -eq $true
 ```
@ -68,12 +74,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

 ## OUTPUTS

+### System.Boolean
 ## 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)
-
--- a/docs/Test-CredentialStoreItem.md
+++ b/docs/Test-CredentialStoreItem.md
@ -1,3 +1,9 @@
+---
+external help file: PSCredentialStore-help.xml
+Module Name: PSCredentialStore
+schema: 2.0.0
+---
+
 # Test-CredentialStoreItem

 ## SYNOPSIS
@ -23,16 +29,15 @@ you try to interact with it.

 ## EXAMPLES

-### BEISPIEL 1
+### EXAMPLE 1
 ```
-If (Test-CredentialStoreItem -RemoteHost "Default") {
-```
-
-Get-CredentialStoreItem -RemoteHost "Default"
+if (Test-CredentialStoreItem -RemoteHost "Default") {
+    Get-CredentialStoreItem -RemoteHost "Default"
 }
-Else {
+else {
    Write-Warning ("The given Remote Host {0} does not exist in the credential Store!" -f $RemoteHost)
 }
+```

 ## PARAMETERS

@ -112,11 +117,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

 ### [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)
-
--- a/docs/Use-CSCertificate.md
+++ b/docs/Use-CSCertificate.md
@ -1,3 +1,9 @@
+---
+external help file: PSCredentialStore-help.xml
+Module Name: PSCredentialStore
+schema: 2.0.0
+---
+
 # Use-CSCertificate

 ## SYNOPSIS
@ -20,7 +26,7 @@ Linking a certificate is needed if you plan to use the same CredentialStore in c

 ## EXAMPLES

-### BEISPIEL 1
+### EXAMPLE 1
 ```
 Use-CSCertificate -Path 'C:\cert.pfx'
 ```
@ -97,11 +103,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

 ### [None]
 ## NOTES
-File Name   : Use-CSCertificate.ps1
-Author      : Marco Blessing - marco.blessing@googlemail.com
-Requires    :

 ## RELATED LINKS
-
-[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore)
-