Skip to content
This repository was archived by the owner on Jul 6, 2022. It is now read-only.

Commit dbe5319

Browse files
OCram85OCram85
authored
Adds markdown help pages in docs folder
* adds docs folder (#5) * fist module description * adds cmdlet markdown help * adds meta pages
1 parent acfc97a commit dbe5319

14 files changed

+1374
-1
lines changed

‎docs/.gitkeep‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This is a placeholder file.

‎docs/Connect-To.md‎

Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
---
2+
external help file: PSCredentialStore-help.xml
3+
Module Name: PSCredentialStore
4+
online version: https://github.com/OCram85/PSCredentialStore
5+
schema: 2.0.0
6+
---
7+
8+
# Connect-To
9+
10+
## SYNOPSIS
11+
Connects to the given host using the stored CredentialStoreItem.
12+
13+
## SYNTAX
14+
15+
### Private (Default)
16+
```
17+
Connect-To -RemoteHost <String> [-Identifier <String>] -Type <String> [-Credentials <PSCredential>]
18+
[<CommonParameters>]
19+
```
20+
21+
### Shared
22+
```
23+
Connect-To -RemoteHost <String> [-Identifier <String>] -Type <String> [-Credentials <PSCredential>]
24+
[-Path <String>] [-Shared] [<CommonParameters>]
25+
```
26+
27+
## DESCRIPTION
28+
Establish a connection to the selected host using a stored CredentialStoreItem.
29+
30+
## EXAMPLES
31+
32+
### -------------------------- EXAMPLE 1 --------------------------
33+
```
34+
Connect-To -RemoteHost "ucs.myside.local" -Type CiscoUcs
35+
```
36+
37+
Connect-To -RemoteHost "ftp.myside.local" -Type FTP
38+
Connect-To -RemoteHost "fas.myside.local" -Type NetAppFAS
39+
Connect-To -RemoteHost "esx01.myside.local" -Type VMware
40+
41+
### -------------------------- EXAMPLE 2 --------------------------
42+
```
43+
$MyCreds = Get-Credential
44+
```
45+
46+
Connect-To -RemoteHost "vcr01.myside.local" -Type VMware -Credentials $MyCreds
47+
Get-VM -Name "*vlm*" | Select-Object -Property Name
48+
Disconnect-From -RemoteHost "vcr01.myside.local" -Type VMware
49+
50+
## PARAMETERS
51+
52+
### -RemoteHost
53+
Specify the host, for which you would like to change the credentials.
54+
55+
```yaml
56+
Type: String
57+
Parameter Sets: (All)
58+
Aliases:
59+
60+
Required: True
61+
Position: Named
62+
Default value: None
63+
Accept pipeline input: False
64+
Accept wildcard characters: False
65+
```
66+
67+
### -Identifier
68+
Defaults to "".
69+
Specify a string, which separates two CredentialStoreItems for the
70+
same hostname.
71+
72+
```yaml
73+
Type: String
74+
Parameter Sets: (All)
75+
Aliases:
76+
77+
Required: False
78+
Position: Named
79+
Default value: None
80+
Accept pipeline input: False
81+
Accept wildcard characters: False
82+
```
83+
84+
### -Type
85+
Specify the host type of the target.
86+
Currently implemented targets are:
87+
- CiscoUcs Establish a connection to a Cisco UCS fabric interconnect.
88+
- FTP Establish a connection to a FTP host.
89+
- NetAppFAS Establish a connection to a NetApp Clustered ONTAP filer.
90+
- VMware Establish a connection to a VMware vCenter or ESXi host.
91+
92+
```yaml
93+
Type: String
94+
Parameter Sets: (All)
95+
Aliases:
96+
97+
Required: True
98+
Position: Named
99+
Default value: None
100+
Accept pipeline input: False
101+
Accept wildcard characters: False
102+
```
103+
104+
### -Credentials
105+
Use this parameter to bypass the stored credentials.
106+
Without this parameter Connect-To tries to read the
107+
needed credentials from the CredentialStore.
108+
If you provide this parameter you skip this lookup behavior.
109+
So you can use it to enable credentials without preparing any user interaction.
110+
111+
```yaml
112+
Type: PSCredential
113+
Parameter Sets: (All)
114+
Aliases:
115+
116+
Required: False
117+
Position: Named
118+
Default value: None
119+
Accept pipeline input: False
120+
Accept wildcard characters: False
121+
```
122+
123+
### -Path
124+
Define a custom path to a shared CredentialStore.
125+
126+
```yaml
127+
Type: String
128+
Parameter Sets: Shared
129+
Aliases:
130+
131+
Required: False
132+
Position: Named
133+
Default value: "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData
134+
Accept pipeline input: False
135+
Accept wildcard characters: False
136+
```
137+
138+
### -Shared
139+
Switch to shared mode with this param.
140+
This enforces the command to work with a shared CredentialStore which
141+
can be decrypted across systems.
142+
143+
```yaml
144+
Type: SwitchParameter
145+
Parameter Sets: Shared
146+
Aliases:
147+
148+
Required: False
149+
Position: Named
150+
Default value: False
151+
Accept pipeline input: False
152+
Accept wildcard characters: False
153+
```
154+
155+
### CommonParameters
156+
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).
157+
158+
## INPUTS
159+
160+
### [None]
161+
162+
## OUTPUTS
163+
164+
### [None]
165+
166+
## NOTES
167+
File Name : Connect-To.ps1
168+
Author : Marco Blessing - marco.blessing@googlemail.com
169+
Requires : PSFTP, PowerCLI
170+
171+
## RELATED LINKS
172+
173+
[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore)
174+

