Files

54 lines
1.2 KiB
Plaintext
Raw Permalink Normal View History

2014-03-24 11:20:32 +01:00
---
2017-06-14 18:04:16 -07:00
description: |
2025-01-24 14:08:16 -08:00
The `null` builder creates an SSH connection and runs provisioners. Use the `null` builder to debug provisioners without incurring long wait times.
2025-01-23 16:02:43 -08:00
page_title: null builder reference
---
2014-03-24 11:20:32 +01:00
<BadgesHeader>
<PluginBadge type="official" />
</BadgesHeader>
2025-01-23 16:02:43 -08:00
# `null` builder
2014-03-24 11:20:32 +01:00
2025-01-23 16:02:43 -08:00
The `null` builder sets up an SSH connection and runs provisioners. You can use it to debug provisioners without incurring long wait times. It does not create a images or artifacts.
2014-03-24 11:20:32 +01:00
## Basic Example
2015-07-22 19:31:00 -07:00
Below is a fully functioning example. It doesn't do anything useful, since no
provisioners are defined, but it will connect to the specified host via ssh.
2014-03-24 11:20:32 +01:00
2020-06-16 17:44:41 +02:00
<Tabs>
<Tab heading="HCL2">
```hcl
source "null" "basic-example" {
ssh_host = "127.0.0.1"
ssh_username = "foo"
ssh_password = "bar"
}
build {
sources = ["sources.null.basic-example"]
}
```
2024-12-19 21:12:49 -05:00
</Tab>
<Tab heading="JSON">
```json
{
"type": "null",
"ssh_host": "127.0.0.1",
"ssh_username": "foo",
"ssh_password": "bar"
}
```
2020-06-16 17:44:41 +02:00
</Tab>
</Tabs>
2014-03-24 11:20:32 +01:00
## Configuration Reference
The null builder has no configuration parameters other than the
2023-01-27 11:47:08 -06:00
[communicator](/packer/docs/templates/legacy_json_templates/communicator) settings.