Skip to content

Commit d773dd4

Browse files
committed
Add warning about winrm-certpath requirements in Windows nodes configuration
1 parent 41f146e commit d773dd4

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/learning/howto/configuring-windows-nodes.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,9 @@ The following properties can optionally be set in the WinRM Node Executor and Wi
9191
* **`WinRM Port`**: The WinRM port to use. The default is port 5985. This can be overridden on nodes with `winrm-port`. <br><br>
9292
* **`WinRM Username`**: Optional username. The username can be set at node level (using the attribute `username`) or at job level (using an input option called `username`). <br><br>
9393
* **`Certificate Path`**: The path for SSL verification. This can be overridden on nodes with `winrm-certpath`. <br><br>
94+
:::warning Important
95+
`winrm-certpath` expects a **file system path** (e.g., `/opt/rundeck/certs/certificate.pem`), **NOT** a Rundeck Key Storage path (e.g., `keys/project/...`). The certificate path is passed directly to the pywinrm library without Key Storage resolution. The certificate file must be in PEM format and readable by the Rundeck user on the Enterprise Runner or Rundeck server.
96+
:::
9497
* **`Connect/Read Times Out`**: The maximum seconds to wait before an HTTP connect/read times out (default 30). This value should be slightly higher than operation timeout, as the server can block *at least* that long. This can be overridden on nodes with `winrm-readtimeout`. <br><br>
9598
* **`Proxy`**: Optionally specify a proxy address for communicating with Windows nodes. Example HTTP proxy strings are `http://server:port` and `http://user:pass@server:port`. An example SOCKS5 proxy string is `socks5://user:pass@server:port`.<br><br>
9699
* **`Operation Timeout`**: The maximum allowed time in seconds for any single wsman HTTP operation (default 20). Note that operation timeouts while receiving output will be silently retried indefinitely. This can be overridden on nodes with `winrm-operationtimeout`.<br><br>

0 commit comments

Comments
 (0)