Get Mrf Profile Parcel For System - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Get Mrf Profile Parcel For System","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/ade8dfef-05e7-3191-b6ee-a5ffe6465bd7","info":{"title":"Feature Profiles - SD-WAN System","description":"Feature profiles associated with UX 2.0 configuration\n\nIncludes API operations for the following:\n- System Feature Profiles in the SD-WAN Solution\n- Managing core system configurations, device management, and platform-level settings\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Mrf Profile Parcels for System feature profile","operationId":"GetMrfProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}","$$ref":"#/components/schemas/CommonCommonDefs_uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"type":"object","properties":{"name":{"type":"string","pattern":"^[^&\u003c\u003e! \"]+$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"secondaryRegion":{"description":"Set secondary region ID","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minimum":1,"maximum":63,"type":"integer","$$ref":"#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_secondaryRegionDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"}},"required":["optionType"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfSecondaryRegionOptionsDef"},"role":{"description":"Set the role for router","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"enum":["edge-router","border-router"],"type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_roleDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"}},"required":["optionType"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfRoleOptionsDef"},"enableMrfMigration":{"description":"Enable migration mode to Multi-Region Fabric","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"enum":["enabled","enabled-from-bgp-core"],"type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_enableMrfMigrationDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"}},"required":["optionType"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfEnableMrfMigrationOptionsDef"},"migrationBgpCommunity":{"description":"Set BGP community during migration from BGP-core based network","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minimum":1,"maximum":4294967295,"type":"integer","$$ref":"#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_migrationBgpCommunityDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"}},"required":["optionType"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfMigrationBgpCommunityOptionsDef"},"enableManagementRegion":{"description":"Enable management region","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"boolean","$$ref":"#/components/schemas/CommonCommonDefs_booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"type":"boolean","enum":[false],"$$ref":"#/components/schemas/CommonCommonDefs_booleanFalseDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfEnableManagemantRegionOptionsDef"},"managementRegion":{"description":"Management Region","type":"object","properties":{"vrfId":{"description":"VRF name for management region","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minimum":1,"maximum":65531,"type":"integer","$$ref":"#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_vrfIdDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"}},"required":["optionType"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfVrfIdOptionsDef"},"gatewayPreference":{"description":"List of affinity group preferences for VRF","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"items":{"minimum":1,"maximum":63,"type":"integer","$$ref":"#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_gatewayPreferenceDef"},"minItems":1,"maxItems":8,"uniqueItems":true,"type":"array","$$ref":"#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_gatewayPreferenceListDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"}},"required":["optionType"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfGatewayPreferenceOptionsDef"},"managementGateway":{"description":"Enable management gateway","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"boolean","$$ref":"#/components/schemas/CommonCommonDefs_booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"type":"boolean","enum":[false],"$$ref":"#/components/schemas/CommonCommonDefs_booleanFalseDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_oneOfManagementGatewayOptionsDef"}},"required":[],"additionalProperties":false}},"required":[],"additionalProperties":false}},"required":["name","data"],"x-metadata":{"minVManageVersion":"20.15.1"},"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdwanSystemMrfCommonRequest_SchemaPayload"}}}}},"$$ref":"#/components/schemas/getListSdwanSystemMrfPayload"},"examples":{"get response example":{"value":{"header":{"generatedOn":1702438718825},"data":[{"parcelId":"09fc54fe-ff36-4640-ae57-c9e71a103902","parcelType":"mrf","createdBy":"admin","lastUpdatedBy":"admin","createdOn":1701866357838,"lastUpdatedOn":1701866357838,"payload":{"data":{"secondaryRegion":{"optionType":"global","value":2},"role":{"optionType":"global","value":"edge-router"},"enableMrfMigration":{"optionType":"global","value":"enabled"},"migrationBgpCommunity":{"optionType":"global","value":100}}}}]},"$$ref":"#/components/examples/getListSdwanSystemMrfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile \u003e System \u003e Mrf-read","method":"get","path":"/v1/feature-profile/sdwan/system/{systemId}/mrf"}}