‎docs/Disconnect-From.md‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
---
2+
external help file: PSCredentialStore-help.xml
3+
Module Name: PSCredentialStore
4+
online version: https://github.com/OCram85/PSCredentialStore
5+
schema: 2.0.0
6+
---
7+
8+
# Disconnect-From
9+
10+
## SYNOPSIS
11+
Terminates a session established with Connect-To using a CredentialStoreItem.
12+
13+
## SYNTAX
14+
15+
```
16+
Disconnect-From [-RemoteHost] <String> [-Type] <String> [-Force] [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
Terminates a session established with Connect-To using a CredentialStoreItem.
21+
22+
## EXAMPLES
23+
24+
### -------------------------- EXAMPLE 1 --------------------------
25+
```
26+
Disconnect-From -RemoteHost "ucs.myside.local" -Type CiscoUcs
27+
```
28+
29+
### -------------------------- EXAMPLE 2 --------------------------
30+
```
31+
Disconnect-From -RemoteHost "ftp.myside.local" -Type FTP
32+
```
33+
34+
### -------------------------- EXAMPLE 3 --------------------------
35+
```
36+
Disconnect-From -RemoteHost "fas.myside.local" -Type NetAppFAS
37+
```
38+
39+
### -------------------------- EXAMPLE 4 --------------------------
40+
```
41+
Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware
42+
```
43+
44+
### -------------------------- EXAMPLE 5 --------------------------
45+
```
46+
Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware -Force:$True
47+
```
48+
49+
## PARAMETERS
50+
51+
### -RemoteHost
52+
Specify the remote endpoint, whose session you would like to terminate.
53+
54+
```yaml
55+
Type: String
56+
Parameter Sets: (All)
57+
Aliases:
58+
59+
Required: True
60+
Position: 1
61+
Default value: None
62+
Accept pipeline input: False
63+
Accept wildcard characters: False
64+
```
65+
66+
### -Type
67+
Specify the host type of the target.
68+
Currently implemented targets are:
69+
- CiscoUcs Establish a connection to a Cisco UCS Fabric Interconnect.
70+
- FTP Establish a connection to a FTP host.
71+
- NetAppFAS Establish a connection to a NetApp Clustered ONTAP filer.
72+
- VMware Establish a connection to a VMware vCenter or ESXi host.
73+
74+
```yaml
75+
Type: String
76+
Parameter Sets: (All)
77+
Aliases:
78+
79+
Required: True
80+
Position: 2
81+
Default value: None
82+
Accept pipeline input: False
83+
Accept wildcard characters: False
84+
```
85+
86+
### -Force
87+
Force the disconnect, even if the disconnect would fail.
88+
89+
```yaml
90+
Type: SwitchParameter
91+
Parameter Sets: (All)
92+
Aliases:
93+
94+
Required: False
95+
Position: Named
96+
Default value: False
97+
Accept pipeline input: False
98+
Accept wildcard characters: False
99+
```
100+
101+
### CommonParameters
102+
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).
103+
104+
## INPUTS
105+
106+
### [None]
107+
108+
## OUTPUTS
109+
110+
### [None]
111+
112+
## NOTES
113+
File Name : Disconnect-To.ps1
114+
Author : Marco Blessing - marco.blessing@googlemail.com
115+
Requires :
116+
117+
## RELATED LINKS
118+
119+
[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore)
120+

‎docs/Get-CredentialStore.md‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
external help file: PSCredentialStore-help.xml
3+
Module Name: PSCredentialStore
4+
online version: https://github.com/OCram85/PSCredentialStore
5+
schema: 2.0.0
6+
---
7+
8+
# Get-CredentialStore
9+
10+
## SYNOPSIS
11+
Reads the complete content of the credential store and returns it as a new object.
12+
13+
## SYNTAX
14+
15+
### Private (Default)
16+
```
17+
Get-CredentialStore [<CommonParameters>]
18+
```
19+
20+
### Shared
21+
```
22+
Get-CredentialStore [-Path <String>] [-Shared] [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
The content is in a raw format.
27+
It means there is no transformation to the different credential types.
28+
You can not use the object properties to connect with remote host.
29+
Therefore please use
30+
Get-CredentialStoreItem.
31+
32+
## EXAMPLES
33+
34+
### -------------------------- EXAMPLE 1 --------------------------
35+
```
36+
$CSContent = Get-CredentialStore -Path "C:\TMP\mystore.json"
37+
```
38+
39+
## PARAMETERS
40+
41+
### -Path
42+
Define a custom path to a shared CredentialStore.
43+
44+
```yaml
45+
Type: String
46+
Parameter Sets: Shared
47+
Aliases:
48+
49+
Required: False
50+
Position: Named
51+
Default value: "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData
52+
Accept pipeline input: False
53+
Accept wildcard characters: False
54+
```
55+
56+
### -Shared
57+
Switch to shared mode with this param.
58+
This enforces the command to work with a shared CredentialStore which
59+
can be decrypted across systems.
60+
61+
```yaml
62+
Type: SwitchParameter
63+
Parameter Sets: Shared
64+
Aliases:
65+
66+
Required: False
67+
Position: Named
68+
Default value: False
69+
Accept pipeline input: False
70+
Accept wildcard characters: False
71+
```
72+
73+
### CommonParameters
74+
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).
75+
76+
## INPUTS
77+
78+
### [None]
79+
80+
## OUTPUTS
81+
82+
### [PSObject] Returns the credential store content as PSObject.
83+
84+
## NOTES
85+
File Name : Get-CredentialStore.ps1
86+
Author : Marco Blessing - marco.blessing@googlemail.com
87+
Requires :
88+
89+
## RELATED LINKS
90+
91+
[https://github.com/OCram85/PSCredentialStore](https://github.com/OCram85/PSCredentialStore)
92+

0 commit comments

Comments
 (0)