scm.getAggregateInterfaceList

Strata Cloud Manager v0.4.3, Nov 8 25

Strata Cloud Manager v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-scm

Strata Cloud Manager v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-scm

Example Usage

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

// Fetch a list of all aggregate interfaces
const allAggregateInterfaces = scm.getAggregateInterfaceList({
    folder: "ngfw-shared",
});
export const scmAggregateInterfaceList = allAggregateInterfaces.then(allAggregateInterfaces => .reduce((__obj, interface) => ({ ...__obj, [_interface.name]: _interface })));

import pulumi
import pulumi_scm as scm

# Fetch a list of all aggregate interfaces
all_aggregate_interfaces = scm.get_aggregate_interface_list(folder="ngfw-shared")
pulumi.export("scmAggregateInterfaceList", {interface.name: interface for interface in all_aggregate_interfaces.datas})

Example coming soon!

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

return await Deployment.RunAsync(() => 
{
    // Fetch a list of all aggregate interfaces
    var allAggregateInterfaces = Scm.GetAggregateInterfaceList.Invoke(new()
    {
        Folder = "ngfw-shared",
    });

    return new Dictionary<string, object?>
    {
        ["scmAggregateInterfaceList"] = ,
    };
});

Example coming soon!

Example coming soon!

Using getAggregateInterfaceList

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 getAggregateInterfaceList(args: GetAggregateInterfaceListArgs, opts?: InvokeOptions): Promise<GetAggregateInterfaceListResult>
function getAggregateInterfaceListOutput(args: GetAggregateInterfaceListOutputArgs, opts?: InvokeOptions): Output<GetAggregateInterfaceListResult>

