Switch

Add a switch to a stack.

API documentation: addNetworkSwitchStack

Parameters:

• network_id (str) –

  Network ID.

• switch_stack_id (str) –

  Switch stack ID.

• serial (str) –

  The serial of the switch to be added.

Returns:

• NetworkSwitchStackResponse –

  Successful operation.

{
  "id": "8473",
  "name": "A cool stack",
  "serials": [
    "QBZY-XWVU-TSRQ",
    "QBAB-CDEF-GHIJ"
  ],
  "isMonitorOnly": false,
  "virtualMac": "00:18:0a:4f:21:19",
  "members": [
    {
      "serial": "QBZY-XWVU-TSRQ",
      "name": "switch 1",
      "model": "MS350-24-HW",
      "mac": "00:18:0a:00:00:09",
      "role": "active"
    }
  ]
}

Clone port-level and some switch-level configuration settings from a source switch to one or more target switches.

API documentation: cloneOrganizationSwitchDevices

Parameters:

• organization_id (str) –

  Organization ID.

• source_serial (str) –

  Serial number of the source switch (must be on a network not bound to a template).

• target_serials (list[str]) –

  Array of serial numbers of one or more target switches (must be on a network not bound to a template).

Returns:

• CloneOrganizationSwitchDevicesResponse –

  Successful operation.

{
  "sourceSerial": "Q234-ABCD-5678",
  "targetSerials": [
    "Q234-ABCD-0001",
    "Q234-ABCD-0002",
    "Q234-ABCD-0003"
  ]
}

Create a layer 3 interface for a switch.

API documentation: createDeviceSwitchRoutingInterface

Parameters:

• serial (str) –

  Serial.

• name (str) –

  A friendly name or description for the interface or VLAN (max length 128 characters).

• mode (CreateDeviceSwitchRoutingInterfaceMode | None, default: None ) –

  L3 Interface mode, can be one of 'vlan', 'routed', 'loopback'. Default is 'vlan'. CS 17.18 or higher is required for 'routed' mode.

• subnet (str | None, default: None ) –

  The network that this L3 interface is on, in CIDR notation (ex. 10.1.1.0/24).

• switch_port_id (str | None, default: None ) –

  Switch Port ID when in Routed mode (CS 17.18 or higher required).

• interface_ip (str | None, default: None ) –

  The IP address that will be used for Layer 3 routing on this VLAN or subnet. This cannot be the same as the device management IP.

• mtu (int | None, default: None ) –

  The interface MTU. Applies to native switch layer 3 interfaces, including VLAN and routed modes.

• multicast_routing (CreateDeviceSwitchRoutingInterfaceMulticastRouting | None, default: None ) –

  Enable multicast support if, multicast routing between VLANs is required. Options are: 'disabled', 'enabled' or 'IGMP snooping querier'. Default is 'disabled'.

• vlan_id (int | None, default: None ) –

  The VLAN this L3 interface is on. VLAN must be between 1 and 4094.

• default_gateway (str | None, default: None ) –

  The next hop for any traffic that isn't going to a directly connected subnet or over a static route. This IP address must exist in a subnet with a L3 interface. Required if this is the first IPv4 interface.

• ospf_settings (CreateDeviceSwitchRoutingInterfaceOspfSettings | None, default: None ) –

  The OSPF routing settings of the interface.

• ipv6 (CreateDeviceSwitchRoutingInterfaceIpv6 | None, default: None ) –

  The IPv6 settings of the interface.

• vrf (CreateDeviceSwitchRoutingInterfaceVrf | None, default: None ) –

  The VRF settings of the interface. Requires IOS XE 17.18 or higher.

• loopback (dict[str, Any] | None, default: None ) –

  The loopback settings of the interface.

Returns:

• CreateDeviceSwitchRoutingInterfaceResponse –

  Successful operation.

{
  "interfaceId": "1234",
  "name": "L3 interface",
  "mode": "vlan",
  "subnet": "192.168.1.0/24",
  "interfaceIp": "192.168.1.2",
  "mtu": 1500,
  "serial": "Q234-ABCD-5678",
  "switchPortId": "1",
  "multicastRouting": "disabled",
  "vlanId": 100,
  "uplinkV4": false,
  "uplinkV6": false,
  "ospfSettings": {
    "area": "0",
    "cost": 1,
    "isPassiveEnabled": true,
    "networkType": "broadcast"
  },
  "ospfV3": {
    "area": "1",
    "cost": 2,
    "isPassiveEnabled": true,
    "networkType": "broadcast"
  },
  "ipv6": {
    "assignmentMode": "static",
    "address": "2001:db8::1",
    "prefix": "2001:db8::/32",
    "gateway": "2001:db8::2"
  },
  "vrf": {
    "name": "Blue"
  },
  "defaultGateway": "192.168.1.1"
}

Create a layer 3 static route for a switch.

API documentation: createDeviceSwitchRoutingStaticRoute

Parameters:

• serial (str) –

  Serial.

• name (str | None, default: None ) –

  Name or description for layer 3 static route.

• subnet (str) –

  The subnet which is routed via this static route and should be specified in CIDR notation (ex. 1.2.3.0/24).

• next_hop_ip (str) –

  IP address of the next hop device to which the device sends its traffic for the subnet.

• advertise_via_ospf_enabled (bool | None, default: None ) –

  Option to advertise static route via OSPF.

• prefer_over_ospf_routes_enabled (bool | None, default: None ) –

  Option to prefer static route over OSPF routes.

• vrf (CreateDeviceSwitchRoutingStaticRouteVrf | None, default: None ) –

  The VRF settings of the interface. Requires IOS XE 17.18 or higher.

Returns:

• CreateDeviceSwitchRoutingStaticRouteResponse –

  Successful operation.

{
  "staticRouteId": "1234",
  "name": "My route",
  "subnet": "192.168.1.0/24",
  "nextHopIp": "1.2.3.4",
  "managementNextHop": "1.2.3.5",
  "vrf": {
    "name": "Blue",
    "leakRouteToDefaultVrf": false
  },
  "advertiseViaOspfEnabled": false,
  "preferOverOspfRoutesEnabled": false
}

Create an access policy for a switch network.

API documentation: createNetworkSwitchAccessPolicy

Parameters:

• network_id (str) –

  Network ID.

• name (str) –

  Name of the access policy(max length 255).

• radius_servers (list[CreateNetworkSwitchAccessPolicyRadiusServersItem]) –

  List of RADIUS servers to require connecting devices to authenticate against before granting network access.

• radius (CreateNetworkSwitchAccessPolicyRadius | None, default: None ) –

  Object for RADIUS Settings.

• guest_port_bouncing (bool | None, default: None ) –

  If enabled, Meraki devices will periodically send access-request messages to these RADIUS servers.

• radius_testing_enabled (bool | None, default: None ) –

  If enabled, Meraki devices will periodically send access-request messages to these RADIUS servers.

• radius_coa_support_enabled (bool | None, default: None ) –

  Change of authentication for RADIUS re-authentication and disconnection.

