ProfileparcelSdwanTransportEsimcellularProfilePostRequest_SchemaPayload - 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":{"name":{"type":"string","pattern":"^[^&\u003c\u003e! \"]+$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_cgFpPpNameDef","description":"Set the eSim CellularProfile feature name"},"description":{"description":"Set the eSim CellularProfile feature description","type":"string"},"data":{"type":"object","description":"eSim Cellular profile config","properties":{"profileInfo":{"type":"object","properties":{"apn":{"description":"Set access point name","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularProfilePostRequest_apnDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularProfilePostRequest_oneOfApnOptionsDef"},"authentication":{"oneOf":[{"type":"object","properties":{"noAuthentication":{"type":"object","description":"No Authentication","properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"type":"string","enum":["none"],"$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularProfilePostRequest_defaultAuthenticationDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularProfilePostRequest_oneOfDefaultAuthenticationOptionsDef"}},"required":["noAuthentication"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularProfilePostRequest_oneOfNoAuthenticationOptionsDef"},{"type":"object","properties":{"needAuthentication":{"type":"object","properties":{"type":{"description":"Set authentication type","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"enum":["pap","chap","pap_chap"],"type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularProfilePostRequest_authenticationDef"}},"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/ProfileparcelSdwanTransportEsimcellularProfilePostRequest_oneOfAuthenticationOptionsDef"},"username":{"description":"Set the profile username","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularProfilePostRequest_usernameDef"}},"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/ProfileparcelSdwanTransportEsimcellularProfilePostRequest_oneOfUsernameOptionsDef"},"password":{"description":"Set the profile password [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularProfilePostRequest_passwordDef"}},"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/ProfileparcelSdwanTransportEsimcellularProfilePostRequest_oneOfPasswordOptionsDef"}},"required":["type","username","password"],"additionalProperties":false}},"required":["needAuthentication"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularProfilePostRequest_oneOfNeedAuthenticationOptionsDef"}]},"pdnType":{"description":"Set packet data network type","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"default":"ipv4","enum":["ipv4","ipv4v6","ipv6"],"type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularProfilePostRequest_pdnTypeDef"}},"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":"string","enum":["ipv4"],"$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularProfilePostRequest_defaultPdnTypeDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularProfilePostRequest_oneOfPdnTypeOptionsDef"},"noOverwrite":{"description":"No Overwrite","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"}},"required":["optionType"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularProfilePostRequest_oneOfNoOverwriteOptionsDef"}},"required":["apn"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularProfilePostRequest_commonCellularProfileInfoDef"},"accountInfo":{"type":"object","properties":{"accountId":{"type":"object","description":"Set provider account Id used for this profile","properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","minLength":1}},"required":["optionType","value"],"additionalProperties":false},"commPlan":{"type":"object","description":"Set communication plan used for this profile","properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","minLength":1}},"required":["optionType","value"],"additionalProperties":false},"ratePlan":{"type":"object","description":"Set rate plan used for this profile","properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","minLength":1}},"required":["optionType","value"],"additionalProperties":false}},"required":["accountId","commPlan","ratePlan"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularProfilePostRequest_eSimAccountInfoDef"}},"required":["profileInfo","accountInfo"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdwanTransportEsimcellularProfilePostRequest_esimCellularProfileConfigDef"}},"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/ProfileparcelSdwanTransportEsimcellularProfilePostRequest_SchemaPayload","title":"ProfileparcelSdwanTransportEsimcellularProfilePostRequest_SchemaPayload"}}