{"type":"api","title":"Update Secure Overlay Configuration","meta":{"id":"/apps/pubhub/media/nfvis-api/e3678dda6abe6c2a26c7698d553a4574e3f45071/262737b2-b3c2-32cd-b07b-fdbdcd23918f","info":{"title":"NFVIS API","description":"NFVIS RESTCONF API Documentation","version":"4.14.1"},"x-parser-conf":{"overview":{"markdownPath":"reference/overview.md"}},"swagger":"2.0","basePath":"/{nfvis_ip}/restconf","schemes":["https"],"securityDefinitions":{"basicAuth":{"type":"basic"}}},"spec":{"tags":["Secure Overlay"],"summary":"Update Secure Overlay Configuration","description":"Update secure overlay configuration","operationId":"data_secure_overlay_secure_overlays_secure_overlay_secure_overlay_name_put","produces":["application/yang-data+json"],"parameters":[{"name":"secure-overlay-name","in":"path","description":"Name of secure overlay connection","required":true,"type":"string","format":"string","$$ref":"#/parameters/secure-overlay-name"},{"name":"secure-overlay","in":"body","description":"NFVIS secure management overlay","required":true,"schema":{"type":"object","properties":{"secure_overlay:secure-overlay":{"type":"array","description":"NFVIS secure management overlay (list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"name":{"description":"Name of secure overlay connection (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"description":{"description":"Description of secure overlay connection (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"local-bridge":{"description":"Local bridge name for overlay (default wan-br) (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"leafref"},"dual-local-bridge":{"description":"Dual local bridge name for overlay (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"leafref"},"local-system-ip-addr":{"description":"Local overlay system IPv4 address (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"union"},"local-system-ip-subnet":{"description":"Local overlay subnet (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"union"},"local-system-ip-bridge":{"description":"Bridge associated with local-system-ip-addr (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"leafref"},"local-id":{"description":"Local id for overlay - IP, FQDN, or email address (default ip address of local-bridge) (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"union"},"remote-interface-ip-addr":{"description":"Remote interface IPv4 address (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"union"},"remote-system-ip-addr":{"type":"array","x-yang":{"type":"leaf-list"},"items":{"description":"Remote system IPv4 address (leaf-list)","type":"string","format":"union"}},"remote-system-ip-subnet":{"type":"array","x-yang":{"type":"leaf-list"},"items":{"description":"Remote overlay subnet (leaf-list)","type":"string","format":"union"}},"remote-id":{"type":"array","x-yang":{"type":"leaf-list"},"items":{"description":"Remote id for overlay - IP, FQDN, DN or email address (default remote-interface-ip-addr) (leaf-list)","type":"string","format":"union"}},"ike-cipher":{"type":"array","x-yang":{"type":"leaf-list"},"items":{"description":"IKE algorithms (leaf-list)","type":"string","format":"enumeration","default":"aes128-sha1-modp1536","enum":["aes128-sha1-modp1536","aes256-sha512-modp2048","aes256-sha512-modp4096"]}},"esp-cipher":{"type":"array","x-yang":{"type":"leaf-list"},"items":{"description":"ESP algorithms (leaf-list)","type":"string","format":"enumeration","default":"aes128-sha1","enum":["aes128-sha1","aes256-sha512","aes256-sha512-modp2048","aes256-sha512-modp4096","aes128-sha1-modp1536","aes256-sha1-modp2048","aes256-sha256-modp2048"]}},"psk":{"description":"Pre-shared-key for authentication (non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"local-psk":{"description":"Local pre-shared-key (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"remote-psk":{"description":"Remote pre-shared-key (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"}}},"bgp-neighbor-name":{"description":"Name of neighbor node for BGP through Secure Overlay (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"state":{"description":"Secure overlay state (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"start","enum":["start","up","down","error"]},"active-local-bridge":{"description":"Name of local bridge actually used in secure overlay (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"state-details":{"description":"Secure overlay state details (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"selected-local-bridge":{"description":"Name of selected bridge actually used in secure overlay (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"active-local-system-ip-addr":{"description":"Name of selected local system ip addr actually used in secure overlay (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"active-remote-interface-ip-addr":{"description":"Active remote interface ip addr currently used in secure overlay (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"active-remote-system-ip-addr":{"description":"Active remote system ip addr currently used in secure overlay (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"active-remote-system-ip-subnet":{"description":"Active remote system ip subnet currently used in secure overlay (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"active-remote-id":{"description":"Active remote id currently used in secure overlay (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"}}}}},"$$ref":"#/definitions/data_secure_overlay_secure-overlays_secure-overlay_secure-overlay-name"},"$$ref":"#/parameters/data_secure_overlay_secure-overlays_secure-overlay_secure-overlay-name"},{"name":"insert","in":"query","description":"controlling the order when adding new list elements","required":false,"type":"string","format":"enumeration","default":"first","enum":["first","last","before","after"],"$$ref":"#/parameters/insert"},{"name":"point","in":"query","description":"used to specify the insertion point","required":false,"type":"string","format":"string","$$ref":"#/parameters/point"}],"responses":{"201":{"description":"list secure-overlay created or replaced"},"204":{"description":"No Content","$$ref":"#/responses/204"},"400":{"description":"Bad Request","$$ref":"#/responses/400"},"401":{"description":"Unauthorized","$$ref":"#/responses/401"},"404":{"description":"Not Found","$$ref":"#/responses/404"},"405":{"description":"Method Not Allowed","$$ref":"#/responses/405"},"409":{"description":"Conflict","$$ref":"#/responses/409"}},"security":[{"basicAuth":[]}],"__originalOperationId":"data_secure_overlay_secure_overlays_secure_overlay_secure_overlay_name_put","consumes":["application/yang-data+json"],"method":"put","path":"/data/secure_overlay:secure-overlays/secure-overlay={secure-overlay-name}"}}