{"type":"api","title":"Find Switch By PK","meta":{"id":"/apps/pubhub/media/nexus-dashboard-api-v1/86cc2501c92a7370499e3d537496e5c722396afb/04a747ed-d1dc-3e58-b0f2-037004d279a6","info":{"contact":{"name":"API Support","url":"https://devnetapps.cisco.com/docs/nexus-dashboard/api-v1/developer-support/"},"description":"Nexus Dashboard Fabric Controller API - SAN","title":"Nexus Dashboard Fabric Controller API - SAN","version":"12.5.0"},"tags":[{"name":"Features"},{"name":"Templates"}],"x-parser-conf":{"overview":{"markdownPath":"reference/overview-legacy-san.md"},"labelConfig":{"endpoint":{"field":"operationId","format":"startCase"}}},"openapi":"3.0.1","servers":[{"url":"/appcenter/cisco/ndfc/api/v1/","description":"Test server"}]},"spec":{"tags":["SAN Discovery Manager"],"summary":"Find Switch by Switch PK","operationId":"findSwitchByPK","parameters":[{"name":"switchWwn","in":"query","required":false,"schema":{"type":"string","default":"-1"}},{"name":"fid","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":-1}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"object","properties":{"name":{"type":"string"},"domainID":{"type":"integer","format":"int32"},"wwn":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"$$ref":"#/components/schemas/WwnDO"},"membership":{"type":"array","items":{"type":"integer","format":"int32"}},"ports":{"type":"integer","format":"int32"},"model":{"type":"string"},"version":{"type":"string"},"upTime":{"type":"integer","format":"int64"},"ipAddress":{"type":"string"},"mgmtAddress":{"type":"array","items":{"type":"string"}},"vendor":{"type":"string"},"displayHdrs":{"type":"array","items":{"type":"string"}},"displayValues":{"type":"array","items":{"type":"string"}},"colDBId":{"type":"integer","format":"int64"},"fid":{"type":"integer","format":"int64"},"present":{"type":"boolean"},"licenseViolation":{"type":"boolean"},"managable":{"type":"boolean"},"mds":{"type":"boolean"},"connUnitStatus":{"type":"integer","format":"int32"},"standbySupState":{"type":"integer","format":"int32"},"activeSupSlot":{"type":"integer","format":"int32"},"unmanagableCause":{"type":"string"},"lastScanTime":{"type":"integer","format":"int64"},"fabricName":{"type":"string"},"modelType":{"type":"integer","format":"int32"},"logicalName":{"type":"string"},"switchDbID":{"type":"integer","format":"int64"},"uid":{"type":"integer","format":"int64"},"release":{"type":"string"},"location":{"type":"string"},"contact":{"type":"string"},"upTimeStr":{"type":"string"},"upTimeNumber":{"type":"integer","format":"int32"},"network":{"type":"string"},"nonMdsModel":{"type":"string"},"numberOfPorts":{"type":"integer","format":"int32"},"availPorts":{"type":"integer","format":"int32"},"usedPorts":{"type":"integer","format":"int32"},"vsanWwn":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"$$ref":"#/components/schemas/WwnDO"},"vsanWwnName":{"type":"string"},"swWwn":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"$$ref":"#/components/schemas/WwnDO"},"swWwnName":{"type":"string"},"serialNumber":{"type":"string"},"domain":{"type":"string"},"principal":{"type":"string"},"status":{"type":"string"},"index":{"type":"integer","format":"int32"},"licenseDetail":{"type":"string"},"sanAnalyticsCapable":{"type":"boolean"},"vdcId":{"type":"integer","format":"int32"},"vdcName":{"type":"string"},"vdcMac":{"type":"string"},"fcoeEnabled":{"type":"boolean"},"cpuUsage":{"type":"integer","format":"int32"},"memoryUsage":{"type":"integer","format":"int32"},"scope":{"type":"string"},"fex":{"type":"boolean"},"health":{"type":"integer","format":"int32"},"npvEnabled":{"type":"boolean"},"linkName":{"type":"string"},"username":{"type":"string"},"primaryIP":{"type":"string"},"primarySwitchDbID":{"type":"integer","format":"int64"},"secondaryIP":{"type":"string"},"secondarySwitchDbID":{"type":"integer","format":"int64"},"moduleIndexOffset":{"type":"integer","format":"int32"},"sysDescr":{"type":"string"},"switchRole":{"type":"string"},"mode":{"type":"string"},"hostName":{"type":"string"},"ipDomain":{"type":"string"},"systemMode":{"type":"string"},"systemModePti":{"type":"string"},"waitForSwitchModeChg":{"type":"boolean"},"sourceVrf":{"type":"string"},"sourceInterface":{"type":"string"},"protoDiscSettings":{"type":"string"},"operMode":{"type":"string"},"startTelemetry":{"type":"boolean"},"modules":{"type":"object","properties":{"column":{"type":"array","items":{"type":"string"}},"row":{"type":"array","items":{"type":"object","properties":{"entry":{"type":"array","items":{"type":"string"}}},"$$ref":"#/components/schemas/DBRowDO"}},"errCode":{"type":"integer","format":"int32"},"errorCause":{"type":"string"},"rowSize":{"type":"integer","format":"int32"},"rows":{"type":"array","items":{"type":"object","properties":{"entry":{"type":"array","items":{"type":"string"}}},"$$ref":"#/components/schemas/DBRowDO"}}},"$$ref":"#/components/schemas/DBEntryDO"},"fexMap":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}},"vpcDomain":{"type":"integer","format":"int64"},"role":{"type":"string"},"peer":{"type":"string"},"peerSerialNumber":{"type":"string"},"peerSwitchDbId":{"type":"integer","format":"int64"},"peerlinkState":{"type":"string"},"keepAliveState":{"type":"string"},"consistencyState":{"type":"boolean"},"sendIntf":{"type":"string"},"recvIntf":{"type":"string"},"elementType":{"type":"string"},"monitorMode":{"type":"boolean"},"freezeMode":{"type":"boolean"},"cfsSyslogStatus":{"type":"integer","format":"int32"},"transceiverPowerCtrl":{"type":"string"},"transceiverPowerCtrlCapacity":{"type":"string"},"ucsFi":{"type":"boolean"},"fiImm":{"type":"boolean"},"seedPlatformType":{"type":"string"},"scalableUnit":{"type":"string"},"vpcConfigured":{"type":"boolean"},"vsanMembership":{"type":"array","writeOnly":true,"items":{"type":"integer","format":"int32"}},"lan":{"type":"boolean"},"nonNexus":{"type":"boolean"},"numberOfPortsStr":{"type":"string"},"usedPortsStr":{"type":"string"},"availPortsStr":{"type":"string"},"pmCollect":{"type":"boolean"},"healthStr":{"type":"string"},"is_smlic_enabled":{"type":"boolean"},"echSupport":{"type":"boolean"},"trapDelayed":{"type":"boolean"},"beaconable":{"type":"boolean"},"interfaceDO":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"swDbId":{"type":"integer","format":"int64"},"sysName":{"type":"string"},"ifIndex":{"type":"integer","format":"int32"},"ifName":{"type":"string"},"ifDesc":{"type":"string"},"operStatusCause":{"type":"string"},"speedStr":{"type":"string"},"vlanList":{"type":"string"},"connToSwitchName":{"type":"string"},"connSwitchDbId":{"type":"integer","format":"int64"},"connectedToType":{"type":"string"},"portChannelMembers":{"type":"string"},"portMode":{"type":"string"},"duplex":{"type":"string"},"stpProtocol":{"type":"string"},"allowedVLANs":{"type":"string"},"macAddress":{"type":"string"},"ipAddress":{"type":"string"},"sfpSerialNumber":{"type":"string"},"speed":{"type":"integer","format":"int64"},"ficonAddress":{"type":"string"},"ifAlias":{"type":"string"},"interfaceDbId":{"type":"integer","format":"int64"},"endPortId":{"type":"integer","format":"int64"},"connToInterfaceIfName":{"type":"string"},"connToSwitchName_2":{"type":"string"},"connSwitchDbId_2":{"type":"integer","format":"int64"},"connectedToType_2":{"type":"string"},"connToInterfaceIfName_2":{"type":"string"},"isFex":{"type":"string"},"isRbacAccessible":{"type":"string"},"adminStatus":{"type":"integer","format":"int32"},"ifType":{"type":"string"},"operStatus":{"type":"integer","format":"int32"},"mtu":{"type":"integer","format":"int32"},"nativeVlanId":{"type":"integer","format":"int32"},"ifAllowedVlan":{"type":"string"},"ifIpmask":{"type":"string"},"ifVrf":{"type":"string"},"portChannelId":{"type":"integer","format":"int64"},"serialNo":{"type":"string"},"policyName":{"type":"string"},"isPhysical":{"type":"string"},"adminStatusStr":{"type":"string"},"operStatusStr":{"type":"string"},"policyNameStr":{"type":"string"},"channelIdStr":{"type":"string"},"connectedToStr":{"type":"string"},"ownerString":{"type":"string"},"isOwnerAllowed":{"type":"string"}},"$$ref":"#/components/schemas/InterfaceDO"}},"discoveryAllowed":{"type":"boolean"},"ipChgAllowed":{"type":"boolean"},"isNonNexus":{"type":"boolean"}},"$$ref":"#/components/schemas/SwitchDO"}}}}},"__originalOperationId":"findSwitchByPK","method":"get","path":"/appcenter/cisco/ndfc/api/v1/san-discovery/san/findSwitchByPK"}}