Multicast Path Lookup
Request Parameters
parameters
[mandatory] - A nested JSON data structure with keystype
[mandatory] - A quoted string with a value ofpathLookup
for an E2E path simulation outputpathLookupType
[mandatory] - A quoted string containing the wordmulticast
protocol
[mandatory] - A quoted string with a value oftcp
,udp
,icmp
source
[mandatory] - A quoted string containing the source IP addressgroup
[mandatory] - A quoted string containing the group IP addressreceiver
[optional] - A quoted string containing the receiver’s IP addressgroupBy
[mandatory] - A quoted string representing the grouping of devices in the output - at this time one ofsiteName
,routingDomain
orstpDomain
securedPath
[mandatory] - A boolean - when you run a path simulation, you can tell IP Fabric if you want to stop when it hits a security policy which blocks the traffic in question (true
) or complete the forwarding path and simply highlight the policy enforcement point (false
)ttl
[mandatory] - integer - Time-to-live value (default is128
)fragmentOffset
[mandatory] - integer - Fragment offset value (default is0
)enableRegions
[mandatory] - boolean - (defaultfalse
)srcRegions
[mandatory] - string - (default.\*
)dstRegions
[mandatory] - string - (default.\*
)otherOptions
[mandatory] - nested JSON dataapplications
[mandatory] - string - (default.\*
)tracked
[mandatory] - boolean - (defaultfalse
)
firstHopAlgorithm
[mandatory] - nested JSON datatype
[mandatory] - Eitherautomatic
oruserDefined
vrf
[Optional and if type ==automatic
]entryPoints
[mandatory] - if type ==userDefined
it is nested array of JSON datahostname
[mandatory] - Hostname stringsn
[mandatory] - IP Fabric Unique Serial Number stringiface
[mandatory] - Interface name
l4Options
[mandatory] - nested JSON data- If
protocol
istcp
srcPorts
[mandatory] - A string representing ports; ex.80,443,1025-4096
dstPorts
[mandatory] - A string representing ports; ex.80,443,1025-4096
flags
[mandatory] - An array of TCP flags to be set in the simulated path or empty array- Valid flags: [
ack
,fin
,psh
,rst
,syn
,urg
]
- Valid flags: [
- If
protocol
isudp
srcPorts
[mandatory] - A string representing ports; ex.80,443,1025-4096
dstPorts
[mandatory] - An integer representing the destination port
- If
protocol
isicmp
refer to: Path Lookup ICMP Decodertype
[mandatory] - An integer representing the ICMP typecode
[mandatory] - An integer representing the ICMP code
- If
Example minimal request body
{
"snapshot": "$last",
"parameters": {
"group": "233.1.1.1",
"groupBy": "siteName",
"pathLookupType": "multicast",
"securedPath": true,
"source": "10.33.230.2",
"type": "pathLookup",
"firstHopAlgorithm": {
"type": "automatic"
},
"protocol": "tcp",
"enableRegions": false,
"srcRegions": ".*",
"dstRegions": ".*",
"ttl": 128,
"fragmentOffset": 0,
"otherOptions": {
"applications": ".*",
"tracked": false
},
"l4Options": {
"dstPorts": "80,443",
"srcPorts": "1024-65535",
"flags": []
}
}