[{"label":"Latest (v1.0)","version":"latest"}]
vmware-sase-platform

Get Enterprise Profile Device Settings

Description

Profile deviceSettings module response spec

Request

Request

URL

URL


get
https://{api_host}//api/sdwan/v2/enterprises/{enterpriseLogicalId}/profiles/{profileLogicalId}/deviceSettings
Copy

Path Parameters

Path Parameters

string
enterpriseLogicalId Required

The logicalId GUID for the target enterprise


string
profileLogicalId Required

The logicalId GUID for the target profile


Query Parameters

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.


Response

Response

Response Body

Response Body

200 OK

Returns BaseDeviceSettings of type application/json

Request successfully processed

{
	"_href": "string",
	"bfd": {
		"enabled": false,
		"override": false,
		"rules": [
			{
				"detectMultiplier": 0,
				"localAddress": "string",
				"multihop": false,
				"peerAddress": "string",
				"receiveInterval": 0,
				"transmitInterval": 0
			}
		],
		"rulesV6": [
			{
				"detectMultiplier": 0,
				"localAddress": "string",
				"multihop": false,
				"peerAddress": "string",
				"receiveInterval": 0,
				"transmitInterval": 0
			}
		]
	},
	"globalIPv6Settings": {
		"advancedConfiguration": {
			"disableAllIPv6Traffic": false,
			"dropRoutingHeaderTypeZeroPackets": false,
			"dropnLogPacketsForRFCReservedFields": false,
			"enforceExtensionHeaderOrderCheck": false,
			"enforceExtensionHeaderValidation": false
		},
		"icmpV6Messages": {
			"disableDestinationUnreachable": false,
			"disableParameterProblem": false,
			"disableTimeExceeded": false
		}
	},
	"ha": {
		"enabled": false,
		"haGracefulSwitchover": false,
		"interface": "string",
		"nodes": [
			{
				"instanceId": 0,
				"serialNumber": "string"
			}
		],
		"vmacoverride": false
	},
	"l2Settings": {
		"arpCleanupTimeoutMinutes": 0,
		"arpDeadTimeoutMinutes": 0,
		"arpStaleTimeoutMinutes": 0,
		"overrideARPTimeout": false
	},
	"lan": {
		"interfaces": [
			{
				"authenticationType": "none",
				"broadcastSsid": false,
				"cwp": false,
				"disabled": false,
				"l2": {
					"MTU": 0,
					"autonegotiation": false,
					"duplex": "FULL",
					"losDetection": false,
					"probeInterval": "1",
					"speed": "string"
				},
				"name": "string",
				"override": false,
				"passphrase": "string",
				"portMode": "access",
				"securityMode": "Open",
				"space": "string",
				"ssid": "string",
				"type": "wired",
				"untaggedVlan": {},
				"vlanIds": 0
			}
		],
		"management": {
			"cidrIp": "string",
			"cidrPrefix": 0
		},
		"managementTraffic": {
			"override": false,
			"sourceInterface": "string"
		},
		"networks": [
			{
				"advertise": false,
				"baseDhcpAddr": {},
				"bindEdgeAddress": false,
				"cidrIp": "string",
				"cidrPrefix": 0,
				"cost": 0,
				"dhcp": {
					"baseDhcpAddr": {},
					"dhcpRelay": {
						"enabled": false,
						"servers": [
							"string"
						]
					},
					"enabled": false,
					"leaseTimeSeconds": 0,
					"numDhcpAddr": 0,
					"options": [
						{
							"metaData": {
								"dataType": "string",
								"description": "string",
								"display": false,
								"list": false,
								"name": "string",
								"option": 0
							},
							"option": 0,
							"type": "string",
							"value": [
								"string"
							]
						}
					],
					"override": false
				},
				"disabled": false,
				"dnsProxy": false,
				"fixedIp": [
					{
						"description": "string",
						"lanIp": "string",
						"macAddress": "string"
					}
				],
				"interfaces": [
					"string"
				],
				"multicast": {
					"igmp": {
						"enabled": false,
						"type": "IGMP_V2"
					},
					"igmpHostQueryIntervalSeconds": 0,
					"igmpMaxQueryResponse": 0,
					"pim": {
						"enabled": false,
						"type": "PIM_SM"
					},
					"pimHelloTimerSeconds": 0,
					"pimKeepAliveTimerSeconds": 0,
					"pimPruneIntervalSeconds": 0
				},
				"name": "string",
				"netmask": "string",
				"numDhcpAddr": 0,
				"ospf": {
					"area": {},
					"enabled": false,
					"override": false,
					"passiveInterface": false
				},
				"override": false,
				"pingResponse": false,
				"radiusAuthentication": {
					"aclCheck": false,
					"enabled": false,
					"macBypass": [
						{
							"address": "string",
							"description": "string"
						}
					]
				},
				"segment": {
					"_href": "string",
					"alertsEnabled": 0,
					"created": "string",
					"data": {},
					"description": "string",
					"draftComment": "string",
					"draftCreated": "string",
					"draftData": "string",
					"lastContact": "string",
					"modified": "string",
					"name": "string",
					"object": "string",
					"operatorAlertsEnabled": 0,
					"previousCreated": "string",
					"previousData": {},
					"status": "string",
					"statusModified": "string",
					"type": "string",
					"version": "string"
				},
				"segmentId": 0,
				"staticReserved": 0,
				"v6Detail": {
					"addressing": {
						"cidrIp": "string",
						"cidrPrefix": 0,
						"netmask": "string",
						"type": "string"
					},
					"advertise": false,
					"bindEdgeAddress": false,
					"dhcpServer": {
						"baseDhcpAddr": {},
						"dhcpRelay": {
							"enabled": false,
							"servers": [
								"string"
							]
						},
						"enabled": false,
						"fixedIp": [
							{
								"description": "string",
								"lanIp": "string",
								"macAddress": "string"
							}
						],
						"leaseTimeSeconds": 0,
						"numDhcpAddr": 0,
						"options": [
							{
								"metaData": {
									"dataType": "string",
									"description": "string",
									"display": false,
									"list": false,
									"name": "string",
									"option": 0
								},
								"option": 0,
								"type": "string",
								"value": [
									"string"
								]
							}
						],
						"prefixDelegation": {
							"enabled": false,
							"pdlist": [
								{
									"poolname": "string",
									"prefix": "string",
									"prefixLen": 0,
									"targetPrefixLen": 0
								}
							]
						},
						"staticReserved": 0
					},
					"ospf": {
						"area": {},
						"enabled": false,
						"override": false,
						"passiveInterface": false
					},
					"override": false,
					"routerAdvertisementHostSettings": {
						"defaultRoutes": false,
						"mtu": false,
						"nd6Timers": false,
						"specificRoutes": false
					}
				},
				"vlanId": 0,
				"vnfInsertion": false
			}
		],
		"visibility": {
			"mode": "MAC",
			"override": false
		}
	},
	"loopbackInterfaces": {
		"advertise": false,
		"cidrIp": "string",
		"cidrPrefix": 0,
		"disableV4": false,
		"disableV6": false,
		"ospf": {
			"area": [
				"string"
			],
			"enabled": false
		},
		"pingResponse": false,
		"segment": 0,
		"v6Detail": {
			"advertise": false,
			"cidrIp": "string",
			"cidrPrefix": 0,
			"ospf": {
				"area": [
					"string"
				],
				"enabled": false
			}
		}
	},
	"models": {},
	"multiSourceQos": {
		"enabled": false,
		"highRatio": 0,
		"lowRatio": 0,
		"maxCapThreshold": 0,
		"minCapThreshold": 0,
		"normalRatio": 0,
		"override": false
	},
	"ntp": {
		"enabled": false,
		"override": false,
		"servers": [
			{
				"server": "string"
			}
		],
		"sourceInterface": "string"
	},
	"ntpServer": {
		"authentication": "NONE",
		"enabled": false,
		"keys": [
			{
				"key": "string",
				"keyNumber": 0
			}
		],
		"override": false,
		"sourceInterface": "string"
	},
	"radioSettings": {
		"country": "string",
		"radios": [
			{
				"band": "string",
				"channel": {},
				"isEnabled": false,
				"mode": "string",
				"name": "string",
				"radioId": 0,
				"width": "string"
			}
		]
	},
	"routedInterfaces": [
		{
			"addressing": {
				"cidrIp": "string",
				"cidrPrefix": {},
				"gateway": "string",
				"netmask": "string",
				"password": "string",
				"type": "DHCP",
				"username": "string"
			},
			"advertise": false,
			"cellular": {
				"apn": {},
				"iptype": "IPv4",
				"network": "ATT",
				"password": {},
				"simPin": {},
				"username": {}
			},
			"dhcpServer": {
				"baseDhcpAddr": {},
				"dhcpRelay": {
					"enabled": false,
					"servers": [
						"string"
					]
				},
				"enabled": false,
				"leaseTimeSeconds": 0,
				"numDhcpAddr": 0,
				"options": [
					{
						"metaData": {
							"dataType": "string",
							"description": "string",
							"display": false,
							"list": false,
							"name": "string",
							"option": 0
						},
						"option": 0,
						"type": "string",
						"value": [
							"string"
						]
					}
				],
				"override": false
			},
			"disableV4": false,
			"disableV6": false,
			"disabled": false,
			"dnsProxy": false,
			"dslSettings": {
				"mode": "adsl2",
				"properties": {}
			},
			"encryptOverlay": false,
			"evdslModemAttached": false,
			"l2": {
				"MTU": 0,
				"autonegotiation": false,
				"duplex": "FULL",
				"losDetection": false,
				"probeInterval": "1",
				"speed": "string"
			},
			"multicast": {
				"igmp": {
					"enabled": false,
					"type": "IGMP_V2"
				},
				"igmpHostQueryIntervalSeconds": 0,
				"igmpMaxQueryResponse": 0,
				"pim": {
					"enabled": false,
					"type": "PIM_SM"
				},
				"pimHelloTimerSeconds": 0,
				"pimKeepAliveTimerSeconds": 0,
				"pimPruneIntervalSeconds": 0
			},
			"name": "string",
			"natDirect": false,
			"ospf": {
				"MTU": 0,
				"area": {},
				"authId": 0,
				"authPassphrase": "string",
				"authentication": false,
				"cost": 0,
				"deadTimer": 0,
				"enableBfd": false,
				"enabled": false,
				"exclusionRoutes": [
					{}
				],
				"helloTimer": 0,
				"inboundRouteLearning": {
					"defaultAction": "ADVERTISE",
					"filters": [
						{
							"action": "ADVERTISE",
							"cidrIp": "string",
							"cidrPrefix": "string"
						}
					]
				},
				"md5Authentication": false,
				"mode": "string",
				"outboundRouteAdvertisement": {
					"defaultAction": "ADVERTISE",
					"filters": [
						{
							"action": "ADVERTISE",
							"cidrIp": "string",
							"cidrPrefix": "string"
						}
					]
				},
				"passive": false,
				"vlanId": 0
			},
			"overlayPreference": "IPv4",
			"override": false,
			"pingResponse": false,
			"radiusAuthentication": {
				"aclCheck": false,
				"enabled": false,
				"macBypass": [
					{
						"address": "string",
						"description": "string"
					}
				]
			},
			"rpf": "SPECIFIC",
			"segment": {
				"_href": "string",
				"alertsEnabled": 0,
				"created": "string",
				"data": {},
				"description": "string",
				"draftComment": "string",
				"draftCreated": "string",
				"draftData": "string",
				"lastContact": "string",
				"modified": "string",
				"name": "string",
				"object": "string",
				"operatorAlertsEnabled": 0,
				"previousCreated": "string",
				"previousData": {},
				"status": "string",
				"statusModified": "string",
				"type": "string",
				"version": "string"
			},
			"segmentId": 0,
			"sfpType": "standard",
			"subinterfaces": [
				{
					"subinterfaceId": 0,
					"subinterfaceType": "SECONDARY_IP"
				}
			],
			"trusted": false,
			"underlayAccounting": false,
			"v6Detail": {
				"addressing": {
					"cidrIp": "string",
					"cidrPrefix": 0,
					"gateway": "string",
					"netmask": "string",
					"raEnabled": false,
					"type": "STATIC"
				},
				"dhcpServer": {
					"baseDhcpAddr": {},
					"dhcpRelay": {
						"enabled": false,
						"servers": [
							"string"
						]
					},
					"enabled": false,
					"fixedIp": [
						{
							"description": "string",
							"lanIp": "string",
							"macAddress": "string"
						}
					],
					"leaseTimeSeconds": 0,
					"numDhcpAddr": 0,
					"options": [
						{
							"metaData": {
								"dataType": "string",
								"description": "string",
								"display": false,
								"list": false,
								"name": "string",
								"option": 0
							},
							"option": 0,
							"type": "string",
							"value": [
								"string"
							]
						}
					],
					"prefixDelegation": {
						"enabled": false,
						"pdlist": [
							{
								"poolname": "string",
								"prefix": "string",
								"prefixLen": 0,
								"targetPrefixLen": 0
							}
						]
					},
					"staticReserved": 0
				},
				"natDirect": false,
				"ospf": {
					"MTU": 0,
					"area": {},
					"cost": 0,
					"deadTimer": 0,
					"enableBfd": false,
					"enabled": false,
					"helloTimer": 0,
					"inboundRouteLearning": {
						"defaultAction": "ADVERTISE",
						"filters": [
							{
								"action": "ADVERTISE",
								"cidrIp": "string",
								"cidrPrefix": "string"
							}
						]
					},
					"mode": "string",
					"outboundRouteAdvertisement": {
						"defaultAction": "ADVERTISE",
						"filters": [
							{
								"action": "ADVERTISE",
								"cidrIp": "string",
								"cidrPrefix": "string"
							}
						]
					},
					"passive": false
				},
				"routerAdvertisementHostSettings": {
					"defaultRoutes": false,
					"mtu": false,
					"nd6Timers": false,
					"specificRoutes": false
				},
				"rpf": "SPECIFIC",
				"trusted": false,
				"wanOverlay": "DISABLED"
			},
			"vlanId": 0,
			"wanOverlay": "DISABLED"
		}
	],
	"segments": [
		{
			"analyticsSettings": {
				"analyticsEnabled": false,
				"override": false,
				"sourceInterface": "string"
			},
			"authentication": {
				"authenticationService": {
					"_href": "string",
					"data": {},
					"name": "string",
					"object": "string",
					"ref": "string",
					"type": "string",
					"version": "string"
				},
				"override": false,
				"ref": "deviceSettings:authentication",
				"sourceInterface": "string"
			},
			"bfd": {
				"enabled": false,
				"override": false,
				"rules": [
					{
						"detectMultiplier": 0,
						"localAddress": "string",
						"multihop": false,
						"peerAddress": "string",
						"receiveInterval": 0,
						"transmitInterval": 0
					}
				],
				"rulesV6": [
					{
						"detectMultiplier": 0,
						"localAddress": "string",
						"multihop": false,
						"peerAddress": "string",
						"receiveInterval": 0,
						"transmitInterval": 0
					}
				]
			},
			"bgp": {
				"ASN": "string",
				"aggregation": [
					{
						"asSet": false,
						"prefix": "string",
						"prefixLength": 0,
						"summaryOnly": false
					}
				],
				"asn": "string",
				"connectedRoutes": false,
				"defaultRoute": {
					"advertise": "string",
					"enabled": false
				},
				"disableASPathCarryOver": false,
				"enableGracefulRestart": false,
				"enabled": false,
				"filters": [
					{
						"ids": [
							"string"
						],
						"name": "string",
						"rules": [
							{
								"action": {
									"type": "PERMIT",
									"values": [
										{
											"type": "AS_PATH_PREPEND",
											"value": "string"
										}
									]
								},
								"match": {
									"exactMatch": false,
									"type": "COMMUNITY",
									"value": "string"
								}
							}
						]
					}
				],
				"holdtime": "string",
				"isEdge": false,
				"keepalive": "string",
				"neighbors": [
					{
						"allowAS": false,
						"connect": "string",
						"defaultRoute": false,
						"enableMd5": false,
						"holdtime": "string",
						"inboundFilter": {
							"ids": [
								"string"
							]
						},
						"keepalive": "string",
						"localIp": "string",
						"maxHop": "string",
						"md5Password": "string",
						"neighborAS": "string",
						"neighborIp": "string",
						"neighborTag": "UPLINK",
						"outboundFilter": {
							"ids": [
								"string"
							]
						},
						"sourceInterface": "string"
					}
				],
				"networks": [
					{
						"cidrIp": "string",
						"cidrPrefix": 0,
						"segment": {
							"_href": "string",
							"alertsEnabled": 0,
							"created": "string",
							"data": {},
							"description": "string",
							"draftComment": "string",
							"draftCreated": "string",
							"draftData": "string",
							"lastContact": "string",
							"modified": "string",
							"name": "string",
							"object": "string",
							"operatorAlertsEnabled": 0,
							"previousCreated": "string",
							"previousData": {},
							"status": "string",
							"statusModified": "string",
							"type": "string",
							"version": "string"
						},
						"segmentId": 0
					}
				],
				"ospf": {
					"enabled": false,
					"metric": 0
				},
				"overlayPrefix": false,
				"override": false,
				"propagateUplink": false,
				"restarttime": "string",
				"routerId": "string",
				"stalepathtime": "string",
				"uplinkCommunity": "string",
				"v6Detail": {
					"connectedRoutes": false,
					"defaultRoute": {
						"advertise": "string",
						"enabled": false
					},
					"neighbors": [
						{
							"allowAS": false,
							"connect": "string",
							"defaultRoute": false,
							"enableMd5": false,
							"holdtime": "string",
							"inboundFilter": {
								"ids": [
									"string"
								]
							},
							"keepalive": "string",
							"localIp": "string",
							"maxHop": "string",
							"md5Password": "string",
							"neighborAS": "string",
							"neighborIp": "string",
							"neighborTag": "UPLINK",
							"outboundFilter": {
								"ids": [
									"string"
								]
							},
							"sourceInterface": "string"
						}
					],
					"networks": [
						{
							"cidrIp": "string",
							"cidrPrefix": 0,
							"segment": {
								"_href": "string",
								"alertsEnabled": 0,
								"created": "string",
								"data": {},
								"description": "string",
								"draftComment": "string",
								"draftCreated": "string",
								"draftData": "string",
								"lastContact": "string",
								"modified": "string",
								"name": "string",
								"object": "string",
								"operatorAlertsEnabled": 0,
								"previousCreated": "string",
								"previousData": {},
								"status": "string",
								"statusModified": "string",
								"type": "string",
								"version": "string"
							},
							"segmentId": 0
						}
					],
					"ospf": {
						"enabled": false,
						"metric": 0
					}
				}
			},
			"css": {
				"cloudSecurityProvider": {
					"_href": "string",
					"data": {},
					"name": "string",
					"object": "string",
					"ref": "string",
					"type": "string",
					"version": "string"
				},
				"cloudSecuritySites": {},
				"config": {
					"GREPROP": {
						"keepaliveIntervalSecs": 0,
						"keepaliveRetries": 0
					},
					"IKEPROP": {},
					"IPSECPROP": {},
					"authenticationAlgorithm": "string",
					"encryptionAlgorithm": "string",
					"redirect": "string",
					"tunnelingProtocol": "GRE"
				},
				"enabled": false,
				"override": false,
				"provider": {},
				"sites": {}
			},
			"dns": {
				"backupProvider": {},
				"dnsBackupProvider": {
					"_href": "string",
					"data": {},
					"name": "string",
					"object": "string",
					"ref": "string",
					"type": "string",
					"version": "string"
				},
				"dnsPrimaryProvider": {
					"_href": "string",
					"data": {},
					"name": "string",
					"object": "string",
					"ref": "string",
					"type": "string",
					"version": "string"
				},
				"dnsPrivateProviders": [
					{
						"_href": "string",
						"data": {},
						"name": "string",
						"object": "string",
						"ref": "string",
						"type": "string",
						"version": "string"
					}
				],
				"localDNS": [
					{
						"fqdn": "string",
						"ipv4Address": [
							"string"
						],
						"ipv6Address": [
							"string"
						]
					}
				],
				"override": false,
				"primaryProvider": {},
				"privateProviders": {},
				"sourceInterface": "string"
			},
			"edgeDirect": {
				"edgeNonSdwanServices": [
					{
						"config": {
							"enabled": false,
							"useAllPublicWanLinks": false
						},
						"edgeNonSdwanService": {
							"_href": "string",
							"data": {},
							"name": "string",
							"object": "string",
							"ref": "string",
							"type": "string",
							"version": "string"
						},
						"edgeNonSdwanSites": {}
					}
				],
				"enabled": false,
				"override": false,
				"providers": {}
			},
			"handOffControllers": {
				"autoSelect": false,
				"gatewayList": [
					{
						"gateway": {
							"_href": "string"
						},
						"ipsecDetail": {
							"ipsecGatewayAddress": "string",
							"strictHostCheck": false
						},
						"logicalId": "string"
					}
				],
				"override": false
			},
			"handOffGateways": {
				"autoSelect": false,
				"gatewayList": [
					{
						"gateway": {
							"_href": "string"
						},
						"ipsecDetail": {
							"ipsecGatewayAddress": "string",
							"strictHostCheck": false
						},
						"logicalId": "string"
					}
				],
				"override": false
			},
			"multiSourceQos": {
				"enabled": false,
				"highRatio": 0,
				"lowRatio": 0,
				"maxCapThreshold": 0,
				"minCapThreshold": 0,
				"normalRatio": 0,
				"override": false
			},
			"multicast": {
				"enabled": false,
				"igmpHostQueryIntervalSeconds": 0,
				"igmpMaxQueryResponse": 0,
				"override": false,
				"pimKeepAliveTimerSeconds": 0,
				"pimOnWanOverlay": {
					"enabled": false,
					"sourceCidrIp": "string",
					"sourceInterface": "string",
					"type": "SOURCE_IP"
				},
				"pimPruneIntervalSeconds": 0,
				"rp": {
					"staticGroups": [
						{
							"multicastGroups": [
								"string"
							],
							"rpAddress": "string"
						}
					],
					"type": "STATIC"
				}
			},
			"nat": {
				"dualRules": [
					{
						"description": "string",
						"destInsideCidrIp": "string",
						"destInsideCidrNetmask": "string",
						"destInsideCidrPrefix": 0,
						"destOutsideCidrIp": "string",
						"destOutsideCidrNetmask": "string",
						"destOutsideCidrPrefix": 0,
						"srcInsideCidrIp": "string",
						"srcInsideCidrNetmask": "string",
						"srcInsideCidrPrefix": 0,
						"srcOutsideCidrIp": "string",
						"srcOutsideCidrNetmask": "string",
						"srcOutsideCidrPrefix": 0
					}
				],
				"override": false,
				"rules": [
					{
						"description": "string",
						"insideCidrIp": "string",
						"insideCidrPrefix": 0,
						"insideNetmask": "string",
						"insidePort": 0,
						"outsideCidrIp": "string",
						"outsideCidrPrefix": 0,
						"outsideNetmask": "string",
						"outsidePort": 0,
						"type": "source"
					}
				]
			},
			"netflow": {
				"collectors": [
					{
						"allowAllSegment": false,
						"filterList": {},
						"logicalId": "string",
						"name": "string",
						"netflowCollector": {
							"_href": "string",
							"data": {},
							"name": "string",
							"object": "string",
							"ref": "string",
							"type": "string",
							"version": "string"
						},
						"netflowFilterList": [
							{
								"_href": "string",
								"data": {},
								"name": "string",
								"object": "string",
								"ref": "string",
								"type": "string",
								"version": "string"
							}
						],
						"sourceInterface": "string",
						"type": "string"
					}
				],
				"enabled": false,
				"intervals": {
					"applicationTable": 0,
					"flowLinkStats": 0,
					"flowStats": 0,
					"interfaceTable": 0,
					"linkTable": 0,
					"tunnelStats": 0,
					"vrfTable": 0
				},
				"override": false,
				"version": 0
			},
			"ntp": {
				"enabled": false,
				"override": false,
				"servers": [
					{
						"server": "string"
					}
				],
				"sourceInterface": "string"
			},
			"ospf": {
				"aggregation": [
					{
						"metric": 0,
						"metricType": "E1",
						"noAdvertise": false,
						"prefix": "string",
						"prefixLength": 0,
						"tag": 0
					}
				],
				"areas": [
					{
						"id": {},
						"name": "string",
						"type": "string"
					}
				],
				"bgp": {
					"enabled": false,
					"metric": 0,
					"metricType": "E1"
				},
				"defaultPrefixes": false,
				"defaultRouteAdvertise": "ALWAYS",
				"defaultRoutes": "OE1",
				"enabled": false,
				"v6Detail": {
					"aggregation": [
						{
							"metric": 0,
							"metricType": "E1",
							"noAdvertise": false,
							"prefix": "string",
							"prefixLength": 0,
							"tag": 0
						}
					],
					"areas": [
						{
							"id": {},
							"name": "string",
							"type": "string"
						}
					],
					"bgp": {
						"enabled": false,
						"metric": 0,
						"metricType": "E1"
					},
					"defaultPrefixes": false,
					"defaultRouteAdvertise": "ALWAYS",
					"defaultRoutes": "OE1",
					"enabled": false
				}
			},
			"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": "nvsViaEdgeService",
						"preferred": false
					}
				],
				"static": [
					{
						"advertise": false,
						"cidrPrefix": "string",
						"cost": 0,
						"description": "string",
						"destination": "string",
						"gateway": "string",
						"icmpProbeLogicalId": "string",
						"netmask": "string",
						"preferred": false,
						"sourceIp": "string",
						"subinterfaceId": 0,
						"vlanId": 0,
						"wanInterface": "string"
					}
				],
				"staticV6": [
					{
						"advertise": false,
						"cidrPrefix": "string",
						"cost": 0,
						"description": "string",
						"destination": "string",
						"gateway": "string",
						"icmpProbeLogicalId": "string",
						"netmask": "string",
						"preferred": false,
						"sourceIp": "string",
						"subinterfaceId": 0,
						"vlanId": 0,
						"wanInterface": "string"
					}
				]
			},
			"secureAccess": {
				"enabled": false,
				"override": false,
				"provider": {},
				"secureAccessProvider": {
					"_href": "string",
					"data": {},
					"name": "string",
					"object": "string",
					"ref": "string",
					"type": "string",
					"version": "string"
				}
			},
			"segment": {
				"_href": "string",
				"alertsEnabled": 0,
				"created": "string",
				"data": {},
				"description": "string",
				"draftComment": "string",
				"draftCreated": "string",
				"draftData": "string",
				"lastContact": "string",
				"modified": "string",
				"name": "string",
				"object": "string",
				"operatorAlertsEnabled": 0,
				"previousCreated": "string",
				"previousData": {},
				"status": "string",
				"statusModified": "string",
				"type": "string",
				"version": "string"
			},
			"snmp": {
				"override": false,
				"port": 0,
				"snmpv2c": {
					"allowedIp": [
						"string"
					],
					"community": "string",
					"enabled": false
				},
				"snmpv3": {
					"enabled": false,
					"users": [
						{
							"authAlg": "string",
							"authentication": false,
							"encrAlg": "string",
							"name": "string",
							"passphrase": "string",
							"privacy": false
						}
					]
				}
			},
			"syslog": {
				"collectors": [
					{
						"host": "string",
						"port": 0,
						"protocol": "TCP",
						"roles": [
							"EDGE EVENT"
						],
						"severity": [
							"EMERGENCY"
						],
						"sourceInterface": "string",
						"tag": "string"
					}
				],
				"enabled": false,
				"facilityCode": "local0",
				"override": false
			},
			"vpn": {
				"backHaulEdges": [
					{
						"logicalId": "string",
						"name": "string",
						"type": "edgeHub"
					}
				],
				"conditionalBackhaul": false,
				"edgeToDataCenter": false,
				"edgeToEdge": false,
				"edgeToEdgeDetail": {
					"autoSelectVpnHubs": false,
					"dynamic": {
						"enabled": false,
						"isolation": {
							"enabled": false
						},
						"timeout": 0,
						"type": "string"
					},
					"encryptionProtocol": "string",
					"isolation": {
						"enabled": false
					},
					"isolationGroupId": "string",
					"isolationGroups": [
						{
							"logicalId": "string"
						}
					],
					"profileIsolation": {
						"enabled": false,
						"isolateDynamic": false,
						"profileLogicalId": "string"
					},
					"useCloudGateway": false,
					"vpnHubs": [
						{
							"_href": "string",
							"data": {},
							"name": "string",
							"object": "string",
							"ref": "string",
							"type": "string",
							"version": "string"
						}
					]
				},
				"edgeToEdgeHub": {
					"enabled": false,
					"ref": "deviceSettings:vpn:edgeHub",
					"vpnHubs": [
						{
							"_href": "string",
							"data": {},
							"name": "string",
							"object": "string",
							"ref": "string",
							"type": "string",
							"version": "string"
						}
					]
				},
				"enabled": false,
				"gatewayNonSdwanSites": [
					{
						"_href": "string",
						"data": {},
						"name": "string",
						"object": "string",
						"ref": "string",
						"type": "string",
						"version": "string"
					}
				],
				"isolationGroupId": "string",
				"ref": "deviceSettings:vpn:dataCenter"
			},
			"vqm": {
				"collectors": [
					{
						"address": "string",
						"port": 0
					}
				],
				"enabled": false,
				"override": false,
				"protocol": {}
			},
			"vrrp": {
				"data": [
					{
						"cidrIp": "string",
						"interface": "string",
						"interval": 0,
						"preempt": false,
						"preemptDelay": 0,
						"priority": 0,
						"subinterfaceId": 0,
						"vlanId": 0,
						"vrid": 0
					}
				],
				"enabled": false
			}
		}
	],
	"snmp": {
		"override": false,
		"port": 0,
		"snmpv2c": {
			"allowedIp": [
				"string"
			],
			"community": "string",
			"enable": false,
			"enabled": false
		},
		"snmpv3": {
			"enable": false,
			"enabled": false,
			"users": [
				{
					"authAlg": "string",
					"authentication": false,
					"encrAlg": "string",
					"name": "string",
					"passphrase": "string",
					"privacy": false
				}
			]
		}
	},
	"softwareUpdate": {
		"window": {
			"beginHour": 0,
			"day": 0,
			"endHour": 0
		},
		"windowed": false
	},
	"tacacs": {
		"ref": "deviceSettings:tacacs",
		"sourceInterface": "string",
		"tacacsService": {
			"_href": "string",
			"data": {},
			"name": "string",
			"object": "string",
			"ref": "string",
			"type": "string",
			"version": "string"
		}
	},
	"vnfs": {
		"edge": {},
		"hasVnfs": false,
		"securityVnf": {
			"vms": [
				{
					"cidrIp": "string",
					"edge": {},
					"hostname": "string",
					"insertionEnabled": false,
					"instanceId": 0,
					"license": {
						"_href": "string",
						"data": {},
						"name": "string",
						"object": "string",
						"ref": "string",
						"type": "string",
						"version": "string"
					},
					"modifiedTimestamp": 0,
					"service": {
						"_href": "string",
						"data": {},
						"name": "string",
						"object": "string",
						"ref": "string",
						"type": "string",
						"version": "string"
					},
					"type": "securityVnf",
					"uuid": "string",
					"uuidTimestamp": "string",
					"vendor": "PaloAlto",
					"vendorSpecificData": {},
					"vlanId": 0,
					"vmDeploy": false,
					"vmPowerOff": false
				}
			]
		}
	},
	"zscaler": {
		"config": {
			"cloud": "zscaler.net",
			"enabled": false,
			"location": {
				"gwProperties": {
					"aupBlockInternetUntilAccepted": false,
					"aupEnabled": false,
					"aupForceSslInspection": false,
					"aupTimeoutInDays": 0,
					"authRequired": false,
					"cautionEnabled": false,
					"displayTimeUnit": "DAY",
					"dnBandwidth": 0,
					"idleTimeInMinutes": 0,
					"ipsControl": false,
					"ofwEnabled": false,
					"surrogateIP": false,
					"surrogateIPEnforcedForKnownBrowsers": false,
					"surrogateRefreshTimeInMinutes": 0,
					"surrogateRefreshTimeUnit": "DAY",
					"upBandwidth": 0,
					"xffForwardEnabled": false
				},
				"name": "string"
			},
			"mtgre": {
				"enabled": false
			},
			"override": false,
			"provider": {
				"_href": "string",
				"data": {},
				"name": "string",
				"object": "string",
				"ref": "string",
				"type": "string",
				"version": "string"
			},
			"subLocations": [
				{
					"gwProperties": {
						"aupBlockInternetUntilAccepted": false,
						"aupEnabled": false,
						"aupForceSslInspection": false,
						"aupTimeoutInDays": 0,
						"authRequired": false,
						"cautionEnabled": false,
						"displayTimeUnit": "DAY",
						"dnBandwidth": 0,
						"idleTimeInMinutes": 0,
						"ipsControl": false,
						"ofwEnabled": false,
						"surrogateIP": false,
						"surrogateIPEnforcedForKnownBrowsers": false,
						"surrogateRefreshTimeInMinutes": 0,
						"surrogateRefreshTimeUnit": "DAY",
						"upBandwidth": 0,
						"xffForwardEnabled": false
					},
					"includeAllLanInterfaces": false,
					"includeAllVlans": false,
					"internalId": "string",
					"ipAddressSelectionManual": false,
					"ipAddresses": [
						"string"
					],
					"lanRoutedInterfaces": [
						"string"
					],
					"name": "string",
					"otherSubLocation": false,
					"ruleId": "string",
					"vlans": 0
				}
			],
			"vendor": "zscaler"
		},
		"deployment": {
			"location": {
				"cloud": "string",
				"logicalId": "string"
			},
			"mtgreSite": {
				"_href": "string",
				"data": {},
				"name": "string",
				"object": "string",
				"ref": "string",
				"type": "string",
				"version": "string"
			},
			"subLocations": [
				{
					"cloud": "string",
					"internalId": "string",
					"logicalId": "string",
					"otherSubLocation": false
				}
			]
		}
	}
}
string
_href Optional

