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
Copy file name to clipboardExpand all lines: docs/index.md
+18-8Lines changed: 18 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,6 +45,14 @@ Use the navigation to the left to read about the available resources.
45
45
|`PROXMOX_VE_SSH_USERNAME`| SSH username | No |
46
46
|`PROXMOX_VE_SSH_PASSWORD`| SSH password | No |
47
47
|`PROXMOX_VE_SSH_PRIVATE_KEY`| SSH private key | No |
48
+
|`PROXMOX_VE_SSH_AGENT`| Use SSH agent for authentication | No |
49
+
|`PROXMOX_VE_SSH_AUTH_SOCK`| SSH agent socket path | No |
50
+
|`PROXMOX_VE_SSH_AGENT_FORWARDING`| Enable SSH agent forwarding | No |
51
+
|`PROXMOX_VE_SSH_SOCKS5_SERVER`| SOCKS5 proxy server address | No |
52
+
|`PROXMOX_VE_SSH_SOCKS5_USERNAME`| SOCKS5 proxy username | No |
53
+
|`PROXMOX_VE_SSH_SOCKS5_PASSWORD`| SOCKS5 proxy password | No |
54
+
|`PROXMOX_VE_MIN_TLS`| Minimum TLS version | No |
55
+
|`PROXMOX_VE_OTP`| One-time password (deprecated) | No |
48
56
|`PROXMOX_VE_TMPDIR`| Custom temporary directory | No |
49
57
50
58
*One of these authentication methods is required
@@ -76,7 +84,7 @@ provider "proxmox" {
76
84
## Authentication
77
85
78
86
The Proxmox provider offers a flexible means of providing credentials for authentication.
79
-
Static credentials and pre-authenticated session-ticket can be provided to the `proxmox` block through one of the choices of arguments below, ordered by precedence:
87
+
Static credentials and pre-authenticated sessionticket can be provided to the `proxmox` block through one of the choices of arguments below, ordered by precedence:
80
88
81
89
-`api_token`
82
90
-`auth_ticket` and `csrf_prevention_token`
@@ -192,20 +200,20 @@ See the [Argument Reference](#argument-reference) section for the supported vari
192
200
### API Token Authentication
193
201
194
202
API Token authentication can be used to authenticate with the Proxmox API without the need to provide a password.
195
-
In combination with the `ssh` block and `ssh-agent` support, this allows for a fully password-less authentication.
203
+
In combination with the `ssh` block and SSH agent support, this allows for a fully password-less authentication.
196
204
197
205
You can create an API Token for a user via the Proxmox UI, or via the command line on the Proxmox host or cluster:
198
206
199
207
- Create a user:
200
208
201
209
```sh
202
-
sudo pveum user add terraform@pve
210
+
pveum user add terraform@pve
203
211
```
204
212
205
213
- Create a role for the user (you can skip this step if you want to use any of the existing roles):
~> The list of available privileges has been changed in PVE 9.0, and the above list is only an example (and most likely too excessive for most use cases), please review it and adjust to your needs.
@@ -214,15 +222,17 @@ You can create an API Token for a user via the Proxmox UI, or via the command li
sudo pveum user token add terraform@pve provider --privsep=0
231
+
pveum user token add terraform@pve provider --privsep=0
224
232
```
225
233
234
+
-> Make sure you copy the token value, as it will not be displayed again.
235
+
226
236
Refer to the upstream docs as needed for additional details concerning [PVE User Management](https://pve.proxmox.com/wiki/User_Management).
227
237
228
238
Generating the token will output a table containing the token's ID and secret which are meant to be concatenated into a single string for use with either the `api_token` field of the `provider` block (fine for testing but should be avoided) or sourced from the `PROXMOX_VE_API_TOKEN` environment variable.
@@ -322,7 +332,7 @@ Please refer to the [Argument Reference](#argument-reference) section to view th
322
332
### SSH Agent
323
333
324
334
The provider does not use OS-specific SSH configuration files, such as `~/.ssh/config`.
325
-
Instead, it uses the SSH protocol directly, and supports the `SSH_AUTH_SOCK` environment variable (or `agent_socket` argument) to connect to the `ssh-agent`.
335
+
Instead, it uses the SSH protocol directly, and supports the `SSH_AUTH_SOCK` environment variable (or `agent_socket` argument) to connect to the SSH agent.
326
336
This allows the provider to use the SSH agent configured by the user, and to support multiple SSH agents running on the same machine.
327
337
You can find more details on the SSH Agent [here](https://www.digitalocean.com/community/tutorials/ssh-essentials-working-with-ssh-servers-clients-and-keys#adding-your-ssh-keys-to-an-ssh-agent-to-avoid-typing-the-passphrase).
328
338
The SSH agent authentication takes precedence over the `private_key` and `password` authentication.
@@ -436,7 +446,7 @@ In the example below, we create a user `terraform` and assign the `sudo` privile
436
446
437
447
You should be able to connect to the target node and see the output containing `APIVER <number>` on the screen without being prompted for your password.
438
448
439
-
Alternatively if`pam_ssh_agent_auth` is configured on the target node the SSH Config option `agent_forwarding` may be used to forward the SSH Agent that was used for the connection to the remote server. This can allow `sudo` without a password which validates public ssh key configured for`pam_ssh_agent_auth`.
449
+
Alternatively if`pam_ssh_agent_auth` is configured on the target node the SSH Config option `agent_forwarding` may be used to forward the SSH agent that was used for the connection to the remote server. This can allow `sudo` without a password which validates public SSH key configured for`pam_ssh_agent_auth`.
-`pool_id` - (Optional) The identifier for a pool to assign the container to.
228
+
-`pool_id` - (Optional, **Deprecated**) The identifier for a pool to assign the container to.
229
+
This field is deprecated and will be removed in a future release. To assign the container to a pool, use the `proxmox_virtual_environment_pool_membership` resource instead.
229
230
-`protection` - (Optional) Whether to set the protection flag of the container (defaults to `false`). This will prevent the container itself and its disk for remove/update operations.
230
231
-`started` - (Optional) Whether to start the container (defaults to `true`).
231
232
-`startup` - (Optional) Defines startup and shutdown behavior of the container.
-`pool_id` - (Optional) The identifier for a pool to assign the virtual machine to.
506
+
-`pool_id` - (Optional, **Deprecated**) The identifier for a pool to assign the virtual machine to.
507
+
This field is deprecated and will be removed in a future release. To assign the VM to a pool, use the `proxmox_virtual_environment_pool_membership` resource instead.
507
508
-`protection` - (Optional) Sets the protection flag of the VM. This will disable the remove VM and remove disk operations (defaults to `false`).
508
509
-`reboot` - (Optional) Reboot the VM after initial creation (defaults to `false`).
509
510
-`reboot_after_update` - (Optional) Reboot the VM after update if needed (defaults to `true`).
0 commit comments