github.com/tonnydourado/packer@v0.6.1-0.20140701134019-5d0cd9676a37/website/source/docs/builders/null.html.markdown (about)

     1  ---
     2  layout: "docs"
     3  ---
     4  
     5  # Null Builder
     6  
     7  Type: `null`
     8  
     9  The null builder is not really a builder, it just setups a SSH connection
    10  and runs the provisioners. It can be used to debug provisioners without
    11  incurring high wait times. It does not create any kind of image or artifact.
    12  
    13  ## Basic Example
    14  
    15  Below is a fully functioning example. It doesn't do anything useful, since
    16  no provisioners are defined, but it will connect to the specified host via ssh.
    17  
    18  <pre class="prettyprint">
    19  {
    20    "type":     "null",
    21    "host":     "127.0.0.1",
    22    "ssh_username": "foo",
    23    "ssh_password": "bar"
    24  }
    25  </pre>
    26  
    27  ## Configuration Reference
    28  
    29  Configuration options are organized below into two categories: required and
    30  optional. Within each category, the available options are alphabetized and
    31  described.
    32  
    33  ### Required:
    34  
    35  * `host` (string) - The hostname or IP address to connect to.
    36  
    37  * `ssh_password` (string) - The password to be used for the ssh connection.
    38    Cannot be combined with ssh_private_key_file.
    39  
    40  * `ssh_private_key_file` (string) - The filename of the ssh private key to be
    41    used for the ssh connection. E.g. /home/user/.ssh/identity_rsa.
    42  
    43  * `ssh_username` (string) - The username to be used for the ssh connection.
    44  
    45  ### Optional:
    46  
    47  * `port` (integer) - ssh port to connect to, defaults to 22.
    48