Create Vpn Profile Parcel For Mobility - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Create Vpn Profile Parcel For Mobility","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/a724d7a2-d5be-3cd7-8f42-0d775cdd69b7","info":{"title":"Feature Profiles - Mobility and NFV","description":"Feature profiles associated with UX 2.0 configuration\n\nIncludes API operations for the following:\n- Feature Profiles in Mobility and NFV Solutions\n- Supporting mobility features and Network Function Virtualization (NFV) configurations.\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create a VPN Profile Parcel for Mobility Global Feature Profile","operationId":"CreateVpnProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"VPN Profile Parcel","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","pattern":"^[^&\u003c\u003e! \"]+$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_cgFpPpNameDef","description":"Set the parcel name"},"description":{"description":"Set the parcel description","type":"string"},"data":{"type":"object","properties":{"vpnTunnels":{"type":"array","description":"Container to provide multiple VPN tunnels configurations","minItems":1,"maxItems":1,"uniqueItems":true,"additionalProperties":false,"items":{"type":"object","properties":{"vpnTunnelInfo":{"type":"object","description":"Provide specific tunnel information","properties":{"name":{"description":"Tunnel Name","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","pattern":"^ipsec[1-5]$","minLength":1,"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_tunnelNameDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfTunnelNameOptionsDef"},"description":{"description":"Tunnel Description","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","pattern":"^[^\u003c\u003e ]*$","minLength":1,"maxLength":127,"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_tunnelDescriptionDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfTunnelDescriptionOptionsDef"},"privateSubnets":{"description":"Container for Local and Remote Private Subnets","type":"object","oneOf":[{"type":"object","properties":{"remotePrivateSubnets":{"description":"Remote Private Subnet","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"array","uniqueItems":true,"minItems":1,"maxItems":75,"additionalProperties":false,"items":{"type":"string","pattern":"^(([01]?\\d\\d?|2[0-1]\\d|22[0-3])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)([01]?\\d\\d?|2[0-4]\\d|25[0-5])/([0-2]?\\d|(3[0-2]))$"},"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_listOfIpv4RemotePrivateSubnetsDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfListOfIpv4RemotePrivateSubnetsOptionsDef"},"localPrivateSubnet":{"description":"Local Private Subnet","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","pattern":"^(([01]?\\d\\d?|2[0-1]\\d|22[0-3])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)([01]?\\d\\d?|2[0-4]\\d|25[0-5])/([0-2]?\\d|(3[0-2]))$","$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ipv4LocalPrivateSubnetsDef"}},"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/ProfileparcelMobilityGlobalVpnPostRequest_oneOfLocalPrivateSubnetOptionsDef"}},"additionalProperties":false,"required":["remotePrivateSubnets","localPrivateSubnet"],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_staticLocalRemotePrivateSubnetDef"}],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfPrivateSubnetsDef"},"preSharedSecret":{"description":"Preshared Secret","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","pattern":"^(?!.*[!#]).*","minLength":1,"maxLength":127,"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_preSharedSecretInputDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfPresharedSecretOptionsDef"},"remotePublicIp":{"description":"Remote Public IP Address","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"array","uniqueItems":true,"minItems":1,"maxItems":1,"additionalProperties":false,"items":{"anyOf":[{"type":"string","pattern":"(^((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?$)|(^\\.$))","minLength":1,"maxLength":253},{"type":"string","format":"ipv4"}]},"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_listOfIpv4OrDomainNameRemotePublicIpAddressesDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfRemotePublicIpOptionsDef"},"tunnelDnsAddress":{"description":"List of Tunnel DNS Addresses","type":"object","oneOf":[{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"array","uniqueItems":true,"minItems":1,"maxItems":1,"additionalProperties":false,"items":{"type":"string","format":"ipv4"},"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_listOfIpv4DNSAddressesDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfListOfIpv4TunnelDnsAddressesOptionsDef"}],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfTunnelDnsAddressOptionsDef"},"localInterface":{"description":"Local Interface","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"enum":["Cellular1/0","GigabitEthernet0/0"],"type":"string","$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_localInterfaceDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfLocalInterfaceOptionsDef"},"tunnelRedundancyConfiguration":{"description":"Container for Fields Related to Redundancy Configuration","type":"object","properties":{"secondaryRemotePublicIp":{"description":"Secondary Remote Public IP Address","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"anyOf":[{"type":"string","pattern":"(^((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?$)|(^\\.$))","minLength":1,"maxLength":253},{"type":"string","format":"ipv4"}],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_secondaryIpv4OrDomainNameRemotePublicIpAddressesDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfSecondaryRemotePublicIpOptionsDef"},"dpdInterval":{"description":"Dead Peer Detection Interval","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"maximum":65535,"minimum":0,"type":"integer","default":10,"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_dpdIntervalDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"maximum":10,"minimum":10,"type":"integer","$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_dpdIntervalDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfDpdIntervalOptionsDef"},"dpdRetries":{"description":"Dead Peer Detection Retries","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"maximum":255,"minimum":0,"type":"integer","default":3,"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_dpdRetriesDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"maximum":3,"minimum":3,"type":"integer","$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_dpdRetriesDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfDpdRetriesOptionsDef"}},"additionalProperties":false,"required":["secondaryRemotePublicIp"],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_tunnelRedundancyConfigDef"}},"required":["name","preSharedSecret","remotePublicIp","localInterface"],"additionalProperties":false},"ipSecPolicy":{"type":"object","description":"Provide IPSEC policy information","properties":{"ikePhase1":{"type":"object","description":"IKE Phase 1","properties":{"cipherSuite":{"description":"IKE Phase 1 Cipher Suite","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"enum":["aes128-cbc-sha1"],"type":"string","$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ikePhase1CipherSuiteDefaultDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"enum":["aes128-cbc-sha1","aes256-cbc-sha1","aes128-cbc-sha256","aes256-cbc-sha256","aes128-gcm","aes256-gcm"],"type":"string","default":"aes128-cbc-sha1","$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ikePhase1CipherSuiteDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfIkePhase1CipherSuiteOptionsDef"},"ikeVersion":{"description":"IKE Phase 1 Version","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"maximum":2,"minimum":2,"type":"integer","$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ikeVersionDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfIkeVersionOptionsDef"},"diffeHellmanGroup":{"description":"IKE Phase 1 Diffe-Hellman Group","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"enum":["14","15","16","19","20","21"],"type":"string","default":"14","$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_diffeHellmanGroupDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"enum":["14"],"type":"string","$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_diffeHellmanGroupDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfDiffeHellmanGroupOptionsDef"},"rekeyTimer":{"description":"IKE Phase 1 Rekey Timer","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"maximum":1209600,"minimum":300,"type":"integer","default":7200,"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_rekeyTimerDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"maximum":7200,"minimum":7200,"type":"integer","$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_rekeyTimerDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfRekeyTimerOptionsDef"}},"required":["cipherSuite","diffeHellmanGroup"],"additionalProperties":false},"ikePhase2CipherSuite":{"description":"Ike Phase 2 Cipher Suite","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"enum":["aes128-sha1"],"type":"string","$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ikePhase2CipherSuiteDefaultDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"enum":["aes128-sha1","aes128-cbc-sha1","aes256-cbc-sha1","aes128-cbc-sha256","aes256-cbc-sha256","aes128-gcm","aes256-gcm"],"type":"string","default":"aes128-sha1","$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ikePhase2CipherSuiteDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfIkePhase2CipherSuiteOptionsDef"},"ikePhase2RekeyTimer":{"description":"Ike Phase 2 Rekey Timer","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"maximum":1209600,"minimum":300,"type":"integer","default":7200,"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ikePhase2RekeyTimerDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"maximum":7200,"minimum":7200,"type":"integer","$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_ikePhase2RekeyDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_oneOfIkePhase2RekeyTimerOptionsDef"}},"required":["ikePhase1","ikePhase2CipherSuite"],"additionalProperties":false}},"required":["vpnTunnelInfo","ipSecPolicy"],"additionalProperties":false}}},"required":["vpnTunnels"],"additionalProperties":false}},"required":["name","data"],"x-metadata":{"minVManageVersion":"20.15.1"},"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelMobilityGlobalVpnPostRequest_SchemaPayload"},"examples":{"AonVPNParcelConfig":{"value":{"data":{"vpnTunnels":[{"vpnTunnelInfo":{"name":{"optionType":"global","value":"ipsec1"},"description":{"optionType":"global","value":"ipsec1TunnelConfiguration"},"privateSubnets":{"remotePrivateSubnets":{"optionType":"global","value":["1.0.0.0/1","2.0.0.0/1"]},"localPrivateSubnet":{"optionType":"variable","value":"{{local-private-subnet}}"}},"preSharedSecret":{"optionType":"global","value":"$ecret@"},"remotePublicIp":{"optionType":"global","value":["1.0.0.0"]},"tunnelDnsAddress":{"optionType":"global","value":["2.0.0.0"]},"localInterface":{"optionType":"global","value":"Cellular1/0"},"tunnelRedundancyConfiguration":{"secondaryRemotePublicIp":{"optionType":"global","value":"5.4.3.2"},"dpdInterval":{"optionType":"global","value":30},"dpdRetries":{"optionType":"global","value":20}}},"ipSecPolicy":{"ikePhase1":{"cipherSuite":{"optionType":"default","value":"aes128-cbc-sha1"},"ikeVersion":{"optionType":"default","value":2},"diffeHellmanGroup":{"optionType":"global","value":"14"},"rekeyTimer":{"optionType":"global","value":1209600}},"ikePhase2CipherSuite":{"optionType":"default","value":"aes128-sha1"},"ikePhase2RekeyTimer":{"optionType":"global","value":1209600}}}]},"description":"Aon VPN Parcel config","name":"AonVPNParcelConfig"},"$$ref":"#/components/examples/ProfileparcelMobilityGlobalVpnPostRequest_AonVPNParcelConfig"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"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}"}},"required":["id"],"x-metadata":{"minVManageVersion":"20.15.1"},"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload"},"examples":{"example_1":{"value":{"id":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"},"$$ref":"#/components/examples/ProfileparcelCommonPostResponse_example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile \u003e Teleworker \u003e Vpn-write","method":"post","path":"/v1/feature-profile/mobility/global/{profileId}/vpn"}}