def get_aggregate_interface_list(device: Optional[str] = None,
                                 folder: Optional[str] = None,
                                 limit: Optional[int] = None,
                                 name: Optional[str] = None,
                                 offset: Optional[int] = None,
                                 snippet: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetAggregateInterfaceListResult
def get_aggregate_interface_list_output(device: Optional[pulumi.Input[str]] = None,
                                 folder: Optional[pulumi.Input[str]] = None,
                                 limit: Optional[pulumi.Input[int]] = None,
                                 name: Optional[pulumi.Input[str]] = None,
                                 offset: Optional[pulumi.Input[int]] = None,
                                 snippet: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetAggregateInterfaceListResult]

func GetAggregateInterfaceList(ctx *Context, args *GetAggregateInterfaceListArgs, opts ...InvokeOption) (*GetAggregateInterfaceListResult, error)
func GetAggregateInterfaceListOutput(ctx *Context, args *GetAggregateInterfaceListOutputArgs, opts ...InvokeOption) GetAggregateInterfaceListResultOutput

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

public static class GetAggregateInterfaceList 
{
    public static Task<GetAggregateInterfaceListResult> InvokeAsync(GetAggregateInterfaceListArgs args, InvokeOptions? opts = null)
    public static Output<GetAggregateInterfaceListResult> Invoke(GetAggregateInterfaceListInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAggregateInterfaceListResult> getAggregateInterfaceList(GetAggregateInterfaceListArgs args, InvokeOptions options)
public static Output<GetAggregateInterfaceListResult> getAggregateInterfaceList(GetAggregateInterfaceListArgs args, InvokeOptions options)

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

The following arguments are supported:

Device string: The device of the item.
Folder string: The folder of the item. Default: Shared.
Limit int: The max number of items to return. Default: 200.
Name string: The name of the item.
Offset int: The offset of the first item to return.
Snippet string: The snippet of the item.

Device string: The device of the item.
Folder string: The folder of the item. Default: Shared.
Limit int: The max number of items to return. Default: 200.
Name string: The name of the item.
Offset int: The offset of the first item to return.
Snippet string: The snippet of the item.

device String: The device of the item.
folder String: The folder of the item. Default: Shared.
limit Integer: The max number of items to return. Default: 200.
name String: The name of the item.
offset Integer: The offset of the first item to return.
snippet String: The snippet of the item.

device string: The device of the item.
folder string: The folder of the item. Default: Shared.
limit number: The max number of items to return. Default: 200.
name string: The name of the item.
offset number: The offset of the first item to return.
snippet string: The snippet of the item.

device str: The device of the item.
folder str: The folder of the item. Default: Shared.
limit int: The max number of items to return. Default: 200.
name str: The name of the item.
offset int: The offset of the first item to return.
snippet str: The snippet of the item.

device String: The device of the item.
folder String: The folder of the item. Default: Shared.
limit Number: The max number of items to return. Default: 200.
name String: The name of the item.
offset Number: The offset of the first item to return.
snippet String: The snippet of the item.

getAggregateInterfaceList Result

The following output properties are available:

Datas List<GetAggregateInterfaceListData>: The data.
Id string: The provider-assigned unique ID for this managed resource.
Tfid string
Total int: The total number of items.
Device string: The device of the item.
Folder string: The folder of the item. Default: Shared.
Limit int: The max number of items to return. Default: 200.
Name string: The name of the item.
Offset int: The offset of the first item to return.
Snippet string: The snippet of the item.

Datas []GetAggregateInterfaceListData: The data.
Id string: The provider-assigned unique ID for this managed resource.
Tfid string
Total int: The total number of items.
Device string: The device of the item.
Folder string: The folder of the item. Default: Shared.
Limit int: The max number of items to return. Default: 200.
Name string: The name of the item.
Offset int: The offset of the first item to return.
Snippet string: The snippet of the item.

datas List<GetAggregateInterfaceListData>: The data.
id String: The provider-assigned unique ID for this managed resource.
tfid String
total Integer: The total number of items.
device String: The device of the item.
folder String: The folder of the item. Default: Shared.
limit Integer: The max number of items to return. Default: 200.
name String: The name of the item.
offset Integer: The offset of the first item to return.
snippet String: The snippet of the item.

datas GetAggregateInterfaceListData[]: The data.
id string: The provider-assigned unique ID for this managed resource.
tfid string
total number: The total number of items.
device string: The device of the item.
folder string: The folder of the item. Default: Shared.
limit number: The max number of items to return. Default: 200.
name string: The name of the item.
offset number: The offset of the first item to return.
snippet string: The snippet of the item.

datas Sequence[GetAggregateInterfaceListData]: The data.
id str: The provider-assigned unique ID for this managed resource.
tfid str
total int: The total number of items.
device str: The device of the item.
folder str: The folder of the item. Default: Shared.
limit int: The max number of items to return. Default: 200.
name str: The name of the item.
offset int: The offset of the first item to return.
snippet str: The snippet of the item.

datas List<Property Map>: The data.
id String: The provider-assigned unique ID for this managed resource.
tfid String
total Number: The total number of items.
device String: The device of the item.
folder String: The folder of the item. Default: Shared.
limit Number: The max number of items to return. Default: 200.
name String: The name of the item.
offset Number: The offset of the first item to return.
snippet String: The snippet of the item.

Supporting Types

GetAggregateInterfaceListData

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 GetAggregateInterfaceListDataLayer2: Layer2
Layer3 GetAggregateInterfaceListDataLayer3: 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 GetAggregateInterfaceListDataLayer2: Layer2
Layer3 GetAggregateInterfaceListDataLayer3: 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 GetAggregateInterfaceListDataLayer2: Layer2
layer3 GetAggregateInterfaceListDataLayer3: 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 GetAggregateInterfaceListDataLayer2: Layer2
layer3 GetAggregateInterfaceListDataLayer3: 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 GetAggregateInterfaceListDataLayer2: Layer2
layer3 GetAggregateInterfaceListDataLayer3: 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

GetAggregateInterfaceListDataLayer2

Lacp GetAggregateInterfaceListDataLayer2Lacp: Lacp
VlanTag string: VLAN tag

Lacp GetAggregateInterfaceListDataLayer2Lacp: Lacp
VlanTag string: VLAN tag

lacp GetAggregateInterfaceListDataLayer2Lacp: Lacp
vlanTag String: VLAN tag

lacp GetAggregateInterfaceListDataLayer2Lacp: Lacp
vlanTag string: VLAN tag

lacp GetAggregateInterfaceListDataLayer2Lacp: Lacp
vlan_tag str: VLAN tag

lacp Property Map: Lacp
vlanTag String: VLAN tag

GetAggregateInterfaceListDataLayer2Lacp

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

GetAggregateInterfaceListDataLayer3

Arps List<GetAggregateInterfaceListDataLayer3Arp>: Aggregate Ethernet ARP configuration
DdnsConfig GetAggregateInterfaceListDataLayer3DdnsConfig: Dynamic DNS configuration specific to the Aggregate Interface.
DhcpClient GetAggregateInterfaceListDataLayer3DhcpClient: Aggregate Ethernet DHCP Client Object
InterfaceManagementProfile string: Interface management profile
Ips List<GetAggregateInterfaceListDataLayer3Ip>: Aggregate Interface IP addresses
Lacp GetAggregateInterfaceListDataLayer3Lacp: Lacp
Mtu int: MTU

Arps []GetAggregateInterfaceListDataLayer3Arp: Aggregate Ethernet ARP configuration
DdnsConfig GetAggregateInterfaceListDataLayer3DdnsConfig: Dynamic DNS configuration specific to the Aggregate Interface.
DhcpClient GetAggregateInterfaceListDataLayer3DhcpClient: Aggregate Ethernet DHCP Client Object
InterfaceManagementProfile string: Interface management profile
Ips []GetAggregateInterfaceListDataLayer3Ip: Aggregate Interface IP addresses
Lacp GetAggregateInterfaceListDataLayer3Lacp: Lacp
Mtu int: MTU

arps List<GetAggregateInterfaceListDataLayer3Arp>: Aggregate Ethernet ARP configuration
ddnsConfig GetAggregateInterfaceListDataLayer3DdnsConfig: Dynamic DNS configuration specific to the Aggregate Interface.
dhcpClient GetAggregateInterfaceListDataLayer3DhcpClient: Aggregate Ethernet DHCP Client Object
interfaceManagementProfile String: Interface management profile
ips List<GetAggregateInterfaceListDataLayer3Ip>: Aggregate Interface IP addresses
lacp GetAggregateInterfaceListDataLayer3Lacp: Lacp
mtu Integer: MTU

arps GetAggregateInterfaceListDataLayer3Arp[]: Aggregate Ethernet ARP configuration
ddnsConfig GetAggregateInterfaceListDataLayer3DdnsConfig: Dynamic DNS configuration specific to the Aggregate Interface.
dhcpClient GetAggregateInterfaceListDataLayer3DhcpClient: Aggregate Ethernet DHCP Client Object
interfaceManagementProfile string: Interface management profile
ips GetAggregateInterfaceListDataLayer3Ip[]: Aggregate Interface IP addresses
lacp GetAggregateInterfaceListDataLayer3Lacp: Lacp
mtu number: MTU

arps Sequence[GetAggregateInterfaceListDataLayer3Arp]: Aggregate Ethernet ARP configuration
ddns_config GetAggregateInterfaceListDataLayer3DdnsConfig: Dynamic DNS configuration specific to the Aggregate Interface.
dhcp_client GetAggregateInterfaceListDataLayer3DhcpClient: Aggregate Ethernet DHCP Client Object
interface_management_profile str: Interface management profile
ips Sequence[GetAggregateInterfaceListDataLayer3Ip]: Aggregate Interface IP addresses
lacp GetAggregateInterfaceListDataLayer3Lacp: 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

GetAggregateInterfaceListDataLayer3Arp

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

GetAggregateInterfaceListDataLayer3DdnsConfig

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

GetAggregateInterfaceListDataLayer3DhcpClient

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 GetAggregateInterfaceListDataLayer3DhcpClientSendHostname: 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 GetAggregateInterfaceListDataLayer3DhcpClientSendHostname: 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 GetAggregateInterfaceListDataLayer3DhcpClientSendHostname: 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 GetAggregateInterfaceListDataLayer3DhcpClientSendHostname: 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 GetAggregateInterfaceListDataLayer3DhcpClientSendHostname: 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

GetAggregateInterfaceListDataLayer3DhcpClientSendHostname

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

GetAggregateInterfaceListDataLayer3Ip

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

GetAggregateInterfaceListDataLayer3Lacp

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.

Strata Cloud Manager v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-scm

scm.getAggregateInterfaceList

On this page

On this page

Example Usage

Using getAggregateInterfaceList

getAggregateInterfaceList Result

Supporting Types

GetAggregateInterfaceListData

GetAggregateInterfaceListDataLayer2

GetAggregateInterfaceListDataLayer2Lacp

GetAggregateInterfaceListDataLayer3

GetAggregateInterfaceListDataLayer3Arp

GetAggregateInterfaceListDataLayer3DdnsConfig

GetAggregateInterfaceListDataLayer3DhcpClient

GetAggregateInterfaceListDataLayer3DhcpClientSendHostname

GetAggregateInterfaceListDataLayer3Ip

GetAggregateInterfaceListDataLayer3Lacp

Package Details

On this page

On this page