Get General Template - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Get General Template","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/65ee78ac-32f3-329c-b00c-b5d29b6bef36","info":{"title":"UX 1.0 Configuration","description":"Configuration of UX 1.0 device and policy.\n\nIncludes API operations for the following:\n- Managing original SD-WAN device configurations and policy configurations\n- Device templates and feature templates\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Configuration - General Template"],"description":"Get template object definition for given template Id\u003cbr\u003e\u003cbr\u003e\u003cbr\u003eNote: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getGeneralTemplate","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{"templateType":"cedgeVoiceCard","templateMinVersion":"15.0.0","deviceType":["vedge-ISR-4461"],"lastUpdatedBy":"admin","editedTemplateDefinition":{"voice-card":{"vipType":"constant","vipObjectType":"tree","vipPrimaryKey":["port-id"],"vipValue":[{"port-id":{"vipObjectType":"object","vipType":"constant","vipValue":"1/0/7"},"id":{"vipObjectType":"object","vipType":"constant","vipValue":"1/0","vipVariableName":"analog_id"},"module-type":{"vipObjectType":"object","vipType":"constant","vipValue":"SM-X-8FXS/12FXO"},"description":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"analog_description_"},"caller-id":{"enable":{"vipObjectType":"node-only","vipType":"constant","vipValue":"true","vipVariableName":"analog_caller_id_"}},"port-type":{"vipObjectType":"object","vipType":"constant","vipValue":"FXS","vipVariableName":"analog_port_type_"},"secondary":{"dialtone":{"vipObjectType":"node-only","vipType":"ignore","vipValue":"false","vipVariableName":"analog_secondary_dialtone_"}},"shutdown":{"vipObjectType":"object","vipType":"constant","vipValue":"false","vipVariableName":"analog_shutdown_"},"connection":{"plar":{"plar-num":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"analog_connection_plarnum_"},"opx-num-only":{"vipType":"ignore","vipValue":"","vipObjectType":"object"}}},"signal":{"did-type":{"vipType":"ignore","vipValue":"","vipObjectType":"object"},"signal-choice":{"vipObjectType":"object","vipType":"ignore","vipValue":"loopStart","vipVariableName":"analog_signal_choice_"}},"port-range":{"vipObjectType":"object","vipType":"constant","vipValue":"7","vipVariableName":"analog_port_range_"},"local-bypass":{"vipType":"constant","vipValue":"true","vipObjectType":"object"}}]},"voice-card-dig":{"vipType":"constant","vipObjectType":"tree","vipPrimaryKey":["dig-port-id"],"vipValue":[{"dig-port-id":{"vipObjectType":"object","vipType":"constant","vipValue":"0/1/0"},"id-dig":{"vipObjectType":"object","vipType":"constant","vipValue":"0/1"},"framing":{"vipObjectType":"object","vipType":"notIgnore","vipValue":"esf","vipVariableName":"framing_0"},"interface":{"vipType":"constant","vipValue":[{"port-id":{"vipType":"constant","vipValue":"0/1/0","vipObjectType":"object"},"clock-priority":{"vipType":"constant","vipValue":0,"vipObjectType":"object"},"controller-shutdown":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"serial-intf-shutdown":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"voiceport-shutdown":{"vipType":"constant","vipValue":true,"vipObjectType":"object"},"clock-type":{"vipType":"constant","vipValue":"line","vipObjectType":"object"},"clock-position":{"vipType":"ignore","vipValue":"","vipObjectType":"object"}}],"vipObjectType":"tree","vipPrimaryKey":["port-id"]},"interface-type":{"vipObjectType":"object","vipType":"constant","vipValue":"T1 PRI"},"line-termination":{"vipObjectType":"object","vipType":"ignore","vipValue":"120-ohm","vipVariableName":"digital_line-termination"},"linecode":{"vipObjectType":"object","vipType":"constant","vipValue":"b8zs","vipVariableName":"linecode_0"},"module-type":{"vipObjectType":"object","vipType":"constant","vipValue":"NIM-1MFT-T1/E1"},"network-side":{"vipObjectType":"object","vipType":"ignore","vipValue":"false","vipVariableName":"digital_network-side"},"switch-type":{"vipObjectType":"object","vipType":"constant","vipValue":"primary-4ess","vipVariableName":"digital_switch-type"},"timeslots":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"digital_timeslots"},"delay-connect-timer":{"vipObjectType":"object","vipType":"constant","vipValue":20,"vipVariableName":"digital_delay_connect_timer"},"dsp-hairpin":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"framing-australia":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"network-participation":{"vipType":"constant","vipValue":"true","vipObjectType":"object"},"isdn-timer":{"isdn-timer-T200":{"vipObjectType":"object","vipType":"ignore","vipValue":1000,"vipVariableName":"digital_isdn-timer-T200"},"isdn-timer-T203":{"vipObjectType":"object","vipType":"ignore","vipValue":30000,"vipVariableName":"digital_isdn-timer-T203"},"isdn-timer-T301":{"vipObjectType":"object","vipType":"ignore","vipValue":300000,"vipVariableName":"digital_isdn-timer-T301"},"isdn-timer-T303":{"vipObjectType":"object","vipType":"ignore","vipValue":4000,"vipVariableName":"digital_isdn-timer-T303"},"isdn-timer-T306":{"vipObjectType":"object","vipType":"ignore","vipValue":30000,"vipVariableName":"digital_isdn-timer-T306"},"isdn-timer-T309":{"vipObjectType":"object","vipType":"ignore","vipValue":90000,"vipVariableName":"digital_isdn-timer-T309"},"isdn-timer-T310":{"vipObjectType":"object","vipType":"ignore","vipValue":30000,"vipVariableName":"digital_isdn-timer-T310"},"isdn-timer-T321":{"vipObjectType":"object","vipType":"ignore","vipValue":40000,"vipVariableName":"digital_isdn-timer-T321"}},"cablelength-long":{"vipObjectType":"object","vipType":"constant","vipValue":"-7.5","vipVariableName":"digital_cablelength-long"}}]},"clock-dig":{"sync":{"vipObjectType":"object","vipType":"ignore","vipValue":"true","vipVariableName":"digital_sync"},"wait-to-restore":{"vipObjectType":"object","vipType":"ignore","vipValue":300,"vipVariableName":"digital_wait-to-restore"}}},"gTemplateClass":"cedge","templateDefinition":{"voice-card":{"vipType":"constant","vipObjectType":"tree","vipPrimaryKey":["port-id"],"vipValue":[{"port-id":{"vipObjectType":"object","vipType":"constant","vipValue":"1/0/7"},"id":{"vipObjectType":"object","vipType":"constant","vipValue":"1/0","vipVariableName":"analog_id"},"module-type":{"vipObjectType":"object","vipType":"constant","vipValue":"SM-X-8FXS/12FXO"},"description":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"analog_description_"},"caller-id":{"enable":{"vipObjectType":"node-only","vipType":"constant","vipValue":"true","vipVariableName":"analog_caller_id_"}},"port-type":{"vipObjectType":"object","vipType":"constant","vipValue":"FXS","vipVariableName":"analog_port_type_"},"secondary":{"dialtone":{"vipObjectType":"node-only","vipType":"ignore","vipValue":"false","vipVariableName":"analog_secondary_dialtone_"}},"shutdown":{"vipObjectType":"object","vipType":"constant","vipValue":"false","vipVariableName":"analog_shutdown_"},"connection":{"plar":{"plar-num":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"analog_connection_plarnum_"},"opx-num-only":{"vipType":"ignore","vipValue":"","vipObjectType":"object"}}},"signal":{"did-type":{"vipType":"ignore","vipValue":"","vipObjectType":"object"},"signal-choice":{"vipObjectType":"object","vipType":"ignore","vipValue":"loopStart","vipVariableName":"analog_signal_choice_"}},"port-range":{"vipObjectType":"object","vipType":"constant","vipValue":"7","vipVariableName":"analog_port_range_"},"local-bypass":{"vipType":"constant","vipValue":"true","vipObjectType":"object"}}]},"voice-card-dig":{"vipType":"constant","vipObjectType":"tree","vipPrimaryKey":["dig-port-id"],"vipValue":[{"dig-port-id":{"vipObjectType":"object","vipType":"constant","vipValue":"0/1/0"},"id-dig":{"vipObjectType":"object","vipType":"constant","vipValue":"0/1"},"framing":{"vipObjectType":"object","vipType":"notIgnore","vipValue":"esf","vipVariableName":"framing_0"},"interface":{"vipType":"constant","vipValue":[{"port-id":{"vipType":"constant","vipValue":"0/1/0","vipObjectType":"object"},"clock-priority":{"vipType":"constant","vipValue":0,"vipObjectType":"object"},"controller-shutdown":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"serial-intf-shutdown":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"voiceport-shutdown":{"vipType":"constant","vipValue":true,"vipObjectType":"object"},"clock-type":{"vipType":"constant","vipValue":"line","vipObjectType":"object"},"clock-position":{"vipType":"ignore","vipValue":"","vipObjectType":"object"}}],"vipObjectType":"tree","vipPrimaryKey":["port-id"]},"interface-type":{"vipObjectType":"object","vipType":"constant","vipValue":"T1 PRI"},"line-termination":{"vipObjectType":"object","vipType":"ignore","vipValue":"120-ohm","vipVariableName":"digital_line-termination"},"linecode":{"vipObjectType":"object","vipType":"constant","vipValue":"b8zs","vipVariableName":"linecode_0"},"module-type":{"vipObjectType":"object","vipType":"constant","vipValue":"NIM-1MFT-T1/E1"},"network-side":{"vipObjectType":"object","vipType":"ignore","vipValue":"false","vipVariableName":"digital_network-side"},"switch-type":{"vipObjectType":"object","vipType":"constant","vipValue":"primary-4ess","vipVariableName":"digital_switch-type"},"timeslots":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"digital_timeslots"},"delay-connect-timer":{"vipObjectType":"object","vipType":"constant","vipValue":20,"vipVariableName":"digital_delay_connect_timer"},"dsp-hairpin":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"framing-australia":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"network-participation":{"vipType":"constant","vipValue":"true","vipObjectType":"object"},"isdn-timer":{"isdn-timer-T200":{"vipObjectType":"object","vipType":"ignore","vipValue":1000,"vipVariableName":"digital_isdn-timer-T200"},"isdn-timer-T203":{"vipObjectType":"object","vipType":"ignore","vipValue":30000,"vipVariableName":"digital_isdn-timer-T203"},"isdn-timer-T301":{"vipObjectType":"object","vipType":"ignore","vipValue":300000,"vipVariableName":"digital_isdn-timer-T301"},"isdn-timer-T303":{"vipObjectType":"object","vipType":"ignore","vipValue":4000,"vipVariableName":"digital_isdn-timer-T303"},"isdn-timer-T306":{"vipObjectType":"object","vipType":"ignore","vipValue":30000,"vipVariableName":"digital_isdn-timer-T306"},"isdn-timer-T309":{"vipObjectType":"object","vipType":"ignore","vipValue":90000,"vipVariableName":"digital_isdn-timer-T309"},"isdn-timer-T310":{"vipObjectType":"object","vipType":"ignore","vipValue":30000,"vipVariableName":"digital_isdn-timer-T310"},"isdn-timer-T321":{"vipObjectType":"object","vipType":"ignore","vipValue":40000,"vipVariableName":"digital_isdn-timer-T321"}},"cablelength-long":{"vipObjectType":"object","vipType":"constant","vipValue":"-7.5","vipVariableName":"digital_cablelength-long"}}]},"clock-dig":{"sync":{"vipObjectType":"object","vipType":"ignore","vipValue":"true","vipVariableName":"digital_sync"},"wait-to-restore":{"vipObjectType":"object","vipType":"ignore","vipValue":300,"vipVariableName":"digital_wait-to-restore"}}},"configType":"xml","attachedMastersCount":0,"templateId":"30ebbc4a-6596-45b8-acfb-c62fe2add788","createdOn":1652776377626,"@rid":918,"factoryDefault":false,"feature":"vmanage-default","templateName":"template_voice_card","createdBy":"admin","devicesAttached":0,"templateDescription":"template_voice_card","lastUpdatedOn":1652776377626}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Policy Configuration-read","method":"get","path":"/template/feature/object/{templateId}"}}