Get Interface Configuration - NFVIS API - Cisco DevNet

{"type":"api","title":"Get Interface Configuration","meta":{"id":"/apps/pubhub/media/nfvis-api/e3678dda6abe6c2a26c7698d553a4574e3f45071/262737b2-b3c2-32cd-b07b-fdbdcd23918f","info":{"title":"NFVIS API","description":"NFVIS RESTCONF API Documentation","version":"4.14.1"},"x-parser-conf":{"overview":{"markdownPath":"reference/overview.md"}},"swagger":"2.0","basePath":"/{nfvis_ip}/restconf","schemes":["https"],"securityDefinitions":{"basicAuth":{"type":"basic"}}},"spec":{"tags":["Switching"],"summary":"Get Interface Configuration","description":"Display the configuration for a given interface","operationId":"data_switch_switch_interface_gigabitEthernet_gigabitEthernet_name_get","produces":["application/yang-data+json"],"parameters":[{"name":"gigabitEthernet-name","in":"path","description":"","required":true,"type":"string","format":"string","$$ref":"#/parameters/gigabitEthernet-name"},{"name":"content","in":"query","description":"controlling descendant nodes in response","required":false,"type":"string","format":"enumeration","default":"config","enum":["config","nonconfig","all"],"$$ref":"#/parameters/content"}],"responses":{"200":{"description":"OK","schema":{"type":"object","properties":{"switch:gigabitEthernet":{"type":"array","description":"(list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"name":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"description":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"bridge":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"multicast":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"unregistered":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"forwarding","enum":["forwarding","filtering"]}}},"unicast":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"unknown":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"forwarding","enum":["forwarding","filtering"]}}}}},"flowcontrol":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"receive":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"off","enum":["off","on"]}}},"negotiation":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"auto","enum":["auto"]},"qos":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"cos":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"byte"}}},"shutdown":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"[null]"},"snmp":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"trap":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"link-status":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"[null]"}}}}},"speed":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"10","enum":["10","100","1000"]},"spanning-tree":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"bpdu":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"filtering","enum":["filtering","flooding"]},"bpduguard":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"disable","enum":["disable","enable"]},"cost":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint32"},"disable":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"[null]"},"guard":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"root":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"[null]"}}},"link-type":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"point-to-point","enum":["point-to-point","shared"]},"port-priority":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"byte"},"portfast":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"auto","enum":["enable","disable","auto"]},"mst":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"mst-list":{"type":"array","description":"(list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"mstid":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"},"cost":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint32"},"port-priority":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint32"}}}}}}}},"service-acl":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"input":{"type":"array","description":"(list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"input-acl-name":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"default-action":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"deny-all","enum":["deny-all","permit-all"]}}}},"output":{"type":"array","description":"(list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"output-acl-name":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"default-action":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"deny-all","enum":["deny-all","permit-all"]}}}}}},"service-policy":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"input":{"type":"array","description":"(list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"input-policy-name":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"default-action":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"deny-all","enum":["deny-all","permit-all"]}}}},"output":{"type":"array","description":"(list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"output-policy-name":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"default-action":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"deny-all","enum":["deny-all","permit-all"]}}}}}},"switchport":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"access":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"vlan":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"}}},"dot1q-tunnel":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"vlan":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"}}},"general":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"ingress-filtering":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"disable":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"[null]"}}},"acceptable-frame-type":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"all","enum":["all","tagged-only","untagged-only"]},"allowed":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"tagged":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"vlan":{"type":"array","x-yang":{"type":"leaf-list"},"items":{"description":"(leaf-list)","type":"integer","format":"uint16"}}}},"untagged":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"vlan":{"type":"array","x-yang":{"type":"leaf-list"},"items":{"description":"(leaf-list)","type":"integer","format":"uint16"}}}}}},"forbidden":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"vlan":{"type":"array","x-yang":{"type":"leaf-list"},"items":{"description":"(leaf-list)","type":"integer","format":"uint16"}}}},"pvid":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"}}},"mode":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"access","enum":["access","trunk","private-vlan","dot1q-tunnel"]},"private-vlan":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"host-association":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"host-pri-vlan":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"},"host-sec-vlan":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"}}},"mapping":{"type":"array","description":"(list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"mapping-pri-vlan":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"},"mapping-sec-vlan":{"type":"array","x-yang":{"type":"leaf-list"},"items":{"description":"(leaf-list)","type":"integer","format":"uint16"}}}}}}},"community":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"byte"},"protected-port":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"[null]"},"trunk":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"native":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"vlan":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"}}},"allowed":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"vlan":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"ids":{"type":"array","x-yang":{"type":"leaf-list"},"items":{"description":"(leaf-list)","type":"integer","format":"uint16"}},"vlan-range":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"}}}}}}}}},"traffic-shape":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"port":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"cir":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint32"},"cbs":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint32"}}},"queue":{"type":"array","description":"(list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"qid":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"byte"},"cir":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint32"},"cbs":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint32"}}}}}},"port":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"security":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"max":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"},"mode":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"secure":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"permanent","enum":["permanent","delete-on-reset"]},"lock":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"[null]"},"max-addresses":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"[null]"},"regular":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"[null]"}}},"routed":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"secure-address":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"}}},"discard":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"[null]"}}}}},"channel-group":{"type":"array","description":"(list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"cid":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"byte"},"mode":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"on","enum":["on","auto"]}}}},"authentication":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"open":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"[null]"}}},"dot1x":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"authentication":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"802.1x","enum":["802.1x","both","mac"]},"guest-vlan":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"enable":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"[null]"}}},"max-eap-req":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"byte"},"max-hosts":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint32"},"host-mode":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"single-host","enum":["single-host","multi-host"]},"port-control":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"force-unauthorized","enum":["force-unauthorized","auto","force-authorized"]},"reauthentication":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"[null]"},"violation-mode":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"protect","enum":["protect","restrict","shutdown"]},"timeout":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"quiet-period":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"},"reauth-period":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint32"},"server-timeout":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint32"},"supp-timeout":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint32"},"tx-period":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint32"}}}}},"duplex":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"full","enum":["full"]},"mdix":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"mdix-cross":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"auto","enum":["auto","on"]}}},"lacp":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"port-priority":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint32"},"timeout":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"short","enum":["short","long"]}}},"port-security":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"max":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"},"mode-delete-on-reset":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"[null]"},"violation":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"discard","enum":["discard","shutdown"]},"enable":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"[null]"}}},"lldp":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"transmit":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"[null]"},"receive":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"[null]"}}},"power":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"inline":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"device-discovery":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"auto","enum":["auto","never"]},"limit":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"},"four-pair":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"forced":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"[null]"}}},"priority":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"critical","enum":["critical","high","low"]},"powered-device":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"}}}}},"track-state":{"type":"array","description":"Notify state change of interface to the configured VMs VNICs (list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"vm-name":{"description":"\u003cdeploy_name\u003e.\u003cvm_grp_name\u003e or \u003cvm name\u003e (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"vnic-id":{"description":"VMs nicid number (leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"}}}},"storm-control":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"multicast":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"level":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"byte"}}},"broadcast":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"level":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"byte"}}},"unicast":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"level":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"byte"}}}}}}}}},"$$ref":"#/definitions/data_switch_switch_interface_gigabitEthernet_gigabitEthernet-name"}},"204":{"description":"No Content","$$ref":"#/responses/204"},"400":{"description":"Bad Request","$$ref":"#/responses/400"},"401":{"description":"Unauthorized","$$ref":"#/responses/401"},"404":{"description":"Not Found","$$ref":"#/responses/404"},"405":{"description":"Method Not Allowed","$$ref":"#/responses/405"},"409":{"description":"Conflict","$$ref":"#/responses/409"}},"security":[{"basicAuth":[]}],"__originalOperationId":"data_switch_switch_interface_gigabitEthernet_gigabitEthernet_name_get","consumes":["application/yang-data+json"],"method":"get","path":"/data/switch:switch/interface/gigabitEthernet={gigabitEthernet-name}"}}