Marco Blessing
b76668c1e7
All checks were successful
continuous-integration/drone/push Build is passing
#### 📖 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: #66
75 lines
1.4 KiB
Markdown
75 lines
1.4 KiB
Markdown
---
|
|
external help file: ModuleRoot-help.xml
|
|
Module Name: PSCredentialStore
|
|
online version:
|
|
schema: 2.0.0
|
|
---
|
|
|
|
# Test-CSConnection
|
|
|
|
## SYNOPSIS
|
|
Returns the connection state of a given type to the remote host.
|
|
|
|
## SYNTAX
|
|
|
|
```
|
|
Test-CSConnection [-RemoteHost] <String> [-Type] <String> [<CommonParameters>]
|
|
```
|
|
|
|
## DESCRIPTION
|
|
Use this script to check a connection which was established with the \`Connect-To\` cmdlet.
|
|
|
|
## EXAMPLES
|
|
|
|
### EXAMPLE 1
|
|
```
|
|
Test-CMConnection -RemoteHost "vcr01.internal.net" -Type VMware
|
|
```
|
|
|
|
## PARAMETERS
|
|
|
|
### -RemoteHost
|
|
Define the remote host you would like to check.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: True
|
|
Position: 1
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -Type
|
|
Define the connection type you would like to check.
|
|
See the \`Connect-To\` documentation
|
|
for valid type values.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: True
|
|
Position: 2
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### CommonParameters
|
|
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
|
|
|
|
## INPUTS
|
|
|
|
### [None]
|
|
## OUTPUTS
|
|
|
|
### [bool]
|
|
## NOTES
|
|
|
|
## RELATED LINKS
|