getSingleSdRoutingTransportObjecttrackerPayload - 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/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":{"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":{"type":"string"},"data":{"type":"object","properties":{"trackerId":{"description":"Object tracker ID","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":"integer","minimum":1,"maximum":1000,"$$ref":"#/components/schemas/CommonCommonDefs_oneThousandIdDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonObjecttrackerCommonRequest_oneOfTrackerObjectIdDef"},"trackerConfig":{"description":"Object tracker configuration","type":"object","oneOf":[{"properties":{"interface":{"description":"Object tracker config for interface","type":"object","properties":{"ifName":{"description":"interface name","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","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"},{"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_ifNameV2Def"}},"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/CommonCommonDefs_oneOfInterfaceNameV2OptionsNoDefaultDef"},"interfaceTrackType":{"description":"Interface Object tracker type (line-protocol,ip-routing,ipv6-routing)","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"enum":["line-protocol","ip-routing","ipv6-routing"],"default":"line-protocol","type":"string","$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonObjecttrackerCommonRequest_interfaceTrackTypeDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"enum":["line-protocol"],"type":"string","$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonObjecttrackerCommonRequest_defaultInterfaceTrackTypeDef"}},"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/ProfileparcelSdRoutingCommonObjecttrackerCommonRequest_oneOfInterfaceTrackTypeOptionsDef"}},"required":["ifName","interfaceTrackType"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonObjecttrackerCommonRequest_oneOfInterfaceObjectTrackerConfigDef"}},"required":["interface"],"additionalProperties":false},{"properties":{"route":{"description":"Object tracker config for IPv4 route","type":"object","properties":{"address":{"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":"string","pattern":"^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}$","$$ref":"#/components/schemas/CommonCommonDefs_ipv4AddressDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/CommonCommonDefs_oneOfIpV4AddressOptionsDef","description":"IPv4 address","type":"object"},"mask":{"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":"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}],"$$ref":"#/components/schemas/CommonCommonDefs_oneOfIpV4SubnetMaskOptionsDef","description":"IPv4 mask","type":"object"},"vrfName":{"description":"VRF Name","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":"string","pattern":"^[^&\u003c\u003e! \"]+$","minLength":1,"maxLength":32,"$$ref":"#/components/schemas/CommonCommonDefs_vrfDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"}},"required":["optionType"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef"}],"$$ref":"#/components/schemas/CommonCommonDefs_oneOfVrfOptionsWithDefault"}},"required":["address","mask","vrfName"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonObjecttrackerCommonRequest_oneOfRouteObjectTrackerConfigDef"}},"required":["route"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonObjecttrackerCommonRequest_oneOfObjectTrackerConfigOptionsDef"},"delayUpTime":{"description":"Delay Up Time (Seconds)","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"integer","minimum":0,"maximum":180,"$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonObjecttrackerCommonRequest_delayUpTimeDef"}},"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/ProfileparcelSdRoutingCommonObjecttrackerCommonRequest_oneOfDelayUpTimeOptionsDef"},"delayDownTime":{"description":"Delay Down Time (Seconds)","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"integer","minimum":0,"maximum":180,"$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonObjecttrackerCommonRequest_delayDownTimeDef"}},"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/ProfileparcelSdRoutingCommonObjecttrackerCommonRequest_oneOfDelayDownTimeOptionsDef"}},"required":["trackerId","trackerConfig","delayUpTime","delayDownTime"],"additionalProperties":false}},"required":["data"],"x-metadata":{"supportedDeviceTypes":["autonomous-all"],"minVManageVersion":"20.15.1"},"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdRoutingCommonObjecttrackerCommonRequest_SchemaPayload"}},"$$ref":"#/components/schemas/getSingleSdRoutingTransportObjecttrackerPayload","title":"getSingleSdRoutingTransportObjecttrackerPayload"}}