Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi
meraki.devices.getSwitchPorts
Explore with Pulumi AI
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:
getSwitchPorts Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Item
Get
Switch Ports Item - Items
List<Get
Switch Ports Item> - Array of ResponseSwitchGetDeviceSwitchPorts
- Port
Id string - portId path parameter. Port ID
- Serial string
- serial path parameter.
- Id string
- The provider-assigned unique ID for this managed resource.
- Item
Get
Switch Ports Item - Items
[]Get
Switch Ports Item - Array of ResponseSwitchGetDeviceSwitchPorts
- Port
Id string - portId path parameter. Port ID
- Serial string
- serial path parameter.
- id String
- The provider-assigned unique ID for this managed resource.
- item
Get
Switch Ports Item - items
List<Get
Switch Ports Item> - Array of ResponseSwitchGetDeviceSwitchPorts
- port
Id String - portId path parameter. Port ID
- serial String
- serial path parameter.
- id string
- The provider-assigned unique ID for this managed resource.
- item
Get
Switch Ports Item - items
Get
Switch Ports Item[] - Array of ResponseSwitchGetDeviceSwitchPorts
- port
Id string - portId path parameter. Port ID
- serial string
- serial path parameter.
- id str
- The provider-assigned unique ID for this managed resource.
- item
Get
Switch Ports Item - items
Sequence[Get
Switch Ports Item] - 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
- port
Id String - portId path parameter. Port ID
- serial String
- serial path parameter.
Supporting Types
GetSwitchPortsItem
- Access
Policy intNumber - The number of a custom access policy to configure on the switch port. Only applicable when 'accessPolicyType' is 'Custom access policy'.
- Access
Policy stringType - 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 stringGroup Id - 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 string - 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 boolEnabled - 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 string - The link speed for the switch port.
- Link
Negotiation List<string>Capabilities - Available link speeds for the switch port.
- Mac
Allow List<string>Lists - 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
Get
Switch Ports Item Mirror - Port mirror
- Module
Get
Switch Ports Item Module - Expansion module
- Name string
- The name of the switch port.
- Peer
Sgt boolCapable - 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 string - The identifier of the switch port.
- Port
Schedule stringId - The ID of the port schedule. A value of null will clear the port schedule.
- Profile
Get
Switch Ports Item Profile - Profile attributes
- Rstp
Enabled bool - The rapid spanning tree protocol status.
- Sticky
Mac intAllow List Limit - The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
- Sticky
Mac List<string>Allow Lists - The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
- Storm
Control boolEnabled - The storm control status of the switch port.
- Stp
Guard string - The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
- 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.
- Voice
Vlan int - The voice VLAN of the switch port. Only applicable to access ports.
- Access
Policy intNumber - The number of a custom access policy to configure on the switch port. Only applicable when 'accessPolicyType' is 'Custom access policy'.
- Access
Policy stringType - 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 stringGroup Id - 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 string - 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 boolEnabled - 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 string - The link speed for the switch port.
- Link
Negotiation []stringCapabilities - Available link speeds for the switch port.
- Mac
Allow []stringLists - 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
Get
Switch Ports Item Mirror - Port mirror
- Module
Get
Switch Ports Item Module - Expansion module
- Name string
- The name of the switch port.
- Peer
Sgt boolCapable - 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 string - The identifier of the switch port.
- Port
Schedule stringId - The ID of the port schedule. A value of null will clear the port schedule.
- Profile
Get
Switch Ports Item Profile - Profile attributes
- Rstp
Enabled bool - The rapid spanning tree protocol status.
- Sticky
Mac intAllow List Limit - The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
- Sticky
Mac []stringAllow Lists - The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
- Storm
Control boolEnabled - The storm control status of the switch port.
- Stp
Guard string - The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
- []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.
- Voice
Vlan int - The voice VLAN of the switch port. Only applicable to access ports.
- access
Policy IntegerNumber - The number of a custom access policy to configure on the switch port. Only applicable when 'accessPolicyType' is 'Custom access policy'.
- access
Policy StringType - 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 StringGroup Id - 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 String - The VLANs allowed on the switch port. Only applicable to trunk ports.
- dai
Trusted 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.
- flexible
Stacking BooleanEnabled - For supported switches (e.g. MS420/MS425), whether or not the port has flexible stacking enabled.
- isolation
Enabled Boolean - The isolation status of the switch port.
- link
Negotiation String - The link speed for the switch port.
- link
Negotiation List<String>Capabilities - Available link speeds for the switch port.
- mac
Allow List<String>Lists - 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
Get
Switch Ports Item Mirror - Port mirror
- module
Get
Switch Ports Item Module - Expansion module
- name String
- The name of the switch port.
- peer
Sgt BooleanCapable - 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 Boolean - The PoE status of the switch port.
- port
Id String - The identifier of the switch port.
- port
Schedule StringId - The ID of the port schedule. A value of null will clear the port schedule.
- profile
Get
Switch Ports Item Profile - Profile attributes
- rstp
Enabled Boolean - The rapid spanning tree protocol status.
- sticky
Mac IntegerAllow List Limit - The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
- sticky
Mac List<String>Allow Lists - The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
- storm
Control BooleanEnabled - The storm control status of the switch port.
- stp
Guard String - The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
- 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.
- voice
Vlan Integer - The voice VLAN of the switch port. Only applicable to access ports.
- access
Policy numberNumber - The number of a custom access policy to configure on the switch port. Only applicable when 'accessPolicyType' is 'Custom access policy'.
- access
Policy stringType - 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 stringGroup Id - 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 string - The VLANs allowed on the switch port. Only applicable to trunk ports.
- dai
Trusted 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.
- flexible
Stacking booleanEnabled - For supported switches (e.g. MS420/MS425), whether or not the port has flexible stacking enabled.
- isolation
Enabled boolean - The isolation status of the switch port.
- link
Negotiation string - The link speed for the switch port.
- link
Negotiation string[]Capabilities - Available link speeds for the switch port.
- mac
Allow string[]Lists - 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
Get
Switch Ports Item Mirror - Port mirror
- module
Get
Switch Ports Item Module - Expansion module
- name string
- The name of the switch port.
- peer
Sgt booleanCapable - 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 boolean - The PoE status of the switch port.
- port
Id string - The identifier of the switch port.
- port
Schedule stringId - The ID of the port schedule. A value of null will clear the port schedule.
- profile
Get
Switch Ports Item Profile - Profile attributes
- rstp
Enabled boolean - The rapid spanning tree protocol status.
- sticky
Mac numberAllow List Limit - The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
- sticky
Mac string[]Allow Lists - The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
- storm
Control booleanEnabled - The storm control status of the switch port.
- stp
Guard string - The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
- 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.
- voice
Vlan number - The voice VLAN of the switch port. Only applicable to access ports.
- access_
policy_ intnumber - The number of a custom access policy to configure on the switch port. Only applicable when 'accessPolicyType' is 'Custom access policy'.
- access_
policy_ strtype - 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_ strgroup_ id - 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_ boolenabled - 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_ Sequence[str]capabilities - Available link speeds for the switch port.
- mac_
allow_ Sequence[str]lists - 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
Get
Switch Ports Item Mirror - Port mirror
- module
Get
Switch Ports Item Module - Expansion module
- name str
- The name of the switch port.
- peer_
sgt_ boolcapable - 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_ strid - The ID of the port schedule. A value of null will clear the port schedule.
- profile
Get
Switch Ports Item Profile - Profile attributes
- rstp_
enabled bool - The rapid spanning tree protocol status.
- sticky_
mac_ intallow_ list_ limit - The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
- sticky_
mac_ Sequence[str]allow_ lists - The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
- storm_
control_ boolenabled - 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').
- 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.
- access
Policy NumberNumber - The number of a custom access policy to configure on the switch port. Only applicable when 'accessPolicyType' is 'Custom access policy'.
- access
Policy StringType - 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 StringGroup Id - 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 String - The VLANs allowed on the switch port. Only applicable to trunk ports.
- dai
Trusted 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.
- flexible
Stacking BooleanEnabled - For supported switches (e.g. MS420/MS425), whether or not the port has flexible stacking enabled.
- isolation
Enabled Boolean - The isolation status of the switch port.
- link
Negotiation String - The link speed for the switch port.
- link
Negotiation List<String>Capabilities - Available link speeds for the switch port.
- mac
Allow List<String>Lists - 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.
- peer
Sgt BooleanCapable - 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 Boolean - The PoE status of the switch port.
- port
Id String - The identifier of the switch port.
- port
Schedule StringId - The ID of the port schedule. A value of null will clear the port schedule.
- profile Property Map
- Profile attributes
- rstp
Enabled Boolean - The rapid spanning tree protocol status.
- sticky
Mac NumberAllow List Limit - The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
- sticky
Mac List<String>Allow Lists - The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'.
- storm
Control BooleanEnabled - The storm control status of the switch port.
- stp
Guard String - The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard').
- 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.
- voice
Vlan 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
Package Details
- Repository
- meraki pulumi/pulumi-meraki
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
meraki
Terraform Provider.