Switch (Batch)

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Delete a layer 3 interface from the switch.

API documentation: deleteDeviceSwitchRoutingInterface

Parameters:

• serial (str) –

  Serial.

• interface_id (str) –

  Interface ID.

Delete a layer 3 static route for a switch.

API documentation: deleteDeviceSwitchRoutingStaticRoute

Parameters:

• serial (str) –

  Serial.

• static_route_id (str) –

  Static route ID.

Delete an access policy for a switch network.

API documentation: deleteNetworkSwitchAccessPolicy

Parameters:

• network_id (str) –

  Network ID.

• access_policy_number (str) –

  Access policy number.

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.

Split a link aggregation group into separate ports.

API documentation: deleteNetworkSwitchLinkAggregation

Parameters:

• network_id (str) –

  Network ID.

• link_aggregation_id (str) –

  Link aggregation ID.

Delete a quality of service rule.

API documentation: deleteNetworkSwitchQosRule

Parameters:

• network_id (str) –

  Network ID.

• qos_rule_id (str) –

  Qos rule ID.

Delete a multicast rendezvous point.

API documentation: deleteNetworkSwitchRoutingMulticastRendezvousPoint

Parameters:

• network_id (str) –

  Network ID.

• rendezvous_point_id (str) –

  Rendezvous point ID.

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.

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.

Update a switch port.

API documentation: updateDeviceSwitchPort

Parameters:

• serial (str) –

  Serial.

• port_id (str) –

  Port ID.

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

  The name of the switch port.

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

  The list of tags of the switch port.

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

  The status of the switch port.

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

  The PoE status of the switch port.

• type_ (UpdateDeviceSwitchPortType | None, default: None ) –

  The type of the switch port ('access', 'trunk', 'stack', 'routed', 'svl' or 'dad').

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

  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 | None, default: None ) –

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

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

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

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

  The isolation status of the switch port.

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

  The rapid spanning tree protocol status.

• stp_guard (UpdateDeviceSwitchPortStpGuard | None, default: None ) –

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

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

  The state of STP PortFast Trunk on the switch port.

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

  The link speed for the switch port.

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

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

• udld (UpdateDeviceSwitchPortUdld | None, default: None ) –

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

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

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

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

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

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

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

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

  The maximum number of MAC addresses for regular MAC allow list. Only applicable when 'accessPolicyType' is 'MAC allow list'. Note: Config only supported on verions greater than ms18 only for classic switches.

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

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

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

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

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

  The storm control status of the switch port.

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

  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.

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

  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.

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

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

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

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

• profile (UpdateDeviceSwitchPortProfile | None, default: None ) –

  Profile attributes.

• dot3az (UpdateDeviceSwitchPortDot3az | None, default: None ) –

  dot3az settings for the port.

• high_speed (UpdateDeviceSwitchPortHighSpeed | None, default: None ) –

  High speed port enablement settings for C9500-32QC.

Update a layer 3 interface for a switch.

API documentation: updateDeviceSwitchRoutingInterface

Parameters:

• serial (str) –

  Serial.

• interface_id (str) –

  Interface ID.

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

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

• 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 (UpdateDeviceSwitchRoutingInterfaceMulticastRouting | 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 (UpdateDeviceSwitchRoutingInterfaceOspfSettings | None, default: None ) –

  The OSPF routing settings of the interface.

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

  The IPv6 settings of the interface.

• vrf (UpdateDeviceSwitchRoutingInterfaceVrf | 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.

Update a layer 3 interface DHCP configuration for a switch.

API documentation: updateDeviceSwitchRoutingInterfaceDhcp

Parameters:

• serial (str) –

  Serial.

• interface_id (str) –

  Interface ID.

• dhcp_mode (UpdateDeviceSwitchRoutingInterfaceDhcpDhcpMode | None, default: None ) –

  The DHCP mode options for the switch interface ('dhcpDisabled', 'dhcpRelay' or 'dhcpServer').

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

  The DHCP relay server IPs to which DHCP packets would get relayed for the switch interface.

• dhcp_lease_time (UpdateDeviceSwitchRoutingInterfaceDhcpDhcpLeaseTime | None, default: None ) –

  The DHCP lease time config for the dhcp server running on switch interface ('30 minutes', '1 hour', '4 hours', '12 hours', '1 day' or '1 week').

• dns_nameservers_option (UpdateDeviceSwitchRoutingInterfaceDhcpDnsNameserversOption | None, default: None ) –

  The DHCP name server option for the dhcp server running on the switch interface ('googlePublicDns', 'openDns' or 'custom').

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

  The DHCP name server IPs when DHCP name server option is 'custom'.

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

  Enable DHCP boot options to provide PXE boot options configs for the dhcp server running on the switch interface.

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

  The PXE boot server IP for the DHCP server running on the switch interface.

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

  The PXE boot server filename for the DHCP server running on the switch interface.

• dhcp_options (list[UpdateDeviceSwitchRoutingInterfaceDhcpDhcpOptionsItem] | None, default: None ) –

  Array of DHCP options consisting of code, type and value for the DHCP server running on the switch interface.

• reserved_ip_ranges (list[UpdateDeviceSwitchRoutingInterfaceDhcpReservedIpRangesItem] | None, default: None ) –

  Array of DHCP reserved IP assignments for the DHCP server running on the switch interface.

• fixed_ip_assignments (list[UpdateDeviceSwitchRoutingInterfaceDhcpFixedIpAssignmentsItem] | None, default: None ) –

  Array of DHCP fixed IP assignments for the DHCP server running on the switch interface.

Update a layer 3 static route for a switch.

API documentation: updateDeviceSwitchRoutingStaticRoute

Parameters:

• serial (str) –

  Serial.

• static_route_id (str) –

  Static route ID.

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

  Name or description for layer 3 static route.

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

  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 | None, default: None ) –

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

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

  Optional fallback IP address for management traffic.

• 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 (UpdateDeviceSwitchRoutingStaticRouteVrf | None, default: None ) –

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

Update warm spare configuration for a switch.

API documentation: updateDeviceSwitchWarmSpare

Parameters:

• serial (str) –

  Serial.

• enabled (bool) –

  Enable or disable warm spare for a switch.

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

  Serial number of the warm spare switch.

Update an access policy for a switch network.

API documentation: updateNetworkSwitchAccessPolicy

Parameters:

• network_id (str) –

  Network ID.

• access_policy_number (str) –

  Access policy number.

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

  Name of the access policy(max length 255).

• radius_servers (list[UpdateNetworkSwitchAccessPolicyRadiusServersItem] | None, default: None ) –

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

• radius (UpdateNetworkSwitchAccessPolicyRadius | 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 | None, default: None ) –

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

• radius_accounting_servers (list[UpdateNetworkSwitchAccessPolicyRadiusAccountingServersItem] | 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 (UpdateNetworkSwitchAccessPolicyHostMode | None, default: None ) –

  Choose the Host Mode for the access policy.

• access_policy_type (UpdateNetworkSwitchAccessPolicyAccessPolicyType | 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 (UpdateNetworkSwitchAccessPolicyDot1x | 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.

Update the switch alternate management interface for the network.

API documentation: updateNetworkSwitchAlternateManagementInterface

Parameters:

• network_id (str) –

  Network ID.

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

  Boolean value to enable or disable AMI configuration. If enabled, VLAN and protocols must be set.

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

  Alternate management VLAN, must be between 1 and 4094.

• protocols (UpdateNetworkSwitchAlternateManagementInterfaceProtocols | None, default: None ) –

  Can be one or more of the following values: 'radius', 'snmp' or 'syslog'.

• switches (list[UpdateNetworkSwitchAlternateManagementInterfaceSwitchesItem] | None, default: None ) –

  Array of switch serial number and IP assignment. If parameter is present, it cannot have empty body. Note: switches parameter is not applicable for template networks, in other words, do not put 'switches' in the body when updating template networks. Also, an empty 'switches' array will remove all previous assignments.

Update the DHCP server settings.

API documentation: updateNetworkSwitchDhcpServerPolicy

Parameters:

• network_id (str) –

  Network ID.

• alerts (UpdateNetworkSwitchDhcpServerPolicyAlerts | None, default: None ) –

  Alert settings for DHCP servers.

• default_policy (UpdateNetworkSwitchDhcpServerPolicyDefaultPolicy | None, default: None ) –

  'allow' or 'block' new DHCP servers. Default value is 'allow'.

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

  List the MAC addresses of DHCP servers to permit on the network when defaultPolicy is set to block. An empty array will clear the entries.

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

  List the MAC addresses of DHCP servers to block on the network when defaultPolicy is set to allow. An empty array will clear the entries.

• arp_inspection (UpdateNetworkSwitchDhcpServerPolicyArpInspection | None, default: None ) –

  Dynamic ARP Inspection settings.

Update a server that is trusted by Dynamic ARP Inspection on this network.

API documentation: updateNetworkSwitchDhcpServerPolicyArpInspectionTrustedServer

Parameters:

• network_id (str) –

  Network ID.

• trusted_server_id (str) –

  Trusted server ID.

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

  The updated mac address of the trusted server.

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

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

• ipv4 (UpdateNetworkSwitchDhcpServerPolicyArpInspectionTrustedServerIpv4 | None, default: None ) –

  The updated IPv4 attributes of the trusted server.

Update the DSCP to CoS mappings.

API documentation: updateNetworkSwitchDscpToCosMappings

Parameters:

• network_id (str) –

  Network ID.

• mappings (list[UpdateNetworkSwitchDscpToCosMappingsMappingsItem]) –

  An array of DSCP to CoS mappings. An empty array will reset the mappings to default.

Update a link aggregation group.

API documentation: updateNetworkSwitchLinkAggregation

Parameters:

• network_id (str) –

  Network ID.

• link_aggregation_id (str) –

  Link aggregation ID.

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

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

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

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

Update the MTU configuration.

API documentation: updateNetworkSwitchMtu

Parameters:

• network_id (str) –

  Network ID.

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

  MTU size for the entire network. Default value is 9578.

• overrides (list[UpdateNetworkSwitchMtuOverridesItem] | None, default: None ) –

  Override MTU size for individual switches or switch templates. An empty array will clear overrides.

Update a switch port schedule.

API documentation: updateNetworkSwitchPortSchedule

Parameters:

• network_id (str) –

  Network ID.

• port_schedule_id (str) –

  Port schedule ID.

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

  The name for your port schedule.

• port_schedule (UpdateNetworkSwitchPortSchedulePortSchedule | 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.

Update a quality of service rule.

API documentation: updateNetworkSwitchQosRule

Parameters:

• network_id (str) –

  Network ID.

• qos_rule_id (str) –

  Qos rule ID.

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

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

• protocol (UpdateNetworkSwitchQosRuleProtocol | 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 that should be assigned to incoming packet. Set this to -1 to trust incoming DSCP. Default value is 0.

Update the order in which the rules should be processed by the switch.

API documentation: updateNetworkSwitchQosRulesOrder

Parameters:

• network_id (str) –

  Network ID.

• rule_ids (list[str]) –

  A list of quality of service rule IDs arranged in order in which they should be processed by the switch.

Update multicast settings for a network.

API documentation: updateNetworkSwitchRoutingMulticast

Parameters:

• network_id (str) –

  Network ID.

• default_settings (UpdateNetworkSwitchRoutingMulticastDefaultSettings | None, default: None ) –

  Default multicast setting for entire network. IGMP snooping and Flood unknown multicast traffic settings are enabled by default.

• overrides (list[UpdateNetworkSwitchRoutingMulticastOverridesItem] | None, default: None ) –

  Array of paired switches/stacks/profiles and corresponding multicast settings. An empty array will clear the multicast settings.

Update a multicast rendezvous point.

API documentation: updateNetworkSwitchRoutingMulticastRendezvousPoint

Parameters:

• network_id (str) –

  Network ID.

• rendezvous_point_id (str) –

  Rendezvous point 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 (UpdateNetworkSwitchRoutingMulticastRendezvousPointVrf | None, default: None ) –

  The VRF with PIM enabled L3 interface.

Update layer 3 OSPF routing configuration.

API documentation: updateNetworkSwitchRoutingOspf

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. Requires IOS XE 17.18 or higher.

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

  Boolean value to enable or disable OSPF routing. OSPF routing is disabled by default.

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

  Time interval in seconds at which hello packet will be sent to OSPF neighbors to maintain connectivity. Value must be between 1 and 255. Default is 10 seconds.

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

  Time interval to determine when the peer will be declared inactive/dead. Value must be between 1 and 65535.

• areas (list[UpdateNetworkSwitchRoutingOspfAreasItem] | None, default: None ) –

  OSPF areas.

• v3 (UpdateNetworkSwitchRoutingOspfV3 | None, default: None ) –

  OSPF v3 configuration.

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

  Boolean value to enable or disable MD5 authentication. MD5 authentication is disabled by default.

• md5_authentication_key (UpdateNetworkSwitchRoutingOspfMd5AuthenticationKey | None, default: None ) –

  MD5 authentication credentials. This param is only relevant if md5AuthenticationEnabled is true.

Update switch network settings.

API documentation: updateNetworkSwitchSettings

Parameters:

• network_id (str) –

  Network ID.

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

  Management VLAN.

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

  The use Combined Power as the default behavior of secondary power supplies on supported devices.

• power_exceptions (list[UpdateNetworkSwitchSettingsPowerExceptionsItem] | None, default: None ) –

  Exceptions on a per switch basis to "useCombinedPower".

• uplink_client_sampling (UpdateNetworkSwitchSettingsUplinkClientSampling | None, default: None ) –

  Uplink client sampling.

• mac_blocklist (UpdateNetworkSwitchSettingsMacBlocklist | None, default: None ) –

  MAC blocklist.

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

  Port channel fallback.

• uplink_selection (UpdateNetworkSwitchSettingsUplinkSelection | None, default: None ) –

  Settings related to uplink selection on IOS-XE switches.

Update a layer 3 interface for a switch stack.

API documentation: updateNetworkSwitchStackRoutingInterface

Parameters:

• network_id (str) –

  Network ID.

• switch_stack_id (str) –

  Switch stack ID.

• interface_id (str) –

  Interface ID.

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

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

• 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 (UpdateNetworkSwitchStackRoutingInterfaceMulticastRouting | 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 (UpdateNetworkSwitchStackRoutingInterfaceOspfSettings | None, default: None ) –

  The OSPF routing settings of the interface.

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

  The IPv6 settings of the interface.

• vrf (UpdateNetworkSwitchStackRoutingInterfaceVrf | 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.

Update a layer 3 interface DHCP configuration for a switch stack.

API documentation: updateNetworkSwitchStackRoutingInterfaceDhcp

Parameters:

• network_id (str) –

  Network ID.

• switch_stack_id (str) –

  Switch stack ID.

• interface_id (str) –

  Interface ID.

• dhcp_mode (UpdateNetworkSwitchStackRoutingInterfaceDhcpDhcpMode | None, default: None ) –

  The DHCP mode options for the switch stack interface ('dhcpDisabled', 'dhcpRelay' or 'dhcpServer').

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

  The DHCP relay server IPs to which DHCP packets would get relayed for the switch stack interface.

• dhcp_lease_time (UpdateNetworkSwitchStackRoutingInterfaceDhcpDhcpLeaseTime | None, default: None ) –

  The DHCP lease time config for the dhcp server running on switch stack interface ('30 minutes', '1 hour', '4 hours', '12 hours', '1 day' or '1 week').

• dns_nameservers_option (UpdateNetworkSwitchStackRoutingInterfaceDhcpDnsNameserversOption | None, default: None ) –

  The DHCP name server option for the dhcp server running on the switch stack interface ('googlePublicDns', 'openDns' or 'custom').

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

  The DHCP name server IPs when DHCP name server option is ' custom'.

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

  Enable DHCP boot options to provide PXE boot options configs for the dhcp server running on the switch stack interface.

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

  The PXE boot server IP for the DHCP server running on the switch stack interface.

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

  The PXE boot server file name for the DHCP server running on the switch stack interface.

• dhcp_options (list[UpdateNetworkSwitchStackRoutingInterfaceDhcpDhcpOptionsItem] | None, default: None ) –

  Array of DHCP options consisting of code, type and value for the DHCP server running on the switch stack interface.

• reserved_ip_ranges (list[UpdateNetworkSwitchStackRoutingInterfaceDhcpReservedIpRangesItem] | None, default: None ) –

  Array of DHCP reserved IP assignments for the DHCP server running on the switch stack interface.

• fixed_ip_assignments (list[UpdateNetworkSwitchStackRoutingInterfaceDhcpFixedIpAssignmentsItem] | None, default: None ) –

  Array of DHCP fixed IP assignments for the DHCP server running on the switch stack interface.

Update a layer 3 static route for a switch stack.

API documentation: updateNetworkSwitchStackRoutingStaticRoute

Parameters:

• network_id (str) –

  Network ID.

• switch_stack_id (str) –

  Switch stack ID.

• static_route_id (str) –

  Static route ID.

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

  Name or description for layer 3 static route.

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

  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 | None, default: None ) –

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

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

  Optional fallback IP address for management traffic.

• 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 (UpdateNetworkSwitchStackRoutingStaticRouteVrf | None, default: None ) –

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

Update the storm control configuration for a switch network.

API documentation: updateNetworkSwitchStormControl

Parameters:

• network_id (str) –

  Network ID.

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

  Percentage (1 to 99) of total available port bandwidth for broadcast traffic type. Default value 100 percent rate is to clear the configuration.

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

  Percentage (1 to 99) of total available port bandwidth for multicast traffic type. Default value 100 percent rate is to clear the configuration.

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

  Percentage (1 to 99) of total available port bandwidth for unknown unicast (dlf-destination lookup failure) traffic type. Default value 100 percent rate is to clear the configuration.

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

  Grouped traffic types.

Updates STP settings.

API documentation: updateNetworkSwitchStp

Parameters:

• network_id (str) –

  Network ID.

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

  The spanning tree protocol status in network.

• stp_bridge_priority (list[UpdateNetworkSwitchStpStpBridgePriorityItem] | None, default: None ) –

  STP bridge priority for switches/stacks or switch templates. An empty array will clear the STP bridge priority settings.

Update a switch template port.

API documentation: updateOrganizationConfigTemplateSwitchProfilePort

Parameters:

• organization_id (str) –

  Organization ID.

• config_template_id (str) –

  Config template ID.

• profile_id (str) –

  Profile ID.

• port_id (str) –

  Port ID.

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

  The name of the switch template port.

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

  The list of tags of the switch template port.

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

  The status of the switch template port.

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

  The PoE status of the switch template port.

• type_ (UpdateOrganizationConfigTemplateSwitchProfilePortType | None, default: None ) –

  The type of the switch template port ('access', 'trunk', 'stack', 'routed', 'svl' or 'dad').

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

  The VLAN of the switch template port. For a trunk port, this is the native VLAN. A null value will clear the value set for trunk ports.

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

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

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

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

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

  The isolation status of the switch template port.

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

  The rapid spanning tree protocol status.

• stp_guard (UpdateOrganizationConfigTemplateSwitchProfilePortStpGuard | None, default: None ) –

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

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

  The state of STP PortFast Trunk on the switch template port.

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

  The link speed for the switch template port.

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

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

• udld (UpdateOrganizationConfigTemplateSwitchProfilePortUdld | None, default: None ) –

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

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

  The type of the access policy of the switch template port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'.

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

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

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

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

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

  The maximum number of MAC addresses for regular MAC allow list. Only applicable when 'accessPolicyType' is 'MAC allow list'. Note: Config only supported on verions greater than ms18 only for classic switches.

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

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

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

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

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

  The storm control status of the switch template port.

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

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

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

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

• profile (UpdateOrganizationConfigTemplateSwitchProfilePortProfile | None, default: None ) –

  Profile attributes.

• dot3az (UpdateOrganizationConfigTemplateSwitchProfilePortDot3az | None, default: None ) –

  dot3az settings for the port.

• high_speed (UpdateOrganizationConfigTemplateSwitchProfilePortHighSpeed | None, default: None ) –

  High speed port enablement settings for C9500-32QC.