• radius_accounting_enabled (bool) –

  Enable to send start, interim-update and stop messages to a configured RADIUS accounting server for tracking connected clients.

• radius_accounting_servers (list[CreateNetworkSwitchAccessPolicyRadiusAccountingServersItem] | None, default: None ) –

  List of RADIUS accounting servers to require connecting devices to authenticate against before granting network access.

• radius_group_attribute (str | None, default: None ) –

  Acceptable values are "" for None, or "11" for Group Policies ACL.

• host_mode (CreateNetworkSwitchAccessPolicyHostMode | None, default: None ) –

  Choose the Host Mode for the access policy.

• access_policy_type (CreateNetworkSwitchAccessPolicyAccessPolicyType | None, default: None ) –

  Access Type of the policy. Automatically 'Hybrid authentication' when hostMode is 'Multi-Domain'.

• increase_access_speed (bool | None, default: None ) –

  Enabling this option will make switches execute 802.1X and MAC- bypass authentication simultaneously so that clients authenticate faster. Only required when accessPolicyType is 'Hybrid Authentication.

• guest_vlan_id (int | None, default: None ) –

  ID for the guest VLAN allow unauthorized devices access to limited network resources.

• dot1x (CreateNetworkSwitchAccessPolicyDot1x | None, default: None ) –

  802.1x Settings.

• voice_vlan_clients (bool | None, default: None ) –

  CDP/LLDP capable voice clients will be able to use this VLAN. Automatically true when hostMode is 'Multi-Domain'.

• url_redirect_walled_garden_enabled (bool | None, default: None ) –

  Enable to restrict access for clients to a specific set of IP addresses or hostnames prior to authentication.

• url_redirect_walled_garden_ranges (list[str] | None, default: None ) –

  IP address ranges, in CIDR notation, to restrict access for clients to a specific set of IP addresses or hostnames prior to authentication.

• guest_group_policy_id (str | None, default: None ) –

  Group policy Number for guest group policy.

• guest_sgt_id (int | None, default: None ) –

  Security Group Tag ID for guest group policy.

Returns:

• NetworkSwitchAccessPolicyResponse –

  Successful operation.

{
  "accessPolicyNumber": "1234",
  "name": "Access policy #1",
  "radiusServers": [
    {
      "serverId": "1",
      "organizationRadiusServerId": "42",
      "host": "1.2.3.4",
      "port": 22
    }
  ],
  "radius": {
    "criticalAuth": {
      "dataVlanId": 100,
      "voiceVlanId": 100,
      "suspendPortBounce": true,
      "dataGroupPolicyId": "1234",
      "voiceGroupPolicyId": "1234",
      "dataSgtId": 1234,
      "voiceSgtId": 1234
    },
    "failedAuthVlanId": 100,
    "failedAuthGroupPolicyId": "1234",
    "failedAuthSgtId": 1284392014819,
    "reAuthenticationInterval": 120,
    "cache": {
      "enabled": false,
      "timeout": 24
    },
    "authentication": {
      "mode": "Open"
    },
    "preAuthenticationGroupPolicyId": "1234"
  },
  "enforceRadiusMonitoring": false,
  "guestPortBouncing": false,
  "radiusTestingEnabled": false,
  "radiusCoaSupportEnabled": false,
  "radiusAccountingEnabled": true,
  "radiusAccountingServers": [
    {
      "serverId": "2",
      "organizationRadiusServerId": "42",
      "host": "1.2.3.4",
      "port": 22
    }
  ],
  "radiusGroupAttribute": "11",
  "hostMode": "Single-Host",
  "accessPolicyType": "Hybrid authentication",
  "increaseAccessSpeed": false,
  "guestVlanId": 100,
  "dot1x": {
    "controlDirection": "inbound"
  },
  "voiceVlanClients": true,
  "urlRedirectWalledGardenEnabled": true,
  "urlRedirectWalledGardenRanges": [
    "192.168.1.0/24"
  ],
  "counts": {
    "ports": {
      "withThisPolicy": 12
    }
  },
  "guestGroupPolicyId": "1234",
  "guestSgtId": 1284392014819
}

Add a server to be trusted by Dynamic ARP Inspection on this network.

API documentation: createNetworkSwitchDhcpServerPolicyArpInspectionTrustedServer

Parameters:

• network_id (str) –

  Network ID.

• mac (str) –

  The mac address of the trusted server being added.

• vlan (int) –

  The VLAN of the trusted server being added. It must be between 1 and 4094.

• ipv4 (CreateNetworkSwitchDhcpServerPolicyArpInspectionTrustedServerIpv4) –

  The IPv4 attributes of the trusted server being added.

Returns:

• NetworkSwitchDhcpServerPolicyArpInspectionTrustedServerResponse –

  Successful operation.

{
  "trustedServerId": "123",
  "mac": "00:11:22:33:44:55",
  "vlan": 100,
  "ipv4": {
    "address": "1.2.3.4"
  }
}

Create a link aggregation group.

API documentation: createNetworkSwitchLinkAggregation

Parameters:

• network_id (str) –

  Network ID.

• switch_ports (list[CreateNetworkSwitchLinkAggregationSwitchPortsItem] | None, default: None ) –

  Array of switch or stack ports for creating aggregation group. Minimum 2 and maximum 8 ports are supported.

• switch_profile_ports (list[CreateNetworkSwitchLinkAggregationSwitchProfilePortsItem] | None, default: None ) –

  Array of switch profile ports for creating aggregation group. Minimum 2 and maximum 8 ports are supported.

Returns:

• NetworkSwitchLinkAggregationResponse –

  Successful operation.

{
  "id": "NDU2N18yXzM=",
  "switchPorts": [
    {
      "serial": "Q234-ABCD-0001",
      "portId": "1"
    }
  ]
}

Add a switch port schedule.

API documentation: createNetworkSwitchPortSchedule

Parameters:

• network_id (str) –

  Network ID.

• name (str) –

  The name for your port schedule. Required.

• port_schedule (CreateNetworkSwitchPortSchedulePortSchedule | None, default: None ) –

  The schedule for switch port scheduling. Schedules are applied to days of the week. When it's empty, default schedule with all days of a week are configured. Any unspecified day in the schedule is added as a default schedule configuration of the day.

Returns:

• NetworkSwitchPortScheduleResponse –

  Successful operation.

{
  "id": "1234",
  "networkId": "N_24329156",
  "name": "Weekdays schedule",
  "portSchedule": {
    "monday": {
      "active": true,
      "from": "9:00",
      "to": "17:00"
    },
    "tuesday": {
      "active": true,
      "from": "9:00",
      "to": "17:00"
    },
    "wednesday": {
      "active": true,
      "from": "9:00",
      "to": "17:00"
    },
    "thursday": {
      "active": true,
      "from": "9:00",
      "to": "17:00"
    },
    "friday": {
      "active": true,
      "from": "9:00",
      "to": "17:00"
    },
    "saturday": {
      "active": false,
      "from": "0:00",
      "to": "24:00"
    },
    "sunday": {
      "active": false,
      "from": "0:00",
      "to": "24:00"
    }
  }
}

Add a quality of service rule.

