Update Documentation

Update documentation for 3.2.2
darkoperator · Sep 1, 2024 · e88b1a4 · e88b1a4
1 parent daffaba
commit e88b1a4
Show file tree

Hide file tree

Showing 52 changed files with 3,920 additions and 1,794 deletions.
diff --git a/Posh-SSH/PoshSSH.dll b/Posh-SSH/PoshSSH.dll
diff --git a/Posh-SSH/en-US/Posh-SSH-help.xml b/Posh-SSH/en-US/Posh-SSH-help.xml
diff --git a/Posh-SSH/en-US/Posh-SSH.psm1-Help.xml b/Posh-SSH/en-US/Posh-SSH.psm1-Help.xml
diff --git a/Posh-SSH/en-US/PoshSSH.dll-help.xml b/Posh-SSH/en-US/PoshSSH.dll-help.xml
diff --git a/docs/Convert-SSHRegistryToJSonKnownHost.md b/docs/Convert-SSHRegistryToJSonKnownHost.md
@@ -1,5 +1,5 @@
 ---
-external help file: Posh-SSH-Help.xml
+external help file: Posh-SSH-help.xml
 Module Name: Posh-SSH
 online version:
 schema: 2.0.0
@@ -13,7 +13,7 @@ Convert windows registry key storage to Json
 ## SYNTAX
 
 ```
-Convert-SSHRegistryToJSonKnownHost [<CommonParameters>]
+Convert-SSHRegistryToJSonKnownHost
 ```
 
 ## DESCRIPTION
@@ -24,16 +24,13 @@ It is windows-only compatibility cmdlet
 
 ### Example 1
 ```powershell
-PS C:\> Convert-SSHRegistryToJSonKnownHost
+PS C:\> {{ Add example code here }}
 ```
 
-Convert deprecated (v2) windows registry key storage to v3 Json storage
+{{ Add example description here }}
 
 ## PARAMETERS
 
-### 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
 
 ## OUTPUTS

diff --git a/docs/Get-PoshSSHModVersion.md b/docs/Get-PoshSSHModVersion.md
@@ -13,7 +13,7 @@ Gets the current installed version and the latest version of Posh-SSH.
 ## SYNTAX
 
 ```
-Get-PoshSSHModVersion [<CommonParameters>]
+Get-PoshSSHModVersion [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -32,6 +32,21 @@ InstalledVersion                                  CurrentVersion
 
 ## PARAMETERS
 
+### -ProgressAction
+{{ Fill ProgressAction Description }}
+
+```yaml
+Type: ActionPreference
+Parameter Sets: (All)
+Aliases: proga
+
+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-SCPItem.md b/docs/Get-SCPItem.md
@@ -18,7 +18,7 @@ Get-SCPItem -Destination <String> -Path <String> -PathType <String> [-NewName <S
  [-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>]
+ [-ErrorOnUntrusted] [-KnownHost <IStore>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
 ### Key
@@ -27,7 +27,8 @@ Get-SCPItem -Destination <String> -Path <String> -PathType <String> [-NewName <S
  [-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>]
+ [-AcceptKey] [-Force] [-ErrorOnUntrusted] [-KnownHost <IStore>] [-ProgressAction <ActionPreference>]
+ [<CommonParameters>]
 ```
 
 ### KeyString
@@ -36,7 +37,8 @@ Get-SCPItem -Destination <String> -Path <String> -PathType <String> [-NewName <S
  [-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>]
+ [-AcceptKey] [-Force] [-ErrorOnUntrusted] [-KnownHost <IStore>] [-ProgressAction <ActionPreference>]
+ [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -152,7 +154,8 @@ Accept wildcard characters: False
 ```
 
 ### -Force
-Do not check the remote host fingerprint. When downloading if a file already exists it will overwrite the file.
+Do not check the remote host fingerprint.
+When downloading if a file already exists it will overwrite the file.
 
 ```yaml
 Type: SwitchParameter
@@ -379,6 +382,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -ProgressAction
+{{ Fill ProgressAction Description }}
+
+```yaml
+Type: ActionPreference
+Parameter Sets: (All)
+Aliases: proga
+
+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-SFTPChildItem.md b/docs/Get-SFTPChildItem.md
@@ -14,14 +14,14 @@ Gets the items and child items in a specified path.
 
 ### Index (Default)
 ```
-Get-SFTPChildItem [-SessionId] <Int32[]> [[-Path] <String>] [-Recurse] [-Directory] [-File]
- [<CommonParameters>]
+Get-SFTPChildItem [-SessionId] <Int32[]> [[-Path] <String>] [-Recurse] [-Directory] [-File] [-Name <String>]
+ [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
 ### Session
 ```
 Get-SFTPChildItem [-SFTPSession] <SftpSession[]> [[-Path] <String>] [-Recurse] [-Directory] [-File]
- [<CommonParameters>]
+ [-Name <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -190,6 +190,21 @@ Accept pipeline input: False
 Accept wildcard characters: True
 ```
 
+### -ProgressAction
+{{ Fill ProgressAction Description }}
+
+```yaml
+Type: ActionPreference
+Parameter Sets: (All)
+Aliases: proga
+
+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-SFTPContent.md b/docs/Get-SFTPContent.md
@@ -15,13 +15,13 @@ Gets the content of the item at the specified location over SFTP.
 ### Index (Default)
 ```
 Get-SFTPContent [-SessionId] <Int32[]> [-Path] <String> [[-ContentType] <String>] [-Encoding <String>]
- [<CommonParameters>]
+ [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
 ### Session
 ```
 Get-SFTPContent [-SFTPSession] <SftpSession[]> [-Path] <String> [[-ContentType] <String>] [-Encoding <String>]
- [<CommonParameters>]
+ [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -116,6 +116,21 @@ Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 
+### -ProgressAction
+{{ Fill ProgressAction Description }}
+
+```yaml
+Type: ActionPreference
+Parameter Sets: (All)
+Aliases: proga
+
+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
@@ -15,13 +15,13 @@ Downloads via SFTP an item from a SSH server.
 ### Index (Default)
 ```
 Get-SFTPItem [-SessionId] <Int32[]> [-Path] <String[]> [-Destination] <String> [-Force] [-SkipSymLink]
- [<CommonParameters>]
+ [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
 ### Session
 ```
 Get-SFTPItem [-SFTPSession] <SftpSession[]> [-Path] <String[]> [-Destination] <String> [-Force] [-SkipSymLink]
- [<CommonParameters>]
+ [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -129,13 +129,28 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -ProgressAction
+{{ Fill ProgressAction Description }}
+
+```yaml
+Type: ActionPreference
+Parameter Sets: (All)
+Aliases: proga
+
+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).
 
 ## INPUTS
 
 ### System.Int32[]
-SSH.SftpSession[] System.String[] System.String System.Management.Automation.SwitchParameter
+SSH.SftpSession\[\] System.String\[\] System.String System.Management.Automation.SwitchParameter
 
 ## OUTPUTS
 

diff --git a/docs/Get-SFTPLocation.md b/docs/Get-SFTPLocation.md
@@ -14,12 +14,12 @@ Get the current working location for a SFTP connection.
 
 ### Index (Default)
 ```
-Get-SFTPLocation [-SessionId] <Int32[]> [<CommonParameters>]
+Get-SFTPLocation [-SessionId] <Int32[]> [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
 ### Session
 ```
-Get-SFTPLocation [-SFTPSession] <SftpSession[]> [<CommonParameters>]
+Get-SFTPLocation [-SFTPSession] <SftpSession[]> [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -67,6 +67,21 @@ Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 
+### -ProgressAction
+{{ Fill ProgressAction Description }}
+
+```yaml
+Type: ActionPreference
+Parameter Sets: (All)
+Aliases: proga
+
+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-SFTPPathAttribute.md b/docs/Get-SFTPPathAttribute.md
@@ -14,12 +14,14 @@ Get the attributes for a specified path in a SFTP session.
 
 ### Index
 ```
-Get-SFTPPathAttribute [-SessionId] <Int32[]> [-Path] <String> [<CommonParameters>]
+Get-SFTPPathAttribute [-SessionId] <Int32[]> [-Path] <String> [-ProgressAction <ActionPreference>]
+ [<CommonParameters>]
 ```
 
 ### Session
 ```
-Get-SFTPPathAttribute [-SFTPSession] <SftpSession[]> [-Path] <String> [<CommonParameters>]
+Get-SFTPPathAttribute [-SFTPSession] <SftpSession[]> [-Path] <String> [-ProgressAction <ActionPreference>]
+ [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -102,6 +104,21 @@ Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 
+### -ProgressAction
+{{ Fill ProgressAction Description }}
+
+```yaml
+Type: ActionPreference
+Parameter Sets: (All)
+Aliases: proga
+
+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-SFTPPathInformation.md b/docs/Get-SFTPPathInformation.md
@@ -14,12 +14,14 @@ Get the filesystem information for a specified path in a SFTP session.
 
 ### Index
 ```
-Get-SFTPPathInformation [-SessionId] <Int32[]> [-Path] <String> [<CommonParameters>]
+Get-SFTPPathInformation [-SessionId] <Int32[]> [-Path] <String> [-ProgressAction <ActionPreference>]
+ [<CommonParameters>]
 ```
 
 ### Session
 ```
-Get-SFTPPathInformation [-SFTPSession] <SftpSession[]> [-Path] <String> [<CommonParameters>]
+Get-SFTPPathInformation [-SFTPSession] <SftpSession[]> [-Path] <String> [-ProgressAction <ActionPreference>]
+ [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -92,6 +94,21 @@ Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 
+### -ProgressAction
+{{ Fill ProgressAction Description }}
+
+```yaml
+Type: ActionPreference
+Parameter Sets: (All)
+Aliases: proga
+
+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-SFTPSession.md b/docs/Get-SFTPSession.md
@@ -13,7 +13,7 @@ Get current SFTP Sessions that are available for interaction.
 ## SYNTAX
 
 ```
-Get-SFTPSession [[-SessionId] <Int32[]>] [<CommonParameters>]
+Get-SFTPSession [[-SessionId] <Int32[]>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -47,6 +47,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -ProgressAction
+{{ Fill ProgressAction Description }}
+
+```yaml
+Type: ActionPreference
+Parameter Sets: (All)
+Aliases: proga
+
+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).