{"type":"api","title":"Get All Ports Info","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":["Port and Port Channel"],"summary":"Get All Ports Info","description":"Show information about all ports including port channels","operationId":"data_pnic_pnics_get","produces":["application/yang-data+json"],"parameters":[{"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":{"pnic:pnics":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"platform-family":{"description":"platform family (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"UCSC","enum":["UCSC","UCSC-C240-M5SX","UCSE-M2","UCSE-M3","ENCS-5100","ENCS-5400","CSP-2100","CSP-5000","UCSC-M5","UCSC-M6","CE9321","CE8200","C8200","C8300"]},"nfv-mode":{"description":"nfv mode running on system (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"VBRANCH","enum":["VBRANCH","DC","COLO","VWAAS"]},"pnic":{"type":"array","description":"(list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"name":{"description":"pnic name (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"type":{"description":"pnic type (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"ethernet","enum":["ethernet","port_channel"]},"duplex":{"description":"interface duplex (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"half","enum":["half","full","auto"]},"exists":{"description":"Status of the pnic (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"boolean"},"slot":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"port":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"byte"},"speed":{"description":"interface configurational speed (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"10","enum":["10","100","1G","10G","10G_SR","10G_PF","10G_VF","40G","auto"]},"operational-speed":{"description":"interface operational speed (leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint32"},"pcieaddr":{"description":"physical interface pcie address (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"operational-duplex":{"description":"interface operational duplex (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"operational-promiscuous":{"description":"Indicates operational status for promiscuous mode (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"autoneg":{"description":"interface operational autoneg (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"bond":{"description":"bonding for pnic (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"bond_mode":{"description":"bond mode: balance-slb, active-backup, balance-tcp (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"balance-slb","enum":["balance-slb","active-backup","balance-tcp"]},"trunks":{"description":"define vlan trunks. e.g. 100,105-109 (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"lacp_type":{"description":"LACP type (active, passive, off) (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"active","enum":["active","passive","off"]},"member_of":{"description":"pnic name this pnic is a member of (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"leafref"},"pnic_flag":{"description":"flag for whether the pnic in use or not (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"service_owner":{"description":"Service exclusive owner of this pnic (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"sriov_intf":{"description":"sriov VF/PF interface (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"sriov_numvfs":{"description":"SR-IOV Number of VFs currently configured on this pnic (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"int32"},"sriov_totalvfs":{"description":"SR-IOV Maximum VFs that can be configured on this pnic (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"int32"},"sriov_inusevfs":{"description":"SR-IOV Number of configured VFs currently in use on this pnic (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"int32"},"sriov_switch_mode":{"description":"SR-IOV Internal switch mode (VEB (switched) or VEPA (flow-through)) (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"veb","enum":["veb","vepa"]},"sr-iov":{"description":"SR-IOV pnic configuration (non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"numvfs":{"description":"SR-IOV Number of VFs currently configured on this pnic (leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint32"},"totalvfs":{"description":"SR-IOV Maximum VFs that can be configured on this pnic (leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint32"},"inusevfs":{"description":"SR-IOV Number of configured VFs currently in use on this pnic (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"int32"},"switchmode":{"description":"SR-IOV Internal switch mode (VEB (switched) or VEPA (flow-through)) (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"veb","enum":["veb","vepa"]}}},"sriov":{"description":"SR-IOV configuration (non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"numvfs":{"description":"Number of VFs. Must be less than or equal to maxvfs (leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"},"switchmode":{"description":"VEB (switched) or VEPA (flow-through) (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"veb","enum":["veb","vepa"]},"sriov-support":{"description":"SR-IOV supported or not (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"boolean"},"maxvfs":{"description":"Maximum VFs supported (leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"},"numvfs-onsystem":{"description":"Number of VFs on system (leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"},"inusevfs":{"description":"Number of configured VFs currently in use (leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"},"status":{"description":"SR-IOV enabled or disabled (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"enabled","enum":["enabled","disabled","error"]}}},"link_state":{"description":"link state... up or down (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"lldp":{"description":"lldp is enabled or not for this interface (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"enabled","enum":["enabled","disabled"]},"promiscuous":{"description":"promiscuous mode is enabled or not for this interface (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"enabled","enum":["enabled","disabled"]},"mac_address":{"description":"BIA for Physical NICs (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"mtu":{"description":"Maximum Transmission Unit for the physical interface (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"int32"},"adminstatus":{"description":"Admin configured status for a physical interface (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"up","enum":["up","down"]},"adminstatus_link":{"description":"Admin configured status for a physical interface (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"[null]"},"refcnt":{"description":"Refernce count for the physical interface (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"int32"},"track-state":{"type":"array","description":"Notify state change of PNIC 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"}}}},"stats":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"receive":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"bytes":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint64"},"packets":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint64"},"errors":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint32"},"dropped":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint32"},"rate_mbps":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"number","format":"double"},"broadcast":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint64"},"multicast":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint64"}}},"transmit":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"bytes":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint64"},"packets":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint64"},"errors":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint32"},"dropped":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint32"},"collisions":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint32"},"rate_mbps":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"number","format":"double"},"broadcast":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint64"},"multicast":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint64"}}}}},"vfnics":{"description":"List of VFs on this pnic (non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"vfnic":{"type":"array","description":"(list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"vf_idx":{"description":"VF index in pnic table (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"int32"},"name":{"description":"vfnic (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"inuse_flag":{"description":"flag for whether the vf in use or not (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"in-use","enum":["in-use","not-used"]},"service_owner":{"description":"owner service name (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"}}}}}}}}}}}},"$$ref":"#/definitions/data_pnic_pnics"}},"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_pnic_pnics_get","consumes":["application/yang-data+json"],"method":"get","path":"/data/pnic:pnics"}}