API documentation: createNetworkSwitchQosRule

Parameters:

• network_id (str) –

  Network ID.

• vlan (int) –

  The VLAN of the incoming packet. A null value will match any VLAN.

• protocol (CreateNetworkSwitchQosRuleProtocol | None, default: None ) –

  The protocol of the incoming packet. Default value is "ANY".

• src_port (int | None, default: None ) –

  The source port of the incoming packet. Applicable only if protocol is TCP or UDP.

• src_port_range (str | None, default: None ) –

  The source port range of the incoming packet. Applicable only if protocol is set to TCP or UDP.

• dst_port (int | None, default: None ) –

  The destination port of the incoming packet. Applicable only if protocol is TCP or UDP.

• dst_port_range (str | None, default: None ) –

  The destination port range of the incoming packet. Applicable only if protocol is set to TCP or UDP.

• dscp (int | None, default: None ) –

  DSCP tag for the incoming packet. Set this to -1 to trust incoming DSCP. Default value is 0.

Returns:

• NetworkSwitchQosRuleResponse –

  Successful operation.

{
  "id": "1284392014819",
  "vlan": 100,
  "protocol": "TCP",
  "srcPort": 2000,
  "srcPortRange": "70-80",
  "dstPort": 3000,
  "dstPortRange": "3000-3100",
  "dscp": 0
}

Create a multicast rendezvous point.

API documentation: createNetworkSwitchRoutingMulticastRendezvousPoint

Parameters:

• network_id (str) –

  Network ID.

• interface_ip (str) –

  The IP address of the interface where the RP needs to be created.

• multicast_group (str) –

  'Any', or the IP address of a multicast group.

• vrf (CreateNetworkSwitchRoutingMulticastRendezvousPointVrf | None, default: None ) –

  The VRF with PIM enabled L3 interface.

Returns:

• NetworkSwitchRoutingMulticastRendezvousPointResponse –

  Successful operation.

{
  "rendezvousPointId": "1234",
  "serial": "Q234-ABCD-5678",
  "interfaceName": "l3_interface_0",
  "interfaceIp": "192.168.1.2",
  "multicastGroup": "Any"
}

Create a switch stack.

API documentation: createNetworkSwitchStack

Parameters:

• network_id (str) –

  Network ID.

• name (str) –

  The name of the new stack.

• serials (list[str]) –

  An array of switch serials to be added into the new stack.

Returns:

• CreateNetworkSwitchStackResponse –

  Successful operation.

{
  "id": "8473",
  "name": "A cool stack",
  "serials": [
    "QBZY-XWVU-TSRQ",
    "QBAB-CDEF-GHIJ"
  ],
  "workflowId": "8473"
}

Create a layer 3 interface for a switch stack.

API documentation: createNetworkSwitchStackRoutingInterface

Parameters:

• network_id (str) –

  Network ID.

• switch_stack_id (str) –

  Switch stack ID.

• name (str) –

  A friendly name or description for the interface or VLAN (max length 128 characters).

• mode (CreateNetworkSwitchStackRoutingInterfaceMode | None, default: None ) –

  L3 Interface mode, can be one of 'vlan', 'routed', 'loopback'. Default is 'vlan'. CS 17.18 or higher is required for 'routed' mode.

• subnet (str | None, default: None ) –

  The network that this L3 interface is on, in CIDR notation (ex. 10.1.1.0/24).

• switch_port_id (str | None, default: None ) –

  Switch Port ID when in Routed mode (CS 17.18 or higher required).

• interface_ip (str | None, default: None ) –

  The IP address that will be used for Layer 3 routing on this VLAN or subnet. This cannot be the same as the device management IP.

• mtu (int | None, default: None ) –

  The interface MTU. Applies to native switch layer 3 interfaces, including VLAN and routed modes.

• multicast_routing (CreateNetworkSwitchStackRoutingInterfaceMulticastRouting | None, default: None ) –

  Enable multicast support if, multicast routing between VLANs is required. Options are: 'disabled', 'enabled' or 'IGMP snooping querier'. Default is 'disabled'.

• vlan_id (int | None, default: None ) –

  The VLAN this L3 interface is on. VLAN must be between 1 and 4094.

• default_gateway (str | None, default: None ) –

  The next hop for any traffic that isn't going to a directly connected subnet or over a static route. This IP address must exist in a subnet with a L3 interface. Required if this is the first IPv4 interface.

• ospf_settings (CreateNetworkSwitchStackRoutingInterfaceOspfSettings | None, default: None ) –

  The OSPF routing settings of the interface.

• ipv6 (CreateNetworkSwitchStackRoutingInterfaceIpv6 | None, default: None ) –

  The IPv6 settings of the interface.

• vrf (CreateNetworkSwitchStackRoutingInterfaceVrf | None, default: None ) –

  The VRF settings of the interface. Requires IOS XE 17.18 or higher.

• loopback (dict[str, Any] | None, default: None ) –

  The loopback settings of the interface.

Returns:

• CreateDeviceSwitchRoutingInterfaceResponse –

  Successful operation.

{
  "interfaceId": "1234",
  "name": "L3 interface",
  "mode": "vlan",
  "subnet": "192.168.1.0/24",
  "interfaceIp": "192.168.1.2",
  "mtu": 1500,
  "serial": "Q234-ABCD-5678",
  "switchPortId": "1",
  "multicastRouting": "disabled",
  "vlanId": 100,
  "uplinkV4": false,
  "uplinkV6": false,
  "ospfSettings": {
    "area": "0",
    "cost": 1,
    "isPassiveEnabled": true,
    "networkType": "broadcast"
  },
  "ospfV3": {
    "area": "1",
    "cost": 2,
    "isPassiveEnabled": true,
    "networkType": "broadcast"
  },
  "ipv6": {
    "assignmentMode": "static",
    "address": "2001:db8::1",
    "prefix": "2001:db8::/32",
    "gateway": "2001:db8::2"
  },
  "vrf": {
    "name": "Blue"
  },
  "defaultGateway": "192.168.1.1"
}

Create a layer 3 static route for a switch stack.

API documentation: createNetworkSwitchStackRoutingStaticRoute

Parameters:

• network_id (str) –

  Network ID.

• switch_stack_id (str) –

  Switch stack ID.

• name (str | None, default: None ) –

  Name or description for layer 3 static route.

• subnet (str) –

  The subnet which is routed via this static route and should be specified in CIDR notation (ex. 1.2.3.0/24).

• next_hop_ip (str) –

  IP address of the next hop device to which the device sends its traffic for the subnet.

• advertise_via_ospf_enabled (bool | None, default: None ) –

  Option to advertise static route via OSPF.

• prefer_over_ospf_routes_enabled (bool | None, default: None ) –

  Option to prefer static route over OSPF routes.

• vrf (CreateNetworkSwitchStackRoutingStaticRouteVrf | None, default: None ) –

  The VRF settings of the interface. Requires IOS XE 17.18 or higher.

Returns:

• CreateDeviceSwitchRoutingStaticRouteResponse –

  Successful operation.

