Skip to content

Commit

Permalink
Updated Docs
Browse files Browse the repository at this point in the history 
Updated docs using platyps
  • Loading branch information
@darkoperator
darkoperator committed Aug 8, 2021
1 parent f72daf9 commit df64db4
Show file tree
Hide file tree
Showing 11 changed files with 237 additions and 182 deletions.
4 changes: 2 additions & 2 deletions Invoke-DocumentationBuild.ps1
View file
Expand Up @@ -8,9 +8,9 @@ else {
}

Write-Host "Turning markdown documents to External Help files" -ForegroundColor green
New-ExternalHelp .\docs -OutputPath .\Release\en-US -Force -verbose
New-ExternalHelp .\docs -OutputPath .\Posh-SSH\en-US -Force -verbose
Write-Host "Updates markdown files" -ForegroundColor Green
Write-Host "Importing release version of module." -ForegroundColor Green
Import-Module .\Release\Posh-SSH.psd1 -verbose -Force
Import-Module .\Posh-SSH\Posh-SSH.psd1 -verbose -Force
Write-Host "Updating Markdown" -ForegroundColor Green
New-MarkdownHelp -Module Posh-ssh -Force -OutputFolder .\docs
81 changes: 46 additions & 35 deletions Posh-SSH/en-US/Posh-SSH-help.xml
View file
Expand Up @@ -178,19 +178,19 @@
<command:verb>Get</command:verb>
<command:noun>SSHTrustedHost</command:noun>
<maml:description>
<maml:para>{{ Fill in the Synopsis }}</maml:para>
<maml:para>Get the current known hosts either from those trusted by Posh-SSH or from a IStore.</maml:para>
</maml:description>
</command:details>
<maml:description>
<maml:para>{{ Fill in the Description }}</maml:para>
<maml:para>Get the current known hosts either from those trusted by Posh-SSH, also from a Known Host IStore either from New-SSHMemoryKnownHost, Get-SSHJsonKnownHost or Get-SSHOpenSSHKnownHost.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-SSHTrustedHost</maml:name>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">
<maml:name>KnowHostStore</maml:name>
<maml:description>
<maml:para>{{ Fill KnowHostStore Description }}</maml:para>
<maml:para>Known Host IStore either from New-SSHMemoryKnownHost, Get-SSHJsonKnownHost or Get-SSHOpenSSHKnownHost.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
<dev:type>
Expand All @@ -202,7 +202,7 @@
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
<maml:name>HostName</maml:name>
<maml:description>
<maml:para>{{ Fill HostName Description }}</maml:para>
<maml:para>HostName as stored by Posh-SSH or in a IStore.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
Expand All @@ -217,7 +217,7 @@
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
<maml:name>HostName</maml:name>
<maml:description>
<maml:para>{{ Fill HostName Description }}</maml:para>
<maml:para>HostName as stored by Posh-SSH or in a IStore.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
Expand All @@ -229,7 +229,7 @@
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">
<maml:name>KnowHostStore</maml:name>
<maml:description>
<maml:para>{{ Fill KnowHostStore Description }}</maml:para>
<maml:para>Known Host IStore either from New-SSHMemoryKnownHost, Get-SSHJsonKnownHost or Get-SSHOpenSSHKnownHost.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
<dev:type>
Expand Down Expand Up @@ -267,9 +267,27 @@
<command:examples>
<command:example>
<maml:title>-------------------------- Example 1 --------------------------</maml:title>
<dev:code>PS C:\&gt; {{ Add example code here }}</dev:code>
<dev:code>PS C:\&gt; Get-SSHTrustedHost

HostName HostKeyName Fingerprint
-------- ----------- -----------
192.168.1.165 ssh-ed25519 7a:da:ab:88:55:95:5b:34:89:f6:46:7f:13:c5:65:c1</dev:code>
<dev:remarks>
<maml:para>{{ Add example description here }}</maml:para>
<maml:para>Get currently stored known hosts.</maml:para>
</dev:remarks>
</command:example>
<command:example>
<maml:title>-------------------------- Example 2 --------------------------</maml:title>
<dev:code>PS C:\&gt; $inmem = New-SSHMemoryKnownHost
PS C:\&gt; $inmem.SetKey("192.168.1.1","Router","12:f8:7e:78:61:b4:bf:e2:de:24:15:96:4e:d4:72:53")
True
PS C:\&gt; Get-SSHTrustedHost -KnowHostStore $inmem

