Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Netbox Provider
  3. API Docs
  4. Provider
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
e-breuninger/terraform-provider-netbox

netbox.Provider

Explore with Pulumi AI

netbox logo
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
e-breuninger/terraform-provider-netbox

    The provider type for the netbox package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

    Create Provider Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Provider(name: string, args: ProviderArgs, opts?: CustomResourceOptions);
    @overload
def Provider(resource_name: str,
             args: ProviderArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             allow_insecure_https: Optional[bool] = None,
             api_token: Optional[str] = None,
             headers: Optional[Mapping[str, str]] = None,
             request_timeout: Optional[float] = None,
             server_url: Optional[str] = None,
             skip_version_check: Optional[bool] = None,
             strip_trailing_slashes_from_url: Optional[bool] = None)
    func NewProvider(ctx *Context, name string, args ProviderArgs, opts ...ResourceOption) (*Provider, error)
    public Provider(string name, ProviderArgs args, CustomResourceOptions? opts = null)
    public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

    type: pulumi:providers:netbox
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Provider Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Provider resource accepts the following input properties:

    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 bool
    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 Dictionary<string, string>
    Set these header on all requests to Netbox. Can be set via the NETBOX_HEADERS environment variable.
    RequestTimeout double
    Netbox API HTTP request timeout in seconds. Can be set via the NETBOX_REQUEST_TIMEOUT environment variable.
    SkipVersionCheck bool
    StripTrailingSlashesFromUrl bool
    If true, strip trailing slashes from the server_url parameter and print a warning when doing so. Note that using trailing slashes in the server_url parameter will usually lead to errors. Can be set via the NETBOX_STRIP_TRAILING_SLASHES_FROM_URL environment variable. Defaults to true.
    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 bool
    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[string]string
    Set these header on all requests to Netbox. Can be set via the NETBOX_HEADERS environment variable.
    RequestTimeout float64
    Netbox API HTTP request timeout in seconds. Can be set via the NETBOX_REQUEST_TIMEOUT environment variable.
    SkipVersionCheck bool
    StripTrailingSlashesFromUrl bool
    If true, strip trailing slashes from the server_url parameter and print a warning when doing so. Note that using trailing slashes in the server_url parameter will usually lead to errors. Can be set via the NETBOX_STRIP_TRAILING_SLASHES_FROM_URL environment variable. Defaults to true.
    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<String,String>
    Set these header on all requests to Netbox. Can be set via the NETBOX_HEADERS environment variable.
    requestTimeout Double
    Netbox API HTTP request timeout in seconds. Can be set via the NETBOX_REQUEST_TIMEOUT environment variable.
    skipVersionCheck Boolean
    stripTrailingSlashesFromUrl Boolean
    If true, strip trailing slashes from the server_url parameter and print a warning when doing so. Note that using trailing slashes in the server_url parameter will usually lead to errors. Can be set via the NETBOX_STRIP_TRAILING_SLASHES_FROM_URL environment variable. Defaults to true.
    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 {[key: string]: 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
    stripTrailingSlashesFromUrl boolean
    If true, strip trailing slashes from the server_url parameter and print a warning when doing so. Note that using trailing slashes in the server_url parameter will usually lead to errors. Can be set via the NETBOX_STRIP_TRAILING_SLASHES_FROM_URL environment variable. Defaults to true.
    api_token str
    Netbox API authentication token. Can be set via the NETBOX_API_TOKEN environment variable.
    server_url str
    Location of Netbox server including scheme (http or https) and optional port. Can be set via the NETBOX_SERVER_URL environment variable.
    allow_insecure_https bool
    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 Mapping[str, str]
    Set these header on all requests to Netbox. Can be set via the NETBOX_HEADERS environment variable.
    request_timeout float
    Netbox API HTTP request timeout in seconds. Can be set via the NETBOX_REQUEST_TIMEOUT environment variable.
    skip_version_check bool
    strip_trailing_slashes_from_url bool
    If true, strip trailing slashes from the server_url parameter and print a warning when doing so. Note that using trailing slashes in the server_url parameter will usually lead to errors. Can be set via the NETBOX_STRIP_TRAILING_SLASHES_FROM_URL environment variable. Defaults to true.
    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<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
    stripTrailingSlashesFromUrl Boolean
    If true, strip trailing slashes from the server_url parameter and print a warning when doing so. Note that using trailing slashes in the server_url parameter will usually lead to errors. Can be set via the NETBOX_STRIP_TRAILING_SLASHES_FROM_URL environment variable. Defaults to true.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Provider resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

    Repository
    netbox e-breuninger/terraform-provider-netbox
    License
    Notes
    This Pulumi package is based on the netbox Terraform Provider.
    netbox logo
    netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
    e-breuninger/terraform-provider-netbox