This repository has been archived by the owner on Jul 6, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds markdown help pages in docs folder
* adds docs folder (#5) * fist module description * adds cmdlet markdown help * adds meta pages
- Loading branch information
Showing
14 changed files
with
1,374 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
This is a placeholder file. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,174 @@ | ||
--- | ||
external help file: PSCredentialStore-help.xml | ||
Module Name: PSCredentialStore | ||
online version: https://github.com/OCram85/PSCredentialStore | ||
schema: 2.0.0 | ||
--- | ||
|
||
# Connect-To | ||
|
||
## SYNOPSIS | ||
Connects to the given host using the stored CredentialStoreItem. | ||
|
||
## SYNTAX | ||
|
||
### Private (Default) | ||
``` | ||
Connect-To -RemoteHost <String> [-Identifier <String>] -Type <String> [-Credentials <PSCredential>] | ||
[<CommonParameters>] | ||
``` | ||
|
||
### Shared | ||
``` | ||
Connect-To -RemoteHost <String> [-Identifier <String>] -Type <String> [-Credentials <PSCredential>] | ||
[-Path <String>] [-Shared] [<CommonParameters>] | ||
``` | ||
|
||
## DESCRIPTION | ||
Establish a connection to the selected host using a stored CredentialStoreItem. | ||
|
||
## EXAMPLES | ||
|
||
### -------------------------- EXAMPLE 1 -------------------------- | ||
``` | ||
Connect-To -RemoteHost "ucs.myside.local" -Type CiscoUcs | ||
``` | ||
|
||
Connect-To -RemoteHost "ftp.myside.local" -Type FTP | ||
Connect-To -RemoteHost "fas.myside.local" -Type NetAppFAS | ||
Connect-To -RemoteHost "esx01.myside.local" -Type VMware | ||
|
||
### -------------------------- EXAMPLE 2 -------------------------- | ||
``` | ||
$MyCreds = Get-Credential | ||
``` | ||
|
||
Connect-To -RemoteHost "vcr01.myside.local" -Type VMware -Credentials $MyCreds | ||
Get-VM -Name "*vlm*" | Select-Object -Property Name | ||
Disconnect-From -RemoteHost "vcr01.myside.local" -Type VMware | ||
|
||
## PARAMETERS | ||
|
||
### -RemoteHost | ||
Specify the host, for which you would like to change the credentials. | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: True | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -Identifier | ||
Defaults to "". | ||
Specify a string, which separates two CredentialStoreItems for the | ||
same hostname. | ||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -Type | ||
Specify the host type of the target. | ||
Currently implemented targets are: | ||
- CiscoUcs Establish a connection to a Cisco UCS fabric interconnect. | ||
- FTP Establish a connection to a FTP host. | ||
- NetAppFAS Establish a connection to a NetApp Clustered ONTAP filer. | ||
- VMware Establish a connection to a VMware vCenter or ESXi host. | ||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: True | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -Credentials | ||
Use this parameter to bypass the stored credentials. | ||
Without this parameter Connect-To tries to read the | ||
needed credentials from the CredentialStore. | ||
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 | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -Path | ||
Define a custom path to a shared CredentialStore. | ||
```yaml | ||
Type: String | ||
Parameter Sets: Shared | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -Shared | ||
Switch to shared mode with this param. | ||
This enforces the command to work with a shared CredentialStore which | ||
can be decrypted across systems. | ||
```yaml | ||
Type: SwitchParameter | ||
Parameter Sets: Shared | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: 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). | ||
## INPUTS | ||
### [None] | ||
## OUTPUTS | ||
### [None] | ||
## NOTES | ||
File Name : Connect-To.ps1 | ||
Author : Marco Blessing - [email protected] | ||
Requires : PSFTP, PowerCLI | ||
## RELATED LINKS | ||
[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,120 @@ | ||
--- | ||
external help file: PSCredentialStore-help.xml | ||
Module Name: PSCredentialStore | ||
online version: https://github.com/OCram85/PSCredentialStore | ||
schema: 2.0.0 | ||
--- | ||
|
||
# Disconnect-From | ||
|
||
## SYNOPSIS | ||
Terminates a session established with Connect-To using a CredentialStoreItem. | ||
|
||
## SYNTAX | ||
|
||
``` | ||
Disconnect-From [-RemoteHost] <String> [-Type] <String> [-Force] [<CommonParameters>] | ||
``` | ||
|
||
## DESCRIPTION | ||
Terminates a session established with Connect-To using a CredentialStoreItem. | ||
|
||
## EXAMPLES | ||
|
||
### -------------------------- EXAMPLE 1 -------------------------- | ||
``` | ||
Disconnect-From -RemoteHost "ucs.myside.local" -Type CiscoUcs | ||
``` | ||
|
||
### -------------------------- EXAMPLE 2 -------------------------- | ||
``` | ||
Disconnect-From -RemoteHost "ftp.myside.local" -Type FTP | ||
``` | ||
|
||
### -------------------------- EXAMPLE 3 -------------------------- | ||
``` | ||
Disconnect-From -RemoteHost "fas.myside.local" -Type NetAppFAS | ||
``` | ||
|
||
### -------------------------- EXAMPLE 4 -------------------------- | ||
``` | ||
Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware | ||
``` | ||
|
||
### -------------------------- EXAMPLE 5 -------------------------- | ||
``` | ||
Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware -Force:$True | ||
``` | ||
|
||
## PARAMETERS | ||
|
||
### -RemoteHost | ||
Specify the remote endpoint, whose session you would like to terminate. | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: True | ||
Position: 1 | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -Type | ||
Specify the host type of the target. | ||
Currently implemented targets are: | ||
- CiscoUcs Establish a connection to a Cisco UCS Fabric Interconnect. | ||
- FTP Establish a connection to a FTP host. | ||
- NetAppFAS Establish a connection to a NetApp Clustered ONTAP filer. | ||
- VMware Establish a connection to a VMware vCenter or ESXi host. | ||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: True | ||
Position: 2 | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -Force | ||
Force the disconnect, even if the disconnect would fail. | ||
```yaml | ||
Type: SwitchParameter | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: 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). | ||
## INPUTS | ||
### [None] | ||
## OUTPUTS | ||
### [None] | ||
## NOTES | ||
File Name : Disconnect-To.ps1 | ||
Author : Marco Blessing - [email protected] | ||
Requires : | ||
## RELATED LINKS | ||
[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
--- | ||
external help file: PSCredentialStore-help.xml | ||
Module Name: PSCredentialStore | ||
online version: https://github.com/OCram85/PSCredentialStore | ||
schema: 2.0.0 | ||
--- | ||
|
||
# Get-CredentialStore | ||
|
||
## SYNOPSIS | ||
Reads the complete content of the credential store and returns it as a new object. | ||
|
||
## SYNTAX | ||
|
||
### Private (Default) | ||
``` | ||
Get-CredentialStore [<CommonParameters>] | ||
``` | ||
|
||
### Shared | ||
``` | ||
Get-CredentialStore [-Path <String>] [-Shared] [<CommonParameters>] | ||
``` | ||
|
||
## DESCRIPTION | ||
The content is in a raw format. | ||
It means there is no transformation to the different credential types. | ||
You can not use the object properties to connect with remote host. | ||
Therefore please use | ||
Get-CredentialStoreItem. | ||
|
||
## EXAMPLES | ||
|
||
### -------------------------- EXAMPLE 1 -------------------------- | ||
``` | ||
$CSContent = Get-CredentialStore -Path "C:\TMP\mystore.json" | ||
``` | ||
|
||
## PARAMETERS | ||
|
||
### -Path | ||
Define a custom path to a shared CredentialStore. | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: Shared | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -Shared | ||
Switch to shared mode with this param. | ||
This enforces the command to work with a shared CredentialStore which | ||
can be decrypted across systems. | ||
```yaml | ||
Type: SwitchParameter | ||
Parameter Sets: Shared | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: 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). | ||
## INPUTS | ||
### [None] | ||
## OUTPUTS | ||
### [PSObject] Returns the credential store content as PSObject. | ||
## NOTES | ||
File Name : Get-CredentialStore.ps1 | ||
Author : Marco Blessing - [email protected] | ||
Requires : | ||
## RELATED LINKS | ||
[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore) | ||
Oops, something went wrong.