1. Packages
  2. Strata Cloud Manager Provider
  3. API Docs
  4. getAggregateInterface
Strata Cloud Manager v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-scm

scm.getAggregateInterface

Get Started
scm logo
Strata Cloud Manager v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-scm

    AggregateInterface data source

    Example Usage

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

// Look up aggregate interface by its ID.
const scmAggregateInterfaceDs = scm.getAggregateInterface({
    id: "ddad1e64-0b64-41a4-b361-c6199761a8f1",
});
export const aggregateInterfaceDataSourceResults = {
    id: scmAggregateInterfaceDs.then(scmAggregateInterfaceDs => scmAggregateInterfaceDs.id),
    name: scmAggregateInterfaceDs.then(scmAggregateInterfaceDs => scmAggregateInterfaceDs.name),
    comment: scmAggregateInterfaceDs.then(scmAggregateInterfaceDs => scmAggregateInterfaceDs.comment),
    layer3: scmAggregateInterfaceDs.then(scmAggregateInterfaceDs => scmAggregateInterfaceDs.layer3),
    folder: scmAggregateInterfaceDs.then(scmAggregateInterfaceDs => scmAggregateInterfaceDs.folder),
};

    import pulumi
import pulumi_scm as scm

# Look up aggregate interface by its ID.
scm_aggregate_interface_ds = scm.get_aggregate_interface(id="ddad1e64-0b64-41a4-b361-c6199761a8f1")
pulumi.export("aggregateInterfaceDataSourceResults", {
    "id": scm_aggregate_interface_ds.id,
    "name": scm_aggregate_interface_ds.name,
    "comment": scm_aggregate_interface_ds.comment,
    "layer3": scm_aggregate_interface_ds.layer3,
    "folder": scm_aggregate_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 aggregate interface by its ID.
		scmAggregateInterfaceDs, err := scm.LookupAggregateInterface(ctx, &scm.LookupAggregateInterfaceArgs{
			Id: "ddad1e64-0b64-41a4-b361-c6199761a8f1",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("aggregateInterfaceDataSourceResults", pulumi.Map{
			"id":      scmAggregateInterfaceDs.Id,
			"name":    scmAggregateInterfaceDs.Name,
			"comment": scmAggregateInterfaceDs.Comment,
			"layer3":  scmAggregateInterfaceDs.Layer3,
			"folder":  scmAggregateInterfaceDs.Folder,
		})
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Look up aggregate interface by its ID.
    var scmAggregateInterfaceDs = Scm.GetAggregateInterface.Invoke(new()
    {
        Id = "ddad1e64-0b64-41a4-b361-c6199761a8f1",
    });

    return new Dictionary<string, object?>
    {
        ["aggregateInterfaceDataSourceResults"] = 
        {
            { "id", scmAggregateInterfaceDs.Apply(getAggregateInterfaceResult => getAggregateInterfaceResult.Id) },
            { "name", scmAggregateInterfaceDs.Apply(getAggregateInterfaceResult => getAggregateInterfaceResult.Name) },
            { "comment", scmAggregateInterfaceDs.Apply(getAggregateInterfaceResult => getAggregateInterfaceResult.Comment) },
            { "layer3", scmAggregateInterfaceDs.Apply(getAggregateInterfaceResult => getAggregateInterfaceResult.Layer3) },
            { "folder", scmAggregateInterfaceDs.Apply(getAggregateInterfaceResult => getAggregateInterfaceResult.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.GetAggregateInterfaceArgs;
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 aggregate interface by its ID.
        final var scmAggregateInterfaceDs = ScmFunctions.getAggregateInterface(GetAggregateInterfaceArgs.builder()
            .id("ddad1e64-0b64-41a4-b361-c6199761a8f1")
            .build());

        ctx.export("aggregateInterfaceDataSourceResults", Map.ofEntries(
            Map.entry("id", scmAggregateInterfaceDs.id()),
            Map.entry("name", scmAggregateInterfaceDs.name()),
            Map.entry("comment", scmAggregateInterfaceDs.comment()),
            Map.entry("layer3", scmAggregateInterfaceDs.layer3()),
            Map.entry("folder", scmAggregateInterfaceDs.folder())
        ));
    }
}

    variables:
  # Look up aggregate interface by its ID.
  scmAggregateInterfaceDs:
    fn::invoke:
      function: scm:getAggregateInterface
      arguments:
        id: ddad1e64-0b64-41a4-b361-c6199761a8f1
outputs:
  # Output various attributes from the found aggregate interface to verify the lookups were successful.
  aggregateInterfaceDataSourceResults:
    id: ${scmAggregateInterfaceDs.id}
    name: ${scmAggregateInterfaceDs.name}
    comment: ${scmAggregateInterfaceDs.comment}
    layer3: ${scmAggregateInterfaceDs.layer3}
    folder: ${scmAggregateInterfaceDs.folder}

    Using getAggregateInterface

    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 getAggregateInterface(args: GetAggregateInterfaceArgs, opts?: InvokeOptions): Promise<GetAggregateInterfaceResult>
function getAggregateInterfaceOutput(args: GetAggregateInterfaceOutputArgs, opts?: InvokeOptions): Output<GetAggregateInterfaceResult>
    def get_aggregate_interface(id: Optional[str] = None,
                            name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetAggregateInterfaceResult
def get_aggregate_interface_output(id: Optional[pulumi.Input[str]] = None,
                            name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetAggregateInterfaceResult]
    func LookupAggregateInterface(ctx *Context, args *LookupAggregateInterfaceArgs, opts ...InvokeOption) (*LookupAggregateInterfaceResult, error)
func LookupAggregateInterfaceOutput(ctx *Context, args *LookupAggregateInterfaceOutputArgs, opts ...InvokeOption) LookupAggregateInterfaceResultOutput

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

    public static class GetAggregateInterface 
{
    public static Task<GetAggregateInterfaceResult> InvokeAsync(GetAggregateInterfaceArgs args, InvokeOptions? opts = null)
    public static Output<GetAggregateInterfaceResult> Invoke(GetAggregateInterfaceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAggregateInterfaceResult> getAggregateInterface(GetAggregateInterfaceArgs args, InvokeOptions options)
public static Output<GetAggregateInterfaceResult> getAggregateInterface(GetAggregateInterfaceArgs args, InvokeOptions options)

    fn::invoke:
  function: scm:index/getAggregateInterface:getAggregateInterface
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    UUID of the resource
    Name string
    Aggregate interface name
    Id string
    UUID of the resource
    Name string
    Aggregate interface name
    id String
    UUID of the resource
    name String
    Aggregate interface name
    id string
    UUID of the resource
    name string
    Aggregate interface name
    id str
    UUID of the resource
    name str
    Aggregate interface name
    id String
    UUID of the resource
    name String
    Aggregate interface name

    getAggregateInterface Result

    The following output properties are available:

    Comment string
    Aggregate interface description
    DefaultValue string
    Default interface assignment
    Device string
    The device in which the resource is defined
    Folder string
    The folder in which the resource is defined
    Id string
    UUID of the resource
    Layer2 GetAggregateInterfaceLayer2
    Layer2
    Layer3 GetAggregateInterfaceLayer3
    Aggregate Interface Layer 3 configuration
    Name string
    Aggregate interface name
    Snippet string
    The snippet in which the resource is defined
    Tfid string
    Comment string
    Aggregate interface description
    DefaultValue string
    Default interface assignment
    Device string
    The device in which the resource is defined
    Folder string
    The folder in which the resource is defined
    Id string
    UUID of the resource
    Layer2 GetAggregateInterfaceLayer2
    Layer2
    Layer3 GetAggregateInterfaceLayer3
    Aggregate Interface Layer 3 configuration
    Name string
    Aggregate interface name
    Snippet string
    The snippet in which the resource is defined
    Tfid string
    comment String
    Aggregate interface description
    defaultValue String
    Default interface assignment
    device String
    The device in which the resource is defined
    folder String
    The folder in which the resource is defined
    id String
    UUID of the resource
    layer2 GetAggregateInterfaceLayer2
    Layer2
    layer3 GetAggregateInterfaceLayer3
    Aggregate Interface Layer 3 configuration
    name String
    Aggregate interface name
    snippet String
    The snippet in which the resource is defined
    tfid String
    comment string
    Aggregate interface description
    defaultValue string
    Default interface assignment
    device string
    The device in which the resource is defined
    folder string
    The folder in which the resource is defined
    id string
    UUID of the resource
    layer2 GetAggregateInterfaceLayer2
    Layer2
    layer3 GetAggregateInterfaceLayer3
    Aggregate Interface Layer 3 configuration
    name string
    Aggregate interface name
    snippet string
    The snippet in which the resource is defined
    tfid string
    comment str
    Aggregate interface description
    default_value str
    Default interface assignment
    device str
    The device in which the resource is defined
    folder str
    The folder in which the resource is defined
    id str
    UUID of the resource
    layer2 GetAggregateInterfaceLayer2
    Layer2
    layer3 GetAggregateInterfaceLayer3
    Aggregate Interface Layer 3 configuration
    name str
    Aggregate interface name
    snippet str
    The snippet in which the resource is defined
    tfid str
    comment String
    Aggregate interface description
    defaultValue String
    Default interface assignment
    device String
    The device in which the resource is defined
    folder String
    The folder in which the resource is defined
    id String
    UUID of the resource
    layer2 Property Map
    Layer2
    layer3 Property Map
    Aggregate Interface Layer 3 configuration
    name String
    Aggregate interface name
    snippet String
    The snippet in which the resource is defined
    tfid String

    Supporting Types

    GetAggregateInterfaceLayer2

    lacp Property Map
    Lacp
    vlanTag String
    VLAN tag

    GetAggregateInterfaceLayer2Lacp

    Enable bool
    Enable LACP?
    FastFailover bool
    Fast failover
    MaxPorts int
    Maximum number of physical ports bundled in the LAG
    Mode string
    Mode
    SystemPriority int
    LACP system priority in system ID
    TransmissionRate string
    Transmission mode
    Enable bool
    Enable LACP?
    FastFailover bool
    Fast failover
    MaxPorts int
    Maximum number of physical ports bundled in the LAG
    Mode string
    Mode
    SystemPriority int
    LACP system priority in system ID
    TransmissionRate string
    Transmission mode
    enable Boolean
    Enable LACP?
    fastFailover Boolean
    Fast failover
    maxPorts Integer
    Maximum number of physical ports bundled in the LAG
    mode String
    Mode
    systemPriority Integer
    LACP system priority in system ID
    transmissionRate String
    Transmission mode
    enable boolean
    Enable LACP?
    fastFailover boolean
    Fast failover
    maxPorts number
    Maximum number of physical ports bundled in the LAG
    mode string
    Mode
    systemPriority number
    LACP system priority in system ID
    transmissionRate string
    Transmission mode
    enable bool
    Enable LACP?
    fast_failover bool
    Fast failover
    max_ports int
    Maximum number of physical ports bundled in the LAG
    mode str
    Mode
    system_priority int
    LACP system priority in system ID
    transmission_rate str
    Transmission mode
    enable Boolean
    Enable LACP?
    fastFailover Boolean
    Fast failover
    maxPorts Number
    Maximum number of physical ports bundled in the LAG
    mode String
    Mode
    systemPriority Number
    LACP system priority in system ID
    transmissionRate String
    Transmission mode

    GetAggregateInterfaceLayer3

    Arps List<GetAggregateInterfaceLayer3Arp>
    Aggregate Ethernet ARP configuration
    DdnsConfig GetAggregateInterfaceLayer3DdnsConfig
    Dynamic DNS configuration specific to the Aggregate Interface.
    DhcpClient GetAggregateInterfaceLayer3DhcpClient
    Aggregate Ethernet DHCP Client Object
    InterfaceManagementProfile string
    Interface management profile
    Ips List<GetAggregateInterfaceLayer3Ip>
    Aggregate Interface IP addresses
    Lacp GetAggregateInterfaceLayer3Lacp
    Lacp
    Mtu int
    MTU
    Arps []GetAggregateInterfaceLayer3Arp
    Aggregate Ethernet ARP configuration
    DdnsConfig GetAggregateInterfaceLayer3DdnsConfig
    Dynamic DNS configuration specific to the Aggregate Interface.
    DhcpClient GetAggregateInterfaceLayer3DhcpClient
    Aggregate Ethernet DHCP Client Object
    InterfaceManagementProfile string
    Interface management profile
    Ips []GetAggregateInterfaceLayer3Ip
    Aggregate Interface IP addresses
    Lacp GetAggregateInterfaceLayer3Lacp
    Lacp
    Mtu int
    MTU
    arps List<GetAggregateInterfaceLayer3Arp>
    Aggregate Ethernet ARP configuration
    ddnsConfig GetAggregateInterfaceLayer3DdnsConfig
    Dynamic DNS configuration specific to the Aggregate Interface.
    dhcpClient GetAggregateInterfaceLayer3DhcpClient
    Aggregate Ethernet DHCP Client Object
    interfaceManagementProfile String
    Interface management profile
    ips List<GetAggregateInterfaceLayer3Ip>
    Aggregate Interface IP addresses
    lacp GetAggregateInterfaceLayer3Lacp
    Lacp
    mtu Integer
    MTU
    arps GetAggregateInterfaceLayer3Arp[]
    Aggregate Ethernet ARP configuration
    ddnsConfig GetAggregateInterfaceLayer3DdnsConfig
    Dynamic DNS configuration specific to the Aggregate Interface.
    dhcpClient GetAggregateInterfaceLayer3DhcpClient
    Aggregate Ethernet DHCP Client Object
    interfaceManagementProfile string
    Interface management profile
    ips GetAggregateInterfaceLayer3Ip[]
    Aggregate Interface IP addresses
    lacp GetAggregateInterfaceLayer3Lacp
    Lacp
    mtu number
    MTU
    arps Sequence[GetAggregateInterfaceLayer3Arp]
    Aggregate Ethernet ARP configuration
    ddns_config GetAggregateInterfaceLayer3DdnsConfig
    Dynamic DNS configuration specific to the Aggregate Interface.
    dhcp_client GetAggregateInterfaceLayer3DhcpClient
    Aggregate Ethernet DHCP Client Object
    interface_management_profile str
    Interface management profile
    ips Sequence[GetAggregateInterfaceLayer3Ip]
    Aggregate Interface IP addresses
    lacp GetAggregateInterfaceLayer3Lacp
    Lacp
    mtu int
    MTU
    arps List<Property Map>
    Aggregate Ethernet ARP configuration
    ddnsConfig Property Map
    Dynamic DNS configuration specific to the Aggregate Interface.
    dhcpClient Property Map
    Aggregate Ethernet DHCP Client Object
    interfaceManagementProfile String
    Interface management profile
    ips List<Property Map>
    Aggregate Interface IP addresses
    lacp Property Map
    Lacp
    mtu Number
    MTU

    GetAggregateInterfaceLayer3Arp

    HwAddress string
    MAC address
    Name string
    IP address
    HwAddress string
    MAC address
    Name string
    IP address
    hwAddress String
    MAC address
    name String
    IP address
    hwAddress string
    MAC address
    name string
    IP address
    hw_address str
    MAC address
    name str
    IP address
    hwAddress String
    MAC address
    name String
    IP address

    GetAggregateInterfaceLayer3DdnsConfig

    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

    GetAggregateInterfaceLayer3DhcpClient

    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 GetAggregateInterfaceLayer3DhcpClientSendHostname
    Aggregate Ethernet DHCP Client 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 GetAggregateInterfaceLayer3DhcpClientSendHostname
    Aggregate Ethernet DHCP Client 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 GetAggregateInterfaceLayer3DhcpClientSendHostname
    Aggregate Ethernet DHCP Client 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 GetAggregateInterfaceLayer3DhcpClientSendHostname
    Aggregate Ethernet DHCP Client 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 GetAggregateInterfaceLayer3DhcpClientSendHostname
    Aggregate Ethernet DHCP Client 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
    Aggregate Ethernet DHCP Client Send hostname

    GetAggregateInterfaceLayer3DhcpClientSendHostname

    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

    GetAggregateInterfaceLayer3Ip

    Name string
    Aggregate Interface IP addresses name
    Name string
    Aggregate Interface IP addresses name
    name String
    Aggregate Interface IP addresses name
    name string
    Aggregate Interface IP addresses name
    name str
    Aggregate Interface IP addresses name
    name String
    Aggregate Interface IP addresses name

    GetAggregateInterfaceLayer3Lacp

    Enable bool
    Enable LACP?
    FastFailover bool
    Fast failover
    MaxPorts int
    Maximum number of physical ports bundled in the LAG
    Mode string
    Mode
    SystemPriority int
    LACP system priority in system ID
    TransmissionRate string
    Transmission mode
    Enable bool
    Enable LACP?
    FastFailover bool
    Fast failover
    MaxPorts int
    Maximum number of physical ports bundled in the LAG
    Mode string
    Mode
    SystemPriority int
    LACP system priority in system ID
    TransmissionRate string
    Transmission mode
    enable Boolean
    Enable LACP?
    fastFailover Boolean
    Fast failover
    maxPorts Integer
    Maximum number of physical ports bundled in the LAG
    mode String
    Mode
    systemPriority Integer
    LACP system priority in system ID
    transmissionRate String
    Transmission mode
    enable boolean
    Enable LACP?
    fastFailover boolean
    Fast failover
    maxPorts number
    Maximum number of physical ports bundled in the LAG
    mode string
    Mode
    systemPriority number
    LACP system priority in system ID
    transmissionRate string
    Transmission mode
    enable bool
    Enable LACP?
    fast_failover bool
    Fast failover
    max_ports int
    Maximum number of physical ports bundled in the LAG
    mode str
    Mode
    system_priority int
    LACP system priority in system ID
    transmission_rate str
    Transmission mode
    enable Boolean
    Enable LACP?
    fastFailover Boolean
    Fast failover
    maxPorts Number
    Maximum number of physical ports bundled in the LAG
    mode String
    Mode
    systemPriority Number
    LACP system priority in system ID
    transmissionRate String
    Transmission mode

    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
    Schema (JSON)
    pulumi/pulumi-scm
      Meet Neo: Your AI Platform Teammate