PSCredentialStore/docs
Marco Blessing b76668c1e7 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
2022-07-19 11:46:21 +02:00
..
.gitkeep Adds markdown help pages in docs folder 2017-09-28 11:08:41 +02:00
about_PSCredentialStore.md update references (#60) 2022-07-13 08:34:31 +02:00
Connect-To.md fix Test-CredentialStoreItem return (#66) 2022-07-19 11:46:21 +02:00
Disconnect-From.md fix Test-CredentialStoreItem return (#66) 2022-07-19 11:46:21 +02:00
Get-CredentialStore.md fix Test-CredentialStoreItem return (#66) 2022-07-19 11:46:21 +02:00
Get-CredentialStoreItem.md fix Test-CredentialStoreItem return (#66) 2022-07-19 11:46:21 +02:00
Get-CSCertificate.md fix Test-CredentialStoreItem return (#66) 2022-07-19 11:46:21 +02:00
Import-CSCertificate.md fix Test-CredentialStoreItem return (#66) 2022-07-19 11:46:21 +02:00
New-CredentialStore.md fix Test-CredentialStoreItem return (#66) 2022-07-19 11:46:21 +02:00
New-CredentialStoreItem.md fix Test-CredentialStoreItem return (#66) 2022-07-19 11:46:21 +02:00
New-CSCertAttribute.md fix Test-CredentialStoreItem return (#66) 2022-07-19 11:46:21 +02:00
New-CSCertificate.md fix Test-CredentialStoreItem return (#66) 2022-07-19 11:46:21 +02:00
Readme.md fix Test-CredentialStoreItem return (#66) 2022-07-19 11:46:21 +02:00
Remove-CredentialStoreItem.md fix Test-CredentialStoreItem return (#66) 2022-07-19 11:46:21 +02:00
Set-CredentialStoreItem.md fix Test-CredentialStoreItem return (#66) 2022-07-19 11:46:21 +02:00
Test-CredentialStore.md fix Test-CredentialStoreItem return (#66) 2022-07-19 11:46:21 +02:00
Test-CredentialStoreItem.md fix Test-CredentialStoreItem return (#66) 2022-07-19 11:46:21 +02:00
Test-CSCertificate.md fix Test-CredentialStoreItem return (#66) 2022-07-19 11:46:21 +02:00
Test-CSConnection.md fix Test-CredentialStoreItem return (#66) 2022-07-19 11:46:21 +02:00
Use-CSCertificate.md fix Test-CredentialStoreItem return (#66) 2022-07-19 11:46:21 +02:00

Module Name Module Guid Download Help Link Help Version Locale
PSCredentialStore 6800e192-9df8-4e30-b253-eb2c799bbe84
Update Download Link
Update Help Version
en-US

PSCredentialStore Module

Description

See global Readme file for usage instructions.

PSCredentialStore Cmdlets

Connect-To

Connects to the given host using the stored CredentialStoreItem.

Disconnect-From

Terminates a session established with Connect-To using a CredentialStoreItem.

Get-CredentialStore

Reads the complete content of the credential store and returns it as a new object.

Get-CredentialStoreItem

Returns the Credential from a given remote host item.

Get-CSCertificate

Returns the current used valid PfX certificate.

Import-CSCertificate

Imports a linked certificate to the valid store location.

New-CredentialStore

Creates a new credential store File

New-CredentialStoreItem

Adds a credential store item containing host, user and password to the given store.

New-CSCertAttribute

Creates required data for a certificate signing request.

New-CSCertificate

Creates a new PFX certificate for the CredentialStore encryption.

Remove-CredentialStoreItem

Remove the given credentials from the credential store.

Set-CredentialStoreItem

Changes the credentials for the given remote host in the store.

Test-CredentialStore

Returns the credential store state.

Test-CredentialStoreItem

Checks if the given RemoteHost identifier combination exists in the credential store.

Test-CSCertificate

Tests if the linked certificate is store ein the specified cert stores.

Test-CSConnection

Returns the connection state of a given type to the remote host.

Use-CSCertificate

Links an existing PFX Certificate to a CredentialStore.