Update Edge Profile Device Settings
Edge-specific device settings module update spec
Note: By default this API operation executes asynchronously, meaning successful requests to this method will return an HTTP 202 response including tracking resource information (incl. an HTTP Location header with a value like /api/sdwan/v2/asyncOperations/4f951593-aff8-4f3c-9855-10fa5d32a419). Due to a limitation of our documentation automation/tooling, we can only describe non-async API behavior, we are working on this and will update the expected behavior soon
Request
URI
PATCH
https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/edges/{edgeLogicalId}/deviceSettings
COPY
Path Parameters
string
enterpriseLogicalId
Required
The logicalId GUID for the target enterprise
string
edgeLogicalId
Required
The logicalId GUID for the target edge
Query Parameters
string
include
Optional
A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.
Request Body
Responses
200
Request successfully processed
Returns BaseDeviceSettings of type(s) application/json
{
"bfd": {
"enabled": false,
"rules": [
{
"peerAddress": "string",
"localAddress": "string",
"multihop": false,
"detectMultiplier": 0,
"receiveInterval": 0,
"transmitInterval": 0
}
],
"override": false,
"rulesV6": [
{
"peerAddress": "string",
"localAddress": "string",
"multihop": false,
"detectMultiplier": 0,
"receiveInterval": 0,
"transmitInterval": 0
}
]
},
"ha": {
"enabled": false,
"interface": "string",
"vmacoverride": false,
"nodes": [
{
"serialNumber": "string",
"instanceId": 0
}
],
"haGracefulSwitchover": false,
"preEmptSwitchover": false,
"haFailoverCount": 0
},
"lan": {
"interfaces": [
{
"override": false,
"name": "string",
"cwp": false,
"disabled": false,
"l2": {
"autonegotiation": false,
"speed": "string",
"duplex": "string",
"MTU": 0,
"losDetection": false,
"probeInterval": "string"
},
"portMode": "string",
"space": "string",
"type": "string",
"vlanIds": [
0
],
"authenticationType": "string",
"broadcastSsid": false,
"passphrase": "string",
"ssid": "string",
"securityMode": "string"
}
],
"management": {
"cidrIp": "string",
"cidrPrefix": 0
},
"managementTraffic": {
"override": false,
"sourceInterface": "string"
},
"networks": [
{
"override": false,
"advertise": false,
"pingResponse": false,
"dnsProxy": false,
"bindEdgeAddress": false,
"cidrIp": "string",
"cidrPrefix": 0,
"cost": 0,
"dhcp": {
"enabled": false,
"dhcpRelay": {
"enabled": false,
"servers": [
{}
]
},
"leaseTimeSeconds": 0,
"numDhcpAddr": 0,
"options": [
{
"option": 0,
"value": [
{}
],
"type": "string",
"metaData": {
"dataType": "string",
"description": "string",
"display": false,
"list": false,
"name": "string",
"option": 0
}
}
]
},
"disabled": false,
"fixedIp": [
{
"macAddress": "string",
"lanIp": "string",
"description": "string"
}
],
"interfaces": [
{}
],
"multicast": {
"igmp": {
"enabled": false,
"type": "string"
},
"igmpHostQueryIntervalSeconds": 0,
"igmpMaxQueryResponse": 0,
"pim": {
"enabled": false,
"type": "string"
},
"pimHelloTimerSeconds": 0,
"pimKeepAliveTimerSeconds": 0,
"pimPruneIntervalSeconds": 0
},
"name": "string",
"netmask": "string",
"numDhcpAddr": 0,
"ospf": {
"enabled": false,
"passiveInterface": false
},
"interfaceAddress": "string",
"tagLogicalId": "string",
"segmentId": 0,
"segment": {
"_href": "string",
"created": "string",
"description": "string",
"object": "string",
"name": "string",
"type": "string",
"alertsEnabled": 0,
"operatorAlertsEnabled": 0,
"status": "string",
"statusModified": "string",
"previousData": {},
"previousCreated": "string",
"draftData": "string",
"draftCreated": "string",
"draftComment": "string",
"data": {},
"lastContact": "string",
"version": "string",
"modified": "string"
},
"staticReserved": 0,
"v6Detail": {
"override": false,
"advertise": false,
"bindEdgeAddress": false,
"addressing": {
"cidrIp": "string",
"cidrPrefix": 0,
"netmask": "string",
"type": "string",
"interfaceAddress": "string",
"tag": "string",
"tagLogicalId": "string"
},
"dhcpServer": {
"enabled": false,
"dhcpRelay": {
"enabled": false,
"servers": [
{}
]
},
"leaseTimeSeconds": 0,
"options": [
{
"option": 0,
"value": [
{}
],
"type": "string",
"metaData": {
"dataType": "string",
"description": "string",
"display": false,
"list": false,
"name": "string",
"option": 0
}
}
],
"prefixDelegation": {
"enabled": false,
"pdlist": [
{
"poolname": "string",
"prefix": "string",
"prefixLen": 0,
"targetPrefixLen": 0
}
]
},
"numDhcpAddr": 0,
"staticReserved": 0,
"fixedIp": [
{
"macAddress": "string",
"lanIp": "string",
"description": "string"
}
]
},
"routerAdvertisementHostSettings": {
"mtu": false,
"defaultRoutes": false,
"specificRoutes": false,
"nd6Timers": false
},
"ospf": {
"enabled": false,
"override": false,
"passiveInterface": false
}
},
"vlanId": 0,
"vnfInsertion": false,
"radiusAuthentication": {
"enabled": false,
"macBypass": [
{
"address": "string",
"description": "string"
}
],
"aclCheck": false
}
}
],
"visibility": {
"override": false,
"mode": "string"
}
},
"loopbackInterfaces": {
"LO1": {
"cidrIp": "29.23.68.45",
"cidrPrefix": 32,
"segmentId": 0,
"pingResponse": true,
"advertise": true,
"disableV4": false,
"disableV6": true,
"ospf": {
"enabled": false,
"area": []
},
"v6Detail": {
"cidrIp": "",
"cidrPrefix": 128,
"advertise": true,
"ospf": {
"enabled": false,
"area": []
}
}
}
},
"models": {},
"multiSourceQos": {
"enabled": false,
"override": false,
"highRatio": 0,
"normalRatio": 0,
"lowRatio": 0,
"maxCapThreshold": 0,
"minCapThreshold": 0
},
"ntp": {
"sourceInterface": "string",
"enabled": false,
"override": false,
"servers": [
{
"server": "string"
}
]
},
"ntpServer": {
"enabled": false,
"override": false,
"authentication": "string",
"keys": [
{
"key": "string",
"keyNumber": 0
}
],
"sourceInterface": "string"
},
"radioSettings": {
"country": "string",
"radios": [
{
"band": "string",
"isEnabled": false,
"mode": "string",
"name": "string",
"radioId": 0,
"width": "string"
}
]
},
"l2Settings": {
"overrideARPTimeout": false,
"arpStaleTimeoutMinutes": 0,
"arpDeadTimeoutMinutes": 0,
"arpCleanupTimeoutMinutes": 0
},
"globalIPv6Settings": {
"advancedConfiguration": {
"disableAllIPv6Traffic": false,
"dropRoutingHeaderTypeZeroPackets": false,
"enforceExtensionHeaderValidation": false,
"enforceExtensionHeaderOrderCheck": false,
"dropnLogPacketsForRFCReservedFields": false
},
"icmpV6Messages": {
"disableDestinationUnreachable": false,
"disableTimeExceeded": false,
"disableParameterProblem": false
}
},
"autoSimSwitchover": {
"enabled": false,
"switchoverInterval": 0
},
"ccFirewall": {
"enabled": false
},
"routedInterfaces": [
{
"override": false,
"disabled": false,
"disableV4": false,
"disableV6": false,
"overlayPreference": "string",
"addressing": {
"type": "string",
"cidrIp": "string",
"netmask": "string",
"gateway": "string",
"username": "string",
"password": "string"
},
"v6Detail": {
"addressing": {
"type": "string",
"cidrPrefix": 0,
"cidrIp": "string",
"gateway": "string",
"raEnabled": false,
"netmask": "string",
"interfaceAddress": "string",
"tag": "string",
"tagLogicalId": "string"
},
"wanOverlay": "string",
"rpf": "string",
"trusted": false,
"natDirect": false,
"dhcpServer": {
"enabled": false,
"dhcpRelay": {
"enabled": false,
"servers": [
{}
]
},
"leaseTimeSeconds": 0,
"options": [
{
"option": 0,
"value": [
{}
],
"type": "string",
"metaData": {
"dataType": "string",
"description": "string",
"display": false,
"list": false,
"name": "string",
"option": 0
}
}
],
"prefixDelegation": {
"enabled": false,
"pdlist": [
{
"poolname": "string",
"prefix": "string",
"prefixLen": 0,
"targetPrefixLen": 0
}
]
},
"numDhcpAddr": 0,
"staticReserved": 0,
"fixedIp": [
{
"macAddress": "string",
"lanIp": "string",
"description": "string"
}
]
},
"routerAdvertisementHostSettings": {
"mtu": false,
"defaultRoutes": false,
"specificRoutes": false,
"nd6Timers": false
},
"ospf": {
"MTU": 0,
"cost": 0,
"deadTimer": 0,
"enableBfd": false,
"enabled": false,
"helloTimer": 0,
"inboundRouteLearning": {
"defaultAction": "string",
"filters": [
{
"cidrIp": "string",
"cidrPrefix": "string",
"action": "string"
}
]
},
"mode": "string",
"outboundRouteAdvertisement": {
"defaultAction": "string",
"filters": [
{
"cidrIp": "string",
"cidrPrefix": "string",
"action": "string"
}
]
},
"passive": false
},
"clientPrefixDelegation": {
"enabled": false,
"tag": "string",
"tagLogicalId": "string"
}
},
"advertise": false,
"cellular": {
"network": "string",
"iptype": "string"
},
"dhcpServer": {
"enabled": false,
"dhcpRelay": {
"enabled": false,
"servers": [
{}
]
},
"leaseTimeSeconds": 0,
"numDhcpAddr": 0,
"options": [
{
"option": 0,
"value": [
{}
],
"type": "string",
"metaData": {
"dataType": "string",
"description": "string",
"display": false,
"list": false,
"name": "string",
"option": 0
}
}
]
},
"dslSettings": {
"mode": "string"
},
"encryptOverlay": false,
"l2": {
"autonegotiation": false,
"speed": "string",
"duplex": "string",
"MTU": 0,
"losDetection": false,
"probeInterval": "string"
},
"multicast": {
"igmp": {
"enabled": false,
"type": "string"
},
"igmpHostQueryIntervalSeconds": 0,
"igmpMaxQueryResponse": 0,
"pim": {
"enabled": false,
"type": "string"
},
"pimHelloTimerSeconds": 0,
"pimKeepAliveTimerSeconds": 0,
"pimPruneIntervalSeconds": 0
},
"name": "string",
"natDirect": false,
"ospf": {
"authentication": false,
"authId": 0,
"authPassphrase": "string",
"cost": 0,
"deadTimer": 0,
"mode": "string",
"enabled": false,
"enableBfd": false,
"exclusionRoutes": [
{}
],
"helloTimer": 0,
"inboundRouteLearning": {
"defaultAction": "string",
"filters": [
{
"cidrIp": "string",
"cidrPrefix": "string",
"action": "string"
}
]
},
"md5Authentication": false,
"MTU": 0,
"outboundRouteAdvertisement": {
"defaultAction": "string",
"filters": [
{
"cidrIp": "string",
"cidrPrefix": "string",
"action": "string"
}
]
},
"passive": false,
"vlanId": 0
},
"pingResponse": false,
"dnsProxy": false,
"evdslModemAttached": false,
"radiusAuthentication": {
"enabled": false,
"macBypass": [
{
"address": "string",
"description": "string"
}
],
"aclCheck": false
},
"segmentId": 0,
"segment": {
"_href": "string",
"created": "string",
"description": "string",
"object": "string",
"name": "string",
"type": "string",
"alertsEnabled": 0,
"operatorAlertsEnabled": 0,
"status": "string",
"statusModified": "string",
"previousData": {},
"previousCreated": "string",
"draftData": "string",
"draftCreated": "string",
"draftComment": "string",
"data": {},
"lastContact": "string",
"version": "string",
"modified": "string"
},
"sfpType": "string",
"rpf": "string",
"trusted": false,
"underlayAccounting": false,
"vlanId": 0,
"wanOverlay": "string",
"subinterfaces": [
{
"override": false,
"disabled": false,
"disableV4": false,
"disableV6": false,
"overlayPreference": "string",
"addressing": {
"type": "string",
"cidrIp": "string",
"netmask": "string",
"gateway": "string",
"username": "string",
"password": "string"
},
"v6Detail": {
"addressing": {
"type": "string",
"cidrPrefix": 0,
"cidrIp": "string",
"gateway": "string",
"raEnabled": false,
"netmask": "string",
"interfaceAddress": "string",
"tag": "string",
"tagLogicalId": "string"
},
"wanOverlay": "string",
"rpf": "string",
"trusted": false,
"natDirect": false,
"dhcpServer": {
"enabled": false,
"dhcpRelay": {
"enabled": false,
"servers": [
{}
]
},
"leaseTimeSeconds": 0,
"options": [
{
"option": 0,
"value": [
{}
],
"type": "string",
"metaData": {
"dataType": "string",
"description": "string",
"display": false,
"list": false,
"name": "string",
"option": 0
}
}
],
"prefixDelegation": {
"enabled": false,
"pdlist": [
{
"poolname": "string",
"prefix": "string",
"prefixLen": 0,
"targetPrefixLen": 0
}
]
},
"numDhcpAddr": 0,
"staticReserved": 0,
"fixedIp": [
{
"macAddress": "string",
"lanIp": "string",
"description": "string"
}
]
},
"routerAdvertisementHostSettings": {
"mtu": false,
"defaultRoutes": false,
"specificRoutes": false,
"nd6Timers": false
},
"ospf": {
"MTU": 0,
"cost": 0,
"deadTimer": 0,
"enableBfd": false,
"enabled": false,
"helloTimer": 0,
"inboundRouteLearning": {
"defaultAction": "string",
"filters": [
{
"cidrIp": "string",
"cidrPrefix": "string",
"action": "string"
}
]
},
"mode": "string",
"outboundRouteAdvertisement": {
"defaultAction": "string",
"filters": [
{
"cidrIp": "string",
"cidrPrefix": "string",
"action": "string"
}
]
},
"passive": false
},
"clientPrefixDelegation": {
"enabled": false,
"tag": "string",
"tagLogicalId": "string"
}
},
"advertise": false,
"cellular": {
"network": "string",
"iptype": "string"
},
"dhcpServer": {
"enabled": false,
"dhcpRelay": {
"enabled": false,
"servers": [
{}
]
},
"leaseTimeSeconds": 0,
"numDhcpAddr": 0,
"options": [
{
"option": 0,
"value": [
{}
],
"type": "string",
"metaData": {
"dataType": "string",
"description": "string",
"display": false,
"list": false,
"name": "string",
"option": 0
}
}
]
},
"dslSettings": {
"mode": "string"
},
"encryptOverlay": false,
"l2": {
"autonegotiation": false,
"speed": "string",
"duplex": "string",
"MTU": 0,
"losDetection": false,
"probeInterval": "string"
},
"multicast": {
"igmp": {
"enabled": false,
"type": "string"
},
"igmpHostQueryIntervalSeconds": 0,
"igmpMaxQueryResponse": 0,
"pim": {
"enabled": false,
"type": "string"
},
"pimHelloTimerSeconds": 0,
"pimKeepAliveTimerSeconds": 0,
"pimPruneIntervalSeconds": 0
},
"name": "string",
"natDirect": false,
"ospf": {
"authentication": false,
"authId": 0,
"authPassphrase": "string",
"cost": 0,
"deadTimer": 0,
"mode": "string",
"enabled": false,
"enableBfd": false,
"exclusionRoutes": [
{}
],
"helloTimer": 0,
"inboundRouteLearning": {
"defaultAction": "string",
"filters": [
{
"cidrIp": "string",
"cidrPrefix": "string",
"action": "string"
}
]
},
"md5Authentication": false,
"MTU": 0,
"outboundRouteAdvertisement": {
"defaultAction": "string",
"filters": [
{
"cidrIp": "string",
"cidrPrefix": "string",
"action": "string"
}
]
},
"passive": false,
"vlanId": 0
},
"pingResponse": false,
"dnsProxy": false,
"evdslModemAttached": false,
"radiusAuthentication": {
"enabled": false,
"macBypass": [
{
"address": "string",
"description": "string"
}
],
"aclCheck": false
},
"segmentId": 0,
"segment": {
"_href": "string",
"created": "string",
"description": "string",
"object": "string",
"name": "string",
"type": "string",
"alertsEnabled": 0,
"operatorAlertsEnabled": 0,
"status": "string",
"statusModified": "string",
"previousData": {},
"previousCreated": "string",
"draftData": "string",
"draftCreated": "string",
"draftComment": "string",
"data": {},
"lastContact": "string",
"version": "string",
"modified": "string"
},
"sfpType": "string",
"rpf": "string",
"trusted": false,
"underlayAccounting": false,
"vlanId": 0,
"wanOverlay": "string",
"subinterfaceId": 0,
"subinterfaceType": "string"
}
]
}
],
"segments": [
{
"authentication": {
"override": false,
"sourceInterface": "string",
"authenticationService": {
"_href": "string",
"ref": "string",
"data": {},
"version": "string",
"object": "string",
"name": "string",
"type": "string"
},
"ref": "string"
},
"bgp": {
"aggregation": [
{
"prefix": "string",
"prefixLength": "number",
"summaryOnly": false,
"asSet": false
}
],
"enabled": false,
"override": false,
"asn": "string",
"ASN": "string",
"connectedRoutes": false,
"defaultRoute": {
"enabled": false,
"advertise": "string"
},
"disableASPathCarryOver": false,
"filters": [
{
"ids": [
{}
],
"name": "string",
"rules": [
{
"action": {
"type": "string",
"values": [
{
"type": "string",
"value": "string"
}
]
},
"match": {
"exactMatch": false,
"type": "string",
"value": "string"
}
}
]
}
],
"holdtime": "string",
"enableGracefulRestart": false,
"restarttime": "string",
"stalepathtime": "string",
"isEdge": false,
"keepalive": "string",
"neighbors": [
{
"neighborAS": "string",
"neighborIp": "string",
"neighborTag": "string",
"sourceInterface": "string",
"inboundFilter": {
"ids": [
{}
]
},
"outboundFilter": {
"ids": [
{}
]
},
"localIp": "string",
"maxHop": "string",
"allowAS": false,
"connect": "string",
"defaultRoute": false,
"holdtime": "string",
"keepalive": "string",
"enableMd5": false,
"md5Password": "string"
}
],
"networks": [
{
"cidrIp": "string",
"cidrPrefix": 0,
"segmentId": 0,
"segment": {
"_href": "string",
"created": "string",
"description": "string",
"object": "string",
"name": "string",
"type": "string",
"alertsEnabled": 0,
"operatorAlertsEnabled": 0,
"status": "string",
"statusModified": "string",
"previousData": {},
"previousCreated": "string",
"draftData": "string",
"draftCreated": "string",
"draftComment": "string",
"data": {},
"lastContact": "string",
"version": "string",
"modified": "string"
}
}
],
"ospf": {
"enabled": false,
"metric": 0
},
"overlayPrefix": false,
"propagateUplink": false,
"routerId": "string",
"uplinkCommunity": "string",
"v6Detail": {
"defaultRoute": {
"enabled": false,
"advertise": "string"
},
"connectedRoutes": false,
"neighbors": [
{
"neighborAS": "string",
"neighborIp": "string",
"neighborTag": "string",
"sourceInterface": "string",
"inboundFilter": {
"ids": [
{}
]
},
"outboundFilter": {
"ids": [
{}
]
},
"localIp": "string",
"maxHop": "string",
"allowAS": false,
"connect": "string",
"defaultRoute": false,
"holdtime": "string",
"keepalive": "string",
"enableMd5": false,
"md5Password": "string"
}
],
"networks": [
{
"cidrIp": "string",
"cidrPrefix": 0,
"segmentId": 0,
"segment": {
"_href": "string",
"created": "string",
"description": "string",
"object": "string",
"name": "string",
"type": "string",
"alertsEnabled": 0,
"operatorAlertsEnabled": 0,
"status": "string",
"statusModified": "string",
"previousData": {},
"previousCreated": "string",
"draftData": "string",
"draftCreated": "string",
"draftComment": "string",
"data": {},
"lastContact": "string",
"version": "string",
"modified": "string"
}
}
],
"ospf": {
"enabled": false,
"metric": 0
}
}
},
"css": {
"enabled": false,
"override": false,
"config": {
"tunnelingProtocol": "string",
"authenticationAlgorithm": "string",
"redirect": "string",
"IKEPROP": {},
"GREPROP": {
"keepaliveIntervalSecs": 0,
"keepaliveRetries": 0
},
"encryptionAlgorithm": "string",
"IPSECPROP": {}
},
"provider": {},
"cloudSecurityProvider": {
"_href": "string",
"ref": "string",
"data": {},
"version": "string",
"object": "string",
"name": "string",
"type": "string"
},
"sites": [
{}
],
"cloudSecuritySites": [
{}
]
},
"secureAccess": {
"enabled": false,
"override": false,
"provider": {},
"secureAccessProvider": {
"_href": "string",
"ref": "string",
"data": {},
"version": "string",
"object": "string",
"name": "string",
"type": "string"
}
},
"edgeDirect": {
"enabled": false,
"override": false,
"providers": [
{}
],
"edgeNonSdwanServices": [
{
"edgeNonSdwanService": {
"_href": "string",
"ref": "string",
"data": {},
"version": "string",
"object": "string",
"name": "string",
"type": "string"
},
"config": {
"useAllPublicWanLinks": false,
"enabled": false
},
"edgeNonSdwanSites": [
{}
]
}
]
},
"dns": {
"override": false,
"sourceInterface": "string",
"localDNS": [
{
"ipv4Address": [
"string"
],
"ipv6Address": [
"string"
],
"fqdn": "string"
}
],
"primaryProvider": {},
"dnsPrimaryProvider": {
"_href": "string",
"ref": "string",
"data": {},
"version": "string",
"object": "string",
"name": "string",
"type": "string"
},
"backupProvider": {},
"dnsBackupProvider": {
"_href": "string",
"ref": "string",
"data": {},
"version": "string",
"object": "string",
"name": "string",
"type": "string"
},
"privateProviders": {},
"dnsPrivateProviders": [
{
"_href": "string",
"ref": "string",
"data": {},
"version": "string",
"object": "string",
"name": "string",
"type": "string"
}
]
},
"handOffControllers": {
"override": false,
"autoSelect": false,
"gatewayList": [
{
"gateway": {
"_href": "string"
},
"ipsecDetail": {
"ipsecGatewayAddress": "string",
"strictHostCheck": false
},
"logicalId": "string"
}
]
},
"handOffGateways": {
"override": false,
"autoSelect": false,
"gatewayList": [
{
"gateway": {
"_href": "string"
},
"ipsecDetail": {
"ipsecGatewayAddress": "string",
"strictHostCheck": false
},
"logicalId": "string"
}
]
},
"multiSourceQos": {
"enabled": false,
"override": false,
"highRatio": 0,
"normalRatio": 0,
"lowRatio": 0,
"maxCapThreshold": 0,
"minCapThreshold": 0
},
"multicast": {
"enabled": false,
"override": false,
"igmpHostQueryIntervalSeconds": 0,
"igmpMaxQueryResponse": 0,
"pimKeepAliveTimerSeconds": 0,
"pimOnWanOverlay": {
"enabled": false,
"type": "string",
"sourceCidrIp": "string",
"sourceInterface": "string"
},
"pimPruneIntervalSeconds": 0,
"rp": {
"type": "string",
"staticGroups": [
{
"multicastGroups": [
{}
],
"rpAddress": "string"
}
]
}
},
"nat": {
"override": false,
"rules": [
{
"type": "string",
"description": "string",
"insideCidrIp": "string",
"insideCidrPrefix": 0,
"insideNetmask": "string",
"insidePort": 0,
"outsideCidrIp": "string",
"outsideCidrPrefix": 0,
"outsideNetmask": "string",
"outsidePort": 0
}
],
"dualRules": [
{
"description": "string",
"srcInsideCidrIp": "string",
"srcInsideCidrPrefix": 0,
"srcInsideCidrNetmask": "string",
"srcOutsideCidrIp": "string",
"srcOutsideCidrPrefix": 0,
"srcOutsideCidrNetmask": "string",
"destInsideCidrIp": "string",
"destInsideCidrPrefix": 0,
"destInsideCidrNetmask": "string",
"destOutsideCidrIp": "string",
"destOutsideCidrPrefix": 0,
"destOutsideCidrNetmask": "string"
}
]
},
"netflow": {
"enabled": false,
"override": false,
"collectors": [
{
"netflowCollector": {
"_href": "string",
"ref": "string",
"data": {},
"version": "string",
"object": "string",
"name": "string",
"type": "string"
},
"type": "string",
"sourceInterface": "string",
"name": "string",
"allowAllSegment": false,
"logicalId": "string",
"filterList": [
{}
],
"netflowFilterList": [
{
"_href": "string",
"ref": "string",
"data": {},
"version": "string",
"object": "string",
"name": "string",
"type": "string"
}
]
}
],
"version": 0,
"intervals": {
"flowStats": 0,
"flowLinkStats": 0,
"tunnelStats": 0,
"vrfTable": 0,
"applicationTable": 0,
"interfaceTable": 0,
"linkTable": 0
}
},
"ntp": {
"sourceInterface": "string",
"enabled": false,
"override": false,
"servers": [
{
"server": "string"
}
]
},
"ospf": {
"aggregation": [
{
"prefix": "string",
"prefixLength": "number",
"noAdvertise": false,
"tag": "number",
"metric": "number",
"metricType": "string"
}
],
"enabled": false,
"areas": [
{
"name": "string",
"type": "string"
}
],
"bgp": {
"enabled": false,
"metric": 0,
"metricType": "string"
},
"defaultPrefixes": false,
"defaultRouteAdvertise": "string",
"defaultRoutes": "string",
"v6Detail": {
"aggregation": [
{
"prefix": "string",
"prefixLength": "number",
"noAdvertise": false,
"tag": "number",
"metric": "number",
"metricType": "string"
}
],
"enabled": false,
"areas": [
{
"name": "string",
"type": "string"
}
],
"bgp": {
"enabled": false,
"metric": 0,
"metricType": "string"
},
"defaultPrefixes": false,
"defaultRouteAdvertise": "string",
"defaultRoutes": "string"
}
},
"routes": {
"icmpProbes": [
{}
],
"icmpResponders": [
{}
],
"nsd": [
{
"advertise": false,
"cidrIp": "string",
"cidrIpEnd": "string",
"cidrIpStart": "string",
"cidrPrefix": "string",
"cost": 0,
"destination": "string",
"gatewayLogicalId": "string",
"gatewayName": "string",
"isStatic": false,
"name": "string",
"netMask": "string",
"nsd": "string",
"nsdLogicalId": "string",
"nsdType": "string",
"preferred": false
}
],
"static": [
{
"destination": "string",
"netmask": "string",
"sourceIp": "string",
"gateway": "string",
"cost": 0,
"preferred": false,
"description": "string",
"cidrPrefix": "string",
"wanInterface": "string",
"icmpProbeLogicalId": "string",
"vlanId": 0,
"advertise": false,
"subinterfaceId": 0
}
],
"staticV6": [
{
"destination": "string",
"netmask": "string",
"sourceIp": "string",
"gateway": "string",
"cost": 0,
"preferred": false,
"description": "string",
"cidrPrefix": "string",
"wanInterface": "string",
"icmpProbeLogicalId": "string",
"vlanId": 0,
"advertise": false,
"subinterfaceId": 0
}
]
},
"segment": {
"_href": "string",
"created": "string",
"description": "string",
"object": "string",
"name": "string",
"type": "string",
"alertsEnabled": 0,
"operatorAlertsEnabled": 0,
"status": "string",
"statusModified": "string",
"previousData": {},
"previousCreated": "string",
"draftData": "string",
"draftCreated": "string",
"draftComment": "string",
"data": {},
"lastContact": "string",
"version": "string",
"modified": "string"
},
"snmp": {
"override": false,
"port": 0,
"snmpv2c": {
"enabled": false,
"community": "string",
"allowedIp": [
{}
]
},
"snmpv3": {
"enabled": false,
"users": [
{
"name": "string",
"passphrase": "string",
"authAlg": "string",
"authentication": false,
"privacy": false,
"encrAlg": "string"
}
]
}
},
"syslog": {
"enabled": false,
"facilityCode": "string",
"override": false,
"collectors": [
{
"host": "string",
"port": 0,
"protocol": "string",
"roles": [
"string"
],
"severity": [
"string"
],
"sourceInterface": "string",
"tag": "string"
}
]
},
"vpn": {
"enabled": false,
"edgeToDataCenter": false,
"ref": "string",
"gatewayNonSdwanSites": [
{
"_href": "string",
"ref": "string",
"data": {},
"version": "string",
"object": "string",
"name": "string",
"type": "string"
}
],
"isolationGroupId": "string",
"edgeToEdgeHub": {
"enabled": false,
"ref": "string",
"vpnHubs": [
{
"_href": "string",
"ref": "string",
"data": {},
"version": "string",
"object": "string",
"name": "string",
"type": "string"
}
]
},
"edgeToEdge": false,
"edgeToEdgeDetail": {
"autoSelectVpnHubs": false,
"dynamic": {
"enabled": false,
"isolation": {
"enabled": false
},
"type": "string",
"timeout": 0
},
"encryptionProtocol": "string",
"profileIsolation": {
"enabled": false,
"profileLogicalId": "string",
"isolateDynamic": false
},
"isolation": {
"enabled": false
},
"isolationGroupId": "string",
"isolationGroups": [
{
"logicalId": "string"
}
],
"useCloudGateway": false,
"vpnHubs": [
{
"_href": "string",
"ref": "string",
"data": {},
"version": "string",
"object": "string",
"name": "string",
"type": "string"
}
]
},
"conditionalBackhaul": false,
"backHaulEdges": [
{
"logicalId": "string",
"name": "string",
"type": "string"
}
]
},
"vqm": {
"enabled": false,
"override": false,
"collectors": [
{
"address": "string",
"port": 0
}
]
},
"vrrp": {
"enabled": false,
"data": [
{
"cidrIp": "string",
"interface": "string",
"interval": 0,
"preempt": false,
"preemptDelay": 0,
"priority": 0,
"subinterfaceId": 0,
"vlanId": 0,
"vrid": 0
}
]
},
"analyticsSettings": {
"analyticsEnabled": false,
"sourceInterface": "string",
"override": false
},
"bfd": {
"enabled": false,
"rules": [
{
"peerAddress": "string",
"localAddress": "string",
"multihop": false,
"detectMultiplier": 0,
"receiveInterval": 0,
"transmitInterval": 0
}
],
"override": false,
"rulesV6": [
{
"peerAddress": "string",
"localAddress": "string",
"multihop": false,
"detectMultiplier": 0,
"receiveInterval": 0,
"transmitInterval": 0
}
]
}
}
],
"snmp": {
"override": false,
"port": 0,
"snmpv2c": {
"enable": false,
"enabled": false,
"community": "string",
"allowedIp": [
{}
]
},
"snmpv3": {
"enable": false,
"enabled": false,
"users": [
{
"name": "string",
"passphrase": "string",
"authAlg": "string",
"authentication": false,
"privacy": false,
"encrAlg": "string"
}
]
}
},
"softwareUpdate": {
"windowed": false,
"window": {
"day": 0,
"beginHour": 0,
"endHour": 0
}
},
"tacacs": {
"tacacsService": {
"_href": "string",
"ref": "string",
"data": {},
"version": "string",
"object": "string",
"name": "string",
"type": "string"
},
"ref": "string",
"sourceInterface": "string"
},
"vnfs": {
"edge": {},
"hasVnfs": false,
"securityVnf": {
"vms": [
{
"type": "string",
"vendor": "string",
"cidrIp": "string",
"hostname": "string",
"insertionEnabled": false,
"instanceId": 0,
"vlanId": 0,
"vmDeploy": false,
"vmPowerOff": false,
"edge": {},
"license": {
"_href": "string",
"ref": "string",
"data": {},
"version": "string",
"object": "string",
"name": "string",
"type": "string"
},
"service": {
"_href": "string",
"ref": "string",
"data": {},
"version": "string",
"object": "string",
"name": "string",
"type": "string"
},
"uuid": "string",
"uuidTimestamp": "string",
"modifiedTimestamp": 0
}
]
}
},
"zscaler": {
"config": {
"override": false,
"enabled": false,
"cloud": "string",
"vendor": "string",
"provider": {
"_href": "string",
"ref": "string",
"data": {},
"version": "string",
"object": "string",
"name": "string",
"type": "string"
},
"location": {
"name": "string",
"gwProperties": {
"xffForwardEnabled": false,
"authRequired": false,
"aupEnabled": false,
"aupBlockInternetUntilAccepted": false,
"aupForceSslInspection": false,
"aupTimeoutInDays": "number",
"cautionEnabled": false,
"surrogateIP": false,
"idleTimeInMinutes": "number",
"displayTimeUnit": "string",
"surrogateIPEnforcedForKnownBrowsers": false,
"surrogateRefreshTimeInMinutes": "number",
"surrogateRefreshTimeUnit": "string",
"dnBandwidth": "number",
"upBandwidth": "number",
"ipsControl": false,
"ofwEnabled": false
}
},
"subLocations": [
{
"internalId": "string",
"name": "string",
"otherSubLocation": false,
"ruleId": "string",
"gwProperties": {
"xffForwardEnabled": false,
"authRequired": false,
"aupEnabled": false,
"aupBlockInternetUntilAccepted": false,
"aupForceSslInspection": false,
"aupTimeoutInDays": "number",
"cautionEnabled": false,
"surrogateIP": false,
"idleTimeInMinutes": "number",
"displayTimeUnit": "string",
"surrogateIPEnforcedForKnownBrowsers": false,
"surrogateRefreshTimeInMinutes": "number",
"surrogateRefreshTimeUnit": "string",
"dnBandwidth": "number",
"upBandwidth": "number",
"ipsControl": false,
"ofwEnabled": false
},
"vlans": [
"number"
],
"includeAllVlans": false,
"includeAllLanInterfaces": false,
"lanRoutedInterfaces": [
"string"
],
"ipAddressSelectionManual": false,
"ipAddresses": [
"string"
]
}
],
"mtgre": {
"enabled": false
}
},
"deployment": {
"location": {
"logicalId": "string",
"cloud": "string"
},
"subLocations": [
{
"internalId": "string",
"logicalId": "string",
"cloud": "string",
"otherSubLocation": false
}
],
"mtgreSite": {
"_href": "string",
"ref": "string",
"data": {},
"version": "string",
"object": "string",
"name": "string",
"type": "string"
}
}
},
"_href": "string"
}object
bfd
Optional
bfd
object
ha
Optional
ha
object
lan
Optional
lan
object
loopbackInterfaces
Optional
The loop back interface ID should always be prefixed with LO and followed by an integer between 0 and 99. For example, a few valid loop back interface IDs are LO0, LO1, LO13 etc. When the interface ID does not conform to this format, it will be ignored when device settings module is updated.
object
models
Optional
models
object
multiSourceQos
Optional
multiSourceQos
object
ntp
Optional
ntp
object
ntpServer
Optional
ntpServer
object
radioSettings
Optional
radioSettings
object
l2Settings
Optional
l2Settings
object
globalIPv6Settings
Optional
globalIPv6Settings
object
autoSimSwitchover
Optional
autoSimSwitchover
object
ccFirewall
Optional
ccFirewall
array of object
routedInterfaces
Optional
routedInterfaces
array of object
segments
Optional
segments
object
snmp
Optional
snmp
object
softwareUpdate
Optional
softwareUpdate
object
tacacs
Optional
tacacs
object
vnfs
Optional
vnfs
object
zscaler
Optional
zscaler
string
_href
Optional
_href
202
Asynchronous action enqueued
Returns AsyncOperationEnqueued of type(s) application/json
"AsyncOperationEnqueued Object"string
status
Optional
status
Possible values are : ACCEPTED, DONE, ERROR,
string
operationId
Optional
operationId
400
ValidationError
Returns ValidationError of type(s) application/json
"ValidationError Object"string
code
Optional
A unique error code
string
property
Optional
The name of the property to which the error applies, if applicable
string
message
Optional
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
string
displayMessage
Optional
A non-technical description of the error condition
string
documentation
Optional
A link to applicable external documentation
array of object
errors
Optional
A list of property-specific errors
401
Unauthorized
Returns UnAuthorized of type(s) application/json
"UnAuthorized Object"string
code
Optional
A unique error code
string
property
Optional
The name of the property to which the error applies, if applicable
string
message
Optional
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
string
displayMessage
Optional
A non-technical description of the error condition
string
documentation
Optional
A link to applicable external documentation
404
Resource not found
Returns ResourceNotFoundError of type(s) application/json
"ResourceNotFoundError Object"string
code
Optional
A unique error code
string
property
Optional
The name of the property to which the error applies, if applicable
string
message
Optional
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
string
displayMessage
Optional
A non-technical description of the error condition
string
documentation
Optional
A link to applicable external documentation
415
UnsupportedMediaTypeError
Returns UnsupportedMediaTypeError of type(s) application/json
"UnsupportedMediaTypeError Object"string
code
Optional
A unique error code
string
property
Optional
The name of the property to which the error applies, if applicable
string
message
Optional
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
string
displayMessage
Optional
A non-technical description of the error condition
string
documentation
Optional
A link to applicable external documentation
429
Rate Limit Exceeded
Returns RateLimitExceededError of type(s) application/json
"RateLimitExceededError Object"string
code
Optional
A unique error code
string
property
Optional
The name of the property to which the error applies, if applicable
string
message
Optional
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
string
displayMessage
Optional
A non-technical description of the error condition
string
documentation
Optional
A link to applicable external documentation
500
Internal server error
Returns InternalServerError of type(s) application/json
"InternalServerError Object"string
code
Optional
A unique error code
string
property
Optional
The name of the property to which the error applies, if applicable
string
message
Optional
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
string
displayMessage
Optional
A non-technical description of the error condition
string
documentation
Optional
A link to applicable external documentation
Code Samples
COPY
curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]'