{
  "staticRouteId": "1234",
  "name": "My route",
  "subnet": "192.168.1.0/24",
  "nextHopIp": "1.2.3.4",
  "managementNextHop": "1.2.3.5",
  "vrf": {
    "name": "Blue",
    "leakRouteToDefaultVrf": false
  },
  "advertiseViaOspfEnabled": false,
  "preferOverOspfRoutesEnabled": false
}

Cycle a set of switch ports on non-Catalyst MS devices.

API documentation: cycleDeviceSwitchPorts

Parameters:

• serial (str) –

  Serial.

• ports (list[str]) –

  List of switch ports.

Returns:

• CycleDeviceSwitchPortsResponse –

  Successful operation.

{
  "ports": [
    "1",
    "2-5",
    "1_MA-MOD-8X10G_1",
    "1_MA-MOD-8X10G_2-1_MA-MOD-8X10G_8"
  ]
}

Delete a layer 3 interface from the switch.

API documentation: deleteDeviceSwitchRoutingInterface

Parameters:

• serial (str) –

  Serial.

• interface_id (str) –

  Interface ID.

Returns:

• None –

  Successful operation.

Delete a layer 3 static route for a switch.

API documentation: deleteDeviceSwitchRoutingStaticRoute

Parameters:

• serial (str) –

  Serial.

• static_route_id (str) –

  Static route ID.

Returns:

• None –

  Successful operation.

Delete an access policy for a switch network.

API documentation: deleteNetworkSwitchAccessPolicy

Parameters:

• network_id (str) –

  Network ID.

• access_policy_number (str) –

  Access policy number.

Returns:

• None –

  Successful operation.

Remove a server from being trusted by Dynamic ARP Inspection on this network.

API documentation: deleteNetworkSwitchDhcpServerPolicyArpInspectionTrustedServer

Parameters:

• network_id (str) –

  Network ID.

• trusted_server_id (str) –

  Trusted server ID.

Returns:

• None –

  Successful operation.

Split a link aggregation group into separate ports.

API documentation: deleteNetworkSwitchLinkAggregation

Parameters:

• network_id (str) –

  Network ID.

• link_aggregation_id (str) –

  Link aggregation ID.

Returns:

• None –

  Successful operation.

Delete a switch port schedule.

API documentation: deleteNetworkSwitchPortSchedule

Parameters:

• network_id (str) –

  Network ID.

• port_schedule_id (str) –

  Port schedule ID.

Returns:

• None –

  Successful operation.

Delete a quality of service rule.

API documentation: deleteNetworkSwitchQosRule

Parameters:

• network_id (str) –

  Network ID.

• qos_rule_id (str) –

  Qos rule ID.

Returns:

• None –

  Successful operation.

Delete a multicast rendezvous point.

API documentation: deleteNetworkSwitchRoutingMulticastRendezvousPoint

Parameters:

• network_id (str) –

  Network ID.

• rendezvous_point_id (str) –

  Rendezvous point ID.

Returns:

• None –

  Successful operation.

Delete a stack.

API documentation: deleteNetworkSwitchStack

Parameters:

• network_id (str) –

  Network ID.

• switch_stack_id (str) –

  Switch stack ID.

Returns:

• None –

  Successful operation.

Delete a layer 3 interface from a switch stack.

API documentation: deleteNetworkSwitchStackRoutingInterface

Parameters:

• network_id (str) –

  Network ID.

• switch_stack_id (str) –

  Switch stack ID.

• interface_id (str) –

  Interface ID.

Returns:

• None –

  Successful operation.

Delete a layer 3 static route for a switch stack.

API documentation: deleteNetworkSwitchStackRoutingStaticRoute

Parameters:

• network_id (str) –

  Network ID.

• switch_stack_id (str) –

  Switch stack ID.

• static_route_id (str) –

  Static route ID.

Returns:

• None –

  Successful operation.

Return a switch port.

API documentation: getDeviceSwitchPort

Parameters:

• serial (str) –

  Serial.

• port_id (str) –

  Port ID.

Returns:

• DeviceSwitchPortResponse –

  Successful operation.

{
  "portId": "1",
  "name": "My switch port",
  "tags": [
    "tag1",
    "tag2"
  ],
  "enabled": true,
  "poeEnabled": true,
  "type": "access",
  "vlan": 10,
  "voiceVlan": 20,
  "allowedVlans": "1,3,5-10",
  "isolationEnabled": false,
  "rstpEnabled": true,
  "stpGuard": "disabled",
  "stpPortFastTrunk": false,
  "linkNegotiation": "Auto negotiate",
  "linkNegotiationCapabilities": [
    "Auto negotiate",
    "1 Gigabit full duplex (auto)"
  ],
  "portScheduleId": "1234",
  "schedule": {
    "id": "1234",
    "name": "Port Schedule"
  },
  "udld": "Alert only",
  "accessPolicyType": "Sticky MAC allow list",
  "accessPolicyNumber": 2,
  "macAllowList": [
    "34:56:fe:ce:8e:a0",
    "34:56:fe:ce:8e:a1"
  ],
  "macWhitelistLimit": 10,
  "stickyMacAllowList": [
    "34:56:fe:ce:8e:b0",
    "34:56:fe:ce:8e:b1"
  ],
  "stickyMacAllowListLimit": 5,
  "stormControlEnabled": true,
  "adaptivePolicyGroupId": "123",
  "adaptivePolicyGroup": {
    "id": "123",
    "name": "Adaptive Policy Group"
  },
  "peerSgtCapable": false,
  "flexibleStackingEnabled": true,
  "daiTrusted": false,
  "profile": {
    "enabled": false,
    "id": "1284392014819",
    "iname": "iname"
  },
  "module": {
    "model": "MA-MOD-4X10G",
    "serial": "3_MA-MOD-4X10G",
    "slot": 1
  },
  "mirror": {
    "mode": "Not mirroring traffic"
  },
  "dot3az": {
    "enabled": false
  },
  "highSpeed": {
    "enabled": false
  }
}

List the switch ports for a switch.

API documentation: getDeviceSwitchPorts

Parameters:

• serial (str) –

  Serial.

Returns:

• PaginatedResponse[DeviceSwitchPortResponse] –

  Successful operation.

