Table of Contents

Class SwitchPort

Namespace
Meraki.Api.Data
Assembly
Meraki.Api.dll

A device switch port

[DataContract]
public class SwitchPort : NamedItem
Inheritance
SwitchPort
Inherited Members

Properties

AccessPolicyNumber

The number of a custom access policy to configure on the switch port. Only applicable when 'accessPolicyType' is 'Custom access policy'

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "accessPolicyNumber")]
public int? AccessPolicyNumber { get; set; }

Property Value

int?

AccessPolicyType

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'

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "accessPolicyType")]
public string? AccessPolicyType { get; set; }

Property Value

string

AdaptivePolicyGroup

The adaptive policy group data of the port.

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "adaptivePolicyGroup")]
public SwitchPortAssignedAdaptivePolicyGroup? AdaptivePolicyGroup { get; set; }

Property Value

SwitchPortAssignedAdaptivePolicyGroup

AdaptivePolicyGroupId

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.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "adaptivePolicyGroupId")]
public string? AdaptivePolicyGroupId { get; set; }

Property Value

string

AllowedVlans

The VLANs allowed on the switch port. Only applicable to trunk ports.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "allowedVlans")]
public string? AllowedVlans { get; set; }

Property Value

string

DaiTrusted

If true, ARP packets for this port will be considered trusted, and Dynamic ARP Inspection will allow the traffic.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "daiTrusted")]
public bool? DaiTrusted { get; set; }

Property Value

bool?

Dot3az

dot3az settings for the port

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "dot3az")]
public SwitchPortDot3az? Dot3az { get; set; }

Property Value

SwitchPortDot3az

Enabled

The status of the switch port

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "enabled")]
public bool Enabled { get; set; }

Property Value

bool

FlexibleStackingEnabled

For supported switches (e.g. MS420/MS425), whether or not the port has flexible stacking enabled.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "flexibleStackingEnabled")]
public bool? FlexibleStackingEnabled { get; set; }

Property Value

bool?

IsolationEnabled

The isolation status of the switch port

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "isolationEnabled")]
public bool IsolationEnabled { get; set; }

Property Value

bool

LinkNegotiation

The link speed for the switch port

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "linkNegotiation")]
public string LinkNegotiation { get; set; }

Property Value

string

LinkNegotiationCapabilities 

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "linkNegotiationCapabilities")]
public List<string>? LinkNegotiationCapabilities { get; set; }

Property Value

List<string>

MacAllowList

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'

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "macAllowList")]
public List<string>? MacAllowList { get; set; }

Property Value

List<string>

Mirror

Switch Port Mirror

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "mirror")]
public SwitchPortMirror? Mirror { get; set; }

Property Value

SwitchPortMirror

Module

Switch Port Module

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "module")]
public SwitchPortModule? Module { get; set; }

Property Value

SwitchPortModule

PeerSgtCapable

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.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "peerSgtCapable")]
public bool? PeerSgtCapable { get; set; }

Property Value

bool?

PoeEnabled

The PoE status of the switch port

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "poeEnabled")]
public bool PoeEnabled { get; set; }

Property Value

bool

PortId

PortId

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "portId")]
public string PortId { get; set; }

Property Value

string

PortScheduleId

The ID of the port schedule. A value of null will clear the port schedule

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "portScheduleId")]
[JsonProperty(NullValueHandling = NullValueHandling.Include)]
public string? PortScheduleId { get; set; }

Property Value

string

Profile

Profile attributes

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "profile")]
public SwitchPortProfile? Profile { get; set; }

Property Value

SwitchPortProfile

RstpEnabled

The rapid spanning tree protocol status

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "rstpEnabled")]
public bool RstpEnabled { get; set; }

Property Value

bool

Schedule

The port schedule data.

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "schedule")]
public SwitchPortAssignedSchedule? Schedule { get; set; }

Property Value

SwitchPortAssignedSchedule

StackwiseVirtual

Stackwise Virtual settings for the port

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "stackwiseVirtual")]
public SwitchPortStackwiseVirtual? StackwiseVirtual { get; set; }

Property Value

SwitchPortStackwiseVirtual

StickyMacAllowList

The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "stickyMacAllowList")]
public List<string>? StickyMacAllowList { get; set; }

Property Value

List<string>

StickyMacAllowListLimit

The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "stickyMacAllowListLimit")]
public int? StickyMacAllowListLimit { get; set; }

Property Value

int?

StormControlEnabled

The storm control status of the switch port

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "stormControlEnabled")]
public bool? StormControlEnabled { get; set; }

Property Value

bool?

StpGuard

The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard')

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "stpGuard")]
public string StpGuard { get; set; }

Property Value

string

Tags

The list of tags of the switch port

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "tags")]
public List<string> Tags { get; set; }

Property Value

List<string>

Type

The type of the switch port ('trunk' or 'access')

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "type")]
public string Type { get; set; }

Property Value

string

Udld

The action to take when Unidirectional Link is detected (Alert only, Enforce). Default configuration is Alert only.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "udld")]
public string? Udld { get; set; }

Property Value

string

Vlan

The VLAN of the switch port. A null value will clear the value set for trunk ports.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "vlan")]
[JsonProperty(NullValueHandling = NullValueHandling.Include)]
public int? Vlan { get; set; }

Property Value

int?

VoiceVlan

The voice VLAN of the switch port. Only applicable to access ports.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "voiceVlan")]
public int? VoiceVlan { get; set; }

Property Value

int?
Edit this page