You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
creating certificate stores for the `RemoteFile` Orchestrator Extension.
161
162
162
163
</details>
163
-
164
-
Please consult with your system administrator for more information on configuring `SSH/SFTP/SCP` or `WinRM` in your environment.
164
+
C
165
+
Please consult with your system administrator for more information on configuring `SSH/SCP/SFTP` or `WinRM` in your environment.
165
166
166
167
167
168
## Certificate Store Types
@@ -274,7 +275,6 @@ the Keyfactor Command Portal
274
275
| SudoImpersonatingUser | Sudo Impersonating User | The SudoImpersonatingUser field should contain a valid user ID to impersonate using sudo on the destination Linux server. Example: 'impersonatedUserID'. Overrides DefaultSudoImpersonatedUser [config.json](#post-installation) setting. | String || 🔲 Unchecked |
275
276
| RemoveRootCertificate | Remove Root Certificate from Chain | Remove root certificate from chain when adding/renewing a certificate in a store. | Bool | False | 🔲 Unchecked |
276
277
| IncludePortInSPN | Include Port in SPN for WinRM | Internally set the -IncludePortInSPN option when creating the remote PowerShell connection. Needed for some Kerberos configurations. | Bool | False | 🔲 Unchecked |
277
-
| FileTransferProtocol | File Transfer Protocol to Use | Which protocol should be used when uploading/downloading files - SCP, SFTP, or Both (try one, and then if necessary, the other). Overrides FileTransferProtocol [config.json](#post-installation) setting. | MultipleChoice | ,SCP,SFTP,Both | 🔲 Unchecked |
278
278
| SSHPort | SSH Port | Integer value representing the port that should be used when connecting to Linux servers over SSH. Overrides SSHPort [config.json](#post-installation) setting. | String || 🔲 Unchecked |
279
279
| UseShellCommands | Use Shell Commands | Recommended to be set to the default value of 'Y'. For a detailed explanation of this setting, please refer to [Use Shell Commands Setting](#use-shell-commands-setting)| Bool | True | 🔲 Unchecked |
280
280
@@ -929,7 +929,6 @@ The Remote File Orchestrator Extension uses a JSON configuration file. It is loc
929
929
"CreateStoreIfMissing": "N",
930
930
"UseNegotiate": "N",
931
931
"SeparateUploadFilePath": "",
932
-
"FileTransferProtocol": "SCP",
933
932
"DefaultLinuxPermissionsOnStoreCreation": "600",
934
933
"DefaultOwnerOnStoreCreation": "",
935
934
"SSHPort": "",
@@ -944,7 +943,6 @@ The Remote File Orchestrator Extension uses a JSON configuration file. It is loc
944
943
|`CreateStoreIfMissing`|`N`|`Y/N`| Determines if a certificate store should be created during a Management-Add job if it doesn't exist. If `N`, the job will return an error. If `Y`, the store will be created and the certificate added. |
945
944
|`UseNegotiate`|`N`|`Y/N`| Determines if WinRM should use Negotiate (Y) when connecting to the remote server. Only applicable for Windows hosted certificate stores. |
946
945
|`SeparateUploadFilePath`|| Any valid, existing Linux path | Path on the orchestrated server for uploading/downloading temporary work files. If empty, the certificate store location will be used. Only applicable for Linux hosted certificate stores. |
947
-
|`FileTransferProtocol`|`SCP`|`SCP, SFTP, Both`| Protocol used for uploading/downloading files. If `Both`, `SCP` will be tried first, then `SFTP`. Only applicable for Linux hosted certificate stores. |
948
946
|`DefaultLinuxPermissionsOnStoreCreation`|`600`| Any 3-digit value from 000-777 | Linux file permissions set on new certificate stores. If blank, permissions from the parent folder will be used. Only applicable for Linux hosted certificate stores. |
949
947
|`DefaultOwnerOnStoreCreation`|| Any valid user id | Sets the owner for newly created certificate stores. Can include group with format `ownerId:groupId`. If blank, the owner of the parent folder will be used. Only applicable for Linux hosted certificate stores. |
950
948
|`SSHPort`|| Any valid integer representing a port | The port that SSH is listening on. Default is 22. Only applicable for Linux hosted certificate stores. |
@@ -987,7 +985,6 @@ The Remote File Universal Orchestrator extension implements 6 Certificate Store
987
985
| SudoImpersonatingUser | The SudoImpersonatingUser field should contain a valid user ID to impersonate using sudo on the destination Linux server. Example: 'impersonatedUserID'. Overrides DefaultSudoImpersonatedUser [config.json](#post-installation) setting. |
988
986
| RemoveRootCertificate | Remove root certificate from chain when adding/renewing a certificate in a store. |
989
987
| IncludePortInSPN | Internally set the -IncludePortInSPN option when creating the remote PowerShell connection. Needed for some Kerberos configurations. |
990
-
| FileTransferProtocol | Which protocol should be used when uploading/downloading files - SCP, SFTP, or Both (try one, and then if necessary, the other). Overrides FileTransferProtocol [config.json](#post-installation) setting. |
991
988
| SSHPort | Integer value representing the port that should be used when connecting to Linux servers over SSH. Overrides SSHPort [config.json](#post-installation) setting. |
992
989
| UseShellCommands | Recommended to be set to the default value of 'Y'. For a detailed explanation of this setting, please refer to [Use Shell Commands Setting](#use-shell-commands-setting)|
993
990
@@ -1023,7 +1020,6 @@ The Remote File Universal Orchestrator extension implements 6 Certificate Store
1023
1020
| Properties.SudoImpersonatingUser | The SudoImpersonatingUser field should contain a valid user ID to impersonate using sudo on the destination Linux server. Example: 'impersonatedUserID'. Overrides DefaultSudoImpersonatedUser [config.json](#post-installation) setting. |
1024
1021
| Properties.RemoveRootCertificate | Remove root certificate from chain when adding/renewing a certificate in a store. |
1025
1022
| Properties.IncludePortInSPN | Internally set the -IncludePortInSPN option when creating the remote PowerShell connection. Needed for some Kerberos configurations. |
1026
-
| Properties.FileTransferProtocol | Which protocol should be used when uploading/downloading files - SCP, SFTP, or Both (try one, and thenif necessary, the other). Overrides FileTransferProtocol [config.json](#post-installation) setting. |
1027
1023
| Properties.SSHPort | Integer value representing the port that should be used when connecting to Linux servers over SSH. Overrides SSHPort [config.json](#post-installation) setting. |
1028
1024
| Properties.UseShellCommands | Recommended to be set to the default value of 'Y'. For a detailed explanation of this setting, please refer to [Use Shell Commands Setting](#use-shell-commands-setting) |
1029
1025
@@ -1654,7 +1650,7 @@ permissions and ownership when creating certificate stores will be based on the
1654
1650
other Linux environmental settings.
1655
1651
3. Discovery jobs are excluded and will still use the `find` shell command
1656
1652
4. A rare issue exists where the user id assigned to a certificate store has an expired password causing the orchestrator to hang
1657
-
when attempting an SFTP/SCP connection. A modification was added to RemoteFile to check for this condition. Running RemoteFile
1653
+
when attempting an SCP/SFTP connection. A modification was added to RemoteFile to check for this condition. Running RemoteFile
1658
1654
with Use Shell Commands = N will cause this validation check to NOT occur.
1659
1655
5. Both RFORA and RFKDB use proprietary CLI commands in order to manage their respective certificate stores. These commands
1660
1656
will still be executed when Use Shell Commands is set to Y.
0 commit comments