getSingleSdwanTransportEsimcellularControllerPayload - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"model","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/85dbfe00-99e8-3c56-9409-3cee853605a5","info":{"title":"Feature Profiles - SD-WAN Transport","description":"Feature profiles associated with UX 2.0 configuration\n\nIncludes API operations for the following:\n- Transport Feature Profiles in SD-WAN Solution\n- Managing transport layer features such as interface and tunnel configurations\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"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":"Set the eSimCellularController feature name"},"description":{"description":"Set the eSimCellularController feature description","type":"string"},"data":{"type":"object","description":"eSim Cellular controller config","properties":{"controllerConfig":{"type":"object","properties":{"id":{"description":"Cellular ID","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"type":"string","maxLength":5,"$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularControllerPutRequest_idDef"}},"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/ProfileparcelSdwanTransportEsimcellularControllerPutRequest_commonControllerConfigDef/properties/id"},"slot":{"description":"Set primary SIM slot","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"minimum":0,"maximum":0,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularControllerPutRequest_oneOfEsimSlotOptionsDef"},"maxRetry":{"description":"Set SIM failover retries","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minimum":0,"maximum":65535,"type":"integer","$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularControllerPutRequest_maxRetryDef"}},"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/ProfileparcelSdwanTransportEsimcellularControllerPutRequest_commonControllerConfigDef/properties/maxRetry"},"failovertimer":{"description":"Set SIM failover timeout in minutes","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minimum":3,"maximum":7,"type":"integer","$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularControllerPutRequest_failovertimerDef"}},"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/ProfileparcelSdwanTransportEsimcellularControllerPutRequest_commonControllerConfigDef/properties/failovertimer"},"autoSim":{"description":"Enable/Disable Firmware Auto Sim","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":["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"},"value":{"type":"boolean","enum":[true],"$$ref":"#/components/schemas/CommonCommonDefs_booleanTrueDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularControllerPutRequest_commonControllerConfigDef/properties/autoSim"}},"required":["id"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularControllerPutRequest_esimControllerConfigDef"},"slotConfig":{"type":"object","description":"Set the slot specific attach and data profile feature ids","properties":{"slot0Config":{"type":"object","description":"Set the slot specific attach and data profile feature ids","properties":{"attachProfile":{"type":"object","description":"Set esim cellular profile feature id as attach profile","properties":{"refId":{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"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"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_refIdOptionDef"},"refType":{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"enum":["esimcellular-profile"],"type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularControllerPutRequest_refTypeDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularControllerPutRequest_refTypeOptionDef"}},"required":["refId","refType"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularControllerPutRequest_profileRefOptionDef"},"dataProfile":{"type":"object","description":"Set esim cellular profile feature id as data profile","properties":{"refId":{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"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"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_refIdOptionDef"},"refType":{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"enum":["esimcellular-profile"],"type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularControllerPutRequest_refTypeDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularControllerPutRequest_refTypeOptionDef"}},"required":["refId","refType"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularControllerPutRequest_profileRefOptionDef"}},"required":["attachProfile"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularControllerPutRequest_commonSlotConfigDef"}},"required":["slot0Config"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularControllerPutRequest_slotConfigDef"}},"required":["controllerConfig","slotConfig"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularControllerPutRequest_esimControllerConfigOptionDef"}},"required":["name","data"],"x-metadata":{"supportedDeviceTypes":["vedge-C8300-1N1S-4T2X","vedge-C8230E-8TM2X","vedge-C8231-G2","vedge-C8230X-8M2X","vedge-C8235-G2","vedge-C8230-1N-2M2X","vedge-C8231-E-G2","vedge-C8230X-1N-2M2X","vedge-C8235-E-G2","vedge-C8300-1N1S-6T","vedge-C8300-2N2S-4T2X","vedge-C8330-1N1S-4M2X","vedge-C8375-E-G2","vedge-C8330-6TM4SX","vedge-C8330-6TM4X","vedge-C8351-G2","vedge-C8330X-6TM4SX","vedge-C8330X-6TM4X","vedge-C8355-G2","vedge-C8300-2N2S-6T","vedge-C8200L-1N-4T","vedge-C8200-1N-4T","vedge-C1101-4PLTEP","vedge-C1101-4PLTEPW","vedge-C1109-4PLTE2P","vedge-C1109-4PLTE2PW","vedge-C1121-4PLTEP","vedge-C1121-8PLTEP","vedge-C1121-8PLTEPW","vedge-C1121X-8PLTEP","vedge-C1121X-8PLTEPW","vedge-C1126-8PLTEP","vedge-C1126X-8PLTEP","vedge-C1127-8PLTEP","vedge-C1127-8PMLTEP","vedge-C1127X-8PLTEP","vedge-C1127X-8PMLTEP","vedge-C1128-8PLTEP","vedge-C1131-8PLTEPW","vedge-C1131X-8PLTEPW","vedge-C8131-5T1S","vedge-C8130-G2","vedge-C8131-8T2S","vedge-C8140-G2","vedge-C8131X-1C-8T2S","vedge-C8151-G2","vedge-C8131X-1C-8P2S","vedge-C8161-G2","vedge-C1161-8PLTEP","vedge-C1161X-8PLTEP","vedge-IR-1101","vedge-IR-1821","vedge-IR-1831","vedge-IR-1833","vedge-IR-1835","vedge-IR-8140H","vedge-IR-8340"],"minVManageVersion":"20.16.1"},"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularControllerPutRequest_SchemaPayload"}},"$$ref":"#/components/schemas/getSingleSdwanTransportEsimcellularControllerPayload","title":"getSingleSdwanTransportEsimcellularControllerPayload"}}