Configure System - NFVIS API

{"type":"api","title":"Configure System","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":["System Configuration"],"summary":"Configure System","description":"Configure the system by setting the default gateway, management IP address and/or WAN IP address, Enable/Disable DPDK etc","operationId":"data_system_system_settings_post","produces":["application/yang-data+json"],"parameters":[{"name":"settings","in":"body","description":"system wide configurations","required":true,"schema":{"type":"object","properties":{"system:logging":{"description":"Logging configuration (non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"host":{"type":"array","description":"IPv4/IPv6 address or domain name of the remote syslog server (list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"host":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"union"},"host_type":{"description":"The host/server type can be a ipv4 addres or a domain-name (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"ipv4","enum":["ipv4","domain-name"]},"transport":{"description":"Transport protocol to reach remote syslog server (default UDP) (non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"udp":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"[null]"}}},"port":{"description":"Port to reach remote syslog server (leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"}}}},"facility":{"description":"Syslog facility (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"local0","enum":["local0","local1","local2","local3","local4","local5","local6","local7"]},"severity":{"description":"Syslog severity (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"emergency","enum":["emergency","alert","critical","error","warning","notice","informational","debug"]}}},"system:brief":{"type":"array","description":"Summarized list of settings for wan & mgmt config (list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"interface":{"description":"interface type (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"ipv4_address":{"description":"IPv4 address (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"ipv4_netmask":{"description":"IPv4 netmask address (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"ipv4_dhcp":{"description":"IPv4 dhcp enabled (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"ipv4_expire":{"description":"expire date for IPv4 dhcp (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"global_ipv6_address":{"description":"Global IPv6 address (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"global_prefixlen":{"description":"Prefix legnth for global IPv6 address (leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"byte"},"link_local_ipv6_address":{"description":"Link local IPv6 address (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"link_local_prefixlen":{"description":"Prefix length for link local IPv6 address (leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"byte"},"ipv6_dhcp":{"description":"IPv6 dhcp enabled (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"ipv6_slaac":{"description":"IPv6 SLAAC enabled (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"ipv6_dhcp_state":{"description":"IPv6 dhcp state (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"Stateless","enum":["Stateless","Stateful"]}}}},"system:hostname":{"description":"hostname of the system (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"system:dpdk":{"description":"enable dpdk on service bridge (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"disable","enum":["disable","enable"]},"system:dpdk-status":{"description":"Shows operational status for DPDK (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"error","enum":["error","enabled","enabling"]},"system:trusted-source":{"type":"array","x-yang":{"type":"leaf-list"},"items":{"description":"(leaf-list)","type":"string","format":"union"}},"system:ip-receive-acls":{"description":"ACL container for managing interface group (non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"ip-receive-acl":{"type":"array","description":"ACL for managing interface group (list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"source":{"description":"Source network/Netmask (ex, 10.10.0.0/16) for interface (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"union"},"service":{"type":"array","x-yang":{"type":"leaf-list"},"items":{"description":"ACL of service for interface (leaf-list)","type":"string","format":"enumeration","default":"ssh","enum":["ssh","https","icmp","netconf","snmp","scpd"]}},"action":{"description":"ACL of action for interface (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"accept","enum":["accept","reject","drop"]},"priority":{"description":"Priority order for Source network/Netmask rules (leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"}}}}}},"system:mgmt":{"description":"This is for lan-br IP configuration (non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"ip":{"description":"IPV4 address configuration (presence)","type":"object","x-yang":{"type":"container","is_presence":"true"},"properties":{"address":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"netmask":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"}}},"ipv6":{"description":"IPV6 address configuration (non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"address":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"union"}}}}},"system:wan":{"description":"This is for wan-br configuration (non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"ip":{"description":"IPV4 address configuration (presence)","type":"object","x-yang":{"type":"container","is_presence":"true"},"properties":{"address":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"netmask":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"}}},"ipv6":{"description":"IPV6 address configuration (non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"address":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"union"}}},"secondary":{"description":"WAN secondary address configuration (non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"ip":{"description":"IPV4 address configuration (presence)","type":"object","x-yang":{"type":"container","is_presence":"true"},"properties":{"address":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"netmask":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"}}}}},"vlan":{"description":"VLAN tag for management traffic on Wan side (leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"}}},"system:name-server":{"description":"Nameservers to be used for DNS resolver queries (non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"server":{"type":"array","x-yang":{"type":"leaf-list"},"items":{"description":"List of IP address of nameservers that DNS resolver should query (leaf-list)","type":"string","format":"union"}}}},"system:dns-server":{"type":"array","x-yang":{"type":"leaf-list"},"items":{"description":"ip address of the DNS server (leaf-list)","type":"string","format":"union"}},"system:default-gw":{"description":"gateway ip address (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"system:secondary-default-gw":{"description":"Secondary gateway ip address (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"system:secondary-default-gw-metric":{"description":"Secondary default gateway metric (default 1) (leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint32"},"system:active-gateway-detection":{"description":"Enable active gateway detection service (default: false) (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"boolean"},"system:default-gw-ipv6":{"description":"gateway ipv6 address (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"system:domain":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"system:source-interface":{"description":"Source IP address configuration for originating traffic (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"system:disk-space":{"description":"Configure disk space settings (non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"threshold":{"description":"Value in %. Receive warning notifications when disk-space reaches threshold. (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"int32"}}},"system:cimc-access":{"description":"Configure CIMC access through NFVIS on ENCS-5400 platform (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"enable","enum":["enable","disable"]},"system:cimc-password":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"system:bios-password":{"description":"(leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"}},"$$ref":"#/definitions/data_system_system_settings-post"},"$$ref":"#/parameters/data_system_system_settings-post"}],"responses":{"201":{"description":"container settings created"},"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_system_system_settings_post","consumes":["application/yang-data+json"],"method":"post","path":"/data/system:system/settings"}}