[
  {
    "portId": "1",
    "name": "My switch port",
    "tags": [
      "tag1",
      "tag2"
    ],
    "enabled": true,
    "poeEnabled": true,
    "type": "access",
    "vlan": 10,
    "voiceVlan": 20,
    "allowedVlans": "1,3,5-10",
    "isolationEnabled": false,
    "rstpEnabled": true,
    "stpGuard": "disabled",
    "stpPortFastTrunk": false,
    "linkNegotiation": "Auto negotiate",
    "linkNegotiationCapabilities": [
      "Auto negotiate",
      "1 Gigabit full duplex (auto)"
    ],
    "portScheduleId": "1234",
    "schedule": {
      "id": "1234",
      "name": "Port Schedule"
    },
    "udld": "Alert only",
    "accessPolicyType": "Sticky MAC allow list",
    "accessPolicyNumber": 2,
    "macAllowList": [
      "34:56:fe:ce:8e:a0",
      "34:56:fe:ce:8e:a1"
    ],
    "macWhitelistLimit": 10,
    "stickyMacAllowList": [
      "34:56:fe:ce:8e:b0",
      "34:56:fe:ce:8e:b1"
    ],
    "stickyMacAllowListLimit": 5,
    "stormControlEnabled": true,
    "adaptivePolicyGroupId": "123",
    "adaptivePolicyGroup": {
      "id": "123",
      "name": "Adaptive Policy Group"
    },
    "peerSgtCapable": false,
    "flexibleStackingEnabled": true,
    "daiTrusted": false,
    "profile": {
      "enabled": false,
      "id": "1284392014819",
      "iname": "iname"
    },
    "module": {
      "model": "MA-MOD-4X10G",
      "serial": "3_MA-MOD-4X10G",
      "slot": 1
    },
    "mirror": {
      "mode": "Not mirroring traffic"
    },
    "dot3az": {
      "enabled": false
    },
    "highSpeed": {
      "enabled": false
    }
  }
]

Return the status for all the ports of a switch.

API documentation: getDeviceSwitchPortsStatuses

Parameters:

• serial (str) –

  Serial.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 31 days from today.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

Returns:

• PaginatedResponse[GetDeviceSwitchPortsStatusesResponseItem] –

  Successful operation.

[
  {
    "portId": "1",
    "enabled": true,
    "status": "Connected",
    "isUplink": false,
    "errors": [
      "PoE overload",
      "Very high proportion of CRC errors"
    ],
    "warnings": [
      "SecurePort authentication in progress",
      "PoE port was denied power",
      "High proportion of CRC errors"
    ],
    "speed": "10 Gbps",
    "duplex": "full",
    "spanningTree": {
      "statuses": [
        "Learning"
      ]
    },
    "poe": {
      "isAllocated": false
    },
    "usageInKb": {
      "total": 40867,
      "sent": 23008,
      "recv": 17859
    },
    "cdp": {
      "systemName": "",
      "platform": "MS350-24X",
      "deviceId": "0c8ddbddee:ff",
      "portId": "Port 20",
      "nativeVlan": 1,
      "address": "10.0,0.1",
      "managementAddress": "10.0.0.100",
      "version": "1",
      "vtpManagementDomain": "",
      "capabilities": "Switch"
    },
    "lldp": {
      "systemName": "MS350-24X - Test",
      "systemDescription": "MS350-24X Cloud Managed PoE Switch",
      "chassisId": "0c:8d:db:dd:ee:ff",
      "portId": "20",
      "managementVlan": 1,
      "portVlan": 1,
      "managementAddress": "10.0.0.100",
      "portDescription": "Port 20",
      "systemCapabilities": "switch"
    },
    "clientCount": 10,
    "powerUsageInWh": 55.9,
    "trafficInKbps": {
      "total": 2.2,
      "sent": 1.2,
      "recv": 1.0
    },
    "securePort": {
      "enabled": true,
      "active": true,
      "authenticationStatus": "Authentication in progress",
      "configOverrides": {
        "type": "trunk",
        "vlan": 12,
        "voiceVlan": 34,
        "allowedVlans": "all"
      }
    }
  }
]

Return the packet counters for all the ports of a switch.

API documentation: getDeviceSwitchPortsStatusesPackets

Parameters:

• serial (str) –

  Serial.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The value is used only to determine the elapsed duration between t0 and the time of the request; the API snaps that duration to the nearest preset window (5 minutes, 15 minutes, 1 hour, or 1 day).

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify t0. The value must be in seconds and be less than or equal to 86400 seconds (1 day). The default is 1 day.

Returns:

• PaginatedResponse[GetDeviceSwitchPortsStatusesPacketsResponseItem] –

  Successful operation.

[
  {
    "portId": "1",
    "packets": [
      {
        "desc": "Total",
        "total": 112081,
        "sent": 104135,
        "recv": 7946,
        "ratePerSec": {
          "total": 1,
          "sent": 1,
          "recv": 0
        }
      }
    ]
  }
]

Return a layer 3 interface for a switch.

API documentation: getDeviceSwitchRoutingInterface

Parameters:

• serial (str) –

  Serial.

• interface_id (str) –

  Interface ID.

Returns:

• CreateDeviceSwitchRoutingInterfaceResponse –

  Successful operation.

{
  "interfaceId": "1234",
  "name": "L3 interface",
  "mode": "vlan",
  "subnet": "192.168.1.0/24",
  "interfaceIp": "192.168.1.2",
  "mtu": 1500,
  "serial": "Q234-ABCD-5678",
  "switchPortId": "1",
  "multicastRouting": "disabled",
  "vlanId": 100,
  "uplinkV4": false,
  "uplinkV6": false,
  "ospfSettings": {
    "area": "0",
    "cost": 1,
    "isPassiveEnabled": true,
    "networkType": "broadcast"
  },
  "ospfV3": {
    "area": "1",
    "cost": 2,
    "isPassiveEnabled": true,
    "networkType": "broadcast"
  },
  "ipv6": {
    "assignmentMode": "static",
    "address": "2001:db8::1",
    "prefix": "2001:db8::/32",
    "gateway": "2001:db8::2"
  },
  "vrf": {
    "name": "Blue"
  },
  "defaultGateway": "192.168.1.1"
}

Return a layer 3 interface DHCP configuration for a switch.

API documentation: getDeviceSwitchRoutingInterfaceDhcp

Parameters:

• serial (str) –

  Serial.

• interface_id (str) –

  Interface ID.

Returns:

• GetDeviceSwitchRoutingInterfaceDhcpResponse –

  Successful operation.

{
  "dhcpMode": "dhcpServer",
  "dhcpRelayServerIps": [
    "1.2.3.4"
  ],
  "dhcpLeaseTime": "1 day",
  "dnsNameserversOption": "custom",
  "dnsCustomNameservers": [
    "8.8.8.8, 8.8.4.4"
  ],
  "bootOptionsEnabled": true,
  "bootNextServer": "1.2.3.4",
  "bootFileName": "home_boot_file",
  "dhcpOptions": [
    {
      "code": "5",
      "type": "text",
      "value": "five"
    }
  ],
  "reservedIpRanges": [
    {
      "start": "192.168.1.1",
      "end": "192.168.1.10",
      "comment": "A reserved IP range"
    }
  ],
  "fixedIpAssignments": [
    {
      "name": "Cisco Meraki valued client",
      "mac": "22:33:44:55:66:77",
      "ip": "192.168.1.12"
    }
  ]
}

List layer 3 interfaces for a switch.

API documentation: getDeviceSwitchRoutingInterfaces

Parameters:

• serial (str) –

  Serial.

• mode (GetDeviceSwitchRoutingInterfacesMode | None, default: None ) –

  Optional parameter to filter L3 interfaces by mode.

• protocol (GetDeviceSwitchRoutingInterfacesProtocol | None, default: None ) –

  Optional parameter to filter L3 interfaces by protocol.

Returns:

• PaginatedResponse[CreateDeviceSwitchRoutingInterfaceResponse] –

  Successful operation.

[
  {
    "interfaceId": "1234",
    "name": "L3 interface",
    "mode": "vlan",
    "subnet": "192.168.1.0/24",
    "interfaceIp": "192.168.1.2",
    "mtu": 1500,
    "serial": "Q234-ABCD-5678",
    "switchPortId": "1",
    "multicastRouting": "disabled",
    "vlanId": 100,
    "uplinkV4": false,
    "uplinkV6": false,
    "ospfSettings": {
      "area": "0",
      "cost": 1,
      "isPassiveEnabled": true,
      "networkType": "broadcast"
    },
    "ospfV3": {
      "area": "1",
      "cost": 2,
      "isPassiveEnabled": true,
      "networkType": "broadcast"
    },
    "ipv6": {
      "assignmentMode": "static",
      "address": "2001:db8::1",
      "prefix": "2001:db8::/32",
      "gateway": "2001:db8::2"
    },
    "vrf": {
      "name": "Blue"
    },
    "defaultGateway": "192.168.1.1"
  }
]

Return a layer 3 static route for a switch.

API documentation: getDeviceSwitchRoutingStaticRoute

Parameters:

• serial (str) –

  Serial.

• static_route_id (str) –

  Static route ID.

Returns:

• CreateDeviceSwitchRoutingStaticRouteResponse –

  Successful operation.

{
  "staticRouteId": "1234",
  "name": "My route",
  "subnet": "192.168.1.0/24",
  "nextHopIp": "1.2.3.4",
  "managementNextHop": "1.2.3.5",
  "vrf": {
    "name": "Blue",
    "leakRouteToDefaultVrf": false
  },
  "advertiseViaOspfEnabled": false,
  "preferOverOspfRoutesEnabled": false
}

List layer 3 static routes for a switch.

API documentation: getDeviceSwitchRoutingStaticRoutes

Parameters:

• serial (str) –

  Serial.

Returns:

• PaginatedResponse[CreateDeviceSwitchRoutingStaticRouteResponse] –

  Successful operation.

[
  {
    "staticRouteId": "1234",
    "name": "My route",
    "subnet": "192.168.1.0/24",
    "nextHopIp": "1.2.3.4",
    "managementNextHop": "1.2.3.5",
    "vrf": {
      "name": "Blue",
      "leakRouteToDefaultVrf": false
    },
    "advertiseViaOspfEnabled": false,
    "preferOverOspfRoutesEnabled": false
  }
]

Return warm spare configuration for a switch.

API documentation: getDeviceSwitchWarmSpare

Parameters:

• serial (str) –

  Serial.

Returns:

• DeviceSwitchWarmSpareResponse –

  Successful operation.

{
  "enabled": true,
  "primarySerial": "Q234-ABCD-0001",
  "spareSerial": "Q234-ABCD-0002"
}

Return the access control lists for a MS network.

API documentation: getNetworkSwitchAccessControlLists

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkSwitchAccessControlListsResponse –

  Successful operation.

{
  "rules": [
    {
      "comment": "Deny SSH",
      "policy": "deny",
      "ipVersion": "ipv4",
      "protocol": "tcp",
      "srcCidr": "10.1.10.0/24",
      "srcPort": "any",
      "dstCidr": "172.16.30/24",
      "dstPort": "22",
      "vlan": "10"
    }
  ]
}

List the access policies for a switch network.

API documentation: getNetworkSwitchAccessPolicies

Parameters:

• network_id (str) –

  Network ID.

Returns:

• PaginatedResponse[NetworkSwitchAccessPolicyResponse] –

  Successful operation.

[
  {
    "accessPolicyNumber": "1234",
    "name": "Access policy #1",
    "radiusServers": [
      {
        "serverId": "1",
        "organizationRadiusServerId": "42",
        "host": "1.2.3.4",
        "port": 22
      }
    ],
    "radius": {
      "criticalAuth": {
        "dataVlanId": 100,
        "voiceVlanId": 100,
        "suspendPortBounce": true,
        "dataGroupPolicyId": "1234",
        "voiceGroupPolicyId": "1234",
        "dataSgtId": 1234,
        "voiceSgtId": 1234
      },
      "failedAuthVlanId": 100,
      "failedAuthGroupPolicyId": "1234",
      "failedAuthSgtId": 1284392014819,
      "reAuthenticationInterval": 120,
      "cache": {
        "enabled": false,
        "timeout": 24
      },
      "authentication": {
        "mode": "Open"
      },
      "preAuthenticationGroupPolicyId": "1234"
    },
    "enforceRadiusMonitoring": false,
    "guestPortBouncing": false,
    "radiusTestingEnabled": false,
    "radiusCoaSupportEnabled": false,
    "radiusAccountingEnabled": true,
    "radiusAccountingServers": [
      {
        "serverId": "2",
        "organizationRadiusServerId": "42",
        "host": "1.2.3.4",
        "port": 22
      }
    ],
    "radiusGroupAttribute": "11",
    "hostMode": "Single-Host",
    "accessPolicyType": "Hybrid authentication",
    "increaseAccessSpeed": false,
    "guestVlanId": 100,
    "dot1x": {
      "controlDirection": "inbound"
    },
    "voiceVlanClients": true,
    "urlRedirectWalledGardenEnabled": true,
    "urlRedirectWalledGardenRanges": [
      "192.168.1.0/24"
    ],
    "counts": {
      "ports": {
        "withThisPolicy": 12
      }
    },
    "guestGroupPolicyId": "1234",
    "guestSgtId": 1284392014819
  }
]

Return a specific access policy for a switch network.

API documentation: getNetworkSwitchAccessPolicy

Parameters:

• network_id (str) –

  Network ID.

• access_policy_number (str) –

  Access policy number.

Returns:

• NetworkSwitchAccessPolicyResponse –

  Successful operation.

{
  "accessPolicyNumber": "1234",
  "name": "Access policy #1",
  "radiusServers": [
    {
      "serverId": "1",
      "organizationRadiusServerId": "42",
      "host": "1.2.3.4",
      "port": 22
    }
  ],
  "radius": {
    "criticalAuth": {
      "dataVlanId": 100,
      "voiceVlanId": 100,
      "suspendPortBounce": true,
      "dataGroupPolicyId": "1234",
      "voiceGroupPolicyId": "1234",
      "dataSgtId": 1234,
      "voiceSgtId": 1234
    },
    "failedAuthVlanId": 100,
    "failedAuthGroupPolicyId": "1234",
    "failedAuthSgtId": 1284392014819,
    "reAuthenticationInterval": 120,
    "cache": {
      "enabled": false,
      "timeout": 24
    },
    "authentication": {
      "mode": "Open"
    },
    "preAuthenticationGroupPolicyId": "1234"
  },
  "enforceRadiusMonitoring": false,
  "guestPortBouncing": false,
  "radiusTestingEnabled": false,
  "radiusCoaSupportEnabled": false,
  "radiusAccountingEnabled": true,
  "radiusAccountingServers": [
    {
      "serverId": "2",
      "organizationRadiusServerId": "42",
      "host": "1.2.3.4",
      "port": 22
    }
  ],
  "radiusGroupAttribute": "11",
  "hostMode": "Single-Host",
  "accessPolicyType": "Hybrid authentication",
  "increaseAccessSpeed": false,
  "guestVlanId": 100,
  "dot1x": {
    "controlDirection": "inbound"
  },
  "voiceVlanClients": true,
  "urlRedirectWalledGardenEnabled": true,
  "urlRedirectWalledGardenRanges": [
    "192.168.1.0/24"
  ],
  "counts": {
    "ports": {
      "withThisPolicy": 12
    }
  },
  "guestGroupPolicyId": "1234",
  "guestSgtId": 1284392014819
}

