Netbox Provider

Generate Provider

The Netbox provider must be installed as a Local Package by following the instructions for Any Terraform Provider:

pulumi package add terraform-provider e-breuninger/netbox

Overview

The Pulumi Netbox provider is a plugin for Pulumi that allows for the full lifecycle management of Netbox resources.

Use the navigation to the left to read about the available resources.

Supported Netbox versions

Netbox often makes breaking API changes even in non-major releases. Check the table below to see which version this provider is compatible with your Netbox version. It is generally recommended to use the provider version matching your Netbox version.

Additionally, since version 1.6.6, each version of the provider has a built-in list of all Netbox versions it supports at release time. Upon initialization, the provider will probe your Netbox version and include a (non-blocking) warning if the used Netbox version is not supported.

Configuration

You must configure the provider with proper credentials before you can use it. You can configure the provider via attributes in the provider configuration or via environment variables. See Schema for all configuration options

Example Usage

# Pulumi.yaml provider configuration file
name: configuration-example
runtime: nodejs
config:
    netbox:apiToken:
        value: <your api key>
    netbox:serverUrl:
        value: https://demo.netbox.dev

import * as pulumi from "@pulumi/pulumi";

# Pulumi.yaml provider configuration file
name: configuration-example
runtime: python
config:
    netbox:apiToken:
        value: <your api key>
    netbox:serverUrl:
        value: https://demo.netbox.dev

import pulumi

# Pulumi.yaml provider configuration file
name: configuration-example
runtime: dotnet
config:
    netbox:apiToken:
        value: <your api key>
    netbox:serverUrl:
        value: https://demo.netbox.dev

using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() =>
{
});

# Pulumi.yaml provider configuration file
name: configuration-example
runtime: go
config:
    netbox:apiToken:
        value: <your api key>
    netbox:serverUrl:
        value: https://demo.netbox.dev

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

# Pulumi.yaml provider configuration file
name: configuration-example
runtime: yaml
config:
    netbox:apiToken:
        value: <your api key>
    netbox:serverUrl:
        value: https://demo.netbox.dev

{}

# Pulumi.yaml provider configuration file
name: configuration-example
runtime: java
config:
    netbox:apiToken:
        value: <your api key>
    netbox:serverUrl:
        value: https://demo.netbox.dev

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
    }
}

Configuration Reference

Required

• apiToken (String) Netbox API authentication token. Can be set via the NETBOX_API_TOKEN environment variable.

• serverUrl (String) Location of Netbox server including scheme (http or https) and optional port. Can be set via the NETBOX_SERVER_URL environment variable.

• allowInsecureHttps (Boolean) Flag to set whether to allow https with invalid certificates. Can be set via the NETBOX_ALLOW_INSECURE_HTTPS environment variable. Defaults to false.

• headers (Map of String) Set these header on all requests to Netbox. Can be set via the NETBOX_HEADERS environment variable.

• requestTimeout (Number) Netbox API HTTP request timeout in seconds. Can be set via the NETBOX_REQUEST_TIMEOUT environment variable.

• skipVersionCheck (Boolean) If true, do not try to determine the running Netbox version at provider startup. Disables warnings about possibly unsupported Netbox version. Also useful for local testing on pulumi plans. Can be set via the NETBOX_SKIP_VERSION_CHECK environment variable. Defaults to false.

• stripTrailingSlashesFromUrl (Boolean) If true, strip trailing slashes from the serverUrl parameter and print a warning when doing so. Note that using trailing slashes in the serverUrl parameter will usually lead to errors. Can be set via the NETBOX_STRIP_TRAILING_SLASHES_FROM_URL environment variable. Defaults to true.