{"type":"api","title":"Do RMA","meta":{"id":"/apps/pubhub/media/nexus-dashboard-api-v1/86cc2501c92a7370499e3d537496e5c722396afb/ca19d971-84d3-3c2a-862a-c2fba289d1d4","info":{"contact":{"name":"API Support","url":"https://devnetapps.cisco.com/docs/nexus-dashboard/api-v1/developer-support/"},"title":"Nexus Dashboard Fabric Controller API - LAN","description":"Nexus Dashboard Fabric Controller API - LAN","version":"12.5.0"},"tags":[{"name":"End Point Information","description":"Endpoint Locator (EPL) APIs"},{"name":"Fabric Backup and Restore"},{"name":"Change Control"},{"name":"Dashboard"},{"name":"Config Deployer"},{"name":"Fabrics"},{"name":"Inventory"},{"name":"Credentials"},{"name":"Links"},{"name":"OAMs"},{"name":"Switches"},{"name":"Global Interface"},{"name":"Interface Service"},{"name":"Policies"},{"name":"Resource Manager Operations"},{"name":"Top Down LAN Network Operations"},{"name":"Top Down LAN VRF Operations"},{"name":"Service Network Operations"},{"name":"Top Down LAN Network Operations v2"},{"name":"Top Down LAN VRF Operations v2"},{"name":"vPC Pairs"},{"name":"Fabric Inventory"},{"name":"ToR Operations"},{"name":"Templates"},{"name":"Flow Policy Management","description":"IPFM Flow Policy Management"},{"name":"Discovered Hosts","description":"IPFM Discovered Hosts"},{"name":"Host Policy Management","description":"IPFM Host Policy Management"},{"name":"Multicast NAT Modes","description":"Multicast NAT Modes"},{"name":"IPFM Events","description":"IPFM Events"},{"name":"Multicast NAT Recirc Mappings","description":"Multicast NAT Recirc Mappings"},{"name":"Host Alias Management","description":"IPFM Host Aliases listing/create/update/delete"},{"name":"Flow Group Management","description":"IPFM Flow Group"},{"name":"Flow Status","description":"IPFM Flow Status/Chart listings"},{"name":"Topology Management","description":"IPFM Topology listing"},{"name":"Global Settings","description":"IPFM Global Settings"},{"name":"Static Receiver Management","description":"IPFM static receiver listing/create/delete"},{"name":"Host Group Management","description":"IPFM Host Group"},{"name":"RTP Service","description":"RTP Service"},{"name":"Flow Alias Management","description":"IPFM Flow Alias Management"},{"name":"Multicast NAT Rules","description":"Multicast NAT Rules"},{"name":"Telemetry Sync Status","description":"IPFM Telemetry Sync Status"},{"name":"Service Cluster","description":"The first step of L4-L7 services flow, i.e. service node attributes and its physical attachment to VXLAN EVPN fabric"},{"name":"Service Addon","description":"Addon service for L4-L7 services, including route, probe, ACL"},{"name":"Service Chain","description":"The third (optional) step of L4-L7 services flow, i.e. define service chain that consists of multiple service functions in specified order"},{"name":"Audit Log","description":"The audit logs of L4-L7 services"},{"name":"Service Function","description":"The second step of L4-L7 services flow, i.e. service cluster's logical attachments to VXLAN EVPN fabric"},{"name":"Service Insertion","description":"The fourth step of L4-L7 services flow, i.e. service chain for traffic redirect"}],"x-parser-conf":{"overview":{"markdownPath":"reference/overview-legacy-lan.md"},"labelConfig":{"endpoint":{"field":"operationId","format":"startCase"}}},"openapi":"3.0.1","servers":[{"url":"/appcenter/cisco/ndfc/api/v1/","description":"Test server"}]},"spec":{"tags":["Fabrics"],"summary":"RMA change for Switch","description":"RMA (Return Material Authorization) change of the given Switch.","operationId":"doRMA","parameters":[{"name":"fabricName","in":"path","description":"Name of the Fabric. Ex: MyFabric","required":true,"example":"MyFabric","schema":{"type":"string"}},{"name":"ticketId","in":"query","description":"Change Control Ticket ID. This is mandatory if Change Control is enabled. Ex: MyTicket1234","required":false,"example":"MyTicket1234","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["discoveryPassword","discoveryUsername","hostname","imagePolicy","ipAddress","model","newSerialNumber","oldSerialNumber","password","publicKey","version"],"properties":{"oldSerialNumber":{"type":"string","example":"FDO20212311U","description":"Old Switch serial Number. Ex: FDO20212311U"},"newSerialNumber":{"type":"string","example":"FDO12312356J","description":"New Switch serial Number. Ex: FDO12312356J"},"model":{"type":"string","example":"N7K","description":"Switch model. Ex: N7K"},"version":{"type":"string","example":"OS1","description":"Switch version. Ex: OS1"},"hostname":{"type":"string","example":"MyHost","description":"Name of the Host. Ex: MyHost"},"ipAddress":{"type":"string","example":"10.1.1.10","description":"IP Address. Ex: 10.10.10.1"},"publicKey":{"type":"string","example":"MyPublicKey","description":"User public key used for encrypting the data. Ex: MyPublicKey"},"imagePolicy":{"type":"string","example":"MyImagePolicy","description":"Image Policy. Ex: MyImagePolicy"},"password":{"type":"string","example":"password","description":"Password. Ex: password"},"discoveryUsername":{"type":"string","example":"MyUserName","description":"Discovery Username. Ex: MyUserName"},"discoveryPassword":{"type":"string","example":"MyPassword","description":"Discovery Password. Ex: MyPassword"},"data":{"type":"string","example":"{\"modulesModel\": [\"N9K-C93180LC-EX\"], \"gateway\": \"10.1.1.1/24\",\"breakout\": \"interface breakout module 1 port 1-4 map 10g-4x\",\"portMode\": \"hardware profile portmode 48x25G + 2x100G + 4x40G\"}","description":"Data. Ex: {\"modulesModel\": [\"N9K-C93180LC-EX\"], \"gateway\": \"10.1.1.1/24\",\"breakout\": \"interface breakout module 1 port 1-4 map 10g-4x\",\"portMode\": \"hardware profile portmode 48x25G + 2x100G + 4x40G\"}'"},"reAdd":{"type":"boolean","example":false,"description":"reAdd. Ex: false"}},"$$ref":"#/components/schemas/RmaDevice"}}},"description":"RMA Device details. This has details of old and new Switches.","required":true},"responses":{"200":{"description":"Successfully done RMA for the Switch"},"401":{"description":"Unauthorized access to API"},"500":{"description":"Failed to do RMA for the Switch"}},"__originalOperationId":"doRMA","method":"post","path":"/appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabricName}/rma"}}