{"type":"api","title":"Get Preview Cli For Control Component","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/744a8207-9965-344e-aed3-d3ef846a4950","info":{"title":"Others","description":"Other APIs\n- Include APIs that do not belong to other categories\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Configuration - Control Component Setting"],"description":"Preview the CLI configuration for a specific control component. The deviceId can be obtained from the \"uuid\" field in the data returned by the API (GET /dataservice/certificate/data/controller/list)","operationId":"getPreviewCliForControlComponent","parameters":[{"name":"deviceId","in":"path","description":"Control component device UUID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"required":["attachedConfig","newConfig"],"type":"object","properties":{"attachedConfig":{"type":"string","description":"Current running config CLI for specific control component","example":"system\n pseudo-confirm-commit 300\n host-name Controller01"},"newConfig":{"type":"string","description":"Generated intent config CLI for specific control component","example":"system\n pseudo-confirm-commit 300\n host-name Controller01"}},"$$ref":"#/components/schemas/ControlComponentPreviewCliResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"required":["error"],"type":"object","properties":{"error":{"required":["code","details","message","type"],"type":"object","properties":{"code":{"type":"string","description":"Internal error code","example":"CCS0018"},"details":{"type":"string","description":"Error message detail","example":"Unrecognized field user1"},"message":{"type":"string","description":"Error message summary","example":"Invalid control component setting payload"},"type":{"type":"string","description":"Error message title","example":"error"}},"description":"Error response","$$ref":"#/components/schemas/ErrorDetails"}},"$$ref":"#/components/schemas/ErrorResponse"},"examples":{"InvalidControlComponentDeviceId":{"description":"InvalidControlComponentDeviceId","value":{"error":{"message":"Invalid control component device ID, only support controller,validator and manager","code":"CCS0010","details":"Device 73a7730e-9d48-463a-8c7f-924f6edd951c is not existed","type":"error"}},"$$ref":"#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleInvalidcontrolcomponentdeviceidresponse"}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"required":["error"],"type":"object","properties":{"error":{"required":["code","details","message","type"],"type":"object","properties":{"code":{"type":"string","description":"Internal error code","example":"CCS0018"},"details":{"type":"string","description":"Error message detail","example":"Unrecognized field user1"},"message":{"type":"string","description":"Error message summary","example":"Invalid control component setting payload"},"type":{"type":"string","description":"Error message title","example":"error"}},"description":"Error response","$$ref":"#/components/schemas/ErrorDetails"}},"$$ref":"#/components/schemas/ErrorResponse"},"examples":{"PreviewFailedForSettingsNotConfigured":{"description":"PreviewFailedForSettingsNotConfigured","value":{"error":{"message":"Did not find the network settings for any control components","code":"CCS0005","details":"Control component common settings are not configured","type":"error"}},"$$ref":"#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleGetcommonsettingsnotfoundresponse"}}}}},"500":{"description":"Internal Server Error"}},"x-roles-required":"Control Component Settings-read","method":"get","path":"/v1/control-component/devices/{deviceId}/settings/preview"}}