1. Packages
  2. Meraki Provider
  3. API Docs
  4. devices
  5. SwitchPorts
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi

meraki.devices.SwitchPorts

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as meraki from "@pulumi/meraki";
    
    const example = new meraki.devices.SwitchPorts("example", {
        accessPolicyNumber: 2,
        accessPolicyType: "Sticky MAC allow list",
        adaptivePolicyGroupId: "123",
        allowedVlans: "1,3,5-10",
        daiTrusted: false,
        enabled: true,
        flexibleStackingEnabled: true,
        isolationEnabled: false,
        linkNegotiation: "Auto negotiate",
        macAllowLists: [
            "34:56:fe:ce:8e:b0",
            "34:56:fe:ce:8e:b1",
        ],
        name: "My switch port",
        peerSgtCapable: false,
        poeEnabled: true,
        portId: "string",
        portScheduleId: "1234",
        profile: {
            enabled: false,
            id: "1284392014819",
            iname: "iname",
        },
        rstpEnabled: true,
        serial: "string",
        stickyMacAllowLists: [
            "34:56:fe:ce:8e:b0",
            "34:56:fe:ce:8e:b1",
        ],
        stickyMacAllowListLimit: 5,
        stormControlEnabled: true,
        stpGuard: "disabled",
        tags: [
            "tag1",
            "tag2",
        ],
        type: "access",
        udld: "Alert only",
        vlan: 10,
        voiceVlan: 20,
    });
    export const merakiDevicesSwitchPortsExample = example;
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.devices.SwitchPorts("example",
        access_policy_number=2,
        access_policy_type="Sticky MAC allow list",
        adaptive_policy_group_id="123",
        allowed_vlans="1,3,5-10",
        dai_trusted=False,
        enabled=True,
        flexible_stacking_enabled=True,
        isolation_enabled=False,
        link_negotiation="Auto negotiate",
        mac_allow_lists=[
            "34:56:fe:ce:8e:b0",
            "34:56:fe:ce:8e:b1",
        ],
        name="My switch port",
        peer_sgt_capable=False,
        poe_enabled=True,
        port_id="string",
        port_schedule_id="1234",
        profile={
            "enabled": False,
            "id": "1284392014819",
            "iname": "iname",
        },
        rstp_enabled=True,
        serial="string",
        sticky_mac_allow_lists=[
            "34:56:fe:ce:8e:b0",
            "34:56:fe:ce:8e:b1",
        ],
        sticky_mac_allow_list_limit=5,
        storm_control_enabled=True,
        stp_guard="disabled",
        tags=[
            "tag1",
            "tag2",
        ],
        type="access",
        udld="Alert only",
        vlan=10,
        voice_vlan=20)
    pulumi.export("merakiDevicesSwitchPortsExample", example)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/devices"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := devices.NewSwitchPorts(ctx, "example", &devices.SwitchPortsArgs{
    			AccessPolicyNumber:      pulumi.Int(2),
    			AccessPolicyType:        pulumi.String("Sticky MAC allow list"),
    			AdaptivePolicyGroupId:   pulumi.String("123"),
    			AllowedVlans:            pulumi.String("1,3,5-10"),
    			DaiTrusted:              pulumi.Bool(false),
    			Enabled:                 pulumi.Bool(true),
    			FlexibleStackingEnabled: pulumi.Bool(true),
    			IsolationEnabled:        pulumi.Bool(false),
    			LinkNegotiation:         pulumi.String("Auto negotiate"),
    			MacAllowLists: pulumi.StringArray{
    				pulumi.String("34:56:fe:ce:8e:b0"),
    				pulumi.String("34:56:fe:ce:8e:b1"),
    			},
    			Name:           pulumi.String("My switch port"),
    			PeerSgtCapable: pulumi.Bool(false),
    			PoeEnabled:     pulumi.Bool(true),
    			PortId:         pulumi.String("string"),
    			PortScheduleId: pulumi.String("1234"),
    			Profile: &devices.SwitchPortsProfileArgs{
    				Enabled: pulumi.Bool(false),
    				Id:      pulumi.String("1284392014819"),
    				Iname:   pulumi.String("iname"),
    			},
    			RstpEnabled: pulumi.Bool(true),
    			Serial:      pulumi.String("string"),
    			StickyMacAllowLists: pulumi.StringArray{
    				pulumi.String("34:56:fe:ce:8e:b0"),
    				pulumi.String("34:56:fe:ce:8e:b1"),
    			},
    			StickyMacAllowListLimit: pulumi.Int(5),
    			StormControlEnabled:     pulumi.Bool(true),
    			StpGuard:                pulumi.String("disabled"),
    			Tags: pulumi.StringArray{
    				pulumi.String("tag1"),
    				pulumi.String("tag2"),
    			},
    			Type:      pulumi.String("access"),
    			Udld:      pulumi.String("Alert only"),
    			Vlan:      pulumi.Int(10),
    			VoiceVlan: pulumi.Int(20),
    		})
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiDevicesSwitchPortsExample", example)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Meraki = Pulumi.Meraki;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Meraki.Devices.SwitchPorts("example", new()
        {
            AccessPolicyNumber = 2,
            AccessPolicyType = "Sticky MAC allow list",
            AdaptivePolicyGroupId = "123",
            AllowedVlans = "1,3,5-10",
            DaiTrusted = false,
            Enabled = true,
            FlexibleStackingEnabled = true,
            IsolationEnabled = false,
            LinkNegotiation = "Auto negotiate",
            MacAllowLists = new[]
            {
                "34:56:fe:ce:8e:b0",
                "34:56:fe:ce:8e:b1",
            },
            Name = "My switch port",
            PeerSgtCapable = false,
            PoeEnabled = true,
            PortId = "string",
            PortScheduleId = "1234",
            Profile = new Meraki.Devices.Inputs.SwitchPortsProfileArgs
            {
                Enabled = false,
                Id = "1284392014819",
                Iname = "iname",
            },
            RstpEnabled = true,
            Serial = "string",
            StickyMacAllowLists = new[]
            {
                "34:56:fe:ce:8e:b0",
                "34:56:fe:ce:8e:b1",
            },
            StickyMacAllowListLimit = 5,
            StormControlEnabled = true,
            StpGuard = "disabled",
            Tags = new[]
            {
                "tag1",
                "tag2",
            },
            Type = "access",
            Udld = "Alert only",
            Vlan = 10,
            VoiceVlan = 20,
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiDevicesSwitchPortsExample"] = example,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.meraki.devices.SwitchPorts;
    import com.pulumi.meraki.devices.SwitchPortsArgs;
    import com.pulumi.meraki.devices.inputs.SwitchPortsProfileArgs;
    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 example = new SwitchPorts("example", SwitchPortsArgs.builder()
                .accessPolicyNumber(2)
                .accessPolicyType("Sticky MAC allow list")
                .adaptivePolicyGroupId("123")
                .allowedVlans("1,3,5-10")
                .daiTrusted(false)
                .enabled(true)
                .flexibleStackingEnabled(true)
                .isolationEnabled(false)
                .linkNegotiation("Auto negotiate")
                .macAllowLists(            
                    "34:56:fe:ce:8e:b0",
                    "34:56:fe:ce:8e:b1")
                .name("My switch port")
                .peerSgtCapable(false)
                .poeEnabled(true)
                .portId("string")
                .portScheduleId("1234")
                .profile(SwitchPortsProfileArgs.builder()
                    .enabled(false)
                    .id("1284392014819")
                    .iname("iname")
                    .build())
                .rstpEnabled(true)
                .serial("string")
                .stickyMacAllowLists(            
                    "34:56:fe:ce:8e:b0",
                    "34:56:fe:ce:8e:b1")
                .stickyMacAllowListLimit(5)
                .stormControlEnabled(true)
                .stpGuard("disabled")
                .tags(            
                    "tag1",
                    "tag2")
                .type("access")
                .udld("Alert only")
                .vlan(10)
                .voiceVlan(20)
                .build());
    
            ctx.export("merakiDevicesSwitchPortsExample", example);
        }
    }
    
    resources:
      example:
        type: meraki:devices:SwitchPorts
        properties:
          accessPolicyNumber: 2
          accessPolicyType: Sticky MAC allow list
          adaptivePolicyGroupId: '123'
          allowedVlans: 1,3,5-10
          daiTrusted: false
          enabled: true
          flexibleStackingEnabled: true
          isolationEnabled: false
          linkNegotiation: Auto negotiate
          macAllowLists:
            - 34:56:fe:ce:8e:b0
            - 34:56:fe:ce:8e:b1
          name: My switch port
          peerSgtCapable: false
          poeEnabled: true
          portId: string
          portScheduleId: '1234'
          profile:
            enabled: false
            id: '1284392014819'
            iname: iname
          rstpEnabled: true
          serial: string
          stickyMacAllowLists:
            - 34:56:fe:ce:8e:b0
            - 34:56:fe:ce:8e:b1
          stickyMacAllowListLimit: 5
          stormControlEnabled: true
          stpGuard: disabled
          tags:
            - tag1
            - tag2
          type: access
          udld: Alert only
          vlan: 10
          voiceVlan: 20
    outputs:
      merakiDevicesSwitchPortsExample: ${example}
    

    Create SwitchPorts Resource

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

    Constructor syntax

    new SwitchPorts(name: string, args: SwitchPortsArgs, opts?: CustomResourceOptions);
    @overload
    def SwitchPorts(resource_name: str,
                    args: SwitchPortsArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def SwitchPorts(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    port_id: Optional[str] = None,
                    serial: Optional[str] = None,
                    poe_enabled: Optional[bool] = None,
                    flexible_stacking_enabled: Optional[bool] = None,
                    port_schedule_id: Optional[str] = None,
                    enabled: Optional[bool] = None,
                    profile: Optional[SwitchPortsProfileArgs] = None,
                    isolation_enabled: Optional[bool] = None,
                    link_negotiation: Optional[str] = None,
                    rstp_enabled: Optional[bool] = None,
                    name: Optional[str] = None,
                    peer_sgt_capable: Optional[bool] = None,
                    access_policy_number: Optional[int] = None,
                    adaptive_policy_group_id: Optional[str] = None,
                    dai_trusted: Optional[bool] = None,
                    allowed_vlans: Optional[str] = None,
                    mac_allow_lists: Optional[Sequence[str]] = None,
                    access_policy_type: Optional[str] = None,
                    sticky_mac_allow_list_limit: Optional[int] = None,
                    sticky_mac_allow_lists: Optional[Sequence[str]] = None,
                    storm_control_enabled: Optional[bool] = None,
                    stp_guard: Optional[str] = None,
                    tags: Optional[Sequence[str]] = None,
                    type: Optional[str] = None,
                    udld: Optional[str] = None,
                    vlan: Optional[int] = None,
                    voice_vlan: Optional[int] = None)
    func NewSwitchPorts(ctx *Context, name string, args SwitchPortsArgs, opts ...ResourceOption) (*SwitchPorts, error)
    public SwitchPorts(string name, SwitchPortsArgs args, CustomResourceOptions? opts = null)
    public SwitchPorts(String name, SwitchPortsArgs args)
    public SwitchPorts(String name, SwitchPortsArgs args, CustomResourceOptions options)
    
    type: meraki:devices:SwitchPorts
    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 SwitchPortsArgs
    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 SwitchPortsArgs
    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 SwitchPortsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SwitchPortsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SwitchPortsArgs
    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 switchPortsResource = new Meraki.Devices.SwitchPorts("switchPortsResource", new()
    {
        PortId = "string",
        Serial = "string",
        PoeEnabled = false,
        FlexibleStackingEnabled = false,
        PortScheduleId = "string",
        Enabled = false,
        Profile = new Meraki.Devices.Inputs.SwitchPortsProfileArgs
        {
            Enabled = false,
            Id = "string",
            Iname = "string",
        },
        IsolationEnabled = false,
        LinkNegotiation = "string",
        RstpEnabled = false,
        Name = "string",
        PeerSgtCapable = false,
        AccessPolicyNumber = 0,
        AdaptivePolicyGroupId = "string",
        DaiTrusted = false,
        AllowedVlans = "string",
        MacAllowLists = new[]
        {
            "string",
        },
        AccessPolicyType = "string",
        StickyMacAllowListLimit = 0,
        StickyMacAllowLists = new[]
        {
            "string",
        },
        StormControlEnabled = false,
        StpGuard = "string",
        Tags = new[]
        {
            "string",
        },
        Type = "string",
        Udld = "string",
        Vlan = 0,
        VoiceVlan = 0,
    });
    
    example, err := devices.NewSwitchPorts(ctx, "switchPortsResource", &devices.SwitchPortsArgs{
    	PortId:                  pulumi.String("string"),
    	Serial:                  pulumi.String("string"),
    	PoeEnabled:              pulumi.Bool(false),
    	FlexibleStackingEnabled: pulumi.Bool(false),
    	PortScheduleId:          pulumi.String("string"),
    	Enabled:                 pulumi.Bool(false),
    	Profile: &devices.SwitchPortsProfileArgs{
    		Enabled: pulumi.Bool(false),
    		Id:      pulumi.String("string"),
    		Iname:   pulumi.String("string"),
    	},
    	IsolationEnabled:      pulumi.Bool(false),
    	LinkNegotiation:       pulumi.String("string"),
    	RstpEnabled:           pulumi.Bool(false),
    	Name:                  pulumi.String("string"),
    	PeerSgtCapable:        pulumi.Bool(false),
    	AccessPolicyNumber:    pulumi.Int(0),
    	AdaptivePolicyGroupId: pulumi.String("string"),
    	DaiTrusted:            pulumi.Bool(false),
    	AllowedVlans:          pulumi.String("string"),
    	MacAllowLists: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	AccessPolicyType:        pulumi.String("string"),
    	StickyMacAllowListLimit: pulumi.Int(0),
    	StickyMacAllowLists: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	StormControlEnabled: pulumi.Bool(false),
    	StpGuard:            pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Type:      pulumi.String("string"),
    	Udld:      pulumi.String("string"),
    	Vlan:      pulumi.Int(0),
    	VoiceVlan: pulumi.Int(0),
    })
    
    var switchPortsResource = new SwitchPorts("switchPortsResource", SwitchPortsArgs.builder()
        .portId("string")
        .serial("string")
        .poeEnabled(false)
        .flexibleStackingEnabled(false)
        .portScheduleId("string")
        .enabled(false)
        .profile(SwitchPortsProfileArgs.builder()
            .enabled(false)
            .id("string")
            .iname("string")
            .build())
        .isolationEnabled(false)
        .linkNegotiation("string")
        .rstpEnabled(false)
        .name("string")
        .peerSgtCapable(false)
        .accessPolicyNumber(0)
        .adaptivePolicyGroupId("string")
        .daiTrusted(false)
        .allowedVlans("string")
        .macAllowLists("string")
        .accessPolicyType("string")
        .stickyMacAllowListLimit(0)
        .stickyMacAllowLists("string")
        .stormControlEnabled(false)
        .stpGuard("string")
        .tags("string")
        .type("string")
        .udld("string")
        .vlan(0)
        .voiceVlan(0)
        .build());
    
    switch_ports_resource = meraki.devices.SwitchPorts("switchPortsResource",
        port_id="string",
        serial="string",
        poe_enabled=False,
        flexible_stacking_enabled=False,
        port_schedule_id="string",
        enabled=False,
        profile={
            "enabled": False,
            "id": "string",
            "iname": "string",
        },
        isolation_enabled=False,
        link_negotiation="string",
        rstp_enabled=False,
        name="string",
        peer_sgt_capable=False,
        access_policy_number=0,
        adaptive_policy_group_id="string",
        dai_trusted=False,
        allowed_vlans="string",
        mac_allow_lists=["string"],
        access_policy_type="string",
        sticky_mac_allow_list_limit=0,
        sticky_mac_allow_lists=["string"],
        storm_control_enabled=False,
        stp_guard="string",
        tags=["string"],
        type="string",
        udld="string",
        vlan=0,
        voice_vlan=0)
    
    const switchPortsResource = new meraki.devices.SwitchPorts("switchPortsResource", {
        portId: "string",
        serial: "string",
        poeEnabled: false,
        flexibleStackingEnabled: false,
        portScheduleId: "string",
        enabled: false,
        profile: {
            enabled: false,
            id: "string",
            iname: "string",
        },
        isolationEnabled: false,
        linkNegotiation: "string",
        rstpEnabled: false,
        name: "string",
        peerSgtCapable: false,
        accessPolicyNumber: 0,
        adaptivePolicyGroupId: "string",
        daiTrusted: false,
        allowedVlans: "string",
        macAllowLists: ["string"],
        accessPolicyType: "string",
        stickyMacAllowListLimit: 0,
        stickyMacAllowLists: ["string"],
        stormControlEnabled: false,
        stpGuard: "string",
        tags: ["string"],
        type: "string",
        udld: "string",
        vlan: 0,
        voiceVlan: 0,
    });
    
    type: meraki:devices:SwitchPorts
    properties:
        accessPolicyNumber: 0
        accessPolicyType: string
        adaptivePolicyGroupId: string
        allowedVlans: string
        daiTrusted: false
        enabled: false
        flexibleStackingEnabled: false
        isolationEnabled: false
        linkNegotiation: string
        macAllowLists:
            - string
        name: string
        peerSgtCapable: false
        poeEnabled: false
        portId: string
        portScheduleId: string
        profile:
            enabled: false
            id: string
            iname: string
        rstpEnabled: false
        serial: string
        stickyMacAllowListLimit: 0
        stickyMacAllowLists:
            - string
        stormControlEnabled: false
        stpGuard: string
        tags:
            - string
        type: string
        udld: string
        vlan: 0
        voiceVlan: 0
    

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

    PortId string
    The identifier of the switch port.
    Serial string
    serial path parameter.
    AccessPolicyNumber int
    The number of a custom access policy to configure on the switch port. Only applicable when 'accessPolicyType' is 'Custom access policy'.
    AccessPolicyType string
    The type of the access policy of the switch port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'.
    AdaptivePolicyGroupId string
    The adaptive policy group ID that will be used to tag traffic through this switch port. This ID must pre-exist during the configuration, else needs to be created using adaptivePolicy/groups API. Cannot be applied to a port on a switch bound to profile.
    AllowedVlans string
    The VLANs allowed on the switch port. Only applicable to trunk ports.
    DaiTrusted bool
    If true, ARP packets for this port will be considered trusted, and Dynamic ARP Inspection will allow the traffic.
    Enabled bool
    The status of the switch port.
    FlexibleStackingEnabled bool
    For supported switches (e.g. MS420/MS425), whether or not the port has flexible stacking enabled.
    IsolationEnabled bool
    The isolation status of the switch port.
    LinkNegotiation string
    The link speed for the switch port.
    MacAllowLists List<string>
    Only devices with MAC addresses specified in this list will have access to this port. Up to 20 MAC addresses can be defined. Only applicable when 'accessPolicyType' is 'MAC allow list'.
    Name string
    The name of the switch port.
    PeerSgtCapable bool
    If true, Peer SGT is enabled for traffic through this switch port. Applicable to trunk port only, not access port. Cannot be applied to a port on a switch bound to profile.
    PoeEnabled bool
    The PoE status of the switch port.
    PortScheduleId string
    The ID of the port schedule. A value of null will clear the port schedule.
    Profile SwitchPortsProfile
    Profile attributes
    RstpEnabled bool
    The rapid spanning tree protocol status.
    StickyMacAllowListLimit int
    The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    StickyMacAllowLists List<string>
    The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    StormControlEnabled bool
    The storm control status of the switch port.
    StpGuard string
    The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
    Tags List<string>
    The list of tags of the switch port.
    Type string
    The type of the switch port ('trunk' or 'access').
    Udld string
    The action to take when Unidirectional Link is detected (Alert only, Enforce). Default configuration is Alert only.
    Vlan int
    The VLAN of the switch port. For a trunk port, this is the native VLAN. A null value will clear the value set for trunk ports.
    VoiceVlan int
    The voice VLAN of the switch port. Only applicable to access ports.
    PortId string
    The identifier of the switch port.
    Serial string
    serial path parameter.
    AccessPolicyNumber int
    The number of a custom access policy to configure on the switch port. Only applicable when 'accessPolicyType' is 'Custom access policy'.
    AccessPolicyType string
    The type of the access policy of the switch port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'.
    AdaptivePolicyGroupId string
    The adaptive policy group ID that will be used to tag traffic through this switch port. This ID must pre-exist during the configuration, else needs to be created using adaptivePolicy/groups API. Cannot be applied to a port on a switch bound to profile.
    AllowedVlans string
    The VLANs allowed on the switch port. Only applicable to trunk ports.
    DaiTrusted bool
    If true, ARP packets for this port will be considered trusted, and Dynamic ARP Inspection will allow the traffic.
    Enabled bool
    The status of the switch port.
    FlexibleStackingEnabled bool
    For supported switches (e.g. MS420/MS425), whether or not the port has flexible stacking enabled.
    IsolationEnabled bool
    The isolation status of the switch port.
    LinkNegotiation string
    The link speed for the switch port.
    MacAllowLists []string
    Only devices with MAC addresses specified in this list will have access to this port. Up to 20 MAC addresses can be defined. Only applicable when 'accessPolicyType' is 'MAC allow list'.
    Name string
    The name of the switch port.
    PeerSgtCapable bool
    If true, Peer SGT is enabled for traffic through this switch port. Applicable to trunk port only, not access port. Cannot be applied to a port on a switch bound to profile.
    PoeEnabled bool
    The PoE status of the switch port.
    PortScheduleId string
    The ID of the port schedule. A value of null will clear the port schedule.
    Profile SwitchPortsProfileArgs
    Profile attributes
    RstpEnabled bool
    The rapid spanning tree protocol status.
    StickyMacAllowListLimit int
    The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    StickyMacAllowLists []string
    The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    StormControlEnabled bool
    The storm control status of the switch port.
    StpGuard string
    The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
    Tags []string
    The list of tags of the switch port.
    Type string
    The type of the switch port ('trunk' or 'access').
    Udld string
    The action to take when Unidirectional Link is detected (Alert only, Enforce). Default configuration is Alert only.
    Vlan int
    The VLAN of the switch port. For a trunk port, this is the native VLAN. A null value will clear the value set for trunk ports.
    VoiceVlan int
    The voice VLAN of the switch port. Only applicable to access ports.
    portId String
    The identifier of the switch port.
    serial String
    serial path parameter.
    accessPolicyNumber Integer
    The number of a custom access policy to configure on the switch port. Only applicable when 'accessPolicyType' is 'Custom access policy'.
    accessPolicyType String
    The type of the access policy of the switch port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'.
    adaptivePolicyGroupId String
    The adaptive policy group ID that will be used to tag traffic through this switch port. This ID must pre-exist during the configuration, else needs to be created using adaptivePolicy/groups API. Cannot be applied to a port on a switch bound to profile.
    allowedVlans String
    The VLANs allowed on the switch port. Only applicable to trunk ports.
    daiTrusted Boolean
    If true, ARP packets for this port will be considered trusted, and Dynamic ARP Inspection will allow the traffic.
    enabled Boolean
    The status of the switch port.
    flexibleStackingEnabled Boolean
    For supported switches (e.g. MS420/MS425), whether or not the port has flexible stacking enabled.
    isolationEnabled Boolean
    The isolation status of the switch port.
    linkNegotiation String
    The link speed for the switch port.
    macAllowLists List<String>
    Only devices with MAC addresses specified in this list will have access to this port. Up to 20 MAC addresses can be defined. Only applicable when 'accessPolicyType' is 'MAC allow list'.
    name String
    The name of the switch port.
    peerSgtCapable Boolean
    If true, Peer SGT is enabled for traffic through this switch port. Applicable to trunk port only, not access port. Cannot be applied to a port on a switch bound to profile.
    poeEnabled Boolean
    The PoE status of the switch port.
    portScheduleId String
    The ID of the port schedule. A value of null will clear the port schedule.
    profile SwitchPortsProfile
    Profile attributes
    rstpEnabled Boolean
    The rapid spanning tree protocol status.
    stickyMacAllowListLimit Integer
    The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    stickyMacAllowLists List<String>
    The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    stormControlEnabled Boolean
    The storm control status of the switch port.
    stpGuard String
    The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
    tags List<String>
    The list of tags of the switch port.
    type String
    The type of the switch port ('trunk' or 'access').
    udld String
    The action to take when Unidirectional Link is detected (Alert only, Enforce). Default configuration is Alert only.
    vlan Integer
    The VLAN of the switch port. For a trunk port, this is the native VLAN. A null value will clear the value set for trunk ports.
    voiceVlan Integer
    The voice VLAN of the switch port. Only applicable to access ports.
    portId string
    The identifier of the switch port.
    serial string
    serial path parameter.
    accessPolicyNumber number
    The number of a custom access policy to configure on the switch port. Only applicable when 'accessPolicyType' is 'Custom access policy'.
    accessPolicyType string
    The type of the access policy of the switch port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'.
    adaptivePolicyGroupId string
    The adaptive policy group ID that will be used to tag traffic through this switch port. This ID must pre-exist during the configuration, else needs to be created using adaptivePolicy/groups API. Cannot be applied to a port on a switch bound to profile.
    allowedVlans string
    The VLANs allowed on the switch port. Only applicable to trunk ports.
    daiTrusted boolean
    If true, ARP packets for this port will be considered trusted, and Dynamic ARP Inspection will allow the traffic.
    enabled boolean
    The status of the switch port.
    flexibleStackingEnabled boolean
    For supported switches (e.g. MS420/MS425), whether or not the port has flexible stacking enabled.
    isolationEnabled boolean
    The isolation status of the switch port.
    linkNegotiation string
    The link speed for the switch port.
    macAllowLists string[]
    Only devices with MAC addresses specified in this list will have access to this port. Up to 20 MAC addresses can be defined. Only applicable when 'accessPolicyType' is 'MAC allow list'.
    name string
    The name of the switch port.
    peerSgtCapable boolean
    If true, Peer SGT is enabled for traffic through this switch port. Applicable to trunk port only, not access port. Cannot be applied to a port on a switch bound to profile.
    poeEnabled boolean
    The PoE status of the switch port.
    portScheduleId string
    The ID of the port schedule. A value of null will clear the port schedule.
    profile SwitchPortsProfile
    Profile attributes
    rstpEnabled boolean
    The rapid spanning tree protocol status.
    stickyMacAllowListLimit number
    The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    stickyMacAllowLists string[]
    The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    stormControlEnabled boolean
    The storm control status of the switch port.
    stpGuard string
    The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
    tags string[]
    The list of tags of the switch port.
    type string
    The type of the switch port ('trunk' or 'access').
    udld string
    The action to take when Unidirectional Link is detected (Alert only, Enforce). Default configuration is Alert only.
    vlan number
    The VLAN of the switch port. For a trunk port, this is the native VLAN. A null value will clear the value set for trunk ports.
    voiceVlan number
    The voice VLAN of the switch port. Only applicable to access ports.
    port_id str
    The identifier of the switch port.
    serial str
    serial path parameter.
    access_policy_number int
    The number of a custom access policy to configure on the switch port. Only applicable when 'accessPolicyType' is 'Custom access policy'.
    access_policy_type str
    The type of the access policy of the switch port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'.
    adaptive_policy_group_id str
    The adaptive policy group ID that will be used to tag traffic through this switch port. This ID must pre-exist during the configuration, else needs to be created using adaptivePolicy/groups API. Cannot be applied to a port on a switch bound to profile.
    allowed_vlans str
    The VLANs allowed on the switch port. Only applicable to trunk ports.
    dai_trusted bool
    If true, ARP packets for this port will be considered trusted, and Dynamic ARP Inspection will allow the traffic.
    enabled bool
    The status of the switch port.
    flexible_stacking_enabled bool
    For supported switches (e.g. MS420/MS425), whether or not the port has flexible stacking enabled.
    isolation_enabled bool
    The isolation status of the switch port.
    link_negotiation str
    The link speed for the switch port.
    mac_allow_lists Sequence[str]
    Only devices with MAC addresses specified in this list will have access to this port. Up to 20 MAC addresses can be defined. Only applicable when 'accessPolicyType' is 'MAC allow list'.
    name str
    The name of the switch port.
    peer_sgt_capable bool
    If true, Peer SGT is enabled for traffic through this switch port. Applicable to trunk port only, not access port. Cannot be applied to a port on a switch bound to profile.
    poe_enabled bool
    The PoE status of the switch port.
    port_schedule_id str
    The ID of the port schedule. A value of null will clear the port schedule.
    profile SwitchPortsProfileArgs
    Profile attributes
    rstp_enabled bool
    The rapid spanning tree protocol status.
    sticky_mac_allow_list_limit int
    The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    sticky_mac_allow_lists Sequence[str]
    The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    storm_control_enabled bool
    The storm control status of the switch port.
    stp_guard str
    The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
    tags Sequence[str]
    The list of tags of the switch port.
    type str
    The type of the switch port ('trunk' or 'access').
    udld str
    The action to take when Unidirectional Link is detected (Alert only, Enforce). Default configuration is Alert only.
    vlan int
    The VLAN of the switch port. For a trunk port, this is the native VLAN. A null value will clear the value set for trunk ports.
    voice_vlan int
    The voice VLAN of the switch port. Only applicable to access ports.
    portId String
    The identifier of the switch port.
    serial String
    serial path parameter.
    accessPolicyNumber Number
    The number of a custom access policy to configure on the switch port. Only applicable when 'accessPolicyType' is 'Custom access policy'.
    accessPolicyType String
    The type of the access policy of the switch port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'.
    adaptivePolicyGroupId String
    The adaptive policy group ID that will be used to tag traffic through this switch port. This ID must pre-exist during the configuration, else needs to be created using adaptivePolicy/groups API. Cannot be applied to a port on a switch bound to profile.
    allowedVlans String
    The VLANs allowed on the switch port. Only applicable to trunk ports.
    daiTrusted Boolean
    If true, ARP packets for this port will be considered trusted, and Dynamic ARP Inspection will allow the traffic.
    enabled Boolean
    The status of the switch port.
    flexibleStackingEnabled Boolean
    For supported switches (e.g. MS420/MS425), whether or not the port has flexible stacking enabled.
    isolationEnabled Boolean
    The isolation status of the switch port.
    linkNegotiation String
    The link speed for the switch port.
    macAllowLists List<String>
    Only devices with MAC addresses specified in this list will have access to this port. Up to 20 MAC addresses can be defined. Only applicable when 'accessPolicyType' is 'MAC allow list'.
    name String
    The name of the switch port.
    peerSgtCapable Boolean
    If true, Peer SGT is enabled for traffic through this switch port. Applicable to trunk port only, not access port. Cannot be applied to a port on a switch bound to profile.
    poeEnabled Boolean
    The PoE status of the switch port.
    portScheduleId String
    The ID of the port schedule. A value of null will clear the port schedule.
    profile Property Map
    Profile attributes
    rstpEnabled Boolean
    The rapid spanning tree protocol status.
    stickyMacAllowListLimit Number
    The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    stickyMacAllowLists List<String>
    The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    stormControlEnabled Boolean
    The storm control status of the switch port.
    stpGuard String
    The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
    tags List<String>
    The list of tags of the switch port.
    type String
    The type of the switch port ('trunk' or 'access').
    udld String
    The action to take when Unidirectional Link is detected (Alert only, Enforce). Default configuration is Alert only.
    vlan Number
    The VLAN of the switch port. For a trunk port, this is the native VLAN. A null value will clear the value set for trunk ports.
    voiceVlan Number
    The voice VLAN of the switch port. Only applicable to access ports.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    LinkNegotiationCapabilities List<string>
    Available link speeds for the switch port.
    Mirror SwitchPortsMirror
    Port mirror
    Module SwitchPortsModule
    Expansion module
    Id string
    The provider-assigned unique ID for this managed resource.
    LinkNegotiationCapabilities []string
    Available link speeds for the switch port.
    Mirror SwitchPortsMirror
    Port mirror
    Module SwitchPortsModule
    Expansion module
    id String
    The provider-assigned unique ID for this managed resource.
    linkNegotiationCapabilities List<String>
    Available link speeds for the switch port.
    mirror SwitchPortsMirror
    Port mirror
    module SwitchPortsModule
    Expansion module
    id string
    The provider-assigned unique ID for this managed resource.
    linkNegotiationCapabilities string[]
    Available link speeds for the switch port.
    mirror SwitchPortsMirror
    Port mirror
    module SwitchPortsModule
    Expansion module
    id str
    The provider-assigned unique ID for this managed resource.
    link_negotiation_capabilities Sequence[str]
    Available link speeds for the switch port.
    mirror SwitchPortsMirror
    Port mirror
    module SwitchPortsModule
    Expansion module
    id String
    The provider-assigned unique ID for this managed resource.
    linkNegotiationCapabilities List<String>
    Available link speeds for the switch port.
    mirror Property Map
    Port mirror
    module Property Map
    Expansion module

    Look up Existing SwitchPorts Resource

    Get an existing SwitchPorts 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?: SwitchPortsState, opts?: CustomResourceOptions): SwitchPorts
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_policy_number: Optional[int] = None,
            access_policy_type: Optional[str] = None,
            adaptive_policy_group_id: Optional[str] = None,
            allowed_vlans: Optional[str] = None,
            dai_trusted: Optional[bool] = None,
            enabled: Optional[bool] = None,
            flexible_stacking_enabled: Optional[bool] = None,
            isolation_enabled: Optional[bool] = None,
            link_negotiation: Optional[str] = None,
            link_negotiation_capabilities: Optional[Sequence[str]] = None,
            mac_allow_lists: Optional[Sequence[str]] = None,
            mirror: Optional[SwitchPortsMirrorArgs] = None,
            module: Optional[SwitchPortsModuleArgs] = None,
            name: Optional[str] = None,
            peer_sgt_capable: Optional[bool] = None,
            poe_enabled: Optional[bool] = None,
            port_id: Optional[str] = None,
            port_schedule_id: Optional[str] = None,
            profile: Optional[SwitchPortsProfileArgs] = None,
            rstp_enabled: Optional[bool] = None,
            serial: Optional[str] = None,
            sticky_mac_allow_list_limit: Optional[int] = None,
            sticky_mac_allow_lists: Optional[Sequence[str]] = None,
            storm_control_enabled: Optional[bool] = None,
            stp_guard: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            type: Optional[str] = None,
            udld: Optional[str] = None,
            vlan: Optional[int] = None,
            voice_vlan: Optional[int] = None) -> SwitchPorts
    func GetSwitchPorts(ctx *Context, name string, id IDInput, state *SwitchPortsState, opts ...ResourceOption) (*SwitchPorts, error)
    public static SwitchPorts Get(string name, Input<string> id, SwitchPortsState? state, CustomResourceOptions? opts = null)
    public static SwitchPorts get(String name, Output<String> id, SwitchPortsState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AccessPolicyNumber int
    The number of a custom access policy to configure on the switch port. Only applicable when 'accessPolicyType' is 'Custom access policy'.
    AccessPolicyType string
    The type of the access policy of the switch port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'.
    AdaptivePolicyGroupId string
    The adaptive policy group ID that will be used to tag traffic through this switch port. This ID must pre-exist during the configuration, else needs to be created using adaptivePolicy/groups API. Cannot be applied to a port on a switch bound to profile.
    AllowedVlans string
    The VLANs allowed on the switch port. Only applicable to trunk ports.
    DaiTrusted bool
    If true, ARP packets for this port will be considered trusted, and Dynamic ARP Inspection will allow the traffic.
    Enabled bool
    The status of the switch port.
    FlexibleStackingEnabled bool
    For supported switches (e.g. MS420/MS425), whether or not the port has flexible stacking enabled.
    IsolationEnabled bool
    The isolation status of the switch port.
    LinkNegotiation string
    The link speed for the switch port.
    LinkNegotiationCapabilities List<string>
    Available link speeds for the switch port.
    MacAllowLists List<string>
    Only devices with MAC addresses specified in this list will have access to this port. Up to 20 MAC addresses can be defined. Only applicable when 'accessPolicyType' is 'MAC allow list'.
    Mirror SwitchPortsMirror
    Port mirror
    Module SwitchPortsModule
    Expansion module
    Name string
    The name of the switch port.
    PeerSgtCapable bool
    If true, Peer SGT is enabled for traffic through this switch port. Applicable to trunk port only, not access port. Cannot be applied to a port on a switch bound to profile.
    PoeEnabled bool
    The PoE status of the switch port.
    PortId string
    The identifier of the switch port.
    PortScheduleId string
    The ID of the port schedule. A value of null will clear the port schedule.
    Profile SwitchPortsProfile
    Profile attributes
    RstpEnabled bool
    The rapid spanning tree protocol status.
    Serial string
    serial path parameter.
    StickyMacAllowListLimit int
    The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    StickyMacAllowLists List<string>
    The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    StormControlEnabled bool
    The storm control status of the switch port.
    StpGuard string
    The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
    Tags List<string>
    The list of tags of the switch port.
    Type string
    The type of the switch port ('trunk' or 'access').
    Udld string
    The action to take when Unidirectional Link is detected (Alert only, Enforce). Default configuration is Alert only.
    Vlan int
    The VLAN of the switch port. For a trunk port, this is the native VLAN. A null value will clear the value set for trunk ports.
    VoiceVlan int
    The voice VLAN of the switch port. Only applicable to access ports.
    AccessPolicyNumber int
    The number of a custom access policy to configure on the switch port. Only applicable when 'accessPolicyType' is 'Custom access policy'.
    AccessPolicyType string
    The type of the access policy of the switch port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'.
    AdaptivePolicyGroupId string
    The adaptive policy group ID that will be used to tag traffic through this switch port. This ID must pre-exist during the configuration, else needs to be created using adaptivePolicy/groups API. Cannot be applied to a port on a switch bound to profile.
    AllowedVlans string
    The VLANs allowed on the switch port. Only applicable to trunk ports.
    DaiTrusted bool
    If true, ARP packets for this port will be considered trusted, and Dynamic ARP Inspection will allow the traffic.
    Enabled bool
    The status of the switch port.
    FlexibleStackingEnabled bool
    For supported switches (e.g. MS420/MS425), whether or not the port has flexible stacking enabled.
    IsolationEnabled bool
    The isolation status of the switch port.
    LinkNegotiation string
    The link speed for the switch port.
    LinkNegotiationCapabilities []string
    Available link speeds for the switch port.
    MacAllowLists []string
    Only devices with MAC addresses specified in this list will have access to this port. Up to 20 MAC addresses can be defined. Only applicable when 'accessPolicyType' is 'MAC allow list'.
    Mirror SwitchPortsMirrorArgs
    Port mirror
    Module SwitchPortsModuleArgs
    Expansion module
    Name string
    The name of the switch port.
    PeerSgtCapable bool
    If true, Peer SGT is enabled for traffic through this switch port. Applicable to trunk port only, not access port. Cannot be applied to a port on a switch bound to profile.
    PoeEnabled bool
    The PoE status of the switch port.
    PortId string
    The identifier of the switch port.
    PortScheduleId string
    The ID of the port schedule. A value of null will clear the port schedule.
    Profile SwitchPortsProfileArgs
    Profile attributes
    RstpEnabled bool
    The rapid spanning tree protocol status.
    Serial string
    serial path parameter.
    StickyMacAllowListLimit int
    The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    StickyMacAllowLists []string
    The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    StormControlEnabled bool
    The storm control status of the switch port.
    StpGuard string
    The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
    Tags []string
    The list of tags of the switch port.
    Type string
    The type of the switch port ('trunk' or 'access').
    Udld string
    The action to take when Unidirectional Link is detected (Alert only, Enforce). Default configuration is Alert only.
    Vlan int
    The VLAN of the switch port. For a trunk port, this is the native VLAN. A null value will clear the value set for trunk ports.
    VoiceVlan int
    The voice VLAN of the switch port. Only applicable to access ports.
    accessPolicyNumber Integer
    The number of a custom access policy to configure on the switch port. Only applicable when 'accessPolicyType' is 'Custom access policy'.
    accessPolicyType String
    The type of the access policy of the switch port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'.
    adaptivePolicyGroupId String
    The adaptive policy group ID that will be used to tag traffic through this switch port. This ID must pre-exist during the configuration, else needs to be created using adaptivePolicy/groups API. Cannot be applied to a port on a switch bound to profile.
    allowedVlans String
    The VLANs allowed on the switch port. Only applicable to trunk ports.
    daiTrusted Boolean
    If true, ARP packets for this port will be considered trusted, and Dynamic ARP Inspection will allow the traffic.
    enabled Boolean
    The status of the switch port.
    flexibleStackingEnabled Boolean
    For supported switches (e.g. MS420/MS425), whether or not the port has flexible stacking enabled.
    isolationEnabled Boolean
    The isolation status of the switch port.
    linkNegotiation String
    The link speed for the switch port.
    linkNegotiationCapabilities List<String>
    Available link speeds for the switch port.
    macAllowLists List<String>
    Only devices with MAC addresses specified in this list will have access to this port. Up to 20 MAC addresses can be defined. Only applicable when 'accessPolicyType' is 'MAC allow list'.
    mirror SwitchPortsMirror
    Port mirror
    module SwitchPortsModule
    Expansion module
    name String
    The name of the switch port.
    peerSgtCapable Boolean
    If true, Peer SGT is enabled for traffic through this switch port. Applicable to trunk port only, not access port. Cannot be applied to a port on a switch bound to profile.
    poeEnabled Boolean
    The PoE status of the switch port.
    portId String
    The identifier of the switch port.
    portScheduleId String
    The ID of the port schedule. A value of null will clear the port schedule.
    profile SwitchPortsProfile
    Profile attributes
    rstpEnabled Boolean
    The rapid spanning tree protocol status.
    serial String
    serial path parameter.
    stickyMacAllowListLimit Integer
    The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    stickyMacAllowLists List<String>
    The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    stormControlEnabled Boolean
    The storm control status of the switch port.
    stpGuard String
    The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
    tags List<String>
    The list of tags of the switch port.
    type String
    The type of the switch port ('trunk' or 'access').
    udld String
    The action to take when Unidirectional Link is detected (Alert only, Enforce). Default configuration is Alert only.
    vlan Integer
    The VLAN of the switch port. For a trunk port, this is the native VLAN. A null value will clear the value set for trunk ports.
    voiceVlan Integer
    The voice VLAN of the switch port. Only applicable to access ports.
    accessPolicyNumber number
    The number of a custom access policy to configure on the switch port. Only applicable when 'accessPolicyType' is 'Custom access policy'.
    accessPolicyType string
    The type of the access policy of the switch port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'.
    adaptivePolicyGroupId string
    The adaptive policy group ID that will be used to tag traffic through this switch port. This ID must pre-exist during the configuration, else needs to be created using adaptivePolicy/groups API. Cannot be applied to a port on a switch bound to profile.
    allowedVlans string
    The VLANs allowed on the switch port. Only applicable to trunk ports.
    daiTrusted boolean
    If true, ARP packets for this port will be considered trusted, and Dynamic ARP Inspection will allow the traffic.
    enabled boolean
    The status of the switch port.
    flexibleStackingEnabled boolean
    For supported switches (e.g. MS420/MS425), whether or not the port has flexible stacking enabled.
    isolationEnabled boolean
    The isolation status of the switch port.
    linkNegotiation string
    The link speed for the switch port.
    linkNegotiationCapabilities string[]
    Available link speeds for the switch port.
    macAllowLists string[]
    Only devices with MAC addresses specified in this list will have access to this port. Up to 20 MAC addresses can be defined. Only applicable when 'accessPolicyType' is 'MAC allow list'.
    mirror SwitchPortsMirror
    Port mirror
    module SwitchPortsModule
    Expansion module
    name string
    The name of the switch port.
    peerSgtCapable boolean
    If true, Peer SGT is enabled for traffic through this switch port. Applicable to trunk port only, not access port. Cannot be applied to a port on a switch bound to profile.
    poeEnabled boolean
    The PoE status of the switch port.
    portId string
    The identifier of the switch port.
    portScheduleId string
    The ID of the port schedule. A value of null will clear the port schedule.
    profile SwitchPortsProfile
    Profile attributes
    rstpEnabled boolean
    The rapid spanning tree protocol status.
    serial string
    serial path parameter.
    stickyMacAllowListLimit number
    The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    stickyMacAllowLists string[]
    The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    stormControlEnabled boolean
    The storm control status of the switch port.
    stpGuard string
    The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
    tags string[]
    The list of tags of the switch port.
    type string
    The type of the switch port ('trunk' or 'access').
    udld string
    The action to take when Unidirectional Link is detected (Alert only, Enforce). Default configuration is Alert only.
    vlan number
    The VLAN of the switch port. For a trunk port, this is the native VLAN. A null value will clear the value set for trunk ports.
    voiceVlan number
    The voice VLAN of the switch port. Only applicable to access ports.
    access_policy_number int
    The number of a custom access policy to configure on the switch port. Only applicable when 'accessPolicyType' is 'Custom access policy'.
    access_policy_type str
    The type of the access policy of the switch port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'.
    adaptive_policy_group_id str
    The adaptive policy group ID that will be used to tag traffic through this switch port. This ID must pre-exist during the configuration, else needs to be created using adaptivePolicy/groups API. Cannot be applied to a port on a switch bound to profile.
    allowed_vlans str
    The VLANs allowed on the switch port. Only applicable to trunk ports.
    dai_trusted bool
    If true, ARP packets for this port will be considered trusted, and Dynamic ARP Inspection will allow the traffic.
    enabled bool
    The status of the switch port.
    flexible_stacking_enabled bool
    For supported switches (e.g. MS420/MS425), whether or not the port has flexible stacking enabled.
    isolation_enabled bool
    The isolation status of the switch port.
    link_negotiation str
    The link speed for the switch port.
    link_negotiation_capabilities Sequence[str]
    Available link speeds for the switch port.
    mac_allow_lists Sequence[str]
    Only devices with MAC addresses specified in this list will have access to this port. Up to 20 MAC addresses can be defined. Only applicable when 'accessPolicyType' is 'MAC allow list'.
    mirror SwitchPortsMirrorArgs
    Port mirror
    module SwitchPortsModuleArgs
    Expansion module
    name str
    The name of the switch port.
    peer_sgt_capable bool
    If true, Peer SGT is enabled for traffic through this switch port. Applicable to trunk port only, not access port. Cannot be applied to a port on a switch bound to profile.
    poe_enabled bool
    The PoE status of the switch port.
    port_id str
    The identifier of the switch port.
    port_schedule_id str
    The ID of the port schedule. A value of null will clear the port schedule.
    profile SwitchPortsProfileArgs
    Profile attributes
    rstp_enabled bool
    The rapid spanning tree protocol status.
    serial str
    serial path parameter.
    sticky_mac_allow_list_limit int
    The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    sticky_mac_allow_lists Sequence[str]
    The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    storm_control_enabled bool
    The storm control status of the switch port.
    stp_guard str
    The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
    tags Sequence[str]
    The list of tags of the switch port.
    type str
    The type of the switch port ('trunk' or 'access').
    udld str
    The action to take when Unidirectional Link is detected (Alert only, Enforce). Default configuration is Alert only.
    vlan int
    The VLAN of the switch port. For a trunk port, this is the native VLAN. A null value will clear the value set for trunk ports.
    voice_vlan int
    The voice VLAN of the switch port. Only applicable to access ports.
    accessPolicyNumber Number
    The number of a custom access policy to configure on the switch port. Only applicable when 'accessPolicyType' is 'Custom access policy'.
    accessPolicyType String
    The type of the access policy of the switch port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'.
    adaptivePolicyGroupId String
    The adaptive policy group ID that will be used to tag traffic through this switch port. This ID must pre-exist during the configuration, else needs to be created using adaptivePolicy/groups API. Cannot be applied to a port on a switch bound to profile.
    allowedVlans String
    The VLANs allowed on the switch port. Only applicable to trunk ports.
    daiTrusted Boolean
    If true, ARP packets for this port will be considered trusted, and Dynamic ARP Inspection will allow the traffic.
    enabled Boolean
    The status of the switch port.
    flexibleStackingEnabled Boolean
    For supported switches (e.g. MS420/MS425), whether or not the port has flexible stacking enabled.
    isolationEnabled Boolean
    The isolation status of the switch port.
    linkNegotiation String
    The link speed for the switch port.
    linkNegotiationCapabilities List<String>
    Available link speeds for the switch port.
    macAllowLists List<String>
    Only devices with MAC addresses specified in this list will have access to this port. Up to 20 MAC addresses can be defined. Only applicable when 'accessPolicyType' is 'MAC allow list'.
    mirror Property Map
    Port mirror
    module Property Map
    Expansion module
    name String
    The name of the switch port.
    peerSgtCapable Boolean
    If true, Peer SGT is enabled for traffic through this switch port. Applicable to trunk port only, not access port. Cannot be applied to a port on a switch bound to profile.
    poeEnabled Boolean
    The PoE status of the switch port.
    portId String
    The identifier of the switch port.
    portScheduleId String
    The ID of the port schedule. A value of null will clear the port schedule.
    profile Property Map
    Profile attributes
    rstpEnabled Boolean
    The rapid spanning tree protocol status.
    serial String
    serial path parameter.
    stickyMacAllowListLimit Number
    The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    stickyMacAllowLists List<String>
    The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
    stormControlEnabled Boolean
    The storm control status of the switch port.
    stpGuard String
    The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
    tags List<String>
    The list of tags of the switch port.
    type String
    The type of the switch port ('trunk' or 'access').
    udld String
    The action to take when Unidirectional Link is detected (Alert only, Enforce). Default configuration is Alert only.
    vlan Number
    The VLAN of the switch port. For a trunk port, this is the native VLAN. A null value will clear the value set for trunk ports.
    voiceVlan Number
    The voice VLAN of the switch port. Only applicable to access ports.

    Supporting Types

    SwitchPortsMirror, SwitchPortsMirrorArgs

    Mode string
    The port mirror mode. Can be one of ('Destination port', 'Source port' or 'Not mirroring traffic').
    Mode string
    The port mirror mode. Can be one of ('Destination port', 'Source port' or 'Not mirroring traffic').
    mode String
    The port mirror mode. Can be one of ('Destination port', 'Source port' or 'Not mirroring traffic').
    mode string
    The port mirror mode. Can be one of ('Destination port', 'Source port' or 'Not mirroring traffic').
    mode str
    The port mirror mode. Can be one of ('Destination port', 'Source port' or 'Not mirroring traffic').
    mode String
    The port mirror mode. Can be one of ('Destination port', 'Source port' or 'Not mirroring traffic').

    SwitchPortsModule, SwitchPortsModuleArgs

    Model string
    The model of the expansion module.
    Model string
    The model of the expansion module.
    model String
    The model of the expansion module.
    model string
    The model of the expansion module.
    model str
    The model of the expansion module.
    model String
    The model of the expansion module.

    SwitchPortsProfile, SwitchPortsProfileArgs

    Enabled bool
    When enabled, override this port's configuration with a port profile.
    Id string
    When enabled, the ID of the port profile used to override the port's configuration.
    Iname string
    When enabled, the IName of the profile.
    Enabled bool
    When enabled, override this port's configuration with a port profile.
    Id string
    When enabled, the ID of the port profile used to override the port's configuration.
    Iname string
    When enabled, the IName of the profile.
    enabled Boolean
    When enabled, override this port's configuration with a port profile.
    id String
    When enabled, the ID of the port profile used to override the port's configuration.
    iname String
    When enabled, the IName of the profile.
    enabled boolean
    When enabled, override this port's configuration with a port profile.
    id string
    When enabled, the ID of the port profile used to override the port's configuration.
    iname string
    When enabled, the IName of the profile.
    enabled bool
    When enabled, override this port's configuration with a port profile.
    id str
    When enabled, the ID of the port profile used to override the port's configuration.
    iname str
    When enabled, the IName of the profile.
    enabled Boolean
    When enabled, override this port's configuration with a port profile.
    id String
    When enabled, the ID of the port profile used to override the port's configuration.
    iname String
    When enabled, the IName of the profile.

    Import

    $ pulumi import meraki:devices/switchPorts:SwitchPorts example "port_id,serial"
    

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

    Package Details

    Repository
    meraki pulumi/pulumi-meraki
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the meraki Terraform Provider.
    meraki logo
    Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi