1. Packages
  2. Strata Cloud Manager Provider
  3. API Docs
  4. getVlanInterface
Strata Cloud Manager v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi
scm logo
Strata Cloud Manager v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi

    VlanInterface data source

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scm from "@pulumi/scm";
    
    // Look up vlan interface by its ID.
    const scmVlanInterfaceDs = scm.getVlanInterface({
        id: "3f9382a3-5c93-46d9-ae06-a632c2d9ce0c",
    });
    export const vlanInterfaceDataSourceResults = {
        id: scmVlanInterfaceDs.then(scmVlanInterfaceDs => scmVlanInterfaceDs.id),
        name: scmVlanInterfaceDs.then(scmVlanInterfaceDs => scmVlanInterfaceDs.name),
        comment: scmVlanInterfaceDs.then(scmVlanInterfaceDs => scmVlanInterfaceDs.comment),
        vlanTag: scmVlanInterfaceDs.then(scmVlanInterfaceDs => scmVlanInterfaceDs.vlanTag),
        ip: scmVlanInterfaceDs.then(scmVlanInterfaceDs => scmVlanInterfaceDs.ips),
        folder: scmVlanInterfaceDs.then(scmVlanInterfaceDs => scmVlanInterfaceDs.folder),
    };
    
    import pulumi
    import pulumi_scm as scm
    
    # Look up vlan interface by its ID.
    scm_vlan_interface_ds = scm.get_vlan_interface(id="3f9382a3-5c93-46d9-ae06-a632c2d9ce0c")
    pulumi.export("vlanInterfaceDataSourceResults", {
        "id": scm_vlan_interface_ds.id,
        "name": scm_vlan_interface_ds.name,
        "comment": scm_vlan_interface_ds.comment,
        "vlanTag": scm_vlan_interface_ds.vlan_tag,
        "ip": scm_vlan_interface_ds.ips,
        "folder": scm_vlan_interface_ds.folder,
    })
    
    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 {
    		// Look up vlan interface by its ID.
    		scmVlanInterfaceDs, err := scm.LookupVlanInterface(ctx, &scm.LookupVlanInterfaceArgs{
    			Id: "3f9382a3-5c93-46d9-ae06-a632c2d9ce0c",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("vlanInterfaceDataSourceResults", pulumi.Map{
    			"id":      scmVlanInterfaceDs.Id,
    			"name":    scmVlanInterfaceDs.Name,
    			"comment": scmVlanInterfaceDs.Comment,
    			"vlanTag": scmVlanInterfaceDs.VlanTag,
    			"ip":      scmVlanInterfaceDs.Ips,
    			"folder":  scmVlanInterfaceDs.Folder,
    		})
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scm = Pulumi.Scm;
    
    return await Deployment.RunAsync(() => 
    {
        // Look up vlan interface by its ID.
        var scmVlanInterfaceDs = Scm.GetVlanInterface.Invoke(new()
        {
            Id = "3f9382a3-5c93-46d9-ae06-a632c2d9ce0c",
        });
    
        return new Dictionary<string, object?>
        {
            ["vlanInterfaceDataSourceResults"] = 
            {
                { "id", scmVlanInterfaceDs.Apply(getVlanInterfaceResult => getVlanInterfaceResult.Id) },
                { "name", scmVlanInterfaceDs.Apply(getVlanInterfaceResult => getVlanInterfaceResult.Name) },
                { "comment", scmVlanInterfaceDs.Apply(getVlanInterfaceResult => getVlanInterfaceResult.Comment) },
                { "vlanTag", scmVlanInterfaceDs.Apply(getVlanInterfaceResult => getVlanInterfaceResult.VlanTag) },
                { "ip", scmVlanInterfaceDs.Apply(getVlanInterfaceResult => getVlanInterfaceResult.Ips) },
                { "folder", scmVlanInterfaceDs.Apply(getVlanInterfaceResult => getVlanInterfaceResult.Folder) },
            },
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scm.ScmFunctions;
    import com.pulumi.scm.inputs.GetVlanInterfaceArgs;
    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) {
            // Look up vlan interface by its ID.
            final var scmVlanInterfaceDs = ScmFunctions.getVlanInterface(GetVlanInterfaceArgs.builder()
                .id("3f9382a3-5c93-46d9-ae06-a632c2d9ce0c")
                .build());
    
            ctx.export("vlanInterfaceDataSourceResults", Map.ofEntries(
                Map.entry("id", scmVlanInterfaceDs.id()),
                Map.entry("name", scmVlanInterfaceDs.name()),
                Map.entry("comment", scmVlanInterfaceDs.comment()),
                Map.entry("vlanTag", scmVlanInterfaceDs.vlanTag()),
                Map.entry("ip", scmVlanInterfaceDs.ips()),
                Map.entry("folder", scmVlanInterfaceDs.folder())
            ));
        }
    }
    
    variables:
      # Look up vlan interface by its ID.
      scmVlanInterfaceDs:
        fn::invoke:
          function: scm:getVlanInterface
          arguments:
            id: 3f9382a3-5c93-46d9-ae06-a632c2d9ce0c
    outputs:
      # Output various attributes from the found vlan interface to verify the lookups were successful.
      vlanInterfaceDataSourceResults:
        id: ${scmVlanInterfaceDs.id}
        name: ${scmVlanInterfaceDs.name}
        comment: ${scmVlanInterfaceDs.comment}
        vlanTag: ${scmVlanInterfaceDs.vlanTag}
        ip: ${scmVlanInterfaceDs.ips}
        folder: ${scmVlanInterfaceDs.folder}
    

    Using getVlanInterface

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getVlanInterface(args: GetVlanInterfaceArgs, opts?: InvokeOptions): Promise<GetVlanInterfaceResult>
    function getVlanInterfaceOutput(args: GetVlanInterfaceOutputArgs, opts?: InvokeOptions): Output<GetVlanInterfaceResult>
    def get_vlan_interface(id: Optional[str] = None,
                           name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetVlanInterfaceResult
    def get_vlan_interface_output(id: Optional[pulumi.Input[str]] = None,
                           name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetVlanInterfaceResult]
    func LookupVlanInterface(ctx *Context, args *LookupVlanInterfaceArgs, opts ...InvokeOption) (*LookupVlanInterfaceResult, error)
    func LookupVlanInterfaceOutput(ctx *Context, args *LookupVlanInterfaceOutputArgs, opts ...InvokeOption) LookupVlanInterfaceResultOutput

    > Note: This function is named LookupVlanInterface in the Go SDK.

    public static class GetVlanInterface 
    {
        public static Task<GetVlanInterfaceResult> InvokeAsync(GetVlanInterfaceArgs args, InvokeOptions? opts = null)
        public static Output<GetVlanInterfaceResult> Invoke(GetVlanInterfaceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVlanInterfaceResult> getVlanInterface(GetVlanInterfaceArgs args, InvokeOptions options)
    public static Output<GetVlanInterfaceResult> getVlanInterface(GetVlanInterfaceArgs args, InvokeOptions options)
    
    fn::invoke:
      function: scm:index/getVlanInterface:getVlanInterface
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    UUID of the resource
    Name string
    L3 sub-interface name
    Id string
    UUID of the resource
    Name string
    L3 sub-interface name
    id String
    UUID of the resource
    name String
    L3 sub-interface name
    id string
    UUID of the resource
    name string
    L3 sub-interface name
    id str
    UUID of the resource
    name str
    L3 sub-interface name
    id String
    UUID of the resource
    name String
    L3 sub-interface name

    getVlanInterface Result

    The following output properties are available:

    Arps List<GetVlanInterfaceArp>
    ARP configuration
    Comment string
    Description
    DdnsConfig GetVlanInterfaceDdnsConfig
    Dynamic DNS configuration specific to the Vlan Interfaces.
    DefaultValue string
    Default interface assignment
    Device string
    The device in which the resource is defined
    DhcpClient GetVlanInterfaceDhcpClient
    Vlan interfaces DHCP Client Object
    Folder string
    The folder in which the resource is defined
    Id string
    UUID of the resource
    InterfaceManagementProfile string
    Interface management profile
    Ips List<GetVlanInterfaceIp>
    VLAN Interface IP Parent
    Mtu int
    MTU
    Name string
    L3 sub-interface name
    Snippet string
    The snippet in which the resource is defined
    Tfid string
    VlanTag string
    VLAN tag
    Arps []GetVlanInterfaceArp
    ARP configuration
    Comment string
    Description
    DdnsConfig GetVlanInterfaceDdnsConfig
    Dynamic DNS configuration specific to the Vlan Interfaces.
    DefaultValue string
    Default interface assignment
    Device string
    The device in which the resource is defined
    DhcpClient GetVlanInterfaceDhcpClient
    Vlan interfaces DHCP Client Object
    Folder string
    The folder in which the resource is defined
    Id string
    UUID of the resource
    InterfaceManagementProfile string
    Interface management profile
    Ips []GetVlanInterfaceIp
    VLAN Interface IP Parent
    Mtu int
    MTU
    Name string
    L3 sub-interface name
    Snippet string
    The snippet in which the resource is defined
    Tfid string
    VlanTag string
    VLAN tag
    arps List<GetVlanInterfaceArp>
    ARP configuration
    comment String
    Description
    ddnsConfig GetVlanInterfaceDdnsConfig
    Dynamic DNS configuration specific to the Vlan Interfaces.
    defaultValue String
    Default interface assignment
    device String
    The device in which the resource is defined
    dhcpClient GetVlanInterfaceDhcpClient
    Vlan interfaces DHCP Client Object
    folder String
    The folder in which the resource is defined
    id String
    UUID of the resource
    interfaceManagementProfile String
    Interface management profile
    ips List<GetVlanInterfaceIp>
    VLAN Interface IP Parent
    mtu Integer
    MTU
    name String
    L3 sub-interface name
    snippet String
    The snippet in which the resource is defined
    tfid String
    vlanTag String
    VLAN tag
    arps GetVlanInterfaceArp[]
    ARP configuration
    comment string
    Description
    ddnsConfig GetVlanInterfaceDdnsConfig
    Dynamic DNS configuration specific to the Vlan Interfaces.
    defaultValue string
    Default interface assignment
    device string
    The device in which the resource is defined
    dhcpClient GetVlanInterfaceDhcpClient
    Vlan interfaces DHCP Client Object
    folder string
    The folder in which the resource is defined
    id string
    UUID of the resource
    interfaceManagementProfile string
    Interface management profile
    ips GetVlanInterfaceIp[]
    VLAN Interface IP Parent
    mtu number
    MTU
    name string
    L3 sub-interface name
    snippet string
    The snippet in which the resource is defined
    tfid string
    vlanTag string
    VLAN tag
    arps Sequence[GetVlanInterfaceArp]
    ARP configuration
    comment str
    Description
    ddns_config GetVlanInterfaceDdnsConfig
    Dynamic DNS configuration specific to the Vlan Interfaces.
    default_value str
    Default interface assignment
    device str
    The device in which the resource is defined
    dhcp_client GetVlanInterfaceDhcpClient
    Vlan interfaces DHCP Client Object
    folder str
    The folder in which the resource is defined
    id str
    UUID of the resource
    interface_management_profile str
    Interface management profile
    ips Sequence[GetVlanInterfaceIp]
    VLAN Interface IP Parent
    mtu int
    MTU
    name str
    L3 sub-interface name
    snippet str
    The snippet in which the resource is defined
    tfid str
    vlan_tag str
    VLAN tag
    arps List<Property Map>
    ARP configuration
    comment String
    Description
    ddnsConfig Property Map
    Dynamic DNS configuration specific to the Vlan Interfaces.
    defaultValue String
    Default interface assignment
    device String
    The device in which the resource is defined
    dhcpClient Property Map
    Vlan interfaces DHCP Client Object
    folder String
    The folder in which the resource is defined
    id String
    UUID of the resource
    interfaceManagementProfile String
    Interface management profile
    ips List<Property Map>
    VLAN Interface IP Parent
    mtu Number
    MTU
    name String
    L3 sub-interface name
    snippet String
    The snippet in which the resource is defined
    tfid String
    vlanTag String
    VLAN tag

    Supporting Types

    GetVlanInterfaceArp

    HwAddress string
    MAC address
    Interface string
    ARP interface
    Name string
    IP address
    HwAddress string
    MAC address
    Interface string
    ARP interface
    Name string
    IP address
    hwAddress String
    MAC address
    interface_ String
    ARP interface
    name String
    IP address
    hwAddress string
    MAC address
    interface string
    ARP interface
    name string
    IP address
    hw_address str
    MAC address
    interface str
    ARP interface
    name str
    IP address
    hwAddress String
    MAC address
    interface String
    ARP interface
    name String
    IP address

    GetVlanInterfaceDdnsConfig

    DdnsCertProfile string
    Certificate profile
    DdnsEnabled bool
    Enable DDNS?
    DdnsHostname string
    Ddns hostname
    DdnsIp string
    IP to register (static only)
    DdnsUpdateInterval int
    Update interval (days)
    DdnsVendor string
    DDNS vendor
    DdnsVendorConfig string
    DDNS vendor
    DdnsCertProfile string
    Certificate profile
    DdnsEnabled bool
    Enable DDNS?
    DdnsHostname string
    Ddns hostname
    DdnsIp string
    IP to register (static only)
    DdnsUpdateInterval int
    Update interval (days)
    DdnsVendor string
    DDNS vendor
    DdnsVendorConfig string
    DDNS vendor
    ddnsCertProfile String
    Certificate profile
    ddnsEnabled Boolean
    Enable DDNS?
    ddnsHostname String
    Ddns hostname
    ddnsIp String
    IP to register (static only)
    ddnsUpdateInterval Integer
    Update interval (days)
    ddnsVendor String
    DDNS vendor
    ddnsVendorConfig String
    DDNS vendor
    ddnsCertProfile string
    Certificate profile
    ddnsEnabled boolean
    Enable DDNS?
    ddnsHostname string
    Ddns hostname
    ddnsIp string
    IP to register (static only)
    ddnsUpdateInterval number
    Update interval (days)
    ddnsVendor string
    DDNS vendor
    ddnsVendorConfig string
    DDNS vendor
    ddns_cert_profile str
    Certificate profile
    ddns_enabled bool
    Enable DDNS?
    ddns_hostname str
    Ddns hostname
    ddns_ip str
    IP to register (static only)
    ddns_update_interval int
    Update interval (days)
    ddns_vendor str
    DDNS vendor
    ddns_vendor_config str
    DDNS vendor
    ddnsCertProfile String
    Certificate profile
    ddnsEnabled Boolean
    Enable DDNS?
    ddnsHostname String
    Ddns hostname
    ddnsIp String
    IP to register (static only)
    ddnsUpdateInterval Number
    Update interval (days)
    ddnsVendor String
    DDNS vendor
    ddnsVendorConfig String
    DDNS vendor

    GetVlanInterfaceDhcpClient

    CreateDefaultRoute bool
    Automatically create default route pointing to default gateway provided by server
    DefaultRouteMetric int
    Metric of the default route created
    Enable bool
    Enable DHCP?
    SendHostname GetVlanInterfaceDhcpClientSendHostname
    Send hostname
    CreateDefaultRoute bool
    Automatically create default route pointing to default gateway provided by server
    DefaultRouteMetric int
    Metric of the default route created
    Enable bool
    Enable DHCP?
    SendHostname GetVlanInterfaceDhcpClientSendHostname
    Send hostname
    createDefaultRoute Boolean
    Automatically create default route pointing to default gateway provided by server
    defaultRouteMetric Integer
    Metric of the default route created
    enable Boolean
    Enable DHCP?
    sendHostname GetVlanInterfaceDhcpClientSendHostname
    Send hostname
    createDefaultRoute boolean
    Automatically create default route pointing to default gateway provided by server
    defaultRouteMetric number
    Metric of the default route created
    enable boolean
    Enable DHCP?
    sendHostname GetVlanInterfaceDhcpClientSendHostname
    Send hostname
    create_default_route bool
    Automatically create default route pointing to default gateway provided by server
    default_route_metric int
    Metric of the default route created
    enable bool
    Enable DHCP?
    send_hostname GetVlanInterfaceDhcpClientSendHostname
    Send hostname
    createDefaultRoute Boolean
    Automatically create default route pointing to default gateway provided by server
    defaultRouteMetric Number
    Metric of the default route created
    enable Boolean
    Enable DHCP?
    sendHostname Property Map
    Send hostname

    GetVlanInterfaceDhcpClientSendHostname

    Enable bool
    Enable
    Hostname string
    Set interface hostname
    Enable bool
    Enable
    Hostname string
    Set interface hostname
    enable Boolean
    Enable
    hostname String
    Set interface hostname
    enable boolean
    Enable
    hostname string
    Set interface hostname
    enable bool
    Enable
    hostname str
    Set interface hostname
    enable Boolean
    Enable
    hostname String
    Set interface hostname

    GetVlanInterfaceIp

    Name string
    VLAN Interface IP address(es)
    Name string
    VLAN Interface IP address(es)
    name String
    VLAN Interface IP address(es)
    name string
    VLAN Interface IP address(es)
    name str
    VLAN Interface IP address(es)
    name String
    VLAN Interface IP address(es)

    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 v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate