IpTp - Crosswork Network Controller 7.1 APIs

{"type":"model","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/28ed564a-8eed-31ee-a202-dcc7b5d361f7","info":{"title":"RESTCONF Inventory APIs","description":"RESTCONF Inventory APIs exposed by Inventory service.","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"1.0.0"},"tags":[{"name":"RESTCONF APIs","description":"Points to note: \nThe actual response will,\n- Have namespace prefixed in the attribute name\n- Not have attributes whose values are null\n- Have the attribute names \"-\" separated in some cases\n- Have additional section with firstIndex and lastIndex attributes"}],"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/inventory-restconf-api-overview.md"}},"openapi":"3.1.0","servers":[{"url":"https://{server_ip}:30603/crosswork/inventory/restconf/data/v2","description":"Generated server url"}]},"spec":{"type":"object","description":"IpTp","xml":{"name":"ip-tp","prefix":"ns4"},"properties":{"entityTag":{"type":"string","description":"entityTag"},"ipAddress":{"type":"array","description":"ipAddress","xml":{"name":"ip-address","prefix":"ns4"},"items":{"type":"string"}},"subnetMask":{"type":"string","description":"subnetMask","xml":{"name":"subnet-mask","prefix":"ns4"}},"ipAddressPrefix":{"type":"array","description":"ipAddressPrefix","xml":{"name":"ip-address-prefix","prefix":"ns4"},"items":{"type":"string"}},"castType":{"type":"string","description":"castType","xml":{"name":"cast-type","prefix":"ns4"}},"addressCastType":{"type":"array","description":"addressCastType","xml":{"name":"address-cast-type","prefix":"ns4"},"items":{"type":"object","description":"AddressCastType","xml":{"name":"address-cast-type","prefix":"ns4"},"properties":{"entityTag":{"type":"string","description":"Generic tag"},"ipAddress":{"type":"string","description":"IP address","xml":{"name":"ip-address","prefix":"ns4"}},"castType":{"type":"string","description":"Cast type","xml":{"name":"cast-type","prefix":"ns4"}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/AddressCastType"}},"isRoutingAndBridge":{"type":"boolean","description":"isRoutingAndBridge","xml":{"name":"is-routing-and-bridge","prefix":"ns4"}},"vrfName":{"type":"string","description":"vrfName","xml":{"name":"vrf-name","prefix":"ns4"}},"vrf":{"type":"object","description":"Vrf","xml":{"name":"vrf","prefix":"ns4"},"properties":{"entityTag":{"type":"string","description":"entityTag"},"description":{"type":"string","description":"description","xml":{"name":"description","prefix":"ns4"}},"routeDistinguisher":{"type":"string","description":"routeDistinguisher","xml":{"name":"route-distinguisher","prefix":"ns4"}},"addressFamilyList":{"type":"object","description":"Address Family List","xml":{"name":"address-family-list","prefix":"ns4"},"properties":{"entityTag":{"type":"string","description":"Generic tag"},"addressFamily":{"type":"array","description":"addressFamily","xml":{"name":"address-family","prefix":"ns4"},"items":{"type":"object","description":"Address Family","xml":{"name":"address-family","prefix":"ns4"},"properties":{"entityTag":{"type":"string","description":"Generic tag"},"addressFamilyType":{"type":"string","description":"addressFamilyType","xml":{"name":"address-family-type","prefix":"ns4"}},"maxRoutes":{"type":"integer","description":"maxRoutes","xml":{"name":"max-routes","prefix":"ns4"},"format":"int64"},"importRouteTarget":{"type":"string","description":"importRouteTarget","xml":{"name":"import-route-target","prefix":"ns4"}},"exportRouteTarget":{"type":"string","description":"exportRouteTarget","xml":{"name":"export-route-target","prefix":"ns4"}},"importRoutePolicy":{"type":"string","description":"importRoutePolicy","xml":{"name":"import-route-policy","prefix":"ns4"}},"exportRoutePolicy":{"type":"string","description":"exportRoutePolicy","xml":{"name":"export-route-policy","prefix":"ns4"}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/AddressFamily"}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/AddressFamilyList"},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/Vrf"},"peCeRoutingProtocol":{"type":"string","description":"peCeRoutingProtocol","xml":{"name":"pe-cerouting-protocol","prefix":"ns4"}},"ospfProcess":{"type":"object","description":"OspfProcess","xml":{"name":"ospf-process","prefix":"ns4"},"properties":{"entityTag":{"type":"string","description":"entityTag"},"routeId":{"type":"string","description":"routeId","xml":{"name":"route-id","prefix":"ns4"}},"areaId":{"type":"string","description":"areaId","xml":{"name":"area-id","prefix":"ns4"}},"domainId":{"type":"string","description":"domainId","xml":{"name":"domain-id","prefix":"ns4"}},"domainValue":{"type":"string","description":"domainValue","xml":{"name":"domain-value","prefix":"ns4"}},"vrfName":{"type":"string","description":"vrfName","xml":{"name":"vrf-name","prefix":"ns4"}},"any":{"type":"array","description":"any","items":{"type":"object"}}},"$$ref":"#/components/schemas/OspfProcess"},"bgpNeighbor":{"type":"object","description":"BgpNeighbor","xml":{"name":"bgp-neighbor","prefix":"ns4"},"properties":{"entityTag":{"type":"string","description":"Generic tag"},"ipAddress":{"type":"string","description":"ipAddress","xml":{"name":"ip-address","prefix":"ns4"}},"asNumber":{"type":"integer","description":"asNumber","xml":{"name":"as-number","prefix":"ns4"},"format":"int64"},"ebgpMultiHopCount":{"type":"string","description":"ebgpMultiHopCount","xml":{"name":"ebgp-multi-hop-count","prefix":"ns4"}},"localAsNumber":{"type":"integer","description":"localAsNumber","xml":{"name":"local-as-number","prefix":"ns4"},"format":"int64"},"localAsAction":{"type":"string","description":"localAsAction","xml":{"name":"local-as-action","prefix":"ns4"}},"updateSource":{"type":"string","description":"updateSource","xml":{"name":"update-source","prefix":"ns4"}},"bgpAddressFamilyList":{"type":"object","description":"BgpAddressFamilyList","xml":{"name":"bgp-address-family-list","prefix":"ns4"},"properties":{"entityTag":{"type":"string","description":"Generic tag"},"bgpAddressFamily":{"type":"array","description":"bgpAddressFamily","xml":{"name":"bgp-address-family","prefix":"ns4"},"items":{"type":"object","description":"BgpAddressFamily","xml":{"name":"bgp-address-family","prefix":"ns4"},"properties":{"entityTag":{"type":"string","description":"Generic tag"},"addressFamily":{"type":"string","description":"addressFamily","xml":{"name":"address-family","prefix":"ns4"}},"allowAsIn":{"type":"string","description":"allowAsIn","xml":{"name":"allow-as-in","prefix":"ns4"}},"ingressRoutePolicy":{"type":"string","description":"ingressRoutePolicy","xml":{"name":"ingress-route-policy","prefix":"ns4"}},"egressRoutePolicy":{"type":"string","description":"egressRoutePolicy","xml":{"name":"egress-route-policy","prefix":"ns4"}},"localAsNumber":{"type":"integer","description":"localAsNumber","xml":{"name":"local-as-number","prefix":"ns4"},"format":"int64"},"localAsAction":{"type":"string","description":"localAsAction","xml":{"name":"local-as-action","prefix":"ns4"}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/BgpAddressFamily"}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/BgpAddressFamilyList"},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/BgpNeighbor"},"hsrp":{"type":"object","description":"Hsrp","xml":{"name":"hsrp","prefix":"ns4"},"properties":{"entityTag":{"type":"string","description":"entityTag"},"groupNumber":{"type":"integer","description":"groupNumber","xml":{"name":"group-number","prefix":"ns4"},"format":"int64"},"priority":{"type":"integer","description":"priority","xml":{"name":"priority","prefix":"ns4"},"format":"int64"},"virtualIpAddress":{"type":"string","description":"virtualIpAddress","xml":{"name":"virtual-ipaddress","prefix":"ns4"}},"addressFamily":{"type":"string","description":"addressFamily","xml":{"name":"address-family","prefix":"ns4"},"enum":["UNKNOWN","IPV_4","IPV_6"]},"authenticationKey":{"type":"string","description":"authenticationKey","xml":{"name":"authentication-key","prefix":"ns4"}},"helloTimer":{"type":"integer","description":"helloTimer","xml":{"name":"hello-timer","prefix":"ns4"},"format":"int64"},"holdTimer":{"type":"integer","description":"holdTimer","xml":{"name":"hold-timer","prefix":"ns4"},"format":"int64"},"trackedInterface":{"type":"string","description":"trackedInterface","xml":{"name":"tracked-interface","prefix":"ns4"}},"priorityDecrement":{"type":"integer","description":"priorityDecrement","xml":{"name":"priority-decrement","prefix":"ns4"},"format":"int64"},"minDelayInterval":{"type":"integer","description":"minDelayInterval","xml":{"name":"min-delay-interval","prefix":"ns4"},"format":"int64"},"reloadDelayInterval":{"type":"integer","description":"reloadDelayInterval","xml":{"name":"reload-delay-interval","prefix":"ns4"},"format":"int64"},"preemptMinDelay":{"type":"integer","description":"preemptMinDelay","xml":{"name":"preempt-min-delay","prefix":"ns4"},"format":"int64"},"preemptReloadDelay":{"type":"integer","description":"preemptReloadDelay","xml":{"name":"preempt-reload-delay","prefix":"ns4"},"format":"int64"},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/Hsrp"},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/IpTp","title":"IpTp"}}