HostName HostKeyName Fingerprint
-------- ----------- -----------
192.168.1.1 Router 12:f8:7e:78:61:b4:bf:e2:de:24:15:96:4e:d4:72:53</dev:code>
<dev:remarks>
<maml:para>Get stored known hosts from an Memory Known Host store.</maml:para>
</dev:remarks>
</command:example>
</command:examples>
Expand Down Expand Up @@ -951,19 +969,19 @@ VERBOSE: Forwarding has been started.</dev:code>
<command:verb>New</command:verb>
<command:noun>SSHTrustedHost</command:noun>
<maml:description>
<maml:para>{{ Fill in the Synopsis }}</maml:para>
<maml:para>Add a new trusted host for Posh-SSH to use.</maml:para>
</maml:description>
</command:details>
<maml:description>
<maml:para>{{ Fill in the Description }}</maml:para>
<maml:para>Add a new trusted host for Posh-SSH to use. By default it will store the new host in the default Posh-SSH hosts.json file unless a KnownHost store is specified.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>New-SSHTrustedHost</maml:name>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none">
<maml:name>HostName</maml:name>
<maml:description>
<maml:para>{{ Fill HostName Description }}</maml:para>
<maml:para>FQDN or IP address of the host.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
<dev:type>
Expand All @@ -975,7 +993,7 @@ VERBOSE: Forwarding has been started.</dev:code>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none">
<maml:name>FingerPrint</maml:name>
<maml:description>
<maml:para>{{ Fill FingerPrint Description }}</maml:para>
<maml:para>SSH finger print for the the host to be added.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
<dev:type>
Expand All @@ -987,7 +1005,7 @@ VERBOSE: Forwarding has been started.</dev:code>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
<maml:name>KnowHostStore</maml:name>
<maml:description>
<maml:para>{{ Fill KnowHostStore Description }}</maml:para>
<maml:para>Known Host IStore either from New-SSHMemoryKnownHost, Get-SSHJsonKnownHost or Get-SSHOpenSSHKnownHost.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
<dev:type>
Expand All @@ -999,7 +1017,7 @@ VERBOSE: Forwarding has been started.</dev:code>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
<maml:name>Name</maml:name>
<maml:description>
<maml:para>{{ Fill Name Description }}</maml:para>
<maml:para>Friendly name for the key, in the case of OpenSSH it is the ciphers used.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
Expand All @@ -1014,7 +1032,7 @@ VERBOSE: Forwarding has been started.</dev:code>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none">
<maml:name>FingerPrint</maml:name>
<maml:description>
<maml:para>{{ Fill FingerPrint Description }}</maml:para>
<maml:para>SSH finger print for the the host to be added.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
<dev:type>
Expand All @@ -1026,7 +1044,7 @@ VERBOSE: Forwarding has been started.</dev:code>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none">
<maml:name>HostName</maml:name>
<maml:description>
<maml:para>{{ Fill HostName Description }}</maml:para>
<maml:para>FQDN or IP address of the host.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
<dev:type>
Expand All @@ -1038,7 +1056,7 @@ VERBOSE: Forwarding has been started.</dev:code>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
<maml:name>KnowHostStore</maml:name>
<maml:description>
<maml:para>{{ Fill KnowHostStore Description }}</maml:para>
<maml:para>Known Host IStore either from New-SSHMemoryKnownHost, Get-SSHJsonKnownHost or Get-SSHOpenSSHKnownHost.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
<dev:type>
Expand All @@ -1050,7 +1068,7 @@ VERBOSE: Forwarding has been started.</dev:code>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
<maml:name>Name</maml:name>
<maml:description>
<maml:para>{{ Fill Name Description }}</maml:para>
<maml:para>Friendly name for the key, in the case of OpenSSH it is the ciphers used.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
Expand Down Expand Up @@ -1088,9 +1106,10 @@ VERBOSE: Forwarding has been started.</dev:code>
<command:examples>
<command:example>
<maml:title>-------------------------- Example 1 --------------------------</maml:title>
<dev:code>PS C:\&gt; {{ Add example code here }}</dev:code>
<dev:code>PS C:\&gt; $inmem = New-SSHMemoryKnownHost
PS C:\&gt; New-SSHTrustedHost -KnowHostStore $inmem -HostName 192.168.1.165 -FingerPrint 3c:bf:26:9f:d9:63:d7:48:b8:fc:7b:32:e8:f9:5a:b4 -Name Pi</dev:code>
<dev:remarks>
<maml:para>{{ Add example description here }}</maml:para>
<maml:para>Add new host entry to a store.</maml:para>
</dev:remarks>
</command:example>
</command:examples>
Expand All @@ -1107,19 +1126,19 @@ VERBOSE: Forwarding has been started.</dev:code>
<command:verb>Remove</command:verb>
<command:noun>SSHTrustedHost</command:noun>
<maml:description>
<maml:para>{{ Fill in the Synopsis }}</maml:para>
<maml:para>Remove a KnwonHost entry from the default user location or from a KnownHost store.</maml:para>
</maml:description>
</command:details>
<maml:description>
<maml:para>{{ Fill in the Description }}</maml:para>
<maml:para>Remove a KnwonHost entry from the default user location or from a KnownHost store.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Remove-SSHTrustedHost</maml:name>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none">
<maml:name>HostName</maml:name>
<maml:description>
<maml:para>{{ Fill HostName Description }}</maml:para>
<maml:para>Host name of the entry to remove.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
Expand All @@ -1131,7 +1150,7 @@ VERBOSE: Forwarding has been started.</dev:code>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
<maml:name>KnowHostStore</maml:name>
<maml:description>
<maml:para>{{ Fill KnowHostStore Description }}</maml:para>
<maml:para>Known Host IStore either from New-SSHMemoryKnownHost, Get-SSHJsonKnownHost or Get-SSHOpenSSHKnownHost.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
<dev:type>
Expand All @@ -1146,7 +1165,7 @@ VERBOSE: Forwarding has been started.</dev:code>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none">
<maml:name>HostName</maml:name>
<maml:description>
<maml:para>{{ Fill HostName Description }}</maml:para>
<maml:para>Host name of the entry to remove.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
Expand All @@ -1158,7 +1177,7 @@ VERBOSE: Forwarding has been started.</dev:code>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
<maml:name>KnowHostStore</maml:name>
<maml:description>
<maml:para>{{ Fill KnowHostStore Description }}</maml:para>
<maml:para>Known Host IStore either from New-SSHMemoryKnownHost, Get-SSHJsonKnownHost or Get-SSHOpenSSHKnownHost.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">Object</command:parameterValue>
<dev:type>
Expand Down Expand Up @@ -1193,15 +1212,7 @@ VERBOSE: Forwarding has been started.</dev:code>
<maml:para></maml:para>
</maml:alert>
</maml:alertSet>
<command:examples>
<command:example>
<maml:title>-------------------------- Example 1 --------------------------</maml:title>
<dev:code>PS C:\&gt; {{ Add example code here }}</dev:code>
<dev:remarks>
<maml:para>{{ Add example description here }}</maml:para>
</dev:remarks>
</command:example>
</command:examples>
<command:examples />
<command:relatedLinks>
<maml:navigationLink>
<maml:linkText>Online Version:</maml:linkText>
Expand Down
40 changes: 40 additions & 0 deletions docs/Convert-SSHRegistryToJSonKnownHost.md
View file
@@ -0,0 +1,40 @@
---
external help file: Posh-SSH-help.xml
Module Name: Posh-SSH
online version:
schema: 2.0.0
---

