1. Packages
  2. Strata Cloud Manager Provider
  3. API Docs
  4. DhcpInterface
Strata Cloud Manager v1.0.3 published on Thursday, Jan 22, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-scm

scm.DhcpInterface

scm logo
Strata Cloud Manager v1.0.3 published on Thursday, Jan 22, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-scm

    DhcpInterface resource

    Example Usage

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

const dhcpServerExample = new scm.DhcpInterface("dhcp_server_example", {
    folder: "ngfw-shared",
    name: "$test-interface-must-exist",
    server: {
        ipPools: ["10.10.10.10-10.10.10.200"],
        mode: "auto",
        probeIp: true,
        option: {
            dns: {
                primary: "8.8.8.8",
                secondary: "1.1.1.1",
            },
            dnsSuffix: "example.local",
            gateway: "10.10.10.1",
            subnetMask: "255.255.255.0",
            pop3Server: "192.0.2.25",
            smtpServer: "192.0.2.26",
            lease: {
                timeout: 3600,
            },
            ntp: {
                primary: "129.6.15.28",
                secondary: "132.163.96.1",
            },
            wins: {
                primary: "192.168.1.1",
                secondary: "192.168.1.2",
            },
            nis: {
                primary: "192.0.2.10",
                secondary: "192.0.2.11",
            },
            userDefineds: [{
                inherited: true,
                name: "option-foo",
                code: 224,
                ip: ["192.0.2.10"],
            }],
        },
        reserveds: [{
            description: "Reserved lease for printer",
            mac: "aa:bb:cc:dd:ee:ff",
            name: "10.10.10.50",
        }],
    },
});

    import pulumi
import pulumi_scm as scm

