IP Fabric
19 min
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 ip fabric api documentation link https //docs ipfabric io/6 9/ip fabric apiip fabric authentication link https //docs ipfabric io/6 9/ip fabric api/authenticationip fabric api postman link 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 ip fabric generate api token documentation link 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 here 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 here 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 snapshot string optional snapshot uuid or reference ($last, $prev, $lastlocked) to be used for the request reports string optional report to be used for the request attributefilters object optional attribute filters to be applied on present columns sitename array optional name of the resource 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 filters object optional filters to be applied on present columns hostname array optional name of the resource pagination object optional pagination parameters start number optional parameter for get inventory interface limit number optional parameter for get inventory interface sort object optional sorting to be used for the request column string optional the field used to sort the results specify a valid column name to determine the sorting criteria order string optional the sorting direction for the specified column choose either asc for ascending order or desc for descending order output parameter type description status code number http status code of the response reason string response reason phrase meta object output field meta count number count value limit number output field limit size number output field size snapshot string output field snapshot start number output field start data array response data dscr object output field dscr data string response data severity number output field severity duplex object output field duplex data string response data severity number output field severity bandwidth object unique identifier errdisabled object output field errdisabled hastransceiver boolean output field hastransceiver hostname string name of the resource intname string name of the resource intnamealias object name of the resource l1 string output field l1 l2 object output field l2 data string response data severity number output field severity 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" {}, "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 snapshot string optional snapshot uuid or reference ($last, $prev, $lastlocked) to be used for the request reports string optional report to be used for the request attributefilters object optional attribute filters to be applied on present columns sitename array optional name of the resource 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 filters object optional filters to be applied on present columns hostname array optional name of the resource pagination object optional pagination parameters start number optional parameter for get managed ipv4 addresses limit number optional parameter for get managed ipv4 addresses sort object optional sorting to be used for the request column string optional the field used to sort the results specify a valid column name to determine the sorting criteria order string optional the sorting direction for the specified column choose either asc for ascending order or desc for descending order output parameter type description status code number http status code of the response reason string response reason phrase meta object output field meta count number count value limit number output field limit size number output field size snapshot string output field snapshot start number output field start data array response data dnshostnamematch number name of the resource dnsname object name of the resource dnsreversematch object output field dnsreversematch data number response data severity number output field severity hostname string name of the resource intname string name of the resource ip string output field ip mac string output field mac net string output field net sitename string name of the resource sn string output field sn statel1 string output field statel1 statel2 string output field statel2 type string type of the resource vlanid object unique identifier 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" {}, "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