From 07037129badb01c82788e0527a10a247a01268be Mon Sep 17 00:00:00 2001 From: OCram85 Date: Wed, 16 Jan 2019 11:04:28 +0100 Subject: [PATCH] update docs --- docs/Get-CredentialStore.md | 2 +- docs/Get-CredentialStoreItem.md | 4 ++-- docs/New-CredentialStore.md | 4 ++-- docs/New-CredentialStoreItem.md | 8 ++++---- docs/Remove-CredentialStoreItem.md | 4 ++-- docs/Set-CredentialStoreItem.md | 24 ++++++++++++++++++++---- docs/Test-CredentialStore.md | 2 +- 7 files changed, 32 insertions(+), 16 deletions(-) diff --git a/docs/Get-CredentialStore.md b/docs/Get-CredentialStore.md index 4a9b63c..718c9af 100644 --- a/docs/Get-CredentialStore.md +++ b/docs/Get-CredentialStore.md @@ -63,7 +63,7 @@ Type: SwitchParameter Parameter Sets: Shared Aliases: -Required: False +Required: True Position: Named Default value: False Accept pipeline input: False diff --git a/docs/Get-CredentialStoreItem.md b/docs/Get-CredentialStoreItem.md index c1c2fd5..eba717e 100644 --- a/docs/Get-CredentialStoreItem.md +++ b/docs/Get-CredentialStoreItem.md @@ -19,7 +19,7 @@ Get-CredentialStoreItem -RemoteHost [-Identifier ] [] -RemoteHost [-Identifier ] [-Shared] +Get-CredentialStoreItem -RemoteHost [-Identifier ] [-Shared] [-Path ] [] ``` @@ -93,7 +93,7 @@ Type: SwitchParameter Parameter Sets: Shared Aliases: -Required: False +Required: True Position: Named Default value: False Accept pipeline input: False diff --git a/docs/New-CredentialStore.md b/docs/New-CredentialStore.md index c1c2fd5..eba717e 100644 --- a/docs/New-CredentialStore.md +++ b/docs/New-CredentialStore.md @@ -19,7 +19,7 @@ Get-CredentialStoreItem -RemoteHost [-Identifier ] [] -RemoteHost [-Identifier ] [-Shared] +Get-CredentialStoreItem -RemoteHost [-Identifier ] [-Shared] [-Path ] [] ``` @@ -93,7 +93,7 @@ Type: SwitchParameter Parameter Sets: Shared Aliases: -Required: False +Required: True Position: Named Default value: False Accept pipeline input: False diff --git a/docs/New-CredentialStoreItem.md b/docs/New-CredentialStoreItem.md index 5896e9b..6b00dd3 100644 --- a/docs/New-CredentialStoreItem.md +++ b/docs/New-CredentialStoreItem.md @@ -20,8 +20,8 @@ New-CredentialStoreItem -RemoteHost [-Identifier ] [-Credential ### Shared ``` -New-CredentialStoreItem [-Path ] -RemoteHost [-Identifier ] - [-Credential ] [-Shared] [] +New-CredentialStoreItem -RemoteHost [-Identifier ] [-Credential ] [-Shared] + [-Path ] [] ``` ## DESCRIPTION @@ -51,7 +51,7 @@ Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -111,7 +111,7 @@ Type: SwitchParameter Parameter Sets: Shared Aliases: -Required: False +Required: True Position: Named Default value: False Accept pipeline input: False diff --git a/docs/Remove-CredentialStoreItem.md b/docs/Remove-CredentialStoreItem.md index 95e9dcd..2fa9bfa 100644 --- a/docs/Remove-CredentialStoreItem.md +++ b/docs/Remove-CredentialStoreItem.md @@ -19,7 +19,7 @@ Remove-CredentialStoreItem -RemoteHost [-Identifier ] [] -RemoteHost [-Identifier ] [-Shared] +Remove-CredentialStoreItem -RemoteHost [-Identifier ] [-Shared] [-Path ] [] ``` @@ -94,7 +94,7 @@ Type: SwitchParameter Parameter Sets: Shared Aliases: -Required: False +Required: True Position: Named Default value: False Accept pipeline input: False diff --git a/docs/Set-CredentialStoreItem.md b/docs/Set-CredentialStoreItem.md index edc6771..da6d71e 100644 --- a/docs/Set-CredentialStoreItem.md +++ b/docs/Set-CredentialStoreItem.md @@ -14,13 +14,14 @@ Changes the credentials for the given remote host in the store. ### Private (Default) ``` -Set-CredentialStoreItem -RemoteHost [-Identifier ] [] +Set-CredentialStoreItem -RemoteHost [-Identifier ] [-Credential ] + [] ``` ### Shared ``` -Set-CredentialStoreItem [-Path ] -RemoteHost [-Identifier ] [-Shared] - [] +Set-CredentialStoreItem -RemoteHost [-Identifier ] [-Credential ] [-Shared] + [-Path ] [] ``` ## DESCRIPTION @@ -37,6 +38,21 @@ Set-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.lo ## PARAMETERS +### -Credential +{{Fill Credential Description}} + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -Identifier Defaults to "". Specify a string, which separates two CredentialStoreItems for the @@ -94,7 +110,7 @@ Type: SwitchParameter Parameter Sets: Shared Aliases: -Required: False +Required: True Position: Named Default value: False Accept pipeline input: False diff --git a/docs/Test-CredentialStore.md b/docs/Test-CredentialStore.md index 465d450..f3d1170 100644 --- a/docs/Test-CredentialStore.md +++ b/docs/Test-CredentialStore.md @@ -63,7 +63,7 @@ Type: SwitchParameter Parameter Sets: Shared Aliases: -Required: False +Required: True Position: Named Default value: False Accept pipeline input: False