Edge Get Edge Configuration Modules
Gets edge composite configuration modules for the specified Edge (by edgeId).
Privileges required:
READ EDGE
READ ENTERPRISE_PROFILE
Request
URI
POST
https://{api_host}/portal/rest/edge/getEdgeConfigurationModules
COPY
Request Body
Show optional properties
{
"edgeId": 0
}{
"edgeId": 0,
"enterpriseId": 0,
"modules": [
"string"
]
}
integer
edgeId
Required
edgeId
integer
enterpriseId
Optional
enterpriseId
array of
string
modules
Optional
modules
Possible values are :
imageUpdate,
controlPlane,
managementPlane,
firewall,
QOS,
deviceSettings,
WAN,
metaData,
properties,
analyticsSettings,
Responses
200
Request was successfully processed
{
"deviceSettings": {
"version": "string",
"schemaVersion": "string",
"type": "string",
"data": {
"bgp": {
"ASN": "string",
"connectedRoutes": false,
"disableASPathCarryOver": false,
"enabled": false,
"filters": [
{
"id": "string",
"name": "string",
"rules": [
{
"action": {
"type": "string",
"values": [
{
"type": "string",
"value": "string"
}
]
},
"match": {
"exactMatch": false,
"type": "string",
"value": "string"
}
}
]
}
],
"holdtime": "string",
"keepalive": "string",
"neighbors": [
{
"neighborAS": "string",
"neighborIp": "string",
"neighborTag": "string",
"inboundFilter": {
"ids": [
"string"
]
},
"outboundFilter": {
"ids": [
"string"
]
},
"allowAS": false,
"connect": "string",
"defaultRoute": false,
"holdtime": "string",
"keepalive": "string",
"enableMd5": false,
"md5Password": "string"
}
],
"networks": [
{
"cidrIp": "string",
"cidrPrefix": 0
}
],
"overlayPrefix": false,
"propagateUplink": false,
"routerId": "string",
"uplinkCommunity": 0
},
"lan": {
"networks": [
{
"space": "string",
"guest": false,
"secure": false,
"advertise": false,
"pingResponse": false,
"cost": 0,
"dhcp": {
"enabled": false,
"leaseTimeSeconds": 0,
"override": false,
"dhcpRelay": {
"servers": [
"string"
]
}
},
"staticReserved": 0,
"netmask": "string",
"cidrPrefix": 0,
"cidrIp": "string",
"baseDhcpAddr": 0,
"numDhcpAddr": 0,
"name": "string",
"interfaces": [
"string"
],
"vlanId": 0,
"managementIp": "string",
"disabled": false
}
]
},
"routedInterfaces": [
{
"addressing": {
"type": "string",
"cidrPrefix": 0,
"cidrIp": "string",
"netmask": "string",
"gateway": "string",
"username": "string",
"password": "string"
},
"advertise": false,
"pingResponse": false,
"disabled": false,
"dhcpServer": {
"baseDhcpAddr": 0,
"enabled": false,
"leaseTimeSeconds": 0,
"dhcpRelay": {
"servers": [
"string"
]
},
"numDhcpAddr": 0,
"staticReserved": 0,
"options": [
{
"option": 0,
"value": "string",
"type": "string",
"metaData": {
"dataType": "string",
"description": "string",
"display": false,
"list": false,
"name": "string",
"option": 0
}
}
]
},
"encryptOverlay": false,
"l2": {
"autonegotiation": false,
"speed": "string",
"duplex": "string",
"MTU": 0
},
"name": "string",
"natDirect": false,
"ospf": {
"area": 0,
"authentication": false,
"authId": 0,
"authPassphrase": "string",
"cost": 0,
"deadTimer": 0,
"mode": "string",
"enabled": false,
"helloTimer": 0,
"inboundRouteLearning": {
"defaultAction": "string",
"filters": [
{}
]
},
"md5Authentication": false,
"MTU": 0,
"outboundRouteAdvertisement": {
"defaultAction": "string",
"filters": [
{}
]
},
"passive": false,
"vlanId": 0
},
"override": false,
"subinterfaces": [
{
"addressing": {
"cidrIp": "string",
"cidrPrefix": 0,
"gateway": "string",
"netmask": "string",
"type": "string",
"username": "string",
"password": "string"
},
"advertise": false,
"pingResponse": false,
"dhcpServer": {
"baseDhcpAddr": 0,
"enabled": false,
"leaseTimeSeconds": 0,
"dhcpRelay": {
"servers": [
"string"
]
},
"numDhcpAddr": 0,
"staticReserved": 0,
"options": [
{
"option": 0,
"value": "string",
"type": "string",
"metaData": {
"dataType": "string",
"description": "string",
"display": false,
"list": false,
"name": "string",
"option": 0
}
}
]
},
"disabled": false,
"natDirect": false,
"ospf": {
"area": 0,
"authentication": false,
"authId": 0,
"authPassphrase": "string",
"cost": 0,
"deadTimer": 0,
"mode": "string",
"enabled": false,
"helloTimer": 0,
"inboundRouteLearning": {
"defaultAction": "string",
"filters": [
{}
]
},
"md5Authentication": false,
"MTU": 0,
"outboundRouteAdvertisement": {
"defaultAction": "string",
"filters": [
{}
]
},
"passive": false
},
"override": false,
"subinterfaceId": 0,
"subinterfaceType": "string",
"vlanId": 0,
"trusted": false,
"rpf": "string"
}
],
"vlanId": 0,
"wanOverlay": "string",
"trusted": false,
"rpf": "string",
"underlayAccounting": false
}
],
"routes": {
"icmpProbes": [
{}
],
"icmpResponders": [
{}
],
"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
}
]
},
"ha": {
"enabled": false,
"interface": "string",
"nodes": [
{
"serialNumber": "string",
"instanceId": 0
}
]
},
"dns": {
"primaryProvider": {
"ref": "string"
},
"backupProvider": {
"ref": "string"
},
"privateProviders": {
"ref": "string"
}
},
"netflow": {
"enable": false,
"enabled": false,
"version": 0,
"collectors": [
{
"address": "string",
"port": 0
}
]
},
"vqm": {
"enable": false,
"enabled": false,
"protocol": "string",
"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
}
]
},
"snmp": {
"port": 0,
"snmpv2c": {
"enable": false,
"enabled": false,
"community": "string",
"allowedIp": [
"string"
]
},
"snmpv3": {
"enabled": false,
"enable": false,
"users": [
{
"name": "string",
"passphrase": "string",
"authAlg": "string",
"privacy": false,
"encrAlg": "string"
}
]
}
},
"multiSourceQos": {
"enable": false,
"enabled": false,
"highRatio": 0,
"normalRatio": 0,
"lowRatio": 0,
"maxCapThreshold": 0,
"minCapThreshold": 0
},
"tacacs": {
"ref": "string",
"sourceInterface": "string"
}
}
},
"firewall": {
"version": "string",
"schemaVersion": "string",
"type": "string",
"data": "firewall_data Object"
},
"QOS": {
"version": "string",
"schemaVersion": "string",
"type": "string",
"data": "QOSData Object"
},
"WAN": {
"version": "string",
"schemaVersion": "string",
"type": "string",
"data": "WAN_data Object"
},
"controlPlane": {
"version": "string",
"schemaVersion": "string",
"type": "string",
"data": "control_plane_data Object"
},
"managementPlane": {
"version": "string",
"schemaVersion": "string",
"type": "string",
"data": "management_plane_data Object"
},
"imageUpdate": {
"version": "string",
"schemaVersion": "string",
"type": "string",
"data": "image_update_data Object"
}
}
object
deviceSettings
Optional
deviceSettings
object
firewall
Optional
firewall
object
QOS
Optional
QOS
object
WAN
Optional
WAN
object
controlPlane
Optional
controlPlane
object
managementPlane
Optional
managementPlane
object
imageUpdate
Optional
imageUpdate
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"edgeId:"integer"}' https://{api_host}/portal/rest/edge/getEdgeConfigurationModules
Edge Operations
POST
Edge Edge Cancel Reactivation
POST
Edge Edge Provision
POST
Edge Edge Request Reactivation
POST
Edge Get Client Visibility Mode
POST
Edge Get Edge
POST
Edge Get Edge Configuration Modules
POST
Edge Get Edge Configuration Stack
POST
Edge Get Edge Sdwan Peers
POST
Edge Update Edge Admin Password
POST
Edge Update Edge Attributes
POST
Edge Update Edge Credentials By Configuration