Commit 2010a0c9 authored by Chris Bednarski's avatar Chris Bednarski

Merge pull request #2475 from tylert/gh-2474-fix-docs-uint-int-integer-and-wrap-long-lines

Fixes #2474:  Replace use of 'int' and 'uint' in website docs with 'integer' and wrap long lines
parents ee2e0396 3139d3d2
...@@ -239,7 +239,7 @@ qemu-system-x86 command. The arguments are all printed for review. ...@@ -239,7 +239,7 @@ qemu-system-x86 command. The arguments are all printed for review.
If it doesn't shut down in this time, it is an error. By default, the timeout If it doesn't shut down in this time, it is an error. By default, the timeout
is "5m", or five minutes. is "5m", or five minutes.
* `ssh_host_port_min` and `ssh_host_port_max` (uint) - The minimum and * `ssh_host_port_min` and `ssh_host_port_max` (integer) - The minimum and
maximum port to use for the SSH port on the host machine which is forwarded maximum port to use for the SSH port on the host machine which is forwarded
to the SSH port on the guest machine. Because Packer often runs in parallel, to the SSH port on the guest machine. Because Packer often runs in parallel,
Packer will choose a randomly available port in this range to use as the Packer will choose a randomly available port in this range to use as the
......
...@@ -57,7 +57,7 @@ The SSH communicator has the following options: ...@@ -57,7 +57,7 @@ The SSH communicator has the following options:
* `ssh_host` (string) - The address to SSH to. This usually is automatically * `ssh_host` (string) - The address to SSH to. This usually is automatically
configured by the builder. configured by the builder.
* `ssh_port` (int) - The port to connect to SSH. This defaults to 22. * `ssh_port` (integer) - The port to connect to SSH. This defaults to 22.
* `ssh_username` (string) - The username to connect to SSH with. * `ssh_username` (string) - The username to connect to SSH with.
...@@ -67,24 +67,27 @@ The SSH communicator has the following options: ...@@ -67,24 +67,27 @@ The SSH communicator has the following options:
* `ssh_private_key_file` (string) - Path to a PEM encoded private key * `ssh_private_key_file` (string) - Path to a PEM encoded private key
file to use to authentiate with SSH. file to use to authentiate with SSH.
* `ssh_pty` (boolean) - If true, a PTY will be requested for the SSH connection. * `ssh_pty` (boolean) - If true, a PTY will be requested for the SSH
This defaults to false. connection. This defaults to false.
* `ssh_timeout` (string) - The time to wait for SSH to become available. * `ssh_timeout` (string) - The time to wait for SSH to become available.
Packer uses this to determine when the machine has booted so this is usually Packer uses this to determine when the machine has booted so this is
quite long. Example value: "10m" usually quite long. Example value: "10m"
* `ssh_handshake_attempts` (int) - The number of handshakes to attempt with * `ssh_handshake_attempts` (integer) - The number of handshakes to attempt
SSH once it can connect. This defaults to 10. with SSH once it can connect. This defaults to 10.
* `ssh_disable_agent` (boolean) - If true, SSH agent forwarding will be disabled. * `ssh_disable_agent` (boolean) - If true, SSH agent forwarding will be
disabled.
* `ssh_bastion_host` (string) - A bastion host to use for the actual * `ssh_bastion_host` (string) - A bastion host to use for the actual
SSH connection. SSH connection.
* `ssh_bastion_port` (int) - The port of the bastion host. Defaults to 22. * `ssh_bastion_port` (integer) - The port of the bastion host. Defaults to
22.
* `ssh_bastion_username` (string) - The username to connect to the bastion host. * `ssh_bastion_username` (string) - The username to connect to the bastion
host.
* `ssh_bastion_password` (string) - The password to use to authenticate * `ssh_bastion_password` (string) - The password to use to authenticate
with the bastion host. with the bastion host.
...@@ -98,7 +101,8 @@ The WinRM communicator has the following options. ...@@ -98,7 +101,8 @@ The WinRM communicator has the following options.
* `winrm_host` (string) - The address for WinRM to connect to. * `winrm_host` (string) - The address for WinRM to connect to.
* `winrm_port` (int) - The WinRM port to connect to. This defaults to 5985. * `winrm_port` (integer) - The WinRM port to connect to. This defaults to
5985.
* `winrm_username` (string) - The username to use to connect to WinRM. * `winrm_username` (string) - The username to use to connect to WinRM.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment