updateOrgNetworkTemplate
Update an organization network template, including network, port usage, switch management, routing, NAC, and service defaults.
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
uuiduuidRequest Body
application/json
Request Body
Network template configuration applied to sites or site groups
ACL policy defaults provided by this network template
ACL tags available to access policies in this network template
Additional CLI configuration commands provided by this network template
BGP routing defaults for this network template. Property key is the BGP session name
DHCP snooping defaults provided by this network template
DNS servers provided by this network template
DNS search suffixes provided by this network template
Additional IPv4 route defaults in this network template
Additional IPv6 route defaults in this network template
Organization network names imported into this network template
Mist NAC defaults applied by this network template
Multicast settings for networks in the master VRF (not assigned to any vrf_instances); PIM is automatically enabled when any master-VRF network has multicast.enabled==true
Display name of the network template
Layer 3 networks configured by this network template
NTP servers provided by this network template
OSPF area defaults provided by this network template
Port mirroring defaults provided by this network template
Reusable switch port usage profiles provided by this network template
RADIUS authentication and accounting defaults in this network template
Remote syslog defaults provided by this network template
By default, only the configuration generated by Mist is cleaned up during the configuration process. If true, all the existing configuration will be removed.
falseRouting policy defaults applied by this network template
SNMP defaults provided by this network template
Matching rules that select switches for this network template
Management-plane settings applied when this matching rule matches
VRF defaults applied by this network template
VRF instances configured by this network template
Response Body
application/json
curl -X PUT "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/networktemplates/000000ab-00ab-00ab-00ab-0000000000ab" \ -H "Content-Type: application/json" \ -d '{ "additional_config_cmds": [ "set snmp community public" ], "dhcp_snooping": { "all_networks": true, "enable_arp_spoof_check": true, "enable_ip_source_guard": true, "enabled": true, "networks": [ "string" ] }, "dns_servers": [ "string" ], "dns_suffix": [ "string" ], "extra_routes": { "property1": { "via": "string" }, "property2": { "via": "string" } }, "group_tags": {}, "import_org_networks": [ "ap" ], "mist_nac": { "enabled": true, "network": "string" }, "name": "string", "networks": { "property1": { "subnet": "192.168.1.0/24", "vlan_id": 10 }, "property2": { "subnet": "192.168.1.0/24", "vlan_id": 10 } }, "ntp_servers": [ "string" ], "port_usages": { "dynamic": { "mode": "dynamic", "reset_default_when": "link_down", "rules": [ { "equals": "string", "equals_any": [ "string" ], "expression": "string", "src": "lldp_chassis_id", "usage": "string" } ] }, "property1": { "all_networks": false, "allow_dhcpd": true, "bypass_auth_when_server_down": true, "description": "string", "disable_autoneg": false, "disabled": false, "duplex": "auto", "enable_mac_auth": true, "enable_qos": true, "guest_network": "string", "mac_auth_only": true, "mac_auth_protocol": "pap", "mac_limit": 0, "mode": "access", "networks": [ "string" ], "persist_mac": false, "poe_disabled": false, "port_auth": "dot1x", "port_network": "string", "server_reject_network": null, "speed": "auto", "storm_control": { "no_broadcast": false, "no_multicast": false, "no_registered_multicast": false, "no_unknown_unicast": false, "percentage": 80 }, "stp_edge": true, "voip_network": "string" }, "property2": { "all_networks": false, "allow_dhcpd": true, "bypass_auth_when_server_down": true, "description": "string", "disable_autoneg": false, "disabled": false, "duplex": "auto", "enable_mac_auth": true, "enable_qos": true, "guest_network": "string", "mac_auth_only": true, "mac_auth_protocol": "pap", "mac_limit": 0, "mode": "access", "networks": [ "string" ], "persist_mac": false, "poe_disabled": false, "port_network": "string", "server_reject_network": null, "speed": "auto", "storm_control": { "no_broadcast": false, "no_multicast": false, "no_registered_multicast": false, "no_unknown_unicast": false, "percentage": 80 }, "stp_edge": true, "voip_network": "string" } }, "switch_mgmt": { "config_revert_timer": 10, "protect_re": { "enabled": false }, "root_password": "string", "tacacs": { "acct_servers": [ { "host": "198.51.100.1", "port": "49", "secret": "string", "timeout": 10 } ], "enabled": true, "network": "string", "tacplus_servers": [ { "host": "198.51.100.1", "port": "49", "secret": "string", "timeout": 10 } ] } }, "vrf_config": { "enabled": false }, "vrf_instances": { "property1": { "extra_routes": { "property1": { "via": "198.51.100.1" }, "property2": { "via": "198.51.100.2" } }, "networks": [ "string" ] }, "property2": { "extra_routes": { "property1": { "via": "198.51.100.1" }, "property2": { "via": "198.51.100.2" } }, "networks": [ "string" ] } } }'{ "additional_config_cmds": [ "set snmp community public" ], "dhcp_snooping": { "all_networks": true, "enable_arp_spoof_check": true, "enable_ip_source_guard": true, "enabled": true, "networks": [ "string" ] }, "dns_servers": [ "string" ], "dns_suffix": [ "string" ], "extra_routes": { "property1": { "via": "string" }, "property2": { "via": "string" } }, "import_org_networks": [ "ap" ], "mist_nac": { "enabled": true, "network": "string" }, "name": "string", "networks": { "property1": { "subnet": "192.168.1.0/24", "vlan_id": 10 }, "property2": { "subnet": "192.168.1.0/24", "vlan_id": 10 } }, "ntp_servers": [ "string" ], "port_usages": { "dynamic": { "mode": "dynamic", "reset_default_when": "link_down", "rules": [ { "equals": "string", "equals_any": [ "string" ], "expression": "string", "src": "lldp_chassis_id", "usage": "string" } ] }, "property1": { "all_networks": false, "allow_dhcpd": true, "bypass_auth_when_server_down": true, "description": "string", "disable_autoneg": false, "disabled": false, "duplex": "auto", "enable_mac_auth": true, "enable_qos": true, "guest_network": "string", "mac_auth_only": true, "mac_auth_protocol": "pap", "mac_limit": 0, "mode": "access", "networks": [ "string" ], "persist_mac": false, "poe_disabled": false, "port_auth": "dot1x", "port_network": "string", "server_reject_network": null, "speed": "auto", "storm_control": { "no_broadcast": false, "no_multicast": false, "no_registered_multicast": false, "no_unknown_unicast": false, "percentage": 80 }, "stp_edge": true, "voip_network": "string" }, "property2": { "all_networks": false, "allow_dhcpd": true, "bypass_auth_when_server_down": true, "description": "string", "disable_autoneg": false, "disabled": false, "duplex": "auto", "enable_mac_auth": true, "enable_qos": true, "guest_network": "string", "mac_auth_only": true, "mac_auth_protocol": "pap", "mac_limit": 0, "mode": "access", "networks": [ "string" ], "persist_mac": false, "poe_disabled": false, "port_network": "string", "server_reject_network": null, "speed": "auto", "storm_control": { "no_broadcast": false, "no_multicast": false, "no_registered_multicast": false, "no_unknown_unicast": false, "percentage": 80 }, "stp_edge": true, "voip_network": "string" } }, "switch_mgmt": { "config_revert_timer": 10, "protect_re": { "enabled": false }, "root_password": "string", "tacacs": { "acct_servers": [ { "host": "198.51.100.1", "port": "49", "secret": "string", "timeout": 10 } ], "enabled": true, "network": "string", "tacplus_servers": [ { "host": "198.51.100.1", "port": "49", "secret": "string", "timeout": 10 } ] } }, "vrf_config": { "enabled": false }, "vrf_instances": { "property1": { "extra_routes": { "property1": { "via": "198.51.100.1" }, "property2": { "via": "198.51.100.2" } }, "networks": [ "string" ] }, "property2": { "extra_routes": { "property1": { "via": "198.51.100.1" }, "property2": { "via": "198.51.100.2" } }, "networks": [ "string" ] } }}