# Convert-SSHRegistryToJSonKnownHost

## SYNOPSIS
Convert windows registry key storage to Json

## SYNTAX

```
Convert-SSHRegistryToJSonKnownHost
```

## DESCRIPTION
Convert windows registry key storage to Json
It is windows-only compatibility cmdlet

## EXAMPLES

### Example 1
```powershell
PS C:\> {{ Add example code here }}
```

{{ Add example description here }}

## PARAMETERS

## INPUTS

## OUTPUTS

## NOTES

## RELATED LINKS
60 changes: 30 additions & 30 deletions docs/Get-SCPItem.md
View file
Expand Up @@ -14,29 +14,29 @@ Download from a remote server via SCP a file or directory.

### NoKey (Default)
```
Get-SCPItem -Destination <String> -Path <String> -PathType <String> [-NewName <String>] [-NoProgress]
[-ComputerName] <String[]> [-Credential] <PSCredential> [-Port <Int32>] [-ProxyServer <String>]
[-ProxyPort <Int32>] [-ProxyCredential <PSCredential>] [-ProxyType <String>] [-ConnectionTimeout <Int32>]
[-OperationTimeout <Int32>] [-KeepAliveInterval <Int32>] [-AcceptKey] [-Force] [-ErrorOnUntrusted]
[-KnownHost <IStore>] [<CommonParameters>]
Get-SCPItem -Destination <String> -Path <String> -PathType <String> [-NewName <String>]
[-PathTransformation <String>] [-ComputerName] <String[]> [-Credential] <PSCredential> [-Port <Int32>]
[-ProxyServer <String>] [-ProxyPort <Int32>] [-ProxyCredential <PSCredential>] [-ProxyType <String>]
[-ConnectionTimeout <Int32>] [-OperationTimeout <Int32>] [-KeepAliveInterval <Int32>] [-AcceptKey] [-Force]
[-ErrorOnUntrusted] [-KnownHost <IStore>] [<CommonParameters>]
```