dhcp_server_example = scm.DhcpInterface("dhcp_server_example",
    folder="ngfw-shared",
    name="$test-interface-must-exist",
    server={
        "ip_pools": ["10.10.10.10-10.10.10.200"],
        "mode": "auto",
        "probe_ip": True,
        "option": {
            "dns": {
                "primary": "8.8.8.8",
                "secondary": "1.1.1.1",
            },
            "dns_suffix": "example.local",
            "gateway": "10.10.10.1",
            "subnet_mask": "255.255.255.0",
            "pop3_server": "192.0.2.25",
            "smtp_server": "192.0.2.26",
            "lease": {
                "timeout": 3600,
            },
            "ntp": {
                "primary": "129.6.15.28",
                "secondary": "132.163.96.1",
            },
            "wins": {
                "primary": "192.168.1.1",
                "secondary": "192.168.1.2",
            },
            "nis": {
                "primary": "192.0.2.10",
                "secondary": "192.0.2.11",
            },
            "user_defineds": [{
                "inherited": True,
                "name": "option-foo",
                "code": 224,
                "ip": ["192.0.2.10"],
            }],
        },
        "reserveds": [{
            "description": "Reserved lease for printer",
            "mac": "aa:bb:cc:dd:ee:ff",
            "name": "10.10.10.50",
        }],
    })

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := scm.NewDhcpInterface(ctx, "dhcp_server_example", &scm.DhcpInterfaceArgs{
			Folder: pulumi.String("ngfw-shared"),
			Name:   pulumi.String("$test-interface-must-exist"),
			Server: &scm.DhcpInterfaceServerArgs{
				IpPools: pulumi.StringArray{
					pulumi.String("10.10.10.10-10.10.10.200"),
				},
				Mode:    pulumi.String("auto"),
				ProbeIp: pulumi.Bool(true),
				Option: &scm.DhcpInterfaceServerOptionArgs{
					Dns: &scm.DhcpInterfaceServerOptionDnsArgs{
						Primary:   pulumi.String("8.8.8.8"),
						Secondary: pulumi.String("1.1.1.1"),
					},
					DnsSuffix:  pulumi.String("example.local"),
					Gateway:    pulumi.String("10.10.10.1"),
					SubnetMask: pulumi.String("255.255.255.0"),
					Pop3Server: pulumi.String("192.0.2.25"),
					SmtpServer: pulumi.String("192.0.2.26"),
					Lease: &scm.DhcpInterfaceServerOptionLeaseArgs{
						Timeout: pulumi.Int(3600),
					},
					Ntp: &scm.DhcpInterfaceServerOptionNtpArgs{
						Primary:   pulumi.String("129.6.15.28"),
						Secondary: pulumi.String("132.163.96.1"),
					},
					Wins: &scm.DhcpInterfaceServerOptionWinsArgs{
						Primary:   pulumi.String("192.168.1.1"),
						Secondary: pulumi.String("192.168.1.2"),
					},
					Nis: &scm.DhcpInterfaceServerOptionNisArgs{
						Primary:   pulumi.String("192.0.2.10"),
						Secondary: pulumi.String("192.0.2.11"),
					},
					UserDefineds: scm.DhcpInterfaceServerOptionUserDefinedArray{
						&scm.DhcpInterfaceServerOptionUserDefinedArgs{
							Inherited: pulumi.Bool(true),
							Name:      pulumi.String("option-foo"),
							Code:      pulumi.Int(224),
							Ip: []string{
								"192.0.2.10",
							},
						},
					},
				},
				Reserveds: scm.DhcpInterfaceServerReservedArray{
					&scm.DhcpInterfaceServerReservedArgs{
						Description: pulumi.String("Reserved lease for printer"),
						Mac:         pulumi.String("aa:bb:cc:dd:ee:ff"),
						Name:        pulumi.String("10.10.10.50"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var dhcpServerExample = new Scm.DhcpInterface("dhcp_server_example", new()
    {
        Folder = "ngfw-shared",
        Name = "$test-interface-must-exist",
        Server = new Scm.Inputs.DhcpInterfaceServerArgs
        {
            IpPools = new[]
            {
                "10.10.10.10-10.10.10.200",
            },
            Mode = "auto",
            ProbeIp = true,
            Option = new Scm.Inputs.DhcpInterfaceServerOptionArgs
            {
                Dns = new Scm.Inputs.DhcpInterfaceServerOptionDnsArgs
                {
                    Primary = "8.8.8.8",
                    Secondary = "1.1.1.1",
                },
                DnsSuffix = "example.local",
                Gateway = "10.10.10.1",
                SubnetMask = "255.255.255.0",
                Pop3Server = "192.0.2.25",
                SmtpServer = "192.0.2.26",
                Lease = new Scm.Inputs.DhcpInterfaceServerOptionLeaseArgs
                {
                    Timeout = 3600,
                },
                Ntp = new Scm.Inputs.DhcpInterfaceServerOptionNtpArgs
                {
                    Primary = "129.6.15.28",
                    Secondary = "132.163.96.1",
                },
                Wins = new Scm.Inputs.DhcpInterfaceServerOptionWinsArgs
                {
                    Primary = "192.168.1.1",
                    Secondary = "192.168.1.2",
                },
                Nis = new Scm.Inputs.DhcpInterfaceServerOptionNisArgs
                {
                    Primary = "192.0.2.10",
                    Secondary = "192.0.2.11",
                },
                UserDefineds = new[]
                {
                    new Scm.Inputs.DhcpInterfaceServerOptionUserDefinedArgs
                    {
                        Inherited = true,
                        Name = "option-foo",
                        Code = 224,
                        Ip = new[]
                        {
                            "192.0.2.10",
                        },
                    },
                },
            },
            Reserveds = new[]
            {
                new Scm.Inputs.DhcpInterfaceServerReservedArgs
                {
                    Description = "Reserved lease for printer",
                    Mac = "aa:bb:cc:dd:ee:ff",
                    Name = "10.10.10.50",
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.DhcpInterface;
import com.pulumi.scm.DhcpInterfaceArgs;
import com.pulumi.scm.inputs.DhcpInterfaceServerArgs;
import com.pulumi.scm.inputs.DhcpInterfaceServerOptionArgs;
import com.pulumi.scm.inputs.DhcpInterfaceServerOptionDnsArgs;
import com.pulumi.scm.inputs.DhcpInterfaceServerOptionLeaseArgs;
import com.pulumi.scm.inputs.DhcpInterfaceServerOptionNtpArgs;
import com.pulumi.scm.inputs.DhcpInterfaceServerOptionWinsArgs;
import com.pulumi.scm.inputs.DhcpInterfaceServerOptionNisArgs;
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) {
        var dhcpServerExample = new DhcpInterface("dhcpServerExample", DhcpInterfaceArgs.builder()
            .folder("ngfw-shared")
            .name("$test-interface-must-exist")
            .server(DhcpInterfaceServerArgs.builder()
                .ipPools("10.10.10.10-10.10.10.200")
                .mode("auto")
                .probeIp(true)
                .option(DhcpInterfaceServerOptionArgs.builder()
                    .dns(DhcpInterfaceServerOptionDnsArgs.builder()
                        .primary("8.8.8.8")
                        .secondary("1.1.1.1")
                        .build())
                    .dnsSuffix("example.local")
                    .gateway("10.10.10.1")
                    .subnetMask("255.255.255.0")
                    .pop3Server("192.0.2.25")
                    .smtpServer("192.0.2.26")
                    .lease(DhcpInterfaceServerOptionLeaseArgs.builder()
                        .timeout(3600)
                        .build())
                    .ntp(DhcpInterfaceServerOptionNtpArgs.builder()
                        .primary("129.6.15.28")
                        .secondary("132.163.96.1")
                        .build())
                    .wins(DhcpInterfaceServerOptionWinsArgs.builder()
                        .primary("192.168.1.1")
                        .secondary("192.168.1.2")
                        .build())
                    .nis(DhcpInterfaceServerOptionNisArgs.builder()
                        .primary("192.0.2.10")
                        .secondary("192.0.2.11")
                        .build())
                    .userDefineds(DhcpInterfaceServerOptionUserDefinedArgs.builder()
                        .inherited(true)
                        .name("option-foo")
                        .code(224)
                        .ip(List.of("192.0.2.10"))
                        .build())
                    .build())
                .reserveds(DhcpInterfaceServerReservedArgs.builder()
                    .description("Reserved lease for printer")
                    .mac("aa:bb:cc:dd:ee:ff")
                    .name("10.10.10.50")
                    .build())
                .build())
            .build());

    }
}

    resources:
  dhcpServerExample:
    type: scm:DhcpInterface
    name: dhcp_server_example
    properties:
      folder: ngfw-shared
      name: $test-interface-must-exist
      server:
        ipPools:
          - 10.10.10.10-10.10.10.200
        mode: auto
        probeIp: true
        option:
          dns:
            primary: 8.8.8.8
            secondary: 1.1.1.1
          dnsSuffix: example.local
          gateway: 10.10.10.1
          subnetMask: 255.255.255.0
          pop3Server: 192.0.2.25
          smtpServer: 192.0.2.26
          lease:
            timeout: 3600
          ntp:
            primary: 129.6.15.28
            secondary: 132.163.96.1
          wins:
            primary: 192.168.1.1
            secondary: 192.168.1.2
          nis:
            primary: 192.0.2.10
            secondary: 192.0.2.11
          userDefineds:
            - inherited: true
              name: option-foo
              code: 224
              ip:
                - 192.0.2.10
        reserveds:
          - description: Reserved lease for printer
            mac: aa:bb:cc:dd:ee:ff
            name: 10.10.10.50

    Create DhcpInterface Resource

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

    Constructor syntax

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

@overload
def DhcpInterface(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  device: Optional[str] = None,
                  folder: Optional[str] = None,
                  name: Optional[str] = None,
                  relay: Optional[DhcpInterfaceRelayArgs] = None,
                  server: Optional[DhcpInterfaceServerArgs] = None,
                  snippet: Optional[str] = None)
    func NewDhcpInterface(ctx *Context, name string, args *DhcpInterfaceArgs, opts ...ResourceOption) (*DhcpInterface, error)
    public DhcpInterface(string name, DhcpInterfaceArgs? args = null, CustomResourceOptions? opts = null)
    public DhcpInterface(String name, DhcpInterfaceArgs args)
public DhcpInterface(String name, DhcpInterfaceArgs args, CustomResourceOptions options)

    type: scm:DhcpInterface
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 DhcpInterfaceArgs
    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 DhcpInterfaceArgs
    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 DhcpInterfaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DhcpInterfaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DhcpInterfaceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var dhcpInterfaceResource = new Scm.DhcpInterface("dhcpInterfaceResource", new()
{
    Device = "string",
    Folder = "string",
    Name = "string",
    Relay = new Scm.Inputs.DhcpInterfaceRelayArgs
    {
        Ip = new Scm.Inputs.DhcpInterfaceRelayIpArgs
        {
            Enabled = false,
            Servers = new[]
            {
                "string",
            },
        },
    },
    Server = new Scm.Inputs.DhcpInterfaceServerArgs
    {
        IpPools = new[]
        {
            "string",
        },
        Mode = "string",
        Option = new Scm.Inputs.DhcpInterfaceServerOptionArgs
        {
            Dns = new Scm.Inputs.DhcpInterfaceServerOptionDnsArgs
            {
                Primary = "string",
                Secondary = "string",
            },
            DnsSuffix = "string",
            Gateway = "string",
            Inheritance = new Scm.Inputs.DhcpInterfaceServerOptionInheritanceArgs
            {
                Source = "string",
            },
            Lease = new Scm.Inputs.DhcpInterfaceServerOptionLeaseArgs
            {
                Timeout = 0,
                Unlimited = null,
            },
            Nis = new Scm.Inputs.DhcpInterfaceServerOptionNisArgs
            {
                Primary = "string",
                Secondary = "string",
            },
            Ntp = new Scm.Inputs.DhcpInterfaceServerOptionNtpArgs
            {
                Primary = "string",
                Secondary = "string",
            },
            Pop3Server = "string",
            SmtpServer = "string",
            SubnetMask = "string",
            UserDefineds = new[]
            {
                new Scm.Inputs.DhcpInterfaceServerOptionUserDefinedArgs
                {
                    Inherited = false,
                    Name = "string",
                    Asciis = new[]
                    {
                        "string",
                    },
                    Code = 0,
                    Hexes = new[]
                    {
                        "string",
                    },
                    Ips = new[]
                    {
                        "string",
                    },
                },
            },
            Wins = new Scm.Inputs.DhcpInterfaceServerOptionWinsArgs
            {
                Primary = "string",
                Secondary = "string",
            },
        },
        ProbeIp = false,
        Reserveds = new[]
        {
            new Scm.Inputs.DhcpInterfaceServerReservedArgs
            {
                Description = "string",
                Mac = "string",
                Name = "string",
            },
        },
    },
    Snippet = "string",
});

    example, err := scm.NewDhcpInterface(ctx, "dhcpInterfaceResource", &scm.DhcpInterfaceArgs{
	Device: pulumi.String("string"),
	Folder: pulumi.String("string"),
	Name:   pulumi.String("string"),
	Relay: &scm.DhcpInterfaceRelayArgs{
		Ip: &scm.DhcpInterfaceRelayIpArgs{
			Enabled: pulumi.Bool(false),
			Servers: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Server: &scm.DhcpInterfaceServerArgs{
		IpPools: pulumi.StringArray{
			pulumi.String("string"),
		},
		Mode: pulumi.String("string"),
		Option: &scm.DhcpInterfaceServerOptionArgs{
			Dns: &scm.DhcpInterfaceServerOptionDnsArgs{
				Primary:   pulumi.String("string"),
				Secondary: pulumi.String("string"),
			},
			DnsSuffix: pulumi.String("string"),
			Gateway:   pulumi.String("string"),
			Inheritance: &scm.DhcpInterfaceServerOptionInheritanceArgs{
				Source: pulumi.String("string"),
			},
			Lease: &scm.DhcpInterfaceServerOptionLeaseArgs{
				Timeout:   pulumi.Int(0),
				Unlimited: &scm.DhcpInterfaceServerOptionLeaseUnlimitedArgs{},
			},
			Nis: &scm.DhcpInterfaceServerOptionNisArgs{
				Primary:   pulumi.String("string"),
				Secondary: pulumi.String("string"),
			},
			Ntp: &scm.DhcpInterfaceServerOptionNtpArgs{
				Primary:   pulumi.String("string"),
				Secondary: pulumi.String("string"),
			},
			Pop3Server: pulumi.String("string"),
			SmtpServer: pulumi.String("string"),
			SubnetMask: pulumi.String("string"),
			UserDefineds: scm.DhcpInterfaceServerOptionUserDefinedArray{
				&scm.DhcpInterfaceServerOptionUserDefinedArgs{
					Inherited: pulumi.Bool(false),
					Name:      pulumi.String("string"),
					Asciis: pulumi.StringArray{
						pulumi.String("string"),
					},
					Code: pulumi.Int(0),
					Hexes: pulumi.StringArray{
						pulumi.String("string"),
					},
					Ips: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
			},
			Wins: &scm.DhcpInterfaceServerOptionWinsArgs{
				Primary:   pulumi.String("string"),
				Secondary: pulumi.String("string"),
			},
		},
		ProbeIp: pulumi.Bool(false),
		Reserveds: scm.DhcpInterfaceServerReservedArray{
			&scm.DhcpInterfaceServerReservedArgs{
				Description: pulumi.String("string"),
				Mac:         pulumi.String("string"),
				Name:        pulumi.String("string"),
			},
		},
	},
	Snippet: pulumi.String("string"),
})

    var dhcpInterfaceResource = new DhcpInterface("dhcpInterfaceResource", DhcpInterfaceArgs.builder()
    .device("string")
    .folder("string")
    .name("string")
    .relay(DhcpInterfaceRelayArgs.builder()
        .ip(DhcpInterfaceRelayIpArgs.builder()
            .enabled(false)
            .servers("string")
            .build())
        .build())
    .server(DhcpInterfaceServerArgs.builder()
        .ipPools("string")
        .mode("string")
        .option(DhcpInterfaceServerOptionArgs.builder()
            .dns(DhcpInterfaceServerOptionDnsArgs.builder()
                .primary("string")
                .secondary("string")
                .build())
            .dnsSuffix("string")
            .gateway("string")
            .inheritance(DhcpInterfaceServerOptionInheritanceArgs.builder()
                .source("string")
                .build())
            .lease(DhcpInterfaceServerOptionLeaseArgs.builder()
                .timeout(0)
                .unlimited(DhcpInterfaceServerOptionLeaseUnlimitedArgs.builder()
                    .build())
                .build())
            .nis(DhcpInterfaceServerOptionNisArgs.builder()
                .primary("string")
                .secondary("string")
                .build())
            .ntp(DhcpInterfaceServerOptionNtpArgs.builder()
                .primary("string")
                .secondary("string")
                .build())
            .pop3Server("string")
            .smtpServer("string")
            .subnetMask("string")
            .userDefineds(DhcpInterfaceServerOptionUserDefinedArgs.builder()
                .inherited(false)
                .name("string")
                .asciis("string")
                .code(0)
                .hexes("string")
                .ips("string")
                .build())
            .wins(DhcpInterfaceServerOptionWinsArgs.builder()
                .primary("string")
                .secondary("string")
                .build())
            .build())
        .probeIp(false)
        .reserveds(DhcpInterfaceServerReservedArgs.builder()
            .description("string")
            .mac("string")
            .name("string")
            .build())
        .build())
    .snippet("string")
    .build());

    dhcp_interface_resource = scm.DhcpInterface("dhcpInterfaceResource",
    device="string",
    folder="string",
    name="string",
    relay={
        "ip": {
            "enabled": False,
            "servers": ["string"],
        },
    },
    server={
        "ip_pools": ["string"],
        "mode": "string",
        "option": {
            "dns": {
                "primary": "string",
                "secondary": "string",
            },
            "dns_suffix": "string",
            "gateway": "string",
            "inheritance": {
                "source": "string",
            },
            "lease": {
                "timeout": 0,
                "unlimited": {},
            },
            "nis": {
                "primary": "string",
                "secondary": "string",
            },
            "ntp": {
                "primary": "string",
                "secondary": "string",
            },
            "pop3_server": "string",
            "smtp_server": "string",
            "subnet_mask": "string",
            "user_defineds": [{
                "inherited": False,
                "name": "string",
                "asciis": ["string"],
                "code": 0,
                "hexes": ["string"],
                "ips": ["string"],
            }],
            "wins": {
                "primary": "string",
                "secondary": "string",
            },
        },
        "probe_ip": False,
        "reserveds": [{
            "description": "string",
            "mac": "string",
            "name": "string",
        }],
    },
    snippet="string")

    const dhcpInterfaceResource = new scm.DhcpInterface("dhcpInterfaceResource", {
    device: "string",
    folder: "string",
    name: "string",
    relay: {
        ip: {
            enabled: false,
            servers: ["string"],
        },
    },
    server: {
        ipPools: ["string"],
        mode: "string",
        option: {
            dns: {
                primary: "string",
                secondary: "string",
            },
            dnsSuffix: "string",
            gateway: "string",
            inheritance: {
                source: "string",
            },
            lease: {
                timeout: 0,
                unlimited: {},
            },
            nis: {
                primary: "string",
                secondary: "string",
            },
            ntp: {
                primary: "string",
                secondary: "string",
            },
            pop3Server: "string",
            smtpServer: "string",
            subnetMask: "string",
            userDefineds: [{
                inherited: false,
                name: "string",
                asciis: ["string"],
                code: 0,
                hexes: ["string"],
                ips: ["string"],
            }],
            wins: {
                primary: "string",
                secondary: "string",
            },
        },
        probeIp: false,
        reserveds: [{
            description: "string",
            mac: "string",
            name: "string",
        }],
    },
    snippet: "string",
});

    type: scm:DhcpInterface
properties:
    device: string
    folder: string
    name: string
    relay:
        ip:
            enabled: false
            servers:
                - string
    server:
        ipPools:
            - string
        mode: string
        option:
            dns:
                primary: string
                secondary: string
            dnsSuffix: string
            gateway: string
            inheritance:
                source: string
            lease:
                timeout: 0
                unlimited: {}
            nis:
                primary: string
                secondary: string
            ntp:
                primary: string
                secondary: string
            pop3Server: string
            smtpServer: string
            subnetMask: string
            userDefineds:
                - asciis:
                    - string
                  code: 0
                  hexes:
                    - string
                  inherited: false
                  ips:
                    - string
                  name: string
            wins:
                primary: string
                secondary: string
        probeIp: false
        reserveds:
            - description: string
              mac: string
              name: string
    snippet: string

    DhcpInterface 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 DhcpInterface resource accepts the following input properties:

    Device string
    The device in which the resource is defined
    Folder string

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    Name string
    Interface name
    Relay DhcpInterfaceRelay

    Relay

    ℹ️ Note: You must specify exactly one of relay and server.

    Server DhcpInterfaceServer

    Server

    ℹ️ Note: You must specify exactly one of relay and server.

    Snippet string

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    Device string
    The device in which the resource is defined
    Folder string

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    Name string
    Interface name
    Relay DhcpInterfaceRelayArgs

    Relay

    ℹ️ Note: You must specify exactly one of relay and server.

    Server DhcpInterfaceServerArgs

    Server

    ℹ️ Note: You must specify exactly one of relay and server.

    Snippet string

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    device String
    The device in which the resource is defined
    folder String

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    name String
    Interface name
    relay DhcpInterfaceRelay

    Relay

    ℹ️ Note: You must specify exactly one of relay and server.

    server DhcpInterfaceServer

    Server

    ℹ️ Note: You must specify exactly one of relay and server.

    snippet String

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    device string
    The device in which the resource is defined
    folder string

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    name string
    Interface name
    relay DhcpInterfaceRelay

    Relay

    ℹ️ Note: You must specify exactly one of relay and server.

    server DhcpInterfaceServer

    Server

    ℹ️ Note: You must specify exactly one of relay and server.

    snippet string

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    device str
    The device in which the resource is defined
    folder str

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    name str
    Interface name
    relay DhcpInterfaceRelayArgs

    Relay

    ℹ️ Note: You must specify exactly one of relay and server.

    server DhcpInterfaceServerArgs

    Server

    ℹ️ Note: You must specify exactly one of relay and server.

    snippet str

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    device String
    The device in which the resource is defined
    folder String

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    name String
    Interface name
    relay Property Map

    Relay

    ℹ️ Note: You must specify exactly one of relay and server.

    server Property Map

    Server

    ℹ️ Note: You must specify exactly one of relay and server.

    snippet String

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    Outputs

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

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

    Look up Existing DhcpInterface Resource

    Get an existing DhcpInterface resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DhcpInterfaceState, opts?: CustomResourceOptions): DhcpInterface
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        device: Optional[str] = None,
        folder: Optional[str] = None,
        name: Optional[str] = None,
        relay: Optional[DhcpInterfaceRelayArgs] = None,
        server: Optional[DhcpInterfaceServerArgs] = None,
        snippet: Optional[str] = None,
        tfid: Optional[str] = None) -> DhcpInterface
    func GetDhcpInterface(ctx *Context, name string, id IDInput, state *DhcpInterfaceState, opts ...ResourceOption) (*DhcpInterface, error)
    public static DhcpInterface Get(string name, Input<string> id, DhcpInterfaceState? state, CustomResourceOptions? opts = null)
    public static DhcpInterface get(String name, Output<String> id, DhcpInterfaceState state, CustomResourceOptions options)
    resources:  _:    type: scm:DhcpInterface    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Device string
    The device in which the resource is defined
    Folder string

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    Name string
    Interface name
    Relay DhcpInterfaceRelay

    Relay

    ℹ️ Note: You must specify exactly one of relay and server.

    Server DhcpInterfaceServer

    Server

    ℹ️ Note: You must specify exactly one of relay and server.

    Snippet string

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    Tfid string
    Device string
    The device in which the resource is defined
    Folder string

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    Name string
    Interface name
    Relay DhcpInterfaceRelayArgs

    Relay

    ℹ️ Note: You must specify exactly one of relay and server.

    Server DhcpInterfaceServerArgs

    Server

    ℹ️ Note: You must specify exactly one of relay and server.

    Snippet string

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    Tfid string
    device String
    The device in which the resource is defined
    folder String

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    name String
    Interface name
    relay DhcpInterfaceRelay

    Relay

    ℹ️ Note: You must specify exactly one of relay and server.

    server DhcpInterfaceServer

    Server

    ℹ️ Note: You must specify exactly one of relay and server.

    snippet String

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    tfid String
    device string
    The device in which the resource is defined
    folder string

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    name string
    Interface name
    relay DhcpInterfaceRelay

    Relay

    ℹ️ Note: You must specify exactly one of relay and server.

    server DhcpInterfaceServer

    Server

    ℹ️ Note: You must specify exactly one of relay and server.

    snippet string

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    tfid string
    device str
    The device in which the resource is defined
    folder str

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    name str
    Interface name
    relay DhcpInterfaceRelayArgs

    Relay

    ℹ️ Note: You must specify exactly one of relay and server.

    server DhcpInterfaceServerArgs

    Server

    ℹ️ Note: You must specify exactly one of relay and server.

    snippet str

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    tfid str
    device String
    The device in which the resource is defined
    folder String

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    name String
    Interface name
    relay Property Map

    Relay

    ℹ️ Note: You must specify exactly one of relay and server.

    server Property Map

    Server

    ℹ️ Note: You must specify exactly one of relay and server.

    snippet String

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    tfid String

    Supporting Types

    DhcpInterfaceRelay, DhcpInterfaceRelayArgs

    DhcpInterfaceRelayIp, DhcpInterfaceRelayIpArgs

    Enabled bool
    Enabled?
    Servers List<string>
    Server
    Enabled bool
    Enabled?
    Servers []string
    Server
    enabled Boolean
    Enabled?
    servers List<String>
    Server
    enabled boolean
    Enabled?
    servers string[]
    Server
    enabled bool
    Enabled?
    servers Sequence[str]
    Server
    enabled Boolean
    Enabled?
    servers List<String>
    Server

    DhcpInterfaceServer, DhcpInterfaceServerArgs

    IpPools List<string>
    List of IP address pools
    Mode string
    DHCP server mode
    Option DhcpInterfaceServerOption
    Option
    ProbeIp bool
    Ping IP before allocating?
    Reserveds List<DhcpInterfaceServerReserved>
    List of IP reservations
    IpPools []string
    List of IP address pools
    Mode string
    DHCP server mode
    Option DhcpInterfaceServerOption
    Option
    ProbeIp bool
    Ping IP before allocating?
    Reserveds []DhcpInterfaceServerReserved
    List of IP reservations
    ipPools List<String>
    List of IP address pools
    mode String
    DHCP server mode
    option DhcpInterfaceServerOption
    Option
    probeIp Boolean
    Ping IP before allocating?
    reserveds List<DhcpInterfaceServerReserved>
    List of IP reservations
    ipPools string[]
    List of IP address pools
    mode string
    DHCP server mode
    option DhcpInterfaceServerOption
    Option
    probeIp boolean
    Ping IP before allocating?
    reserveds DhcpInterfaceServerReserved[]
    List of IP reservations
    ip_pools Sequence[str]
    List of IP address pools
    mode str
    DHCP server mode
    option DhcpInterfaceServerOption
    Option
    probe_ip bool
    Ping IP before allocating?
    reserveds Sequence[DhcpInterfaceServerReserved]
    List of IP reservations
    ipPools List<String>
    List of IP address pools
    mode String
    DHCP server mode
    option Property Map
    Option
    probeIp Boolean
    Ping IP before allocating?
    reserveds List<Property Map>
    List of IP reservations

    DhcpInterfaceServerOption, DhcpInterfaceServerOptionArgs

    dns Property Map
    Dns
    dnsSuffix String
    DNS suffix
    gateway String
    Default gateway
    inheritance Property Map
    Inheritance
    lease Property Map
    Lease
    nis Property Map
    Nis
    ntp Property Map
    Ntp
    pop3Server String
    POP3 server
    smtpServer String
    SMTP server
    subnetMask String
    Subnet mask
    userDefineds List<Property Map>
    Custom DHCP options
    wins Property Map
    Wins

    DhcpInterfaceServerOptionDns, DhcpInterfaceServerOptionDnsArgs

    Primary string
    Primary DNS server
    Secondary string
    Secondary DNS server
    Primary string
    Primary DNS server
    Secondary string
    Secondary DNS server
    primary String
    Primary DNS server
    secondary String
    Secondary DNS server
    primary string
    Primary DNS server
    secondary string
    Secondary DNS server
    primary str
    Primary DNS server
    secondary str
    Secondary DNS server
    primary String
    Primary DNS server
    secondary String
    Secondary DNS server

    DhcpInterfaceServerOptionInheritance, DhcpInterfaceServerOptionInheritanceArgs

    Source string
    Interface from which to inherit lease options
    Source string
    Interface from which to inherit lease options
    source String
    Interface from which to inherit lease options
    source string
    Interface from which to inherit lease options
    source str
    Interface from which to inherit lease options
    source String
    Interface from which to inherit lease options

    DhcpInterfaceServerOptionLease, DhcpInterfaceServerOptionLeaseArgs

    Timeout int
    DHCP lease timeout (minutes)
    Unlimited DhcpInterfaceServerOptionLeaseUnlimited

    Unlimited

    ℹ️ Note: You must specify exactly one of timeout and unlimited.

    Timeout int
    DHCP lease timeout (minutes)
    Unlimited DhcpInterfaceServerOptionLeaseUnlimited

    Unlimited

    ℹ️ Note: You must specify exactly one of timeout and unlimited.

    timeout Integer
    DHCP lease timeout (minutes)
    unlimited DhcpInterfaceServerOptionLeaseUnlimited

    Unlimited

    ℹ️ Note: You must specify exactly one of timeout and unlimited.

    timeout number
    DHCP lease timeout (minutes)
    unlimited DhcpInterfaceServerOptionLeaseUnlimited

    Unlimited

    ℹ️ Note: You must specify exactly one of timeout and unlimited.

    timeout int
    DHCP lease timeout (minutes)
    unlimited DhcpInterfaceServerOptionLeaseUnlimited

    Unlimited

    ℹ️ Note: You must specify exactly one of timeout and unlimited.

    timeout Number
    DHCP lease timeout (minutes)
    unlimited Property Map

    Unlimited

    ℹ️ Note: You must specify exactly one of timeout and unlimited.

    DhcpInterfaceServerOptionNis, DhcpInterfaceServerOptionNisArgs

    Primary string
    Primary NIS server
    Secondary string
    Secondary NIS server
    Primary string
    Primary NIS server
    Secondary string
    Secondary NIS server
    primary String
    Primary NIS server
    secondary String
    Secondary NIS server
    primary string
    Primary NIS server
    secondary string
    Secondary NIS server
    primary str
    Primary NIS server
    secondary str
    Secondary NIS server
    primary String
    Primary NIS server
    secondary String
    Secondary NIS server

    DhcpInterfaceServerOptionNtp, DhcpInterfaceServerOptionNtpArgs

    Primary string
    Primary NTP server
    Secondary string
    Secondary NTP server
    Primary string
    Primary NTP server
    Secondary string
    Secondary NTP server
    primary String
    Primary NTP server
    secondary String
    Secondary NTP server
    primary string
    Primary NTP server
    secondary string
    Secondary NTP server
    primary str
    Primary NTP server
    secondary str
    Secondary NTP server
    primary String
    Primary NTP server
    secondary String
    Secondary NTP server

    DhcpInterfaceServerOptionUserDefined, DhcpInterfaceServerOptionUserDefinedArgs

    Inherited bool
    Inherited from DHCP server inheritance source?
    Name string
    Option name
    Asciis List<string>
    Ascii
    Code int
    Option code
    Hexes List<string>
    Hex
    Ips List<string>
    Ip
    Inherited bool
    Inherited from DHCP server inheritance source?
    Name string
    Option name
    Asciis []string
    Ascii
    Code int
    Option code
    Hexes []string
    Hex
    Ips []string
    Ip
    inherited Boolean
    Inherited from DHCP server inheritance source?
    name String
    Option name
    asciis List<String>
    Ascii
    code Integer
    Option code
    hexes List<String>
    Hex
    ips List<String>
    Ip
    inherited boolean
    Inherited from DHCP server inheritance source?
    name string
    Option name
    asciis string[]
    Ascii
    code number
    Option code
    hexes string[]
    Hex
    ips string[]
    Ip
    inherited bool
    Inherited from DHCP server inheritance source?
    name str
    Option name
    asciis Sequence[str]
    Ascii
    code int
    Option code
    hexes Sequence[str]
    Hex
    ips Sequence[str]
    Ip
    inherited Boolean
    Inherited from DHCP server inheritance source?
    name String
    Option name
    asciis List<String>
    Ascii
    code Number
    Option code
    hexes List<String>
    Hex
    ips List<String>
    Ip

    DhcpInterfaceServerOptionWins, DhcpInterfaceServerOptionWinsArgs

    Primary string
    Primary WINS server
    Secondary string
    Secondary WINS server
    Primary string
    Primary WINS server
    Secondary string
    Secondary WINS server
    primary String
    Primary WINS server
    secondary String
    Secondary WINS server
    primary string
    Primary WINS server
    secondary string
    Secondary WINS server
    primary str
    Primary WINS server
    secondary str
    Secondary WINS server
    primary String
    Primary WINS server
    secondary String
    Secondary WINS server

    DhcpInterfaceServerReserved, DhcpInterfaceServerReservedArgs

    Description string
    Reservation description
    Mac string
    Reserved MAC address
    Name string
    Reserved IP address
    Description string
    Reservation description
    Mac string
    Reserved MAC address
    Name string
    Reserved IP address
    description String
    Reservation description
    mac String
    Reserved MAC address
    name String
    Reserved IP address
    description string
    Reservation description
    mac string
    Reserved MAC address
    name string
    Reserved IP address
    description str
    Reservation description
    mac str
    Reserved MAC address
    name str
    Reserved IP address
    description String
    Reservation description
    mac String
    Reserved MAC address
    name String
    Reserved IP address

    Import

    The following command can be used to import a resource not managed by Terraform:

    bash

    $ pulumi import scm:index/dhcpInterface:DhcpInterface example folder:::id

    or

    bash

    $ pulumi import scm:index/dhcpInterface:DhcpInterface example :snippet::id

    or

    bash

    $ pulumi import scm:index/dhcpInterface:DhcpInterface example ::device:id

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    scm pulumi/pulumi-scm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scm Terraform Provider.
    scm logo
    Strata Cloud Manager v1.0.3 published on Thursday, Jan 22, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-scm
      Meet Neo: Your AI Platform Teammate