Create Nfvirtual Wan Parcel - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Create Nfvirtual Wan Parcel","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 (NFVirtual)"],"description":"Create a WAN Profile Parcel for Networks feature profile","operationId":"CreateNfvirtualWanParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"WAN config 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":{"type":"string"},"data":{"if":{"properties":{"dhcp":{"properties":{"value":{"const":false}}}}},"then":{"required":["color","interface_name","ip_address","netmask","type"]},"else":{"required":["color"]},"type":"object","properties":{"color":{"description":"Color","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"],"type":"string","$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_colorDef"}},"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/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfColorOptionsDef"},"interface_name":{"description":"WAN interface or Port name","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_wanInterfaceNameDef"}},"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/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfWanInterfaceNameOptionsDef"},"network_name":{"description":"Name of the WAN Network","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","maxLength":17,"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_network_nameDef"}},"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/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfNetwork_nameOptionsDef"},"bridge":{"description":"Name of the WAN Bridge","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","maxLength":20,"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_bridgeDef"}},"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/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfBridgeOptionsDef"},"mode":{"description":"Trunk or Access Mode of the Interface","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"enum":["trunk","access"],"type":"string","$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_modeDef"}},"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":{"enum":["trunk"],"type":"string","$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_defaultModeDef"}},"required":["optionType"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfModeOptionsDef"},"dhcp":{"description":"dhcp","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"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfDhcpOptionsDef"},"ip_address":{"description":"IPv4 address on WAN interface","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","anyOf":[{"format":"ipv4"}],"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_ipv4AddressDef"}},"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/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfIpv4AddressOptionsDef"},"netmask":{"description":"subnet mask","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","enum":["255.255.255.255","255.255.255.254","255.255.255.252","255.255.255.248","255.255.255.240","255.255.255.224","255.255.255.192","255.255.255.128","255.255.255.0","255.255.254.0","255.255.252.0","255.255.248.0","255.255.240.0","255.255.224.0","255.255.192.0","255.255.128.0","255.255.0.0","255.254.0.0","255.252.0.0","255.240.0.0","255.224.0.0","255.192.0.0","255.128.0.0","255.0.0.0","254.0.0.0","252.0.0.0","248.0.0.0","240.0.0.0","224.0.0.0","192.0.0.0","128.0.0.0","0.0.0.0"],"$$ref":"#/components/schemas/CommonCommonDefs_ipv4SubnetMaskDef"}},"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/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfNetmaskOptionsDef"},"shutdown":{"description":"Shutdown for WAN Interface","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"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfShutdownOptionsDef"},"defaultGateway":{"description":"Set Default Gateway","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","anyOf":[{"format":"ipv4"}],"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_defaultGatewayDef"}},"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/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfDefaultGatewayOptionsDef"},"type":{"description":"Set admin distance","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","enum":["primary","secondary(1)","none"],"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_typeDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfTypeOptionsDef"},"vlan":{"description":"Range of VLANs for the network","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","pattern":"((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?))","$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_vlanDef"}},"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/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfVlanOptionsDef"},"native_vlan":{"description":"Native Vlan for the network","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"integer","minimum":1,"maximum":4095,"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_native_vlanDef"}},"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/ProfileparcelNfvirtualNetworksWanPostRequest_oneOfNative_vlanOptionsDef"}},"additionalProperties":false}},"required":["data"],"x-metadata":{"minVManageVersion":"20.15.1"},"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelNfvirtualNetworksWanPostRequest_SchemaPayload"},"examples":{"WANInterfaceParcelGlobalDefault":{"value":{"data":{"color":{"optionType":"global","value":"xxx"},"interface_name":{"optionType":"global","value":"xxx"},"network_name":{"optionType":"global","value":"xxx"},"bridge":{"optionType":"global","value":"xxx"},"mode":{"optionType":"global","value":"trunk"},"dhcp":{"optionType":"default","value":false},"ip_address":{"optionType":"global","value":"xxx"},"netmask":{"optionType":"global","value":"xxx"},"shutdown":{"optionType":"default","value":false},"defaultGateway":{"optionType":"global","value":"xxx"}},"name":"WANInterfaceParcelGlobalDefault"},"$$ref":"#/components/examples/ProfileparcelNfvirtualNetworksWanPostRequest_WANInterfaceParcelGlobalDefault"}}}},"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 Nfvirtual Networks \u003e Wan-write","method":"post","path":"/v1/feature-profile/nfvirtual/networks/{networksId}/wan"}}