### Key
```
Get-SCPItem -Destination <String> -Path <String> -PathType <String> [-NewName <String>] [-NoProgress]
[-ComputerName] <String[]> [-Credential] <PSCredential> [-Port <Int32>] [-ProxyServer <String>]
[-ProxyPort <Int32>] [-ProxyCredential <PSCredential>] [-ProxyType <String>] [-KeyFile <String>]
[-ConnectionTimeout <Int32>] [-OperationTimeout <Int32>] [-KeepAliveInterval <Int32>] [-AcceptKey] [-Force]
[-ErrorOnUntrusted] [-KnownHost <IStore>] [<CommonParameters>]
Get-SCPItem -Destination <String> -Path <String> -PathType <String> [-NewName <String>]
[-PathTransformation <String>] [-ComputerName] <String[]> [-Credential] <PSCredential> [-Port <Int32>]
[-ProxyServer <String>] [-ProxyPort <Int32>] [-ProxyCredential <PSCredential>] [-ProxyType <String>]
[-KeyFile <String>] [-ConnectionTimeout <Int32>] [-OperationTimeout <Int32>] [-KeepAliveInterval <Int32>]
[-AcceptKey] [-Force] [-ErrorOnUntrusted] [-KnownHost <IStore>] [<CommonParameters>]
```

### KeyString
```
Get-SCPItem -Destination <String> -Path <String> -PathType <String> [-NewName <String>] [-NoProgress]
[-ComputerName] <String[]> [-Credential] <PSCredential> [-Port <Int32>] [-ProxyServer <String>]
[-ProxyPort <Int32>] [-ProxyCredential <PSCredential>] [-ProxyType <String>] [-KeyString <String[]>]
[-ConnectionTimeout <Int32>] [-OperationTimeout <Int32>] [-KeepAliveInterval <Int32>] [-AcceptKey] [-Force]
[-ErrorOnUntrusted] [-KnownHost <IStore>] [<CommonParameters>]
Get-SCPItem -Destination <String> -Path <String> -PathType <String> [-NewName <String>]
[-PathTransformation <String>] [-ComputerName] <String[]> [-Credential] <PSCredential> [-Port <Int32>]
[-ProxyServer <String>] [-ProxyPort <Int32>] [-ProxyCredential <PSCredential>] [-ProxyType <String>]
[-KeyString <String[]>] [-ConnectionTimeout <Int32>] [-OperationTimeout <Int32>] [-KeepAliveInterval <Int32>]
[-AcceptKey] [-Force] [-ErrorOnUntrusted] [-KnownHost <IStore>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -211,21 +211,6 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

### -NoProgress
Do not show upload progress.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

### -OperationTimeout
Timeout for execution of an operation.

Expand Down Expand Up @@ -378,6 +363,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -PathTransformation
Remote Path transormation to use.

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
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).

Expand Down

0 comments on commit df64db4

Please sign in to comment.