Return the switch alternate management interface for the network.

API documentation: getNetworkSwitchAlternateManagementInterface

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkSwitchAlternateManagementInterfaceResponse –

  Successful operation.

{
  "enabled": true,
  "useOobMgmt": false,
  "vlanId": 100,
  "protocols": [
    "radius",
    "snmp",
    "syslog"
  ],
  "switches": [
    {
      "serial": "Q234-ABCD-5678",
      "alternateManagementIp": "1.2.3.4",
      "subnetMask": "255.255.255.0",
      "gateway": "1.2.3.5"
    }
  ]
}

Return the DHCP server settings.

API documentation: getNetworkSwitchDhcpServerPolicy

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkSwitchDhcpServerPolicyResponse –

  Successful operation.

{
  "alerts": {
    "email": {
      "enabled": true
    }
  },
  "defaultPolicy": "block",
  "blockedServers": [
    "00:50:56:00:00:03",
    "00:50:56:00:00:04"
  ],
  "allowedServers": [
    "00:50:56:00:00:01",
    "00:50:56:00:00:02"
  ],
  "alwaysAllowedServers": [
    "00:50:56:00:00:05",
    "00:50:56:00:00:06"
  ],
  "arpInspection": {
    "enabled": true,
    "unsupportedModels": [
      "MS120-8",
      "MS125-24"
    ]
  }
}

Return the list of servers trusted by Dynamic ARP Inspection on this network.

API documentation: getNetworkSwitchDhcpServerPolicyArpInspectionTrustedServers

Parameters:

• network_id (str) –

  Network ID.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.

• starting_after (str | None, default: None ) –

  A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• ending_before (str | None, default: None ) –

  A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[NetworkSwitchDhcpServerPolicyArpInspectionTrustedServerResponse] –

  Successful operation.

[
  {
    "trustedServerId": "123",
    "mac": "00:11:22:33:44:55",
    "vlan": 100,
    "ipv4": {
      "address": "1.2.3.4"
    }
  }
]

Return the devices that have a Dynamic ARP Inspection warning and their warnings.

API documentation: getNetworkSwitchDhcpServerPolicyArpInspectionWarningsByDevice

Parameters:

• network_id (str) –

  Network ID.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.

• starting_after (str | None, default: None ) –

  A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• ending_before (str | None, default: None ) –

  A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[GetNetworkSwitchDhcpServerPolicyArpInspectionWarningsByDeviceResponseItem] –

  Successful operation.

[
  {
    "serial": "Q234-ABCD-0001",
    "name": "My switch",
    "url": "https://n1.meraki.com//n//manage/nodes/new_list/000000000000",
    "supportsInspection": false,
    "hasTrustedPort": false
  }
]

Return the network's DHCPv4 servers seen within the selected timeframe (default 1 day).

API documentation: getNetworkSwitchDhcpV4ServersSeen

Parameters:

• network_id (str) –

  Network ID.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 31 days from today.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.

• starting_after (str | None, default: None ) –

  A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• ending_before (str | None, default: None ) –

  A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[GetNetworkSwitchDhcpV4ServersSeenResponseItem] –

  Successful operation.

[
  {
    "mac": "00:11:22:33:44:55",
    "vlan": 100,
    "clientId": "k74272e",
    "isAllowed": true,
    "lastSeenAt": "2018-02-11T00:00:00.090210Z",
    "seenBy": [
      {
        "serial": "Q234-ABCD-0001",
        "name": "My switch2",
        "url": "https://n1.meraki.com//n//manage/nodes/new_list/0000000000001"
      }
    ],
    "type": "device",
    "device": {
      "serial": "Q234-ABCD-0002",
      "name": "My AP",
      "url": "https://n1.meraki.com//n//manage/nodes/new_list/000000000000",
      "interface": {
        "name": "My L3 Interface",
        "url": "https://n1.meraki.com//n//manage/configure/switch_l3/l3_interface/00000"
      }
    },
    "ipv4": {
      "address": "10.0.0.0/24",
      "subnet": "192.168.1.0/24",
      "gateway": "1.2.3.5"
    },
    "isConfigured": true,
    "lastAck": {
      "ts": "2018-02-11T00:00:00.090210Z",
      "ipv4": {
        "address": "123.123.123.1"
      }
    },
    "lastPacket": {
      "source": {
        "mac": "00:11:22:33:44:55",
        "ipv4": {
          "address": "1.2.3.4"
        },
        "port": 443
      },
      "destination": {
        "mac": "22:33:44:55:66:77",
        "ipv4": {
          "address": "123.123.123.1"
        },
        "port": 444
      },
      "type": "ACK",
      "ethernet": {
        "type": "0x1212"
      },
      "ip": {
        "id": "0x1313",
        "version": 4,
        "length": 24929,
        "headerLength": 1,
        "protocol": 1,
        "ttl": 50,
        "dscp": {
          "tag": 24,
          "ecn": 1
        }
      },
      "udp": {
        "length": 24929,
        "checksum": "0x1414"
      },
      "fields": {
        "op": 1,
        "htype": 1,
        "hlen": 6,
        "hops": 0,
        "xid": "0x11111111",
        "secs": 1526087474,
        "flags": "0x0000",
        "ciaddr": "1.2.3.4",
        "yiaddr": "123.123.123.1",
        "siaddr": "1.2.3.4",
        "giaddr": "1.2.3.5",
        "chaddr": "abcdefghijkl",
        "sname": "1.2.3.4",
        "magicCookie": "0x22222222",
        "options": [
          {
            "name": "Lease time",
            "value": "86400 seconds"
          }
        ]
      }
    }
  }
]

Return the DSCP to CoS mappings.

API documentation: getNetworkSwitchDscpToCosMappings

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkSwitchDscpToCosMappingsResponse –

  Successful operation.

{
  "mappings": [
    {
      "dscp": 1,
      "cos": 1,
      "title": "Video"
    }
  ]
}

List link aggregation groups.

API documentation: getNetworkSwitchLinkAggregations

Parameters:

• network_id (str) –

  Network ID.

Returns:

• PaginatedResponse[NetworkSwitchLinkAggregationResponse] –

  Successful operation.

[
  {
    "id": "NDU2N18yXzM=",
    "switchPorts": [
      {
        "serial": "Q234-ABCD-0001",
        "portId": "1"
      }
    ]
  }
]

Return the MTU configuration.

API documentation: getNetworkSwitchMtu

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkSwitchMtuResponse –

  Successful operation.

{
  "defaultMtuSize": 9578,
  "overrides": [
    {
      "switches": [
        "Q234-ABCD-0001",
        "Q234-ABCD-0002",
        "Q234-ABCD-0003"
      ],
      "switchProfiles": [
        "1284392014819",
        "2983092129865"
      ],
      "mtuSize": 1500
    }
  ]
}

List switch port schedules.

API documentation: getNetworkSwitchPortSchedules

Parameters:

• network_id (str) –

  Network ID.

Returns:

• PaginatedResponse[NetworkSwitchPortScheduleResponse] –

  Successful operation.

[
  {
    "id": "1234",
    "networkId": "N_24329156",
    "name": "Weekdays schedule",
    "portSchedule": {
      "monday": {
        "active": true,
        "from": "9:00",
        "to": "17:00"
      },
      "tuesday": {
        "active": true,
        "from": "9:00",
        "to": "17:00"
      },
      "wednesday": {
        "active": true,
        "from": "9:00",
        "to": "17:00"
      },
      "thursday": {
        "active": true,
        "from": "9:00",
        "to": "17:00"
      },
      "friday": {
        "active": true,
        "from": "9:00",
        "to": "17:00"
      },
      "saturday": {
        "active": false,
        "from": "0:00",
        "to": "24:00"
      },
      "sunday": {
        "active": false,
        "from": "0:00",
        "to": "24:00"
      }
    }
  }
]

Return a quality of service rule.

API documentation: getNetworkSwitchQosRule

Parameters:

• network_id (str) –

  Network ID.

• qos_rule_id (str) –

  Qos rule ID.

Returns:

• NetworkSwitchQosRuleResponse –

  Successful operation.

{
  "id": "1284392014819",
  "vlan": 100,
  "protocol": "TCP",
  "srcPort": 2000,
  "srcPortRange": "70-80",
  "dstPort": 3000,
  "dstPortRange": "3000-3100",
  "dscp": 0
}

List quality of service rules.

API documentation: getNetworkSwitchQosRules

Parameters:

• network_id (str) –

  Network ID.

Returns:

• PaginatedResponse[NetworkSwitchQosRuleResponse] –

  Successful operation.

[
  {
    "id": "1284392014819",
    "vlan": 100,
    "protocol": "TCP",
    "srcPort": 2000,
    "srcPortRange": "70-80",
    "dstPort": 3000,
    "dstPortRange": "3000-3100",
    "dscp": 0
  }
]

Return the quality of service rule IDs by order in which they will be processed by the switch.

API documentation: getNetworkSwitchQosRulesOrder

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkSwitchQosRulesOrderResponse –

  Successful operation.

{
  "ruleIds": [
    "1284392014819",
    "2983092129865"
  ]
}

Return multicast settings for a network.

API documentation: getNetworkSwitchRoutingMulticast

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkSwitchRoutingMulticastResponse –

  Successful operation.

{
  "defaultSettings": {
    "igmpSnoopingEnabled": true,
    "floodUnknownMulticastTrafficEnabled": true
  },
  "overrides": [
    {
      "switches": [
        "Q234-ABCD-0001",
        "Q234-ABCD-0002",
        "Q234-ABCD-0003"
      ],
      "stacks": [
        "789102",
        "123456",
        "129102"
      ],
      "switchProfiles": [
        "1234",
        "4567"
      ],
      "igmpSnoopingEnabled": true,
      "floodUnknownMulticastTrafficEnabled": true
    }
  ]
}

Return a multicast rendezvous point.

API documentation: getNetworkSwitchRoutingMulticastRendezvousPoint

Parameters:

• network_id (str) –

  Network ID.

• rendezvous_point_id (str) –

  Rendezvous point ID.

Returns:

• NetworkSwitchRoutingMulticastRendezvousPointResponse –

  Successful operation.

{
  "rendezvousPointId": "1234",
  "serial": "Q234-ABCD-5678",
  "interfaceName": "l3_interface_0",
  "interfaceIp": "192.168.1.2",
  "multicastGroup": "Any"
}

List multicast rendezvous points.

API documentation: getNetworkSwitchRoutingMulticastRendezvousPoints

Parameters:

• network_id (str) –

  Network ID.

Returns:

• PaginatedResponse[NetworkSwitchRoutingMulticastRendezvousPointResponse] –

  Successful operation.

[
  {
    "rendezvousPointId": "1234",
    "serial": "Q234-ABCD-5678",
    "interfaceName": "l3_interface_0",
    "interfaceIp": "192.168.1.2",
    "multicastGroup": "Any"
  }
]

Return layer 3 OSPF routing configuration.

API documentation: getNetworkSwitchRoutingOspf

Parameters:

• network_id (str) –

  Network ID.

• vrf (str | None, default: None ) –

  The VRF to return the OSPF routing configuration for. When not provided, the default VRF is used. Included on networks with IOS XE 17.18 or higher.

Returns:

• NetworkSwitchRoutingOspfResponse –

  Successful operation.

{
  "enabled": true,
  "helloTimerInSeconds": 10,
  "deadTimerInSeconds": 40,
  "areas": [
    {
      "areaId": "1284392014819",
      "areaName": "Backbone",
      "areaType": "normal"
    }
  ],
  "v3": {
    "enabled": true,
    "helloTimerInSeconds": 10,
    "deadTimerInSeconds": 40,
    "areas": [
      {
        "areaId": "1284392014819",
        "areaName": "V3 Backbone",
        "areaType": "normal"
      }
    ]
  },
  "md5AuthenticationEnabled": true,
  "md5AuthenticationKey": {
    "id": 1234,
    "passphrase": "abc1234"
  },
  "vrf": {
    "name": "Blue"
  }
}

Returns the switch network settings.

API documentation: getNetworkSwitchSettings

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkSwitchSettingsResponse –

  Successful operation.

{
  "vlan": 100,
  "useCombinedPower": false,
  "powerExceptions": [
    {
      "serial": "Q234-ABCD-0001",
      "powerType": "redundant"
    }
  ],
  "uplinkClientSampling": {
    "enabled": true
  },
  "macBlocklist": {
    "enabled": true
  },
  "portChannelFallback": true,
  "uplinkSelection": {
    "failback": {
      "enabled": true
    },
    "candidates": "all"
  }
}

Show a switch stack.

API documentation: getNetworkSwitchStack

Parameters:

• network_id (str) –

  Network ID.

• switch_stack_id (str) –

  Switch stack ID.

Returns:

• NetworkSwitchStackResponse –

  Successful operation.

{
  "id": "8473",
  "name": "A cool stack",
  "serials": [
    "QBZY-XWVU-TSRQ",
    "QBAB-CDEF-GHIJ"
  ],
  "isMonitorOnly": false,
  "virtualMac": "00:18:0a:4f:21:19",
  "members": [
    {
      "serial": "QBZY-XWVU-TSRQ",
      "name": "switch 1",
      "model": "MS350-24-HW",
      "mac": "00:18:0a:00:00:09",
      "role": "active"
    }
  ]
}