forked from OCram85/PSCredentialStore
fix Test-CredentialStoreItem return (#66)
#### 📖 Summary - `Test-CredentialStoreItem` now returns `$false` and not a terminating error if store doesn't exists. - Updates platyPS generated docs #### 📑 Test Plan > 💡 Select your test plan for the code changes. - [x] Tested via Drone.io pipeline - [ ] Custom test - [ ] No test plan ##### Details / Justification <!-- Add your test details or justification for missing tests here. --> #### 📚 Additional Notes - fixes #50 Co-authored-by: OCram85 <marco.blessing@googlemail.com> Reviewed-on: OCram85/PSCredentialStore#66
This commit is contained in:
parent
ae62cccfaa
commit
b76668c1e7
@ -1,194 +1,195 @@
|
|||||||
---
|
---
|
||||||
external help file: PSCredentialStore-help.xml
|
external help file: ModuleRoot-help.xml
|
||||||
Module Name: PSCredentialStore
|
Module Name: PSCredentialStore
|
||||||
schema: 2.0.0
|
online version:
|
||||||
---
|
schema: 2.0.0
|
||||||
|
---
|
||||||
# Connect-To
|
|
||||||
|
# Connect-To
|
||||||
## SYNOPSIS
|
|
||||||
Connects to the given host using the stored CredentialStoreItem.
|
## SYNOPSIS
|
||||||
|
Connects to the given host using the stored CredentialStoreItem.
|
||||||
## SYNTAX
|
|
||||||
|
## SYNTAX
|
||||||
### Private (Default)
|
|
||||||
```
|
### Private (Default)
|
||||||
Connect-To -RemoteHost <String> [-Identifier <String>] -Type <String> [-Credentials <PSCredential>] [-PassThru]
|
```
|
||||||
[<CommonParameters>]
|
Connect-To -RemoteHost <String> [-Identifier <String>] -Type <String> [-Credentials <PSCredential>] [-PassThru]
|
||||||
```
|
[<CommonParameters>]
|
||||||
|
```
|
||||||
### Shared
|
|
||||||
```
|
### Shared
|
||||||
Connect-To -RemoteHost <String> [-Identifier <String>] -Type <String> [-Credentials <PSCredential>] [-Shared]
|
```
|
||||||
[-Path <String>] [-PassThru] [<CommonParameters>]
|
Connect-To -RemoteHost <String> [-Identifier <String>] -Type <String> [-Credentials <PSCredential>] [-Shared]
|
||||||
```
|
[-Path <String>] [-PassThru] [<CommonParameters>]
|
||||||
|
```
|
||||||
## DESCRIPTION
|
|
||||||
Establish a connection to the selected host using a stored CredentialStoreItem.
|
## DESCRIPTION
|
||||||
|
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
|
```
|
||||||
```
|
Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTP
|
||||||
|
```
|
||||||
### EXAMPLE 7
|
|
||||||
```
|
### EXAMPLE 7
|
||||||
Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS
|
```
|
||||||
```
|
Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS
|
||||||
|
```
|
||||||
## PARAMETERS
|
|
||||||
|
## PARAMETERS
|
||||||
### -Credentials
|
|
||||||
Use this parameter to bypass the stored credentials.
|
### -Credentials
|
||||||
Without this parameter Connect-To tries to read the
|
Use this parameter to bypass the stored credentials.
|
||||||
needed credentials from the CredentialStore.
|
Without this parameter Connect-To tries to read the
|
||||||
If you provide this parameter you skip this lookup behavior.
|
needed credentials from the CredentialStore.
|
||||||
So you can use it to enable credentials without preparing any user interaction.
|
If you provide this parameter you skip this lookup behavior.
|
||||||
|
So you can use it to enable credentials without preparing any user interaction.
|
||||||
```yaml
|
|
||||||
Type: PSCredential
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: PSCredential
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Identifier
|
|
||||||
Defaults to "".
|
### -Identifier
|
||||||
Specify a string, which separates two CredentialStoreItems for the
|
Defaults to "".
|
||||||
same hostname.
|
Specify a string, which separates two CredentialStoreItems for the
|
||||||
|
same hostname.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -PassThru
|
|
||||||
Returns the value from the underlying connection type function.
|
### -PassThru
|
||||||
|
Returns the value from the underlying connection type function.
|
||||||
```yaml
|
|
||||||
Type: SwitchParameter
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: SwitchParameter
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: False
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: False
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Path
|
|
||||||
Define a custom path to a shared CredentialStore.
|
### -Path
|
||||||
|
Define a custom path to a shared CredentialStore.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: Shared
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: Shared
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -RemoteHost
|
|
||||||
Specify the host, for which you would like to change the credentials.
|
### -RemoteHost
|
||||||
|
Specify the host, for which you would like to change the credentials.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: Named
|
Required: True
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Shared
|
|
||||||
Switch to shared mode with this param.
|
### -Shared
|
||||||
This enforces the command to work with a shared CredentialStore which
|
Switch to shared mode with this param.
|
||||||
can be decrypted across systems.
|
This enforces the command to work with a shared CredentialStore which
|
||||||
|
can be decrypted across systems.
|
||||||
```yaml
|
|
||||||
Type: SwitchParameter
|
```yaml
|
||||||
Parameter Sets: Shared
|
Type: SwitchParameter
|
||||||
Aliases:
|
Parameter Sets: Shared
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: Named
|
Required: True
|
||||||
Default value: False
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: False
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Type
|
|
||||||
Specify the host type of the target.
|
### -Type
|
||||||
Currently implemented targets are: Possible connection values are:
|
Specify the host type of the target.
|
||||||
CiscoUcs, FTP, NetAppFAS, VMware, CisServer, ExchangeHTTP, ExchangeHTTPS, SCP.
|
Currently implemented targets are: Possible connection values are:
|
||||||
|
CiscoUcs, FTP, NetAppFAS, VMware, CisServer, ExchangeHTTP, ExchangeHTTPS, SCP.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: Named
|
Required: True
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
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).
|
### 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
|
|
||||||
|
## INPUTS
|
||||||
### [None]
|
|
||||||
## OUTPUTS
|
### [None]
|
||||||
|
## OUTPUTS
|
||||||
### [None]
|
|
||||||
## NOTES
|
### [None]
|
||||||
|
## NOTES
|
||||||
## RELATED LINKS
|
|
||||||
|
## RELATED LINKS
|
||||||
|
|||||||
@ -1,123 +1,124 @@
|
|||||||
---
|
---
|
||||||
external help file: PSCredentialStore-help.xml
|
external help file: ModuleRoot-help.xml
|
||||||
Module Name: PSCredentialStore
|
Module Name: PSCredentialStore
|
||||||
schema: 2.0.0
|
online version:
|
||||||
---
|
schema: 2.0.0
|
||||||
|
---
|
||||||
# Disconnect-From
|
|
||||||
|
# Disconnect-From
|
||||||
## SYNOPSIS
|
|
||||||
Terminates a session established with Connect-To using a CredentialStoreItem.
|
## SYNOPSIS
|
||||||
|
Terminates a session established with Connect-To using a CredentialStoreItem.
|
||||||
## SYNTAX
|
|
||||||
|
## SYNTAX
|
||||||
```
|
|
||||||
Disconnect-From [-RemoteHost] <String> [-Type] <String> [-Force] [<CommonParameters>]
|
```
|
||||||
```
|
Disconnect-From [-RemoteHost] <String> [-Type] <String> [-Force] [<CommonParameters>]
|
||||||
|
```
|
||||||
## DESCRIPTION
|
|
||||||
Terminates a session established with Connect-To using a CredentialStoreItem.
|
## DESCRIPTION
|
||||||
|
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
|
|
||||||
```
|
### EXAMPLE 7
|
||||||
Disconnect-From -RemoteHost "exchange01.myside.local" -Type ExchangeHTTP
|
```
|
||||||
```
|
Disconnect-From -RemoteHost "exchange01.myside.local" -Type ExchangeHTTP
|
||||||
|
```
|
||||||
### EXAMPLE 8
|
|
||||||
```
|
### EXAMPLE 8
|
||||||
Disconnect-From -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS
|
```
|
||||||
```
|
Disconnect-From -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS
|
||||||
|
```
|
||||||
## PARAMETERS
|
|
||||||
|
## PARAMETERS
|
||||||
### -Force
|
|
||||||
Force the disconnect, even if the disconnect would fail.
|
### -Force
|
||||||
|
Force the disconnect, even if the disconnect would fail.
|
||||||
```yaml
|
|
||||||
Type: SwitchParameter
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: SwitchParameter
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: False
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: False
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -RemoteHost
|
|
||||||
Specify the remote endpoint, whose session you would like to terminate.
|
### -RemoteHost
|
||||||
|
Specify the remote endpoint, whose session you would like to terminate.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: 1
|
Required: True
|
||||||
Default value: None
|
Position: 1
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Type
|
|
||||||
Specify the host type of the target.
|
### -Type
|
||||||
Currently implemented targets are: CiscoUcs, FTP, NetAppFAS, VMware,
|
Specify the host type of the target.
|
||||||
CisServer, ExchangeHTTP, ExchangeHTTPS, SCP.
|
Currently implemented targets are: CiscoUcs, FTP, NetAppFAS, VMware,
|
||||||
|
CisServer, ExchangeHTTP, ExchangeHTTPS, SCP.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: 2
|
Required: True
|
||||||
Default value: None
|
Position: 2
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
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).
|
### 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
|
|
||||||
|
## INPUTS
|
||||||
### [None]
|
|
||||||
## OUTPUTS
|
### [None]
|
||||||
|
## OUTPUTS
|
||||||
### [None]
|
|
||||||
## NOTES
|
### [None]
|
||||||
|
## NOTES
|
||||||
## RELATED LINKS
|
|
||||||
|
## RELATED LINKS
|
||||||
|
|||||||
@ -1,71 +1,72 @@
|
|||||||
---
|
---
|
||||||
external help file: PSCredentialStore-help.xml
|
external help file: ModuleRoot-help.xml
|
||||||
Module Name: PSCredentialStore
|
Module Name: PSCredentialStore
|
||||||
schema: 2.0.0
|
online version:
|
||||||
---
|
schema: 2.0.0
|
||||||
|
---
|
||||||
# Get-CSCertificate
|
|
||||||
|
# Get-CSCertificate
|
||||||
## SYNOPSIS
|
|
||||||
Returns the current used valid PfX certificate.
|
## SYNOPSIS
|
||||||
|
Returns the current used valid PfX certificate.
|
||||||
## SYNTAX
|
|
||||||
|
## SYNTAX
|
||||||
```
|
|
||||||
Get-CSCertificate [-Type] <String> [-Thumbprint] <String> [<CommonParameters>]
|
```
|
||||||
```
|
Get-CSCertificate [-Type] <String> [-Thumbprint] <String> [<CommonParameters>]
|
||||||
|
```
|
||||||
## DESCRIPTION
|
|
||||||
Use this function to get the available pfx certificate respecting the config hierarchy.
|
## DESCRIPTION
|
||||||
|
Use this function to get the available pfx certificate respecting the config hierarchy.
|
||||||
## EXAMPLES
|
|
||||||
|
## EXAMPLES
|
||||||
### EXAMPLE 1
|
|
||||||
```
|
### EXAMPLE 1
|
||||||
Get-CSCertificate -Type 'Shared' -Thumbprint '12334456'
|
```
|
||||||
```
|
Get-CSCertificate -Type 'Shared' -Thumbprint '12334456'
|
||||||
|
```
|
||||||
## PARAMETERS
|
|
||||||
|
## PARAMETERS
|
||||||
### -Thumbprint
|
|
||||||
Provide the credentials thumbprint for the search.
|
### -Thumbprint
|
||||||
|
Provide the credentials thumbprint for the search.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: 2
|
Required: True
|
||||||
Default value: None
|
Position: 2
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Type
|
|
||||||
Select the current credential store type.
|
### -Type
|
||||||
|
Select the current credential store type.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: 1
|
Required: True
|
||||||
Default value: None
|
Position: 1
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
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).
|
### 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
|
|
||||||
|
## INPUTS
|
||||||
### [None]
|
|
||||||
## OUTPUTS
|
### [None]
|
||||||
|
## OUTPUTS
|
||||||
### [System.Security.Cryptography.X509Certificates.X509Certificate2]
|
|
||||||
## NOTES
|
### [System.Security.Cryptography.X509Certificates.X509Certificate2]
|
||||||
|
## NOTES
|
||||||
## RELATED LINKS
|
|
||||||
|
## RELATED LINKS
|
||||||
|
|||||||
@ -1,83 +1,84 @@
|
|||||||
---
|
---
|
||||||
external help file: PSCredentialStore-help.xml
|
external help file: ModuleRoot-help.xml
|
||||||
Module Name: PSCredentialStore
|
Module Name: PSCredentialStore
|
||||||
schema: 2.0.0
|
online version:
|
||||||
---
|
schema: 2.0.0
|
||||||
|
---
|
||||||
# Get-CredentialStore
|
|
||||||
|
# Get-CredentialStore
|
||||||
## SYNOPSIS
|
|
||||||
Reads the complete content of the credential store and returns it as a new object.
|
## SYNOPSIS
|
||||||
|
Reads the complete content of the credential store and returns it as a new object.
|
||||||
## SYNTAX
|
|
||||||
|
## SYNTAX
|
||||||
### Private (Default)
|
|
||||||
```
|
### Private (Default)
|
||||||
Get-CredentialStore [<CommonParameters>]
|
```
|
||||||
```
|
Get-CredentialStore [<CommonParameters>]
|
||||||
|
```
|
||||||
### Shared
|
|
||||||
```
|
### Shared
|
||||||
Get-CredentialStore [-Path <String>] [-Shared] [<CommonParameters>]
|
```
|
||||||
```
|
Get-CredentialStore [-Path <String>] [-Shared] [<CommonParameters>]
|
||||||
|
```
|
||||||
## DESCRIPTION
|
|
||||||
The content is in a raw format.
|
## DESCRIPTION
|
||||||
It means there is no transformation to the different credential types.
|
The content is in a raw format.
|
||||||
You can not use the object properties to connect with remote host.
|
It means there is no transformation to the different credential types.
|
||||||
Therefore please use
|
You can not use the object properties to connect with remote host.
|
||||||
Get-CredentialStoreItem.
|
Therefore please use
|
||||||
|
Get-CredentialStoreItem.
|
||||||
## EXAMPLES
|
|
||||||
|
## EXAMPLES
|
||||||
### EXAMPLE 1
|
|
||||||
```
|
### EXAMPLE 1
|
||||||
$CSContent = Get-CredentialStore -Path "C:\TMP\mystore.json"
|
```
|
||||||
```
|
$CSContent = Get-CredentialStore -Path "C:\TMP\mystore.json"
|
||||||
|
```
|
||||||
## PARAMETERS
|
|
||||||
|
## PARAMETERS
|
||||||
### -Path
|
|
||||||
Define a custom path to a shared CredentialStore.
|
### -Path
|
||||||
|
Define a custom path to a shared CredentialStore.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: Shared
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: Shared
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Shared
|
|
||||||
Switch to shared mode with this param.
|
### -Shared
|
||||||
This enforces the command to work with a shared CredentialStore which
|
Switch to shared mode with this param.
|
||||||
can be decrypted across systems.
|
This enforces the command to work with a shared CredentialStore which
|
||||||
|
can be decrypted across systems.
|
||||||
```yaml
|
|
||||||
Type: SwitchParameter
|
```yaml
|
||||||
Parameter Sets: Shared
|
Type: SwitchParameter
|
||||||
Aliases:
|
Parameter Sets: Shared
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: Named
|
Required: True
|
||||||
Default value: False
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: False
|
||||||
Accept wildcard characters: False
|
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).
|
### 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
|
|
||||||
|
## INPUTS
|
||||||
### [None]
|
|
||||||
## OUTPUTS
|
### [None]
|
||||||
|
## OUTPUTS
|
||||||
### [PSObject] Returns the credential store content as PSObject.
|
|
||||||
## NOTES
|
### [PSObject] Returns the credential store content as PSObject.
|
||||||
|
## NOTES
|
||||||
## RELATED LINKS
|
|
||||||
|
## RELATED LINKS
|
||||||
|
|||||||
@ -1,113 +1,114 @@
|
|||||||
---
|
---
|
||||||
external help file: PSCredentialStore-help.xml
|
external help file: ModuleRoot-help.xml
|
||||||
Module Name: PSCredentialStore
|
Module Name: PSCredentialStore
|
||||||
schema: 2.0.0
|
online version:
|
||||||
---
|
schema: 2.0.0
|
||||||
|
---
|
||||||
# Get-CredentialStoreItem
|
|
||||||
|
# Get-CredentialStoreItem
|
||||||
## SYNOPSIS
|
|
||||||
Returns the Credential from a given remote host item.
|
## SYNOPSIS
|
||||||
|
Returns the Credential from a given remote host item.
|
||||||
## SYNTAX
|
|
||||||
|
## SYNTAX
|
||||||
### Private (Default)
|
|
||||||
```
|
### Private (Default)
|
||||||
Get-CredentialStoreItem -RemoteHost <String> [-Identifier <String>] [<CommonParameters>]
|
```
|
||||||
```
|
Get-CredentialStoreItem -RemoteHost <String> [-Identifier <String>] [<CommonParameters>]
|
||||||
|
```
|
||||||
### Shared
|
|
||||||
```
|
### Shared
|
||||||
Get-CredentialStoreItem -RemoteHost <String> [-Identifier <String>] [-Shared] [-Path <String>]
|
```
|
||||||
[<CommonParameters>]
|
Get-CredentialStoreItem -RemoteHost <String> [-Identifier <String>] [-Shared] [-Path <String>]
|
||||||
```
|
[<CommonParameters>]
|
||||||
|
```
|
||||||
## DESCRIPTION
|
|
||||||
Return the credential as PSCredential object.
|
## DESCRIPTION
|
||||||
|
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"
|
||||||
|
```
|
||||||
## PARAMETERS
|
|
||||||
|
## PARAMETERS
|
||||||
### -Identifier
|
|
||||||
Provide a custom identifier to the given remote host key.
|
### -Identifier
|
||||||
This enables you to store multiple credentials
|
Provide a custom identifier to the given remote host key.
|
||||||
for a single remote host entry.
|
This enables you to store multiple credentials
|
||||||
For example ad/sys1, ftp/sys1, mssql/sys1
|
for a single remote host entry.
|
||||||
|
For example ad/sys1, ftp/sys1, mssql/sys1
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Path
|
|
||||||
Define a custom path to a shared CredentialStore.
|
### -Path
|
||||||
|
Define a custom path to a shared CredentialStore.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: Shared
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: Shared
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -RemoteHost
|
|
||||||
Specify the host, for which you would like to change the credentials.
|
### -RemoteHost
|
||||||
|
Specify the host, for which you would like to change the credentials.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: Named
|
Required: True
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Shared
|
|
||||||
Switch to shared mode with this param.
|
### -Shared
|
||||||
This enforces the command to work with a shared CredentialStore which
|
Switch to shared mode with this param.
|
||||||
can be decrypted across systems.
|
This enforces the command to work with a shared CredentialStore which
|
||||||
|
can be decrypted across systems.
|
||||||
```yaml
|
|
||||||
Type: SwitchParameter
|
```yaml
|
||||||
Parameter Sets: Shared
|
Type: SwitchParameter
|
||||||
Aliases:
|
Parameter Sets: Shared
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: Named
|
Required: True
|
||||||
Default value: False
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: False
|
||||||
Accept wildcard characters: False
|
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).
|
### 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
|
|
||||||
|
## INPUTS
|
||||||
### [None]
|
|
||||||
## OUTPUTS
|
### [None]
|
||||||
|
## OUTPUTS
|
||||||
### [System.Management.Automation.PSCredential]
|
|
||||||
## NOTES
|
### [System.Management.Automation.PSCredential]
|
||||||
|
## NOTES
|
||||||
## RELATED LINKS
|
|
||||||
|
## RELATED LINKS
|
||||||
|
|||||||
@ -1,72 +1,73 @@
|
|||||||
---
|
---
|
||||||
external help file: PSCredentialStore-help.xml
|
external help file: ModuleRoot-help.xml
|
||||||
Module Name: PSCredentialStore
|
Module Name: PSCredentialStore
|
||||||
schema: 2.0.0
|
online version:
|
||||||
---
|
schema: 2.0.0
|
||||||
|
---
|
||||||
# Import-CSCertificate
|
|
||||||
|
# Import-CSCertificate
|
||||||
## SYNOPSIS
|
|
||||||
Imports a linked certificate to the valid store location.
|
## SYNOPSIS
|
||||||
|
Imports a linked certificate to the valid store location.
|
||||||
## SYNTAX
|
|
||||||
|
## SYNTAX
|
||||||
```
|
|
||||||
Import-CSCertificate [-Type] <String> [-Path] <FileInfo> [<CommonParameters>]
|
```
|
||||||
```
|
Import-CSCertificate [-Type] <String> [-Path] <FileInfo> [<CommonParameters>]
|
||||||
|
```
|
||||||
## DESCRIPTION
|
|
||||||
Import-CSCertificate takes a pfx certificate file and imports it to the supposed certificate store for
|
## DESCRIPTION
|
||||||
private and shared credential stores.
|
Import-CSCertificate takes a pfx certificate file and imports it to the supposed certificate store for
|
||||||
|
private and shared credential stores.
|
||||||
## EXAMPLES
|
|
||||||
|
## EXAMPLES
|
||||||
### EXAMPLE 1
|
|
||||||
```
|
### EXAMPLE 1
|
||||||
Import-CSCertificate -Type 'Private' -Path (Join-Path -Path $Env:APPDATA -ChildItem 'PfxCertificate.pfx')
|
```
|
||||||
```
|
Import-CSCertificate -Type 'Private' -Path (Join-Path -Path $Env:APPDATA -ChildItem 'PfxCertificate.pfx')
|
||||||
|
```
|
||||||
## PARAMETERS
|
|
||||||
|
## PARAMETERS
|
||||||
### -Path
|
|
||||||
Provide a valid path to pfx certificate file.
|
### -Path
|
||||||
|
Provide a valid path to pfx certificate file.
|
||||||
```yaml
|
|
||||||
Type: FileInfo
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: FileInfo
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: 2
|
Required: True
|
||||||
Default value: None
|
Position: 2
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Type
|
|
||||||
Select between the a private and shared credential store.
|
### -Type
|
||||||
|
Select between the a private and shared credential store.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: 1
|
Required: True
|
||||||
Default value: None
|
Position: 1
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
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).
|
### 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
|
|
||||||
|
## INPUTS
|
||||||
### [None]
|
|
||||||
## OUTPUTS
|
### [None]
|
||||||
|
## OUTPUTS
|
||||||
### [None]
|
|
||||||
## NOTES
|
### [None]
|
||||||
|
## NOTES
|
||||||
## RELATED LINKS
|
|
||||||
|
## RELATED LINKS
|
||||||
|
|||||||
@ -1,147 +1,156 @@
|
|||||||
---
|
---
|
||||||
external help file: PSCredentialStore-help.xml
|
external help file: ModuleRoot-help.xml
|
||||||
Module Name: PSCredentialStore
|
Module Name: PSCredentialStore
|
||||||
schema: 2.0.0
|
online version:
|
||||||
---
|
schema: 2.0.0
|
||||||
|
---
|
||||||
# New-CSCertAttribute
|
|
||||||
|
# New-CSCertAttribute
|
||||||
## SYNOPSIS
|
|
||||||
Creates required data for a certificate signing request.
|
## SYNOPSIS
|
||||||
|
Creates required data for a certificate signing request.
|
||||||
## SYNTAX
|
|
||||||
|
## SYNTAX
|
||||||
```
|
|
||||||
New-CSCertAttribute [-Country] <String> [-State] <String> [-City] <String> [-Organization] <String>
|
```
|
||||||
[-OrganizationalUnitName] <String> [-CommonName] <String> [[-Days] <Int32>] [<CommonParameters>]
|
New-CSCertAttribute [-Country] <String> [-State] <String> [-City] <String> [-Organization] <String>
|
||||||
```
|
[-OrganizationalUnitName] <String> [-CommonName] <String> [[-Days] <Int32>] [<CommonParameters>]
|
||||||
|
```
|
||||||
## DESCRIPTION
|
|
||||||
Defines the certificate related properties for an upcoming New-PfxCertificate execution.
|
## DESCRIPTION
|
||||||
|
Defines the certificate related properties for an upcoming New-PfxCertificate execution.
|
||||||
## EXAMPLES
|
|
||||||
|
## EXAMPLES
|
||||||
### EXAMPLE 1
|
|
||||||
```
|
### EXAMPLE 1
|
||||||
New-CSCertAttribute -Country 'DE' -State 'BW' -City 'Karlsruhe' -Organization 'AwesomeIT' -OrganizationalUnitName '' -CommonName 'MyPrivateCert'
|
```
|
||||||
```
|
$AttribParams = @{
|
||||||
|
Country = 'DE'
|
||||||
## PARAMETERS
|
State = 'BW'
|
||||||
|
City = 'Karlsruhe'
|
||||||
### -City
|
Organization ='AwesomeIT'
|
||||||
Certificate city value.
|
OrganizationalUnitName ='PSCredentialStore'
|
||||||
|
CommonName ='MyPrivateCert'
|
||||||
```yaml
|
}
|
||||||
Type: String
|
New-CSCertAttribute @AttribParams
|
||||||
Parameter Sets: (All)
|
```
|
||||||
Aliases:
|
|
||||||
|
## PARAMETERS
|
||||||
Required: True
|
|
||||||
Position: 3
|
### -City
|
||||||
Default value: None
|
Certificate city value.
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
```yaml
|
||||||
```
|
Type: String
|
||||||
|
Parameter Sets: (All)
|
||||||
### -CommonName
|
Aliases:
|
||||||
The certificate common name.
|
|
||||||
|
Required: True
|
||||||
```yaml
|
Position: 3
|
||||||
Type: String
|
Default value: None
|
||||||
Parameter Sets: (All)
|
Accept pipeline input: False
|
||||||
Aliases:
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
Required: True
|
|
||||||
Position: 6
|
### -CommonName
|
||||||
Default value: None
|
The certificate common name.
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
```yaml
|
||||||
```
|
Type: String
|
||||||
|
Parameter Sets: (All)
|
||||||
### -Country
|
Aliases:
|
||||||
County code like EN, DE, IT, FR...
|
|
||||||
|
Required: True
|
||||||
```yaml
|
Position: 6
|
||||||
Type: String
|
Default value: None
|
||||||
Parameter Sets: (All)
|
Accept pipeline input: False
|
||||||
Aliases:
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
Required: True
|
|
||||||
Position: 1
|
### -Country
|
||||||
Default value: None
|
County code like EN, DE, IT, FR...
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
```yaml
|
||||||
```
|
Type: String
|
||||||
|
Parameter Sets: (All)
|
||||||
### -Days
|
Aliases:
|
||||||
The validation time itself.
|
|
||||||
|
Required: True
|
||||||
```yaml
|
Position: 1
|
||||||
Type: Int32
|
Default value: None
|
||||||
Parameter Sets: (All)
|
Accept pipeline input: False
|
||||||
Aliases:
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
Required: False
|
|
||||||
Position: 7
|
### -Days
|
||||||
Default value: 365
|
The validation time itself.
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
```yaml
|
||||||
```
|
Type: Int32
|
||||||
|
Parameter Sets: (All)
|
||||||
### -Organization
|
Aliases:
|
||||||
Certificate organization value.
|
|
||||||
|
Required: False
|
||||||
```yaml
|
Position: 7
|
||||||
Type: String
|
Default value: 365
|
||||||
Parameter Sets: (All)
|
Accept pipeline input: False
|
||||||
Aliases:
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
Required: True
|
|
||||||
Position: 4
|
### -Organization
|
||||||
Default value: None
|
Certificate organization value.
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
```yaml
|
||||||
```
|
Type: String
|
||||||
|
Parameter Sets: (All)
|
||||||
### -OrganizationalUnitName
|
Aliases:
|
||||||
Certificate OrganizationalUnitName value.
|
|
||||||
|
Required: True
|
||||||
```yaml
|
Position: 4
|
||||||
Type: String
|
Default value: None
|
||||||
Parameter Sets: (All)
|
Accept pipeline input: False
|
||||||
Aliases:
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
Required: True
|
|
||||||
Position: 5
|
### -OrganizationalUnitName
|
||||||
Default value: None
|
Certificate OrganizationalUnitName value.
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
```yaml
|
||||||
```
|
Type: String
|
||||||
|
Parameter Sets: (All)
|
||||||
### -State
|
Aliases:
|
||||||
Certificate state value.
|
|
||||||
|
Required: True
|
||||||
```yaml
|
Position: 5
|
||||||
Type: String
|
Default value: None
|
||||||
Parameter Sets: (All)
|
Accept pipeline input: False
|
||||||
Aliases:
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
Required: True
|
|
||||||
Position: 2
|
### -State
|
||||||
Default value: None
|
Certificate state value.
|
||||||
Accept pipeline input: False
|
|
||||||
Accept wildcard characters: False
|
```yaml
|
||||||
```
|
Type: String
|
||||||
|
Parameter Sets: (All)
|
||||||
### CommonParameters
|
Aliases:
|
||||||
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).
|
|
||||||
|
Required: True
|
||||||
## INPUTS
|
Position: 2
|
||||||
|
Default value: None
|
||||||
### [None]
|
Accept pipeline input: False
|
||||||
## OUTPUTS
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### [PSCredentialStore.Certificate.CSRDetails]
|
|
||||||
## NOTES
|
### 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).
|
||||||
## RELATED LINKS
|
|
||||||
|
## INPUTS
|
||||||
|
|
||||||
|
### [None]
|
||||||
|
## OUTPUTS
|
||||||
|
|
||||||
|
### [PSCredentialStore.Certificate.CSRDetails]
|
||||||
|
## NOTES
|
||||||
|
|
||||||
|
## RELATED LINKS
|
||||||
|
|||||||
@ -1,120 +1,121 @@
|
|||||||
---
|
---
|
||||||
external help file: PSCredentialStore-help.xml
|
external help file: ModuleRoot-help.xml
|
||||||
Module Name: PSCredentialStore
|
Module Name: PSCredentialStore
|
||||||
schema: 2.0.0
|
online version:
|
||||||
---
|
schema: 2.0.0
|
||||||
|
---
|
||||||
# New-CSCertificate
|
|
||||||
|
# New-CSCertificate
|
||||||
## SYNOPSIS
|
|
||||||
Creates a new PFX certificate for the CredentialStore encryption.
|
## SYNOPSIS
|
||||||
|
Creates a new PFX certificate for the CredentialStore encryption.
|
||||||
## SYNTAX
|
|
||||||
|
## SYNTAX
|
||||||
```
|
|
||||||
New-CSCertificate [-CRTAttribute] <Object> [[-KeyName] <String>] [[-CertName] <String>] [-WhatIf] [-Confirm]
|
```
|
||||||
[<CommonParameters>]
|
New-CSCertificate [-CRTAttribute] <Object> [[-KeyName] <String>] [[-CertName] <String>] [-WhatIf] [-Confirm]
|
||||||
```
|
[<CommonParameters>]
|
||||||
|
```
|
||||||
## DESCRIPTION
|
|
||||||
Use this function to create a custom self signed certificate used by the PSCredentialStore module.
|
## DESCRIPTION
|
||||||
|
Use this function to create a custom self signed certificate used by the PSCredentialStore module.
|
||||||
## EXAMPLES
|
|
||||||
|
## EXAMPLES
|
||||||
### EXAMPLE 1
|
|
||||||
```
|
### EXAMPLE 1
|
||||||
New-CSCertificate -CRTAttribute $CRTAttribute -KeyName './myprivate.key' -CertName './mycert.pfx'
|
```
|
||||||
```
|
New-CSCertificate -CRTAttribute $CRTAttribute -KeyName './myprivate.key' -CertName './mycert.pfx'
|
||||||
|
```
|
||||||
## PARAMETERS
|
|
||||||
|
## PARAMETERS
|
||||||
### -CertName
|
|
||||||
Provide a custom full path and name for the PFX certificate file.
|
### -CertName
|
||||||
The file extension has to be \`*.pfx\`
|
Provide a custom full path and name for the PFX certificate file.
|
||||||
|
The file extension has to be \`*.pfx\`
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: 3
|
Required: False
|
||||||
Default value: ./certificate.pfx
|
Position: 3
|
||||||
Accept pipeline input: False
|
Default value: ./certificate.pfx
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -CRTAttribute
|
|
||||||
Provide certificate related attributes provided by function New-CRTAttribute.
|
### -CRTAttribute
|
||||||
|
Provide certificate related attributes provided by function New-CRTAttribute.
|
||||||
```yaml
|
|
||||||
Type: Object
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: Object
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: 1
|
Required: True
|
||||||
Default value: None
|
Position: 1
|
||||||
Accept pipeline input: True (ByValue)
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: True (ByValue)
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -KeyName
|
|
||||||
Provide a custom full path and name for the private key.
|
### -KeyName
|
||||||
The file extension has to be \`*.key\`.
|
Provide a custom full path and name for the private key.
|
||||||
|
The file extension has to be \`*.key\`.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: 2
|
Required: False
|
||||||
Default value: ./private.key
|
Position: 2
|
||||||
Accept pipeline input: False
|
Default value: ./private.key
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Confirm
|
|
||||||
Prompts you for confirmation before running the cmdlet.
|
### -Confirm
|
||||||
|
Prompts you for confirmation before running the cmdlet.
|
||||||
```yaml
|
|
||||||
Type: SwitchParameter
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: SwitchParameter
|
||||||
Aliases: cf
|
Parameter Sets: (All)
|
||||||
|
Aliases: cf
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -WhatIf
|
|
||||||
Shows what would happen if the cmdlet runs.
|
### -WhatIf
|
||||||
The cmdlet is not run.
|
Shows what would happen if the cmdlet runs.
|
||||||
|
The cmdlet is not run.
|
||||||
```yaml
|
|
||||||
Type: SwitchParameter
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: SwitchParameter
|
||||||
Aliases: wi
|
Parameter Sets: (All)
|
||||||
|
Aliases: wi
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
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).
|
### 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
|
|
||||||
|
## INPUTS
|
||||||
### [PSCredentialStore.Certificate.Attribute]
|
|
||||||
## OUTPUTS
|
### [PSCredentialStore.Certificate.Attribute]
|
||||||
|
## OUTPUTS
|
||||||
### [None]
|
|
||||||
## NOTES
|
### [None]
|
||||||
|
## NOTES
|
||||||
## RELATED LINKS
|
|
||||||
|
## RELATED LINKS
|
||||||
|
|||||||
@ -1,202 +1,203 @@
|
|||||||
---
|
---
|
||||||
external help file: PSCredentialStore-help.xml
|
external help file: ModuleRoot-help.xml
|
||||||
Module Name: PSCredentialStore
|
Module Name: PSCredentialStore
|
||||||
schema: 2.0.0
|
online version:
|
||||||
---
|
schema: 2.0.0
|
||||||
|
---
|
||||||
# New-CredentialStore
|
|
||||||
|
# New-CredentialStore
|
||||||
## SYNOPSIS
|
|
||||||
Creates a new credential store File
|
## SYNOPSIS
|
||||||
|
Creates a new credential store File
|
||||||
## SYNTAX
|
|
||||||
|
## SYNTAX
|
||||||
### Private (Default)
|
|
||||||
```
|
### Private (Default)
|
||||||
New-CredentialStore [-Force] [-PassThru] [-SkipPFXCertCreation] [-UseCertStore] [-WhatIf] [-Confirm]
|
```
|
||||||
[<CommonParameters>]
|
New-CredentialStore [-Force] [-PassThru] [-SkipPFXCertCreation] [-UseCertStore] [-WhatIf] [-Confirm]
|
||||||
```
|
[<CommonParameters>]
|
||||||
|
```
|
||||||
### Shared
|
|
||||||
```
|
### Shared
|
||||||
New-CredentialStore [-Shared] [-Path <FileInfo>] [-Force] [-PassThru] [-SkipPFXCertCreation] [-UseCertStore]
|
```
|
||||||
[-WhatIf] [-Confirm] [<CommonParameters>]
|
New-CredentialStore [-Shared] [-Path <FileInfo>] [-Force] [-PassThru] [-SkipPFXCertCreation] [-UseCertStore]
|
||||||
```
|
[-WhatIf] [-Confirm] [<CommonParameters>]
|
||||||
|
```
|
||||||
## DESCRIPTION
|
|
||||||
You need to run this script first to create a new credential store before you try to
|
## DESCRIPTION
|
||||||
save new credentials with New-CredentialStoreItem.
|
You need to run this script first to create a new credential store before you try to
|
||||||
|
save new credentials with New-CredentialStoreItem.
|
||||||
## EXAMPLES
|
|
||||||
|
## EXAMPLES
|
||||||
### EXAMPLE 1
|
|
||||||
```
|
### EXAMPLE 1
|
||||||
New-CredentialStore
|
```
|
||||||
# Creates a new private CredentialStore
|
New-CredentialStore
|
||||||
```
|
# Creates a new private CredentialStore
|
||||||
|
```
|
||||||
### EXAMPLE 2
|
|
||||||
```
|
### EXAMPLE 2
|
||||||
New-CredentialStore -Force
|
```
|
||||||
# Resets an existing private CredentialStore
|
New-CredentialStore -Force
|
||||||
```
|
# Resets an existing private CredentialStore
|
||||||
|
```
|
||||||
### EXAMPLE 3
|
|
||||||
```
|
### EXAMPLE 3
|
||||||
New-CredentialStore -Shared
|
```
|
||||||
# Creates a new shared CredentialStore
|
New-CredentialStore -Shared
|
||||||
```
|
# Creates a new shared CredentialStore
|
||||||
|
```
|
||||||
### EXAMPLE 4
|
|
||||||
```
|
### EXAMPLE 4
|
||||||
New-CredentialStore -Shared -Path "C:\TMP\CredentialStore.json"
|
```
|
||||||
# Creates a new shared CredentialStore in the given location.
|
New-CredentialStore -Shared -Path "C:\TMP\CredentialStore.json"
|
||||||
```
|
# Creates a new shared CredentialStore in the given location.
|
||||||
|
```
|
||||||
## PARAMETERS
|
|
||||||
|
## PARAMETERS
|
||||||
### -Force
|
|
||||||
Use this switch to reset an existing store.
|
### -Force
|
||||||
The complete content will be wiped.
|
Use this switch to reset an existing store.
|
||||||
|
The complete content will be wiped.
|
||||||
```yaml
|
|
||||||
Type: SwitchParameter
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: SwitchParameter
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: False
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: False
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -PassThru
|
|
||||||
{{ Fill PassThru Description }}
|
### -PassThru
|
||||||
|
{{ Fill PassThru Description }}
|
||||||
```yaml
|
|
||||||
Type: SwitchParameter
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: SwitchParameter
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: False
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: False
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Path
|
|
||||||
Define a location for the new shared CredentialStore.
|
### -Path
|
||||||
The default store will be created in
|
Define a location for the new shared CredentialStore.
|
||||||
$Env:ProgramData\PSCredentialStore dir.
|
The default store will be created in
|
||||||
|
$Env:ProgramData\PSCredentialStore dir.
|
||||||
```yaml
|
|
||||||
Type: FileInfo
|
```yaml
|
||||||
Parameter Sets: Shared
|
Type: FileInfo
|
||||||
Aliases:
|
Parameter Sets: Shared
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Shared
|
|
||||||
Creates a CredentialStore in the Shared mode.
|
### -Shared
|
||||||
This enables you to read the CredentialStore Items on
|
Creates a CredentialStore in the Shared mode.
|
||||||
different systems or profiles.
|
This enables you to read the CredentialStore Items on
|
||||||
In addition you can optionally provide a custom path wit the -Path parameter.
|
different systems or profiles.
|
||||||
|
In addition you can optionally provide a custom path wit the -Path parameter.
|
||||||
```yaml
|
|
||||||
Type: SwitchParameter
|
```yaml
|
||||||
Parameter Sets: Shared
|
Type: SwitchParameter
|
||||||
Aliases:
|
Parameter Sets: Shared
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: Named
|
Required: True
|
||||||
Default value: False
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: False
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -SkipPFXCertCreation
|
|
||||||
You can skip the pfx certificate creation process.
|
### -SkipPFXCertCreation
|
||||||
This makes sense if you have a previously created cert or want to
|
You can skip the pfx certificate creation process.
|
||||||
import a cert in cross-platform environments.
|
This makes sense if you have a previously created cert
|
||||||
|
or want to import a cert in cross-platform environments.
|
||||||
```yaml
|
|
||||||
Type: SwitchParameter
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: SwitchParameter
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: False
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: False
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -UseCertStore
|
|
||||||
Instead of using a plain pfx file beside your CredentialStore file you can import it into the user or machine
|
### -UseCertStore
|
||||||
certificate store.
|
Instead of using a plain pfx file beside your CredentialStore file you can import it into the user or
|
||||||
In this case the system itself secures the cert and you don't hat to set custom NTFS
|
machine certificate store.
|
||||||
permissions so secure your shared certificate.
|
In this case the system itself secures the cert and you don't hat to set custom
|
||||||
|
NTFS permissions so secure your shared certificate.
|
||||||
```yaml
|
|
||||||
Type: SwitchParameter
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: SwitchParameter
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: False
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: False
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Confirm
|
|
||||||
Prompts you for confirmation before running the cmdlet.
|
### -Confirm
|
||||||
|
Prompts you for confirmation before running the cmdlet.
|
||||||
```yaml
|
|
||||||
Type: SwitchParameter
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: SwitchParameter
|
||||||
Aliases: cf
|
Parameter Sets: (All)
|
||||||
|
Aliases: cf
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -WhatIf
|
|
||||||
Shows what would happen if the cmdlet runs.
|
### -WhatIf
|
||||||
The cmdlet is not run.
|
Shows what would happen if the cmdlet runs.
|
||||||
|
The cmdlet is not run.
|
||||||
```yaml
|
|
||||||
Type: SwitchParameter
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: SwitchParameter
|
||||||
Aliases: wi
|
Parameter Sets: (All)
|
||||||
|
Aliases: wi
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
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).
|
### 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
|
|
||||||
|
## INPUTS
|
||||||
### [None]
|
|
||||||
## OUTPUTS
|
### [None]
|
||||||
|
## OUTPUTS
|
||||||
### ['PSCredentialStore.Store'] Returns the recently created CredentialStore object if the -PassThru parameter
|
|
||||||
### was given.
|
### ['PSCredentialStore.Store'] Returns the recently created CredentialStore object if the -PassThru parameter
|
||||||
## NOTES
|
### was given.
|
||||||
|
## NOTES
|
||||||
## RELATED LINKS
|
|
||||||
|
## RELATED LINKS
|
||||||
|
|||||||
@ -1,133 +1,134 @@
|
|||||||
---
|
---
|
||||||
external help file: PSCredentialStore-help.xml
|
external help file: ModuleRoot-help.xml
|
||||||
Module Name: PSCredentialStore
|
Module Name: PSCredentialStore
|
||||||
schema: 2.0.0
|
online version:
|
||||||
---
|
schema: 2.0.0
|
||||||
|
---
|
||||||
# New-CredentialStoreItem
|
|
||||||
|
# New-CredentialStoreItem
|
||||||
## SYNOPSIS
|
|
||||||
Adds a credential store item containing host, user and password to the given store.
|
## SYNOPSIS
|
||||||
|
Adds a credential store item containing host, user and password to the given store.
|
||||||
## SYNTAX
|
|
||||||
|
## SYNTAX
|
||||||
### Private (Default)
|
|
||||||
```
|
### Private (Default)
|
||||||
New-CredentialStoreItem -RemoteHost <String> [-Identifier <String>] [-Credential <PSCredential>]
|
```
|
||||||
[<CommonParameters>]
|
New-CredentialStoreItem -RemoteHost <String> [-Identifier <String>] [-Credential <PSCredential>]
|
||||||
```
|
[<CommonParameters>]
|
||||||
|
```
|
||||||
### Shared
|
|
||||||
```
|
### Shared
|
||||||
New-CredentialStoreItem -RemoteHost <String> [-Identifier <String>] [-Credential <PSCredential>] [-Shared]
|
```
|
||||||
[-Path <String>] [<CommonParameters>]
|
New-CredentialStoreItem -RemoteHost <String> [-Identifier <String>] [-Credential <PSCredential>] [-Shared]
|
||||||
```
|
[-Path <String>] [<CommonParameters>]
|
||||||
|
```
|
||||||
## DESCRIPTION
|
|
||||||
The credentials are stored without any relations to it's further use.
|
## DESCRIPTION
|
||||||
If you need to change an existing
|
The credentials are stored without any relations to it's further use.
|
||||||
item please use Set-CredentialStoreItem.
|
If you need to change an existing
|
||||||
You need to decide afterwards, whether to use the credential for
|
item please use Set-CredentialStoreItem.
|
||||||
a VIConnection, NetApp FAS or UCS Fabric Interconnect.
|
You need to decide afterwards, whether to use the credential for
|
||||||
|
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"
|
||||||
|
```
|
||||||
## PARAMETERS
|
|
||||||
|
## PARAMETERS
|
||||||
### -Credential
|
|
||||||
You can provide credentials optionally as pre existing pscredential object.
|
### -Credential
|
||||||
|
You can provide credentials optionally as pre existing pscredential object.
|
||||||
```yaml
|
|
||||||
Type: PSCredential
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: PSCredential
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: True (ByValue)
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: True (ByValue)
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Identifier
|
|
||||||
Provide a custom identifier to the given remote host key.
|
### -Identifier
|
||||||
This enables you to store multiple credentials
|
Provide a custom identifier to the given remote host key.
|
||||||
for a single remote host entry.
|
This enables you to store multiple credentials
|
||||||
For example ad/sys1, ftp/sys1, mssql/sys1
|
for a single remote host entry.
|
||||||
|
For example ad/sys1, ftp/sys1, mssql/sys1
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Path
|
|
||||||
Define the store in which you would like to add a new item.
|
### -Path
|
||||||
|
Define the store in which you would like to add a new item.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: Shared
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: Shared
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -RemoteHost
|
|
||||||
The identifier or rather name for the given credentials.
|
### -RemoteHost
|
||||||
|
The identifier or rather name for the given credentials.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: Named
|
Required: True
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Shared
|
|
||||||
Define the CredentialStore where you want to add the new item.
|
### -Shared
|
||||||
Default is always personal but can be
|
Define the CredentialStore where you want to add the new item.
|
||||||
changed to shared, or even shared with custom path.
|
Default is always personal but can be
|
||||||
|
changed to shared, or even shared with custom path.
|
||||||
```yaml
|
|
||||||
Type: SwitchParameter
|
```yaml
|
||||||
Parameter Sets: Shared
|
Type: SwitchParameter
|
||||||
Aliases:
|
Parameter Sets: Shared
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: Named
|
Required: True
|
||||||
Default value: False
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: False
|
||||||
Accept wildcard characters: False
|
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).
|
### 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
|
|
||||||
|
## INPUTS
|
||||||
### [None]
|
|
||||||
## OUTPUTS
|
### [None]
|
||||||
|
## OUTPUTS
|
||||||
### [None]
|
|
||||||
## NOTES
|
### [None]
|
||||||
|
## NOTES
|
||||||
## RELATED LINKS
|
|
||||||
|
## RELATED LINKS
|
||||||
|
|||||||
@ -1,64 +1,64 @@
|
|||||||
---
|
---
|
||||||
Module Name: PSCredentialStore
|
Module Name: PSCredentialStore
|
||||||
Module Guid: 6800e192-9df8-4e30-b253-eb2c799bbe84 6800e192-9df8-4e30-b253-eb2c799bbe84
|
Module Guid: 6800e192-9df8-4e30-b253-eb2c799bbe84
|
||||||
Download Help Link: {{ Update Download Link }}
|
Download Help Link: {{ Update Download Link }}
|
||||||
Help Version: {{ Please enter version of help manually (X.X.X.X) format }}
|
Help Version: {{ Update Help Version }}
|
||||||
Locale: en-US
|
Locale: en-US
|
||||||
---
|
---
|
||||||
|
|
||||||
# PSCredentialStore Module
|
# PSCredentialStore Module
|
||||||
## Description
|
## Description
|
||||||
{{ Fill in the Description }}
|
See global Readme file for usage instructions.
|
||||||
|
|
||||||
## PSCredentialStore Cmdlets
|
## PSCredentialStore Cmdlets
|
||||||
### [Connect-To](Connect-To.md)
|
### [Connect-To](Connect-To.md)
|
||||||
Connects to the given host using the stored CredentialStoreItem.
|
Connects to the given host using the stored CredentialStoreItem.
|
||||||
|
|
||||||
### [Disconnect-From](Disconnect-From.md)
|
### [Disconnect-From](Disconnect-From.md)
|
||||||
Terminates a session established with Connect-To using a CredentialStoreItem.
|
Terminates a session established with Connect-To using a CredentialStoreItem.
|
||||||
|
|
||||||
### [Get-CredentialStore](Get-CredentialStore.md)
|
### [Get-CredentialStore](Get-CredentialStore.md)
|
||||||
Reads the complete content of the credential store and returns it as a new object.
|
Reads the complete content of the credential store and returns it as a new object.
|
||||||
|
|
||||||
### [Get-CredentialStoreItem](Get-CredentialStoreItem.md)
|
### [Get-CredentialStoreItem](Get-CredentialStoreItem.md)
|
||||||
Returns the Credential from a given remote host item.
|
Returns the Credential from a given remote host item.
|
||||||
|
|
||||||
### [Get-CSCertificate](Get-CSCertificate.md)
|
### [Get-CSCertificate](Get-CSCertificate.md)
|
||||||
Returns the current used valid PfX certificate.
|
Returns the current used valid PfX certificate.
|
||||||
|
|
||||||
### [Import-CSCertificate](Import-CSCertificate.md)
|
### [Import-CSCertificate](Import-CSCertificate.md)
|
||||||
Imports a linked certificate to the valid store location.
|
Imports a linked certificate to the valid store location.
|
||||||
|
|
||||||
### [New-CredentialStore](New-CredentialStore.md)
|
### [New-CredentialStore](New-CredentialStore.md)
|
||||||
Creates a new credential store File
|
Creates a new credential store File
|
||||||
|
|
||||||
### [New-CredentialStoreItem](New-CredentialStoreItem.md)
|
### [New-CredentialStoreItem](New-CredentialStoreItem.md)
|
||||||
Adds a credential store item containing host, user and password to the given store.
|
Adds a credential store item containing host, user and password to the given store.
|
||||||
|
|
||||||
### [New-CSCertAttribute](New-CSCertAttribute.md)
|
### [New-CSCertAttribute](New-CSCertAttribute.md)
|
||||||
Creates required data for a certificate signing request.
|
Creates required data for a certificate signing request.
|
||||||
|
|
||||||
### [New-CSCertificate](New-CSCertificate.md)
|
### [New-CSCertificate](New-CSCertificate.md)
|
||||||
Creates a new PFX certificate for the CredentialStore encryption.
|
Creates a new PFX certificate for the CredentialStore encryption.
|
||||||
|
|
||||||
### [Remove-CredentialStoreItem](Remove-CredentialStoreItem.md)
|
### [Remove-CredentialStoreItem](Remove-CredentialStoreItem.md)
|
||||||
Remove the given credentials from the credential store.
|
Remove the given credentials from the credential store.
|
||||||
|
|
||||||
### [Set-CredentialStoreItem](Set-CredentialStoreItem.md)
|
### [Set-CredentialStoreItem](Set-CredentialStoreItem.md)
|
||||||
Changes the credentials for the given remote host in the store.
|
Changes the credentials for the given remote host in the store.
|
||||||
|
|
||||||
### [Test-CredentialStore](Test-CredentialStore.md)
|
### [Test-CredentialStore](Test-CredentialStore.md)
|
||||||
Returns the credential store state.
|
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-CSCertificate](Test-CSCertificate.md)
|
### [Test-CSCertificate](Test-CSCertificate.md)
|
||||||
Tests if the linked certificate is store ein the specified cert stores.
|
Tests if the linked certificate is store ein the specified cert stores.
|
||||||
|
|
||||||
### [Test-CSConnection](Test-CSConnection.md)
|
### [Test-CSConnection](Test-CSConnection.md)
|
||||||
Returns the connection state of a given type to the remote host.
|
Returns the connection state of a given type to the remote host.
|
||||||
|
|
||||||
### [Use-CSCertificate](Use-CSCertificate.md)
|
### [Use-CSCertificate](Use-CSCertificate.md)
|
||||||
Links an existing PFX Certificate to a CredentialStore.
|
Links an existing PFX Certificate to a CredentialStore.
|
||||||
|
|
||||||
@ -1,127 +1,128 @@
|
|||||||
---
|
---
|
||||||
external help file: PSCredentialStore-help.xml
|
external help file: ModuleRoot-help.xml
|
||||||
Module Name: PSCredentialStore
|
Module Name: PSCredentialStore
|
||||||
schema: 2.0.0
|
online version:
|
||||||
---
|
schema: 2.0.0
|
||||||
|
---
|
||||||
# Remove-CredentialStoreItem
|
|
||||||
|
# Remove-CredentialStoreItem
|
||||||
## SYNOPSIS
|
|
||||||
Remove the given credentials from the credential store.
|
## SYNOPSIS
|
||||||
|
Remove the given credentials from the credential store.
|
||||||
## SYNTAX
|
|
||||||
|
## SYNTAX
|
||||||
### Private (Default)
|
|
||||||
```
|
### Private (Default)
|
||||||
Remove-CredentialStoreItem -RemoteHost <String> [-Identifier <String>] [<CommonParameters>]
|
```
|
||||||
```
|
Remove-CredentialStoreItem -RemoteHost <String> [-Identifier <String>] [<CommonParameters>]
|
||||||
|
```
|
||||||
### Shared
|
|
||||||
```
|
### Shared
|
||||||
Remove-CredentialStoreItem -RemoteHost <String> [-Identifier <String>] [-Shared] [-Path <String>]
|
```
|
||||||
[<CommonParameters>]
|
Remove-CredentialStoreItem -RemoteHost <String> [-Identifier <String>] [-Shared] [-Path <String>]
|
||||||
```
|
[<CommonParameters>]
|
||||||
|
```
|
||||||
## DESCRIPTION
|
|
||||||
Use this CMDLet to completely remove an credential store item.
|
## DESCRIPTION
|
||||||
|
Use this CMDLet to completely remove an credential store item.
|
||||||
## EXAMPLES
|
|
||||||
|
## EXAMPLES
|
||||||
### EXAMPLE 1
|
|
||||||
```
|
### EXAMPLE 1
|
||||||
Remove-CredentialStoreItem -RemoteHost "esx01.myside.local"
|
```
|
||||||
```
|
Remove-CredentialStoreItem -RemoteHost "esx01.myside.local"
|
||||||
|
```
|
||||||
### EXAMPLE 2
|
|
||||||
```
|
### EXAMPLE 2
|
||||||
Remove-CredentialStoreItem -Shared -RemoteHost "esx01.myside.local"
|
```
|
||||||
```
|
Remove-CredentialStoreItem -Shared -RemoteHost "esx01.myside.local"
|
||||||
|
```
|
||||||
### EXAMPLE 3
|
|
||||||
```
|
### EXAMPLE 3
|
||||||
Remove-CredentialStoreItem -Shared -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local"
|
```
|
||||||
```
|
Remove-CredentialStoreItem -Shared -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local"
|
||||||
|
```
|
||||||
### EXAMPLE 4
|
|
||||||
```
|
### EXAMPLE 4
|
||||||
Remove-CredentialStoreItem -RemoteHost "esx01.myside.local" -Identifier svc
|
```
|
||||||
```
|
Remove-CredentialStoreItem -RemoteHost "esx01.myside.local" -Identifier svc
|
||||||
|
```
|
||||||
## PARAMETERS
|
|
||||||
|
## PARAMETERS
|
||||||
### -Identifier
|
|
||||||
Defaults to "".
|
### -Identifier
|
||||||
Specify a string, which separates two CredentialStoreItems for the
|
Defaults to "".
|
||||||
same hostname.
|
Specify a string, which separates two CredentialStoreItems for the
|
||||||
|
same hostname.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Path
|
|
||||||
Define the store in which your given host entry already exists.
|
### -Path
|
||||||
|
Define the store in which your given host entry already exists.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: Shared
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: Shared
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -RemoteHost
|
|
||||||
Specify the host you for which you would like to change the credentials.
|
### -RemoteHost
|
||||||
|
Specify the host you for which you would like to change the credentials.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: Named
|
Required: True
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Shared
|
|
||||||
Switch to shared mode with this param.
|
### -Shared
|
||||||
This enforces the command to work with a shared CredentialStore which
|
Switch to shared mode with this param.
|
||||||
can be decrypted across systems.
|
This enforces the command to work with a shared CredentialStore which
|
||||||
|
can be decrypted across systems.
|
||||||
```yaml
|
|
||||||
Type: SwitchParameter
|
```yaml
|
||||||
Parameter Sets: Shared
|
Type: SwitchParameter
|
||||||
Aliases:
|
Parameter Sets: Shared
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: Named
|
Required: True
|
||||||
Default value: False
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: False
|
||||||
Accept wildcard characters: False
|
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).
|
### 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
|
|
||||||
|
## INPUTS
|
||||||
### [None]
|
|
||||||
## OUTPUTS
|
### [None]
|
||||||
|
## OUTPUTS
|
||||||
### [None]
|
|
||||||
## NOTES
|
### [None]
|
||||||
|
## NOTES
|
||||||
## RELATED LINKS
|
|
||||||
|
## RELATED LINKS
|
||||||
|
|||||||
@ -1,133 +1,134 @@
|
|||||||
---
|
---
|
||||||
external help file: PSCredentialStore-help.xml
|
external help file: ModuleRoot-help.xml
|
||||||
Module Name: PSCredentialStore
|
Module Name: PSCredentialStore
|
||||||
schema: 2.0.0
|
online version:
|
||||||
---
|
schema: 2.0.0
|
||||||
|
---
|
||||||
# Set-CredentialStoreItem
|
|
||||||
|
# Set-CredentialStoreItem
|
||||||
## SYNOPSIS
|
|
||||||
Changes the credentials for the given remote host in the store.
|
## SYNOPSIS
|
||||||
|
Changes the credentials for the given remote host in the store.
|
||||||
## SYNTAX
|
|
||||||
|
## SYNTAX
|
||||||
### Private (Default)
|
|
||||||
```
|
### Private (Default)
|
||||||
Set-CredentialStoreItem -RemoteHost <String> [-Identifier <String>] [-Credential <PSCredential>]
|
```
|
||||||
[<CommonParameters>]
|
Set-CredentialStoreItem -RemoteHost <String> [-Identifier <String>] [-Credential <PSCredential>]
|
||||||
```
|
[<CommonParameters>]
|
||||||
|
```
|
||||||
### Shared
|
|
||||||
```
|
### Shared
|
||||||
Set-CredentialStoreItem -RemoteHost <String> [-Identifier <String>] [-Credential <PSCredential>] [-Shared]
|
```
|
||||||
[-Path <String>] [<CommonParameters>]
|
Set-CredentialStoreItem -RemoteHost <String> [-Identifier <String>] [-Credential <PSCredential>] [-Shared]
|
||||||
```
|
[-Path <String>] [<CommonParameters>]
|
||||||
|
```
|
||||||
## DESCRIPTION
|
|
||||||
Use this function to update your already stored RemoteHost items.
|
## DESCRIPTION
|
||||||
|
Use this function to update your already stored RemoteHost items.
|
||||||
## 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"
|
||||||
|
```
|
||||||
### EXAMPLE 2
|
|
||||||
```
|
### EXAMPLE 2
|
||||||
Set-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" -Identifier svc
|
```
|
||||||
```
|
Set-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" -Identifier svc
|
||||||
|
```
|
||||||
## PARAMETERS
|
|
||||||
|
## PARAMETERS
|
||||||
### -Credential
|
|
||||||
Provided the new credentials you want to update inside the RemoteHost item.
|
### -Credential
|
||||||
|
Provided the new credentials you want to update inside the RemoteHost item.
|
||||||
```yaml
|
|
||||||
Type: PSCredential
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: PSCredential
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: True (ByValue)
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: True (ByValue)
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Identifier
|
|
||||||
Defaults to "".
|
### -Identifier
|
||||||
Specify a string, which separates two CredentialStoreItems for the
|
Defaults to "".
|
||||||
same hostname.
|
Specify a string, which separates two CredentialStoreItems for the
|
||||||
|
same hostname.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Path
|
|
||||||
Define the store in which your given host entry already exists.
|
### -Path
|
||||||
|
Define the store in which your given host entry already exists.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: Shared
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: Shared
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -RemoteHost
|
|
||||||
Specify the host you for which you would like to change the credentials.
|
### -RemoteHost
|
||||||
|
Specify the host you for which you would like to change the credentials.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: Named
|
Required: True
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Shared
|
|
||||||
Switch to shared mode with this param.
|
### -Shared
|
||||||
This enforces the command to work with a shared CredentialStore which
|
Switch to shared mode with this param.
|
||||||
can be decrypted across systems.
|
This enforces the command to work with a shared CredentialStore which
|
||||||
|
can be decrypted across systems.
|
||||||
```yaml
|
|
||||||
Type: SwitchParameter
|
```yaml
|
||||||
Parameter Sets: Shared
|
Type: SwitchParameter
|
||||||
Aliases:
|
Parameter Sets: Shared
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: Named
|
Required: True
|
||||||
Default value: False
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: False
|
||||||
Accept wildcard characters: False
|
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).
|
### 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
|
|
||||||
|
## INPUTS
|
||||||
### [None]
|
|
||||||
## OUTPUTS
|
### [None]
|
||||||
|
## OUTPUTS
|
||||||
### [None]
|
|
||||||
## NOTES
|
### [None]
|
||||||
|
## NOTES
|
||||||
## RELATED LINKS
|
|
||||||
|
## RELATED LINKS
|
||||||
|
|||||||
@ -1,56 +1,57 @@
|
|||||||
---
|
---
|
||||||
external help file: PSCredentialStore-help.xml
|
external help file: ModuleRoot-help.xml
|
||||||
Module Name: PSCredentialStore
|
Module Name: PSCredentialStore
|
||||||
schema: 2.0.0
|
online version:
|
||||||
---
|
schema: 2.0.0
|
||||||
|
---
|
||||||
# Test-CSCertificate
|
|
||||||
|
# Test-CSCertificate
|
||||||
## SYNOPSIS
|
|
||||||
Tests if the linked certificate is store ein the specified cert stores.
|
## SYNOPSIS
|
||||||
|
Tests if the linked certificate is store ein the specified cert stores.
|
||||||
## SYNTAX
|
|
||||||
|
## SYNTAX
|
||||||
```
|
|
||||||
Test-CSCertificate [-Type] <String> [<CommonParameters>]
|
```
|
||||||
```
|
Test-CSCertificate [-Type] <String> [<CommonParameters>]
|
||||||
|
```
|
||||||
## DESCRIPTION
|
|
||||||
Test-CSCertificate should be an easy high level test for the linked certificate.
|
## DESCRIPTION
|
||||||
|
Test-CSCertificate should be an easy high level test for the linked certificate.
|
||||||
## EXAMPLES
|
|
||||||
|
## EXAMPLES
|
||||||
### EXAMPLE 1
|
|
||||||
```
|
### EXAMPLE 1
|
||||||
Test-CSCertificate -Type 'Shared'
|
```
|
||||||
```
|
Test-CSCertificate -Type 'Shared'
|
||||||
|
```
|
||||||
## PARAMETERS
|
|
||||||
|
## PARAMETERS
|
||||||
### -Type
|
|
||||||
Select between 'Private' or 'Shared'.
|
### -Type
|
||||||
|
Select between 'Private' or 'Shared'.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: 1
|
Required: True
|
||||||
Default value: None
|
Position: 1
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
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).
|
### 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
|
|
||||||
|
## INPUTS
|
||||||
### [None]
|
|
||||||
## OUTPUTS
|
### [None]
|
||||||
|
## OUTPUTS
|
||||||
### [bool]
|
|
||||||
## NOTES
|
### [bool]
|
||||||
|
## NOTES
|
||||||
## RELATED LINKS
|
|
||||||
|
## RELATED LINKS
|
||||||
|
|||||||
@ -1,73 +1,74 @@
|
|||||||
---
|
---
|
||||||
external help file: PSCredentialStore-help.xml
|
external help file: ModuleRoot-help.xml
|
||||||
Module Name: PSCredentialStore
|
Module Name: PSCredentialStore
|
||||||
schema: 2.0.0
|
online version:
|
||||||
---
|
schema: 2.0.0
|
||||||
|
---
|
||||||
# Test-CSConnection
|
|
||||||
|
# Test-CSConnection
|
||||||
## SYNOPSIS
|
|
||||||
Returns the connection state of a given type to the remote host.
|
## SYNOPSIS
|
||||||
|
Returns the connection state of a given type to the remote host.
|
||||||
## SYNTAX
|
|
||||||
|
## SYNTAX
|
||||||
```
|
|
||||||
Test-CSConnection [-RemoteHost] <String> [-Type] <String> [<CommonParameters>]
|
```
|
||||||
```
|
Test-CSConnection [-RemoteHost] <String> [-Type] <String> [<CommonParameters>]
|
||||||
|
```
|
||||||
## DESCRIPTION
|
|
||||||
Use this script to check a connection which was established with the \`Connect-To\` cmdlet.
|
## DESCRIPTION
|
||||||
|
Use this script to check a connection which was established with the \`Connect-To\` cmdlet.
|
||||||
## EXAMPLES
|
|
||||||
|
## EXAMPLES
|
||||||
### EXAMPLE 1
|
|
||||||
```
|
### EXAMPLE 1
|
||||||
Test-CMConnection -RemoteHost "vcr01.internal.net" -Type VMware
|
```
|
||||||
```
|
Test-CMConnection -RemoteHost "vcr01.internal.net" -Type VMware
|
||||||
|
```
|
||||||
## PARAMETERS
|
|
||||||
|
## PARAMETERS
|
||||||
### -RemoteHost
|
|
||||||
Define the remote host you would like to check.
|
### -RemoteHost
|
||||||
|
Define the remote host you would like to check.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: 1
|
Required: True
|
||||||
Default value: None
|
Position: 1
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Type
|
|
||||||
Define the connection type you would like to check.
|
### -Type
|
||||||
See the \`Connect-To\` documentation
|
Define the connection type you would like to check.
|
||||||
for valid type values.
|
See the \`Connect-To\` documentation
|
||||||
|
for valid type values.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: 2
|
Required: True
|
||||||
Default value: None
|
Position: 2
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
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).
|
### 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
|
|
||||||
|
## INPUTS
|
||||||
### [None]
|
|
||||||
## OUTPUTS
|
### [None]
|
||||||
|
## OUTPUTS
|
||||||
### [bool]
|
|
||||||
## NOTES
|
### [bool]
|
||||||
|
## NOTES
|
||||||
## RELATED LINKS
|
|
||||||
|
## RELATED LINKS
|
||||||
|
|||||||
@ -1,80 +1,81 @@
|
|||||||
---
|
---
|
||||||
external help file: PSCredentialStore-help.xml
|
external help file: ModuleRoot-help.xml
|
||||||
Module Name: PSCredentialStore
|
Module Name: PSCredentialStore
|
||||||
schema: 2.0.0
|
online version:
|
||||||
---
|
schema: 2.0.0
|
||||||
|
---
|
||||||
# Test-CredentialStore
|
|
||||||
|
# Test-CredentialStore
|
||||||
## SYNOPSIS
|
|
||||||
Returns the credential store state.
|
## SYNOPSIS
|
||||||
|
Returns the credential store state.
|
||||||
## SYNTAX
|
|
||||||
|
## SYNTAX
|
||||||
### Private (Default)
|
|
||||||
```
|
### Private (Default)
|
||||||
Test-CredentialStore [<CommonParameters>]
|
```
|
||||||
```
|
Test-CredentialStore [<CommonParameters>]
|
||||||
|
```
|
||||||
### Shared
|
|
||||||
```
|
### Shared
|
||||||
Test-CredentialStore [-Path <String>] [-Shared] [<CommonParameters>]
|
```
|
||||||
```
|
Test-CredentialStore [-Path <String>] [-Shared] [<CommonParameters>]
|
||||||
|
```
|
||||||
## DESCRIPTION
|
|
||||||
Use this script to test your credential store.
|
## DESCRIPTION
|
||||||
For now it only checks if
|
Use this script to test your credential store.
|
||||||
the file exists.
|
For now it only checks if
|
||||||
|
the file exists.
|
||||||
## EXAMPLES
|
|
||||||
|
## EXAMPLES
|
||||||
### EXAMPLE 1
|
|
||||||
```
|
### EXAMPLE 1
|
||||||
Test-CredentialStore -eq $true
|
```
|
||||||
```
|
Test-CredentialStore -eq $true
|
||||||
|
```
|
||||||
## PARAMETERS
|
|
||||||
|
## PARAMETERS
|
||||||
### -Path
|
|
||||||
Define a custom path to a shared CredentialStore.
|
### -Path
|
||||||
|
Define a custom path to a shared CredentialStore.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: Shared
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: Shared
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Shared
|
|
||||||
Switch to shared mode with this param.
|
### -Shared
|
||||||
This enforces the command to work with a shared CredentialStore which
|
Switch to shared mode with this param.
|
||||||
can be decrypted across systems.
|
This enforces the command to work with a shared CredentialStore which
|
||||||
|
can be decrypted across systems.
|
||||||
```yaml
|
|
||||||
Type: SwitchParameter
|
```yaml
|
||||||
Parameter Sets: Shared
|
Type: SwitchParameter
|
||||||
Aliases:
|
Parameter Sets: Shared
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: Named
|
Required: True
|
||||||
Default value: False
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: False
|
||||||
Accept wildcard characters: False
|
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).
|
### 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
|
|
||||||
|
## INPUTS
|
||||||
## OUTPUTS
|
|
||||||
|
## OUTPUTS
|
||||||
### System.Boolean
|
|
||||||
## NOTES
|
### System.Boolean
|
||||||
|
## NOTES
|
||||||
## RELATED LINKS
|
|
||||||
|
## RELATED LINKS
|
||||||
|
|||||||
@ -1,121 +1,128 @@
|
|||||||
---
|
---
|
||||||
external help file: PSCredentialStore-help.xml
|
external help file: ModuleRoot-help.xml
|
||||||
Module Name: PSCredentialStore
|
Module Name: PSCredentialStore
|
||||||
schema: 2.0.0
|
online version:
|
||||||
---
|
schema: 2.0.0
|
||||||
|
---
|
||||||
# Test-CredentialStoreItem
|
|
||||||
|
# Test-CredentialStoreItem
|
||||||
## SYNOPSIS
|
|
||||||
Checks if the given RemoteHost identifier combination exists in the credential store.
|
## SYNOPSIS
|
||||||
|
Checks if the given RemoteHost identifier combination exists in the credential store.
|
||||||
## SYNTAX
|
|
||||||
|
## SYNTAX
|
||||||
### Private (Default)
|
|
||||||
```
|
### Private (Default)
|
||||||
Test-CredentialStoreItem -RemoteHost <String> [-Identifier <String>] [<CommonParameters>]
|
```
|
||||||
```
|
Test-CredentialStoreItem -RemoteHost <String> [-Identifier <String>] [<CommonParameters>]
|
||||||
|
```
|
||||||
### Shared
|
|
||||||
```
|
### Shared
|
||||||
Test-CredentialStoreItem [-Path <String>] -RemoteHost <String> [-Identifier <String>] [-Shared]
|
```
|
||||||
[<CommonParameters>]
|
Test-CredentialStoreItem [-Path <String>] -RemoteHost <String> [-Identifier <String>] [-Shared]
|
||||||
```
|
[<CommonParameters>]
|
||||||
|
```
|
||||||
## DESCRIPTION
|
|
||||||
Use this cmdlet for basic checks with a single item.
|
## DESCRIPTION
|
||||||
Check the item first with this function before
|
Use this cmdlet for basic checks with a single item.
|
||||||
you try to interact with it.
|
Check the item first with this function before
|
||||||
|
you try to interact with it.
|
||||||
## EXAMPLES
|
|
||||||
|
> :bulb: Breaking Change for \`v1.1.0+\`:
|
||||||
### EXAMPLE 1
|
>
|
||||||
```
|
> Test-CredentialStoreItem will return \`$false\` even if the store doesn't exist.
|
||||||
if (Test-CredentialStoreItem -RemoteHost "Default") {
|
> We removed the terminating
|
||||||
Get-CredentialStoreItem -RemoteHost "Default"
|
> error and replaced it with a warning message.
|
||||||
}
|
|
||||||
else {
|
## EXAMPLES
|
||||||
Write-Warning ("The given Remote Host {0} does not exist in the credential Store!" -f $RemoteHost)
|
|
||||||
}
|
### EXAMPLE 1
|
||||||
```
|
```
|
||||||
|
if (Test-CredentialStoreItem -RemoteHost "Default") {
|
||||||
## PARAMETERS
|
Get-CredentialStoreItem -RemoteHost "Default"
|
||||||
|
}
|
||||||
### -Identifier
|
else {
|
||||||
Adds an optional identifier to the given RemoteHost.
|
Write-Warning ("The given Remote Host {0} does not exist in the credential Store!" -f $RemoteHost)
|
||||||
Makes it possible to store multiple credentials
|
}
|
||||||
for a single host.
|
```
|
||||||
|
|
||||||
```yaml
|
## PARAMETERS
|
||||||
Type: String
|
|
||||||
Parameter Sets: (All)
|
### -Identifier
|
||||||
Aliases:
|
Adds an optional identifier to the given RemoteHost.
|
||||||
|
Makes it possible to store multiple credentials
|
||||||
Required: False
|
for a single host.
|
||||||
Position: Named
|
|
||||||
Default value: None
|
```yaml
|
||||||
Accept pipeline input: False
|
Type: String
|
||||||
Accept wildcard characters: False
|
Parameter Sets: (All)
|
||||||
```
|
Aliases:
|
||||||
|
|
||||||
### -Path
|
Required: False
|
||||||
Define a custom credential store you try to read from.
|
Position: Named
|
||||||
Without the \`-Path\` parameter
|
Default value: None
|
||||||
\`Test-CredentialStoreItem\` tries to read from the default private store.
|
Accept pipeline input: False
|
||||||
|
Accept wildcard characters: False
|
||||||
```yaml
|
```
|
||||||
Type: String
|
|
||||||
Parameter Sets: Shared
|
### -Path
|
||||||
Aliases:
|
Define a custom credential store you try to read from.
|
||||||
|
Without the \`-Path\` parameter
|
||||||
Required: False
|
\`Test-CredentialStoreItem\` tries to read from the default private store.
|
||||||
Position: Named
|
|
||||||
Default value: "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData
|
```yaml
|
||||||
Accept pipeline input: False
|
Type: String
|
||||||
Accept wildcard characters: False
|
Parameter Sets: Shared
|
||||||
```
|
Aliases:
|
||||||
|
|
||||||
### -RemoteHost
|
Required: False
|
||||||
Specify the host, for which you would like to change the credentials.
|
Position: Named
|
||||||
|
Default value: "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData
|
||||||
```yaml
|
Accept pipeline input: False
|
||||||
Type: String
|
Accept wildcard characters: False
|
||||||
Parameter Sets: (All)
|
```
|
||||||
Aliases:
|
|
||||||
|
### -RemoteHost
|
||||||
Required: True
|
Specify the host, for which you would like to change the credentials.
|
||||||
Position: Named
|
|
||||||
Default value: None
|
```yaml
|
||||||
Accept pipeline input: False
|
Type: String
|
||||||
Accept wildcard characters: False
|
Parameter Sets: (All)
|
||||||
```
|
Aliases:
|
||||||
|
|
||||||
### -Shared
|
Required: True
|
||||||
Switch to shared mode with this param.
|
Position: Named
|
||||||
This enforces the command to work with a shared CredentialStore which
|
Default value: None
|
||||||
can be decrypted across systems.
|
Accept pipeline input: False
|
||||||
|
Accept wildcard characters: False
|
||||||
```yaml
|
```
|
||||||
Type: SwitchParameter
|
|
||||||
Parameter Sets: Shared
|
### -Shared
|
||||||
Aliases:
|
Switch to shared mode with this param.
|
||||||
|
This enforces the command to work with a shared CredentialStore which
|
||||||
Required: False
|
can be decrypted across systems.
|
||||||
Position: Named
|
|
||||||
Default value: False
|
```yaml
|
||||||
Accept pipeline input: False
|
Type: SwitchParameter
|
||||||
Accept wildcard characters: False
|
Parameter Sets: Shared
|
||||||
```
|
Aliases:
|
||||||
|
|
||||||
### CommonParameters
|
Required: False
|
||||||
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).
|
Position: Named
|
||||||
|
Default value: False
|
||||||
## INPUTS
|
Accept pipeline input: False
|
||||||
|
Accept wildcard characters: False
|
||||||
### [None]
|
```
|
||||||
## OUTPUTS
|
|
||||||
|
### CommonParameters
|
||||||
### [None]
|
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).
|
||||||
## NOTES
|
|
||||||
|
## INPUTS
|
||||||
## RELATED LINKS
|
|
||||||
|
### [None]
|
||||||
|
## OUTPUTS
|
||||||
|
|
||||||
|
### [None]
|
||||||
|
## NOTES
|
||||||
|
|
||||||
|
## RELATED LINKS
|
||||||
|
|||||||
@ -1,107 +1,108 @@
|
|||||||
---
|
---
|
||||||
external help file: PSCredentialStore-help.xml
|
external help file: ModuleRoot-help.xml
|
||||||
Module Name: PSCredentialStore
|
Module Name: PSCredentialStore
|
||||||
schema: 2.0.0
|
online version:
|
||||||
---
|
schema: 2.0.0
|
||||||
|
---
|
||||||
# Use-CSCertificate
|
|
||||||
|
# Use-CSCertificate
|
||||||
## SYNOPSIS
|
|
||||||
Links an existing PFX Certificate to a CredentialStore.
|
## SYNOPSIS
|
||||||
|
Links an existing PFX Certificate to a CredentialStore.
|
||||||
## SYNTAX
|
|
||||||
|
## SYNTAX
|
||||||
### Private (Default)
|
|
||||||
```
|
### Private (Default)
|
||||||
Use-CSCertificate -Path <String> [-UseCertStore] [<CommonParameters>]
|
```
|
||||||
```
|
Use-CSCertificate -Path <String> [-UseCertStore] [<CommonParameters>]
|
||||||
|
```
|
||||||
### Shared
|
|
||||||
```
|
### Shared
|
||||||
Use-CSCertificate -Path <String> [-CredentialStore <String>] [-Shared] [-UseCertStore] [<CommonParameters>]
|
```
|
||||||
```
|
Use-CSCertificate -Path <String> [-CredentialStore <String>] [-Shared] [-UseCertStore] [<CommonParameters>]
|
||||||
|
```
|
||||||
## DESCRIPTION
|
|
||||||
Linking a certificate is needed if you plan to use the same CredentialStore in cross platform scenarios.
|
## DESCRIPTION
|
||||||
|
Linking a certificate is needed if you plan to use the same CredentialStore in cross platform scenarios.
|
||||||
## EXAMPLES
|
|
||||||
|
## EXAMPLES
|
||||||
### EXAMPLE 1
|
|
||||||
```
|
### EXAMPLE 1
|
||||||
Use-CSCertificate -Path 'C:\cert.pfx'
|
```
|
||||||
```
|
Use-CSCertificate -Path 'C:\cert.pfx'
|
||||||
|
```
|
||||||
## PARAMETERS
|
|
||||||
|
## PARAMETERS
|
||||||
### -CredentialStore
|
|
||||||
Specify a custom path for a shared credential store.
|
### -CredentialStore
|
||||||
|
Specify a custom path for a shared credential store.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: Shared
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: Shared
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Path
|
|
||||||
Specify the path to the PFX Certificate you want to link for usage.
|
### -Path
|
||||||
|
Specify the path to the PFX Certificate you want to link for usage.
|
||||||
```yaml
|
|
||||||
Type: String
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: String
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: Named
|
Required: True
|
||||||
Default value: None
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: None
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -Shared
|
|
||||||
Use the credential store in shared mode.
|
### -Shared
|
||||||
|
Use the credential store in shared mode.
|
||||||
```yaml
|
|
||||||
Type: SwitchParameter
|
```yaml
|
||||||
Parameter Sets: Shared
|
Type: SwitchParameter
|
||||||
Aliases:
|
Parameter Sets: Shared
|
||||||
|
Aliases:
|
||||||
Required: True
|
|
||||||
Position: Named
|
Required: True
|
||||||
Default value: False
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: False
|
||||||
Accept wildcard characters: False
|
Accept pipeline input: False
|
||||||
```
|
Accept wildcard characters: False
|
||||||
|
```
|
||||||
### -UseCertStore
|
|
||||||
Use the given certificate and import it into the corresponding certificate store.
|
### -UseCertStore
|
||||||
|
Use the given certificate and import it into the corresponding certificate store.
|
||||||
```yaml
|
|
||||||
Type: SwitchParameter
|
```yaml
|
||||||
Parameter Sets: (All)
|
Type: SwitchParameter
|
||||||
Aliases:
|
Parameter Sets: (All)
|
||||||
|
Aliases:
|
||||||
Required: False
|
|
||||||
Position: Named
|
Required: False
|
||||||
Default value: False
|
Position: Named
|
||||||
Accept pipeline input: False
|
Default value: False
|
||||||
Accept wildcard characters: False
|
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).
|
### 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
|
|
||||||
|
## INPUTS
|
||||||
### [None]
|
|
||||||
## OUTPUTS
|
### [None]
|
||||||
|
## OUTPUTS
|
||||||
### [None]
|
|
||||||
## NOTES
|
### [None]
|
||||||
|
## NOTES
|
||||||
## RELATED LINKS
|
|
||||||
|
## RELATED LINKS
|
||||||
|
|||||||
@ -7,6 +7,10 @@ function Test-CredentialStoreItem {
|
|||||||
Use this cmdlet for basic checks with a single item. Check the item first with this function before
|
Use this cmdlet for basic checks with a single item. Check the item first with this function before
|
||||||
you try to interact with it.
|
you try to interact with it.
|
||||||
|
|
||||||
|
Breaking Change for `v1.1.0+`:
|
||||||
|
Test-CredentialStoreItem will return `$false` even if the store doesn't exist. We removed the terminating
|
||||||
|
error and replaced it with a warning message.
|
||||||
|
|
||||||
.PARAMETER Path
|
.PARAMETER Path
|
||||||
Define a custom credential store you try to read from. Without the `-Path` parameter
|
Define a custom credential store you try to read from. Without the `-Path` parameter
|
||||||
`Test-CredentialStoreItem` tries to read from the default private store.
|
`Test-CredentialStoreItem` tries to read from the default private store.
|
||||||
@ -88,10 +92,10 @@ function Test-CredentialStoreItem {
|
|||||||
}
|
}
|
||||||
else {
|
else {
|
||||||
$MsgParams = @{
|
$MsgParams = @{
|
||||||
ErrorAction = 'Stop'
|
Message = "The given credential store ({0}) does not exist!" -f $Path
|
||||||
Message = "The given credential store ({0}) does not exist!" -f $Path
|
|
||||||
}
|
}
|
||||||
Write-Error @MsgParams
|
Write-Warning @MsgParams
|
||||||
|
return $false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user