Clarify if ssh_timeout
and ssh_handshake_attempts
are mutually exclusive
#217
Labels
bug
Something isn't working
Description
The documentation says the following:
This leaves me wondering:
ssh_timeout
andssh_handshake_attempts
fields mutually exclusive? It kind of sounds like that, but it's not clear.ssh_timeout
ifssh_handshake_attempts
is set (and vice versa)? (if they are not mutually exclusive, of course).This should be clarified in the documentation.
I think that the root cause for my confusion is that the default values are explained with so many conditions. If I have understood things correctly, these are the possible states for the default values:
ssh_timeout
is setssh_handshake_attempts
is setssh_timeout
default valuessh_handshake_attempts
default valueDoes this table correctly represent all possible states? If so, I see no reason for all the conditionals in explaining the fields' default values. If my table is correct, we can simply say that "the default value for
ssh_timeout
is 5 min and the default value forssh_handshake_attempts
is 10".Use Case(s)
The documentation should be clear on how things works.
Potential References
Originally posted as hashicorp/packer-plugin-vsphere#289
The text was updated successfully, but these errors were encountered: