diff --git a/Invoke-DocumentationBuild.ps1 b/Invoke-DocumentationBuild.ps1
index 9369fbaa..1e8ee8cf 100644
--- a/Invoke-DocumentationBuild.ps1
+++ b/Invoke-DocumentationBuild.ps1
@@ -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
diff --git a/Posh-SSH/en-US/Posh-SSH-help.xml b/Posh-SSH/en-US/Posh-SSH-help.xml
index 921178d9..94872046 100644
--- a/Posh-SSH/en-US/Posh-SSH-help.xml
+++ b/Posh-SSH/en-US/Posh-SSH-help.xml
@@ -178,11 +178,11 @@
Get
SSHTrustedHost
- {{ Fill in the Synopsis }}
+ Get the current known hosts either from those trusted by Posh-SSH or from a IStore.
- {{ Fill in the Description }}
+ 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.
@@ -190,7 +190,7 @@
KnowHostStore
- {{ Fill KnowHostStore Description }}
+ Known Host IStore either from New-SSHMemoryKnownHost, Get-SSHJsonKnownHost or Get-SSHOpenSSHKnownHost.
Object
@@ -202,7 +202,7 @@
HostName
- {{ Fill HostName Description }}
+ HostName as stored by Posh-SSH or in a IStore.
String
@@ -217,7 +217,7 @@
HostName
- {{ Fill HostName Description }}
+ HostName as stored by Posh-SSH or in a IStore.
String
@@ -229,7 +229,7 @@
KnowHostStore
- {{ Fill KnowHostStore Description }}
+ Known Host IStore either from New-SSHMemoryKnownHost, Get-SSHJsonKnownHost or Get-SSHOpenSSHKnownHost.
Object
@@ -267,9 +267,27 @@
-------------------------- Example 1 --------------------------
- PS C:\> {{ Add example code here }}
+ PS C:\> 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
- {{ Add example description here }}
+ Get currently stored known hosts.
+
+
+
+ -------------------------- Example 2 --------------------------
+ PS C:\> $inmem = New-SSHMemoryKnownHost
+PS C:\> $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:\> 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
+
+ Get stored known hosts from an Memory Known Host store.
@@ -951,11 +969,11 @@ VERBOSE: Forwarding has been started.
New
SSHTrustedHost
- {{ Fill in the Synopsis }}
+ Add a new trusted host for Posh-SSH to use.
- {{ Fill in the Description }}
+ 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.
@@ -963,7 +981,7 @@ VERBOSE: Forwarding has been started.
HostName
- {{ Fill HostName Description }}
+ FQDN or IP address of the host.
Object
@@ -975,7 +993,7 @@ VERBOSE: Forwarding has been started.
FingerPrint
- {{ Fill FingerPrint Description }}
+ SSH finger print for the the host to be added.
Object
@@ -987,7 +1005,7 @@ VERBOSE: Forwarding has been started.
KnowHostStore
- {{ Fill KnowHostStore Description }}
+ Known Host IStore either from New-SSHMemoryKnownHost, Get-SSHJsonKnownHost or Get-SSHOpenSSHKnownHost.
Object
@@ -999,7 +1017,7 @@ VERBOSE: Forwarding has been started.
Name
- {{ Fill Name Description }}
+ Friendly name for the key, in the case of OpenSSH it is the ciphers used.
String
@@ -1014,7 +1032,7 @@ VERBOSE: Forwarding has been started.
FingerPrint
- {{ Fill FingerPrint Description }}
+ SSH finger print for the the host to be added.
Object
@@ -1026,7 +1044,7 @@ VERBOSE: Forwarding has been started.
HostName
- {{ Fill HostName Description }}
+ FQDN or IP address of the host.
Object
@@ -1038,7 +1056,7 @@ VERBOSE: Forwarding has been started.
KnowHostStore
- {{ Fill KnowHostStore Description }}
+ Known Host IStore either from New-SSHMemoryKnownHost, Get-SSHJsonKnownHost or Get-SSHOpenSSHKnownHost.
Object
@@ -1050,7 +1068,7 @@ VERBOSE: Forwarding has been started.
Name
- {{ Fill Name Description }}
+ Friendly name for the key, in the case of OpenSSH it is the ciphers used.
String
@@ -1088,9 +1106,10 @@ VERBOSE: Forwarding has been started.
-------------------------- Example 1 --------------------------
- PS C:\> {{ Add example code here }}
+ PS C:\> $inmem = New-SSHMemoryKnownHost
+PS C:\> 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
- {{ Add example description here }}
+ Add new host entry to a store.
@@ -1107,11 +1126,11 @@ VERBOSE: Forwarding has been started.
Remove
SSHTrustedHost
- {{ Fill in the Synopsis }}
+ Remove a KnwonHost entry from the default user location or from a KnownHost store.
- {{ Fill in the Description }}
+ Remove a KnwonHost entry from the default user location or from a KnownHost store.
@@ -1119,7 +1138,7 @@ VERBOSE: Forwarding has been started.
HostName
- {{ Fill HostName Description }}
+ Host name of the entry to remove.
String
@@ -1131,7 +1150,7 @@ VERBOSE: Forwarding has been started.
KnowHostStore
- {{ Fill KnowHostStore Description }}
+ Known Host IStore either from New-SSHMemoryKnownHost, Get-SSHJsonKnownHost or Get-SSHOpenSSHKnownHost.
Object
@@ -1146,7 +1165,7 @@ VERBOSE: Forwarding has been started.
HostName
- {{ Fill HostName Description }}
+ Host name of the entry to remove.
String
@@ -1158,7 +1177,7 @@ VERBOSE: Forwarding has been started.
KnowHostStore
- {{ Fill KnowHostStore Description }}
+ Known Host IStore either from New-SSHMemoryKnownHost, Get-SSHJsonKnownHost or Get-SSHOpenSSHKnownHost.
Object
@@ -1193,15 +1212,7 @@ VERBOSE: Forwarding has been started.
-
-
- -------------------------- Example 1 --------------------------
- PS C:\> {{ Add example code here }}
-
- {{ Add example description here }}
-
-
-
+
Online Version:
diff --git a/docs/Convert-SSHRegistryToJSonKnownHost.md b/docs/Convert-SSHRegistryToJSonKnownHost.md
new file mode 100644
index 00000000..1f411926
--- /dev/null
+++ b/docs/Convert-SSHRegistryToJSonKnownHost.md
@@ -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
diff --git a/docs/Get-SCPItem.md b/docs/Get-SCPItem.md
index f9396bb8..995b3a40 100644
--- a/docs/Get-SCPItem.md
+++ b/docs/Get-SCPItem.md
@@ -14,29 +14,29 @@ Download from a remote server via SCP a file or directory.
### NoKey (Default)
```
-Get-SCPItem -Destination -Path -PathType [-NewName ] [-NoProgress]
- [-ComputerName] [-Credential] [-Port ] [-ProxyServer ]
- [-ProxyPort ] [-ProxyCredential ] [-ProxyType ] [-ConnectionTimeout ]
- [-OperationTimeout ] [-KeepAliveInterval ] [-AcceptKey] [-Force] [-ErrorOnUntrusted]
- [-KnownHost ] []
+Get-SCPItem -Destination -Path -PathType [-NewName ]
+ [-PathTransformation ] [-ComputerName] [-Credential] [-Port ]
+ [-ProxyServer ] [-ProxyPort ] [-ProxyCredential ] [-ProxyType ]
+ [-ConnectionTimeout ] [-OperationTimeout ] [-KeepAliveInterval ] [-AcceptKey] [-Force]
+ [-ErrorOnUntrusted] [-KnownHost ] []
```
### Key
```
-Get-SCPItem -Destination -Path -PathType [-NewName ] [-NoProgress]
- [-ComputerName] [-Credential] [-Port ] [-ProxyServer ]
- [-ProxyPort ] [-ProxyCredential ] [-ProxyType ] [-KeyFile ]
- [-ConnectionTimeout ] [-OperationTimeout ] [-KeepAliveInterval ] [-AcceptKey] [-Force]
- [-ErrorOnUntrusted] [-KnownHost ] []
+Get-SCPItem -Destination -Path -PathType [-NewName ]
+ [-PathTransformation ] [-ComputerName] [-Credential] [-Port ]
+ [-ProxyServer ] [-ProxyPort ] [-ProxyCredential ] [-ProxyType ]
+ [-KeyFile ] [-ConnectionTimeout ] [-OperationTimeout ] [-KeepAliveInterval ]
+ [-AcceptKey] [-Force] [-ErrorOnUntrusted] [-KnownHost ] []
```
### KeyString
```
-Get-SCPItem -Destination -Path -PathType [-NewName ] [-NoProgress]
- [-ComputerName] [-Credential] [-Port ] [-ProxyServer ]
- [-ProxyPort ] [-ProxyCredential ] [-ProxyType ] [-KeyString ]
- [-ConnectionTimeout ] [-OperationTimeout ] [-KeepAliveInterval ] [-AcceptKey] [-Force]
- [-ErrorOnUntrusted] [-KnownHost ] []
+Get-SCPItem -Destination -Path -PathType [-NewName ]
+ [-PathTransformation ] [-ComputerName] [-Credential] [-Port ]
+ [-ProxyServer ] [-ProxyPort ] [-ProxyCredential ] [-ProxyType ]
+ [-KeyString ] [-ConnectionTimeout ] [-OperationTimeout ] [-KeepAliveInterval ]
+ [-AcceptKey] [-Force] [-ErrorOnUntrusted] [-KnownHost ] []
```
## DESCRIPTION
@@ -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.
@@ -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).
diff --git a/docs/Get-SFTPItem.md b/docs/Get-SFTPItem.md
index d42ca432..a43723df 100644
--- a/docs/Get-SFTPItem.md
+++ b/docs/Get-SFTPItem.md
@@ -14,14 +14,14 @@ Downloads via SFTP an item from a SSH server.
### Index (Default)
```
-Get-SFTPItem [-SessionId] [-Path] [-Destination] [-NoProgress] [-Force]
- [-SkipSymLink] []
+Get-SFTPItem [-SessionId] [-Path] [-Destination] [-Force] [-SkipSymLink]
+ []
```
### Session
```
-Get-SFTPItem [-SFTPSession] [-Path] [-Destination] [-NoProgress] [-Force]
- [-SkipSymLink] []
+Get-SFTPItem [-SFTPSession] [-Path] [-Destination] [-Force] [-SkipSymLink]
+ []
```
## DESCRIPTION
@@ -69,21 +69,6 @@ Accept pipeline input: False
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
-```
-
### -Path
Remote path of item to download.
diff --git a/docs/Get-SSHRegistryKnownHost.md b/docs/Get-SSHRegistryKnownHost.md
new file mode 100644
index 00000000..60479090
--- /dev/null
+++ b/docs/Get-SSHRegistryKnownHost.md
@@ -0,0 +1,40 @@
+---
+external help file: Posh-SSH-help.xml
+Module Name: Posh-SSH
+online version: https://github.com/darkoperator/Posh-SSH/tree/master/docs
+schema: 2.0.0
+---
+
+# Get-SSHRegistryKnownHost
+
+## SYNOPSIS
+Get KnownHosts from registry (readonly)
+
+## SYNTAX
+
+```
+Get-SSHRegistryKnownHost
+```
+
+## DESCRIPTION
+Get KnownHosts from registry (readonly)
+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
diff --git a/docs/Get-SSHTrustedHost.md b/docs/Get-SSHTrustedHost.md
index 4757740e..72d65829 100644
--- a/docs/Get-SSHTrustedHost.md
+++ b/docs/Get-SSHTrustedHost.md
@@ -1,5 +1,5 @@
---
-external help file: Posh-SSH-help.xml
+external help file: Posh-SSH.psm1-Help.xml
Module Name: Posh-SSH
online version: https://github.com/darkoperator/Posh-SSH/tree/master/docs
schema: 2.0.0
@@ -8,78 +8,58 @@ schema: 2.0.0
# Get-SSHTrustedHost
## SYNOPSIS
-Get the current known hosts either from those trusted by Posh-SSH or from a IStore.
## SYNTAX
### Local (Default)
```
-Get-SSHTrustedHost [-HostName ] []
+Get-SSHTrustedHost [[-HostName] ] []
```
### Store
```
-Get-SSHTrustedHost [-KnowHostStore]