Docs Packages
  1. Packages
  2. Cisco Meraki
  3. API Docs
  4. devices
  5. getSwitchPorts
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
pulumi/pulumi-meraki

meraki.devices.getSwitchPorts

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
pulumi/pulumi-meraki

    Example Usage

    Using getSwitchPorts

    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 getSwitchPorts(args: GetSwitchPortsArgs, opts?: InvokeOptions): Promise<GetSwitchPortsResult>
function getSwitchPortsOutput(args: GetSwitchPortsOutputArgs, opts?: InvokeOptions): Output<GetSwitchPortsResult>
    def get_switch_ports(port_id: Optional[str] = None,
                     serial: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetSwitchPortsResult
def get_switch_ports_output(port_id: Optional[pulumi.Input[str]] = None,
                     serial: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetSwitchPortsResult]
    func LookupSwitchPorts(ctx *Context, args *LookupSwitchPortsArgs, opts ...InvokeOption) (*LookupSwitchPortsResult, error)
func LookupSwitchPortsOutput(ctx *Context, args *LookupSwitchPortsOutputArgs, opts ...InvokeOption) LookupSwitchPortsResultOutput

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

    public static class GetSwitchPorts 
{
    public static Task<GetSwitchPortsResult> InvokeAsync(GetSwitchPortsArgs args, InvokeOptions? opts = null)
    public static Output<GetSwitchPortsResult> Invoke(GetSwitchPortsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSwitchPortsResult> getSwitchPorts(GetSwitchPortsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: meraki:devices/getSwitchPorts:getSwitchPorts
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PortId string
    portId path parameter. Port ID
    Serial string
    serial path parameter.
    PortId string
    portId path parameter. Port ID
    Serial string
    serial path parameter.
    portId String
    portId path parameter. Port ID
    serial String
    serial path parameter.
    portId string
    portId path parameter. Port ID
    serial string
    serial path parameter.
    port_id str
    portId path parameter. Port ID
    serial str
    serial path parameter.
    portId String
    portId path parameter. Port ID
    serial String
    serial path parameter.

    getSwitchPorts Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Item GetSwitchPortsItem
    Items List<GetSwitchPortsItem>
    Array of ResponseSwitchGetDeviceSwitchPorts
    PortId string
    portId path parameter. Port ID
    Serial string
    serial path parameter.
    Id string
    The provider-assigned unique ID for this managed resource.
    Item GetSwitchPortsItem
    Items []GetSwitchPortsItem
    Array of ResponseSwitchGetDeviceSwitchPorts
    PortId string
    portId path parameter. Port ID
    Serial string
    serial path parameter.
    id String
    The provider-assigned unique ID for this managed resource.
    item GetSwitchPortsItem
    items List<GetSwitchPortsItem>
    Array of ResponseSwitchGetDeviceSwitchPorts
    portId String
    portId path parameter. Port ID
    serial String
    serial path parameter.
    id string
    The provider-assigned unique ID for this managed resource.
    item GetSwitchPortsItem
    items GetSwitchPortsItem[]
    Array of ResponseSwitchGetDeviceSwitchPorts
    portId string
    portId path parameter. Port ID
    serial string
    serial path parameter.
    id str
    The provider-assigned unique ID for this managed resource.
    item GetSwitchPortsItem
    items Sequence[GetSwitchPortsItem]
    Array of ResponseSwitchGetDeviceSwitchPorts
    port_id str
    portId path parameter. Port ID
    serial str
    serial path parameter.
    id String
    The provider-assigned unique ID for this managed resource.
    item Property Map
    items List<Property Map>
    Array of ResponseSwitchGetDeviceSwitchPorts
    portId String
    portId path parameter. Port ID
    serial String
    serial path parameter.

    Supporting Types

    GetSwitchPortsItem

    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 GetSwitchPortsItemMirror
    Port mirror
    Module GetSwitchPortsItemModule
    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 GetSwitchPortsItemProfile
    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.
    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 GetSwitchPortsItemMirror
    Port mirror
    Module GetSwitchPortsItemModule
    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 GetSwitchPortsItemProfile
    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.
    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 GetSwitchPortsItemMirror
    Port mirror
    module GetSwitchPortsItemModule
    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 GetSwitchPortsItemProfile
    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.
    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 GetSwitchPortsItemMirror
    Port mirror
    module GetSwitchPortsItemModule
    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 GetSwitchPortsItemProfile
    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.
    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 GetSwitchPortsItemMirror
    Port mirror
    module GetSwitchPortsItemModule
    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 GetSwitchPortsItemProfile
    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.
    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.
    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.

    GetSwitchPortsItemMirror

    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').

    GetSwitchPortsItemModule

    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.

    GetSwitchPortsItemProfile

    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.

    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.2.4 published on Friday, Jun 14, 2024 by Pulumi
    pulumi/pulumi-meraki