github.com/daniellockard/packer@v0.7.6-0.20141210173435-5a9390934716/website/source/docs/builders/null.html.markdown (about)

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