DeviceSettingsBFD
bfd Optional

DeviceSettingsGlobalIPv6Settings
globalIPv6Settings Optional

DeviceSettingsHA
ha Optional

DeviceSettingsL2Settings
l2Settings Optional

DeviceSettingsLAN
lan Optional

DeviceSettingsLoopbackInterfaces
loopbackInterfaces Optional

InlineBaseDeviceSettings_models
models Optional

DeviceSettingsMultiSourceQOS
multiSourceQos Optional

DeviceSettingsNTP
ntp Optional

DeviceSettingsNTPAsServer
ntpServer Optional

DeviceSettingsRadioSettings
radioSettings Optional

array of DeviceSettingsRoutedInterface
routedInterfaces Optional

array of DeviceSettingsSegment
segments Optional

DeviceSettingsSNMPOuter
snmp Optional

DeviceSettingsSoftwareUpdate
softwareUpdate Optional

DeviceSettingsTACACS
tacacs Optional

DeviceSettingsVNFS
vnfs Optional

DeviceSettingsZscaler
zscaler Optional
Errors

Errors

ValidationError
400

ValidationError


UnAuthorized
401

Unauthorized


ResourceNotFoundError
404

Resource not found


RateLimitExceededError
429

Rate Limit Exceeded


InternalServerError
500

Internal server error

Code Samples

Code Samples

cURL Command

curl https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/profiles/{profileLogicalId}/deviceSettings


Feedback

Was this page helpful?