IP Fabric

the ip fabric connector enables automated interactions with ip fabric's network infrastructure automation platform, allowing for detailed network visibility and analysis ip fabric is an advanced network infrastructure visibility and analytics platform that provides comprehensive network snapshots for enhanced monitoring and troubleshooting the ip fabric connector for swimlane turbine enables users to automate the retrieval of network interface details and managed ipv4 address information, streamlining network analysis and incident response by integrating with ip fabric, swimlane turbine users gain the ability to efficiently query network states, ensuring swift identification and resolution of network issues, and maintaining robust network health limitations none to date supported versions this ip fabric connector uses the version 6 9 api additional docs https //docs ipfabric io/6 9/ip fabric api https //docs ipfabric io/6 9/ip fabric api/authentication https //www postman com/ipfabric/ip fabric public workspace/collection/3bxr6lt/ip fabric v6 9 configuration prerequisites to effectively utilize the ip fabric connector within the swimlane turbine platform, ensure you have the following api key authentication with the necessary parameters url the endpoint url for the ip fabric api api token a valid api token from ip fabric to authenticate requests authentication methods api key authentication url the endpoint url for the ip fabric api api token your unique token to authenticate requests to the ip fabric api setup instructions to use api tokens, you need to generate them in the ui (in settings → integration → api tokens) or using the api please note that the token string is only visible when you create the token in the ui or in the returned api json response for this reason, please make sure that you copy the token string when creating the api token in the ui starting from version 6 3 0, the api token must be auto generated by ip fabric and cannot be a custom string this is a breaking change when posting to /api/v6 3/api tokens, which no longer accepts the token argument when creating a new token using the api https //docs ipfabric io/6 9/ip fabric settings/integration/api tokens capabilities this connector provides the following capabilities get inventory interface get managed ipv4 addresses get inventory interface interface inventory table represents information about every discovered interface in the network, including the state information as observed during the last analysis ip fabric's documentation for this action can be found https //www postman com/ipfabric/ip fabric public workspace/request/u435ojv/interface inventory json get managed ipv4 addresses information about every ip address on every managed network infrastructure device dns checks on managed ip addresses are also performed to verify the dns consistency ip fabric's documentation for this action can be found https //www postman com/ipfabric/ip fabric public workspace/request/mnxoygd/managed ipv4 addresses json configurations ip fabric api key authentication authenticates using an api key configuration parameters parameter description type required url a url to the target host string required x api token api token string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions get inventory interface retrieve details from the interface inventory table, including state information of all network interfaces observed in the last analysis endpoint url /api/v6 9/tables/inventory/interfaces method get input argument name type required description parameters snapshot string optional snapshot uuid or reference ($last, $prev, $lastlocked) to be used for the request parameters reports string optional report to be used for the request parameters attributefilters object optional attribute filters to be applied on present columns parameters attributefilters sitename array optional parameters for the get inventory interface action parameters columns array optional column names to be returned example column names duplex, bandwidth, errdisabled, hastransceiver, hostname, intname, intnamealias, l1, l2, loginip, logintype, mac, media, mtu, nameoriginal, primaryip, reason, rel, sitename, sn, speed, speedvalue, speedtype, transceiverpn, transceiversn, transceivertype, slug parameters filters object optional filters to be applied on present columns parameters filters hostname array optional parameters for the get inventory interface action parameters pagination object optional pagination parameters parameters pagination start number optional parameters for the get inventory interface action parameters pagination limit number optional parameters for the get inventory interface action parameters sort object optional sorting to be used for the request parameters sort column string optional the field used to sort the results specify a valid column name to determine the sorting criteria parameters sort order string optional the sorting direction for the specified column choose either asc for ascending order or desc for descending order input example {"parameters" {"snapshot" "$last","reports" "/inventory/interfaces","attributefilters" {"sitename" \["sitename"]},"columns" \["dscr","duplex","bandwidth","errdisabled","hastransceiver","hostname","intname","intnamealias","l1","l2","loginip","logintype","mac","media","mtu","nameoriginal","primaryip","reason","rel","sitename","sn","speed","speedvalue","speedtype","transceiverpn","transceiversn","transceivertype","slug"],"filters" {"hostname" \["eq","value"]},"pagination" {"start" 0,"limit" 1},"sort" {"column" "hostname","order" "asc"}}} output parameter type description status code number http status code of the response reason string response reason phrase meta object output field meta meta count number count value meta limit number output field meta limit meta size number output field meta size meta snapshot string output field meta snapshot meta start number output field meta start data array response data data dscr object response data data dscr data string response data data dscr severity number response data data duplex object response data data duplex data string response data data duplex severity number response data data bandwidth object response data data errdisabled object response data data hastransceiver boolean response data data hostname string response data data intname string response data data intnamealias object response data data l1 string response data data l2 object response data data l2 data string response data data l2 severity number response data output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "fri, 21 feb 2025 20 37 23 gmt"},"reason" "ok","json body" {" meta" {"count" 2,"limit" 1,"size" 1,"snapshot" "2527da67 c550 4ea0 94ec b1c991cb7e5a","start" 0},"data" \[{}]}} get managed ipv4 addresses retrieves details on all managed ipv4 addresses across network devices, including dns consistency checks endpoint url /api/v6 9/tables/addressing/managed devs method get input argument name type required description parameters snapshot string optional snapshot uuid or reference ($last, $prev, $lastlocked) to be used for the request parameters reports string optional report to be used for the request parameters attributefilters object optional attribute filters to be applied on present columns parameters attributefilters sitename array optional parameters for the get managed ipv4 addresses action parameters columns array optional column names to be returned example column names dnshostnamematch, dnsname, dnsreversematch, hostname, intname, ip, mac, net, sitename, sn, statel1, statel2, type, vlanid, vrf parameters filters object optional filters to be applied on present columns parameters filters hostname array optional parameters for the get managed ipv4 addresses action parameters pagination object optional pagination parameters parameters pagination start number optional parameters for the get managed ipv4 addresses action parameters pagination limit number optional parameters for the get managed ipv4 addresses action parameters sort object optional sorting to be used for the request parameters sort column string optional the field used to sort the results specify a valid column name to determine the sorting criteria parameters sort order string optional the sorting direction for the specified column choose either asc for ascending order or desc for descending order input example {"parameters" {"snapshot" "$last","reports" "/technology/addressing/managed ip","attributefilters" {"sitename" \["sitename"]},"columns" \["dnshostnamematch","dnsname","dnsreversematch","hostname","intname","ip","mac","net","sitename","sn","statel1","statel2","type","vlanid","vrf"],"filters" {"hostname" \["eq","value"]},"pagination" {"start" 0,"limit" 1},"sort" {"column" "hostname","order" "asc"}}} output parameter type description status code number http status code of the response reason string response reason phrase meta object output field meta meta count number count value meta limit number output field meta limit meta size number output field meta size meta snapshot string output field meta snapshot meta start number output field meta start data array response data data dnshostnamematch number response data data dnsname object response data data dnsreversematch object response data data dnsreversematch data number response data data dnsreversematch severity number response data data hostname string response data data intname string response data data ip string response data data mac string response data data net string response data data sitename string response data data sn string response data data statel1 string response data data statel2 string response data data type string response data data vlanid object response data output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "fri, 21 feb 2025 20 37 23 gmt"},"reason" "ok","json body" {" meta" {"count" 2,"limit" 1,"size" 1,"snapshot" "2527da67 c550 4ea0 94ec b1c991cb7e5a","start" 0},"data" \[{}]}} response headers header description example content length the length of the response body in bytes 140 content type the media type of the resource application/json date the date and time at which the message was originated fri, 21 feb 2025 20 37 23 gmt