ProfileparcelSdRoutingCommonRoutingOspfv3Ipv4CommonRequest_areaInterfaceDef - Cisco Catalyst SD-WAN Manager API, Release 20.18 - Cisco DevNet

{"type":"model","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/f75de7c3-5553-375b-b45f-644916a52d4b","info":{"title":"Feature Profiles - SD-Routing","description":"Feature profiles associated with UX 2.0 configuration\n\nIncludes API operations for the following:\n- Feature Profiles in SD-Routing Solution\n- Supporting software-defined routing features and autonomous router management\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"properties":{"ifName":{"description":"Set interface name","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"oneOf":[{"type":"string","pattern":"^(Ethernet|GigabitEthernet|TenGigabitEthernet|TwoGigabitEthernet|FiveGigabitEthernet|TwentyFiveGigabitEthernet|TwentyFiveGigE|HundredGigE|FortyGigabitEthernet|FastEthernet)(0|[1-9][0-9]?|(0|[1-9][0-9]?).[1-9][0-9]{0,3}|(0|[1-9][0-9]?)/(0|[1-9][0-9]?)/(0|[1-9][0-9]?).[1-9][0-9]{0,3}|[0-9]{1,2}/(0|[1-9][0-9]?)/(0|[1-9][0-9]?)|(0|[1-9][0-9]?)/(0|[1-9][0-9]?).[1-9][0-9]{0,3}|(0|[1-9][0-9]?)/(0|[1-9][0-9]?))$","minLength":3,"maxLength":32,"$$ref":"#/components/schemas/CommonCommonDefs_ethMainAndSubIfNameOptionDef"},{"type":"string","pattern":"^Loopback(0|[1-9][0-9]{0,9})$","minLength":9,"maxLength":18,"$$ref":"#/components/schemas/CommonCommonDefs_loopbackIfNameOptionDef"},{"type":"string","pattern":"^Vlan([1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-3][0-9][0-9][0-9]|40[0-9][0-4])$","minLength":5,"maxLength":8,"$$ref":"#/components/schemas/CommonCommonDefs_sviIfNameOptionDef"},{"type":"string","pattern":"^Tunnel(0|[1-9][0-9]{0,9})$","minLength":7,"maxLength":16,"$$ref":"#/components/schemas/CommonCommonDefs_tunnelIfNameOptionDef"},{"minLength":6,"type":"string","maxLength":8,"pattern":"^ipsec([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$","$$ref":"#/components/schemas/CommonCommonDefs_ipsecIfNameDef"},{"type":"string","pattern":"^dmvpn([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$","minLength":6,"maxLength":8,"$$ref":"#/components/schemas/CommonCommonDefs_dmvpnTunnelIfNameOptionDef"},{"type":"string","pattern":"^Cellular([0-9]+/[0-9]+/[0-9]+)$","minLength":9,"maxLength":32,"$$ref":"#/components/schemas/CommonCommonDefs_cellIfNameOptionDef"}],"$$ref":"#/components/schemas/CommonCommonDefs_sdRoutingOspfAreaInterfaceNameDef"}},"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/ProfileparcelSdRoutingCommonRoutingOspfv3Ipv4CommonRequest_oneOfAreaInterfaceNameOptionsDef"},"helloInterval":{"description":"Set interval between OSPF hello packets","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"default":10,"minimum":1,"maximum":65535,"type":"integer","$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonRoutingOspfv3Ipv4CommonRequest_areaInterfaceHelloIntervalDef"}},"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":"integer","minimum":10,"maximum":10,"$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonRoutingOspfv3Ipv4CommonRequest_defaultAreaInterfaceHelloIntervalDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonRoutingOspfv3Ipv4CommonRequest_oneOfAreaInterfaceHelloIntervalOptionsDef"},"deadInterval":{"description":"Set interval after which neighbor is declared to be down","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"default":40,"minimum":1,"maximum":65535,"type":"integer","$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonRoutingOspfv3Ipv4CommonRequest_areaInterfaceDeadIntervalDef"}},"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":"integer","minimum":40,"maximum":40,"$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonRoutingOspfv3Ipv4CommonRequest_defaultAreaInterfaceDeadIntervalDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonRoutingOspfv3Ipv4CommonRequest_oneOfAreaInterfaceDeadIntervalOptionsDef"},"retransmitInterval":{"description":"Set time between retransmitting LSAs","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"default":5,"minimum":1,"maximum":65535,"type":"integer","$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonRoutingOspfv3Ipv4CommonRequest_areaInterfaceRetransmitIntervalDef"}},"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":"integer","minimum":5,"maximum":5,"$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonRoutingOspfv3Ipv4CommonRequest_defaultAreaInterfaceRetransmitIntervalDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonRoutingOspfv3Ipv4CommonRequest_oneOfAreaInterfaceRetransmitIntervalOptionsDef"},"cost":{"description":"Set cost of OSPF interface","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minimum":1,"maximum":65535,"type":"integer","$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonRoutingOspfv3Ipv4CommonRequest_areaInterfaceCostDef"}},"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/ProfileparcelSdRoutingCommonRoutingOspfv3Ipv4CommonRequest_oneOfAreaInterfaceCostOptionsDef"},"networkType":{"description":"Set the OSPF network type","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"enum":["broadcast","point-to-point","non-broadcast","point-to-multipoint"],"type":"string","$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonRoutingOspfv3Ipv4CommonRequest_areaInterfaceNetworkDef"}},"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/ProfileparcelSdRoutingCommonRoutingOspfv3Ipv4CommonRequest_oneOfAreaInterfaceNetworkOptionsDef"},"passiveInterface":{"description":"Set the interface to advertise its address, but not to actively run OSPF","type":"object","oneOf":[{"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":["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}],"$$ref":"#/components/schemas/CommonCommonDefs_oneOfOnBooleanDefaultFalseOptionsDef"},"authenticationConfig":{"description":"Set OSPF interface authentication configuration","type":"object","oneOf":[{"properties":{"authType":{"description":"No Authentication by default","type":"object","properties":{"optionType":{"type":"string","enum":["global","default"]},"value":{"type":"string","enum":["no-auth"]}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonRoutingOspfv3Ipv4CommonRequest_areaInterfaceNoAuthTypeDef"}},"required":["authType"],"additionalProperties":false},{"properties":{"authType":{"description":"IPSec authentication with SHA1","type":"object","properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","enum":["ipsec-sha1"]}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonRoutingOspfv3Ipv4CommonRequest_areaInterfaceIpsecSha1AuthTypeDef"},"spi":{"description":"Set OSPF interface authentication IPSec SPI, range 256..4294967295","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minimum":256,"maximum":4294967295,"type":"integer","$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonRoutingOspfv3Ipv4CommonRequest_areaInterfaceSpiDef"}},"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/ProfileparcelSdRoutingCommonRoutingOspfv3Ipv4CommonRequest_oneOfAreaInterfaceSpiOptionsDef"},"authKey":{"description":"Set OSPF interface authentication IPSEC key","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","pattern":"^[0-9a-fA-F]{40}$","$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonRoutingOspfv3Ipv4CommonRequest_areaInterfaceSha1AuthKeyDef"}},"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/ProfileparcelSdRoutingCommonRoutingOspfv3Ipv4CommonRequest_oneOfAreaInterfaceSha1AuthKeyOptionsDef"}},"required":["authType","spi","authKey"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonRoutingOspfv3Ipv4CommonRequest_oneOfAreaInterfaceAuthConfigOptionsDef"}},"required":["ifName"],"additionalProperties":false,"title":"ProfileparcelSdRoutingCommonRoutingOspfv3Ipv4CommonRequest_areaInterfaceDef"}}