NETCONF Configuration Guide
YANG API Reference
ip
44 min
asternos ip module description asternos yang model for ip yang tree diagram module asternos ip augment /if\ interfaces/if\ interface + rw ipv4 \| + rw address \[ip prefix] \| | + rw ip prefix inet\ ip prefix \| + rw neighbor \[ip] \| + rw ip inet\ ipv4 address no zone \| + rw mac address yang\ mac address \| + ro origin? neighbor origin + rw ipv6 + rw address \[ip prefix] \| + rw ip prefix inet\ ip prefix + rw neighbor \[ip] \| + rw ip inet\ ipv6 address no zone \| + rw mac address yang\ mac address \| + ro origin? neighbor origin \| + ro is router? empty \| + ro state? enumeration + rw router advertisement + rw managed flag? boolean + rw other config flag? boolean + rw link mtu? cmn\ mtu type + rw on link flag? boolean + rw autonomous flag? boolean + rw prefixes \[prefix] \| + rw prefix inet\ ipv6 prefix + rw rdnsses \[rdnss] \| + rw rdnss inet\ ipv6 address no zone + rw routes \[route] + rw route inet\ ipv6 prefix + rw preferred? enumeration rpcs + x show ipv4 neighbor summary \| + ro output \| + ro data? \<anydata> + x show ipv6 neighbor summary + w input \| + w ip? inet\ ipv6 address no zone \| + w interface? union + ro output + ro data? \<anydata> resources resource list path access /?/interfaces/interface/ipv4 read write /?/interfaces/interface/ipv4/address read write /?/interfaces/interface/ipv4/address/ip prefix read write /?/interfaces/interface/ipv4/neighbor read write /?/interfaces/interface/ipv4/neighbor/ip read write /?/interfaces/interface/ipv4/neighbor/mac address read write /?/interfaces/interface/ipv4/neighbor/origin read only /?/interfaces/interface/ipv6 read write /?/interfaces/interface/ipv6/address read write /?/interfaces/interface/ipv6/address/ip prefix read write /?/interfaces/interface/ipv6/neighbor read write /?/interfaces/interface/ipv6/neighbor/ip read write /?/interfaces/interface/ipv6/neighbor/mac address read write /?/interfaces/interface/ipv6/neighbor/origin read only /?/interfaces/interface/ipv6/neighbor/is router read only /?/interfaces/interface/ipv6/neighbor/state read only /?/interfaces/interface/ipv6/router advertisement read write /?/interfaces/interface/ipv6/router advertisement/managed flag read write /?/interfaces/interface/ipv6/router advertisement/other config flag read write /?/interfaces/interface/ipv6/router advertisement/link mtu read write /?/interfaces/interface/ipv6/router advertisement/on link flag read write /?/interfaces/interface/ipv6/router advertisement/autonomous flag read write /?/interfaces/interface/ipv6/router advertisement/prefixes read write /?/interfaces/interface/ipv6/router advertisement/prefixes/prefix read write /?/interfaces/interface/ipv6/router advertisement/rdnsses read write /?/interfaces/interface/ipv6/router advertisement/rdnsses/rdnss read write /?/interfaces/interface/ipv6/router advertisement/routes read write /?/interfaces/interface/ipv6/router advertisement/routes/route read write /?/interfaces/interface/ipv6/router advertisement/routes/preferred read write detailed nodes /?/interfaces/interface/ipv4 path /?/interfaces/interface/ipv4 node type container description parameters for the ipv4 address family access read write /?/interfaces/interface/ipv4/address path /?/interfaces/interface/ipv4/address node type list description the list of ipv4 addresses on the interface access read write /?/interfaces/interface/ipv4/address/ip prefix path /?/interfaces/interface/ipv4/address/ip prefix node type leaf description no description available access read write data type constraints multiple constraints the ipv6 prefix type represents an ipv6 prefix the prefix length is given by the number following the slash character and must be less than or equal to 128 a prefix length value of n corresponds to an ip address mask that has n contiguous 1 bits from the most significant bit (msb) and all other bits set to 0 the canonical format of an ipv6 prefix has all bits of the ipv6 address set to zero that are not part of the ipv6 prefix furthermore, the ipv6 address is represented as defined in section 4 of rfc 5952 the definition of ipv6 prefix does not require that bits, which are not part of the prefix, are set to zero however, implementations have to return values in canonical format, which requires non prefix bits to be set to zero this means that 2001\ db8 1/64 must be accepted as a valid value but it will be converted into the canonical format 2001\ db8 /64 the ipv4 prefix type represents an ipv4 prefix the prefix length is given by the number following the slash character and must be less than or equal to 32 a prefix length value of n corresponds to an ip address mask that has n contiguous 1 bits from the most significant bit (msb) and all other bits set to 0 the canonical format of an ipv4 prefix has all bits of the ipv4 address set to zero that are not part of the ipv4 prefix the definition of ipv4 prefix does not require that bits, which are not part of the prefix, are set to zero however, implementations have to return values in canonical format, which requires non prefix bits to be set to zero this means that 192 0 2 1/24 must be accepted as a valid value but it will be converted into the canonical format 192 0 2 0/24 must condition contains(current(), ' ') /?/interfaces/interface/ipv4/neighbor path /?/interfaces/interface/ipv4/neighbor node type list description a list of mappings from ipv4 addresses to link layer addresses entries in this list in the intended configuration are used as static entries in the arp cache in the operational state, this list represents the arp cache access read write /?/interfaces/interface/ipv4/neighbor/ip path /?/interfaces/interface/ipv4/neighbor/ip node type leaf description the ipv4 address of the neighbor node access read write data type constraints an ipv4 address without a zone index this type, derived from the type ipv4 address, may be used in situations where the zone is known from the context and no zone index is needed /?/interfaces/interface/ipv4/neighbor/mac address path /?/interfaces/interface/ipv4/neighbor/mac address node type leaf description the link layer address of the neighbor node access read write data type constraints the mac address type represents an ieee 802 mac address the canonical representation uses lowercase characters in the value set and its semantics, this type is equivalent to the macaddress textual convention of the smiv2 mandatory yes /?/interfaces/interface/ipv4/neighbor/origin path /?/interfaces/interface/ipv4/neighbor/origin node type leaf description the origin of this neighbor entry access read only data type constraints enumeration with options other static dynamic /?/interfaces/interface/ipv6 path /?/interfaces/interface/ipv6 node type container description parameters for the ipv6 address family access read write /?/interfaces/interface/ipv6/address path /?/interfaces/interface/ipv6/address node type list description the list of ipv6 addresses on the interface access read write /?/interfaces/interface/ipv6/address/ip prefix path /?/interfaces/interface/ipv6/address/ip prefix node type leaf description no description available access read write data type constraints multiple constraints the ipv6 prefix type represents an ipv6 prefix the prefix length is given by the number following the slash character and must be less than or equal to 128 a prefix length value of n corresponds to an ip address mask that has n contiguous 1 bits from the most significant bit (msb) and all other bits set to 0 the canonical format of an ipv6 prefix has all bits of the ipv6 address set to zero that are not part of the ipv6 prefix furthermore, the ipv6 address is represented as defined in section 4 of rfc 5952 the definition of ipv6 prefix does not require that bits, which are not part of the prefix, are set to zero however, implementations have to return values in canonical format, which requires non prefix bits to be set to zero this means that 2001\ db8 1/64 must be accepted as a valid value but it will be converted into the canonical format 2001\ db8 /64 must condition contains(current(), ' ') the ipv4 prefix type represents an ipv4 prefix the prefix length is given by the number following the slash character and must be less than or equal to 32 a prefix length value of n corresponds to an ip address mask that has n contiguous 1 bits from the most significant bit (msb) and all other bits set to 0 the canonical format of an ipv4 prefix has all bits of the ipv4 address set to zero that are not part of the ipv4 prefix the definition of ipv4 prefix does not require that bits, which are not part of the prefix, are set to zero however, implementations have to return values in canonical format, which requires non prefix bits to be set to zero this means that 192 0 2 1/24 must be accepted as a valid value but it will be converted into the canonical format 192 0 2 0/24 /?/interfaces/interface/ipv6/neighbor path /?/interfaces/interface/ipv6/neighbor node type list description a list of mappings from ipv6 addresses to link layer addresses entries in this list in the intended configuration are used as static entries in the neighbor cache in the operational state, this list represents the neighbor cache access read write /?/interfaces/interface/ipv6/neighbor/ip path /?/interfaces/interface/ipv6/neighbor/ip node type leaf description the ipv6 address of the neighbor node access read write data type constraints an ipv6 address without a zone index this type, derived from the type ipv6 address, may be used in situations where the zone is known from the context and no zone index is needed /?/interfaces/interface/ipv6/neighbor/mac address path /?/interfaces/interface/ipv6/neighbor/mac address node type leaf description the link layer address of the neighbor node in the operational state, if the neighbor's 'state' leaf is 'incomplete', this leaf is not instantiated access read write data type constraints the mac address type represents an ieee 802 mac address the canonical representation uses lowercase characters in the value set and its semantics, this type is equivalent to the macaddress textual convention of the smiv2 mandatory yes /?/interfaces/interface/ipv6/neighbor/origin path /?/interfaces/interface/ipv6/neighbor/origin node type leaf description the origin of this neighbor entry access read only data type constraints enumeration with options other static dynamic /?/interfaces/interface/ipv6/neighbor/is router path /?/interfaces/interface/ipv6/neighbor/is router node type leaf description indicates that the neighbor node acts as a router access read only data type constraints empty type /?/interfaces/interface/ipv6/neighbor/state path /?/interfaces/interface/ipv6/neighbor/state node type leaf description the neighbor unreachability detection state of this entry access read only data type constraints enumeration with options incomplete reachable stale delay probe /?/interfaces/interface/ipv6/router advertisement path /?/interfaces/interface/ipv6/router advertisement node type container description support for ipv6 router advertisements access read write constraints when condition / /name\[starts with(text(), 'vlan')] /?/interfaces/interface/ipv6/router advertisement/managed flag path /?/interfaces/interface/ipv6/router advertisement/managed flag node type leaf description the value to be placed in the 'managed address configuration' flag field in the router advertisement access read write data type constraints valid in \[true, false] /?/interfaces/interface/ipv6/router advertisement/other config flag path /?/interfaces/interface/ipv6/router advertisement/other config flag node type leaf description the value to be placed in the 'other configuration' flag field in the router advertisement access read write data type constraints valid in \[true, false] /?/interfaces/interface/ipv6/router advertisement/link mtu path /?/interfaces/interface/ipv6/router advertisement/link mtu node type leaf description the value to be placed in mtu options sent by the router a value of zero indicates that no mtu options are sent access read write data type constraints valid range 1312 to 9216 /?/interfaces/interface/ipv6/router advertisement/on link flag path /?/interfaces/interface/ipv6/router advertisement/on link flag node type leaf description the value to be placed in the on link flag ('l bit') field in the prefix information option access read write data type constraints valid in \[true, false] /?/interfaces/interface/ipv6/router advertisement/autonomous flag path /?/interfaces/interface/ipv6/router advertisement/autonomous flag node type leaf description the value to be placed in the autonomous flag field in the prefix information option access read write data type constraints valid in \[true, false] /?/interfaces/interface/ipv6/router advertisement/prefixes path /?/interfaces/interface/ipv6/router advertisement/prefixes node type list description support for an advertised prefix entry access read write /?/interfaces/interface/ipv6/router advertisement/prefixes/prefix path /?/interfaces/interface/ipv6/router advertisement/prefixes/prefix node type leaf description ipv6 address prefix access read write data type constraints the ipv6 prefix type represents an ipv6 prefix the prefix length is given by the number following the slash character and must be less than or equal to 128 a prefix length value of n corresponds to an ip address mask that has n contiguous 1 bits from the most significant bit (msb) and all other bits set to 0 the canonical format of an ipv6 prefix has all bits of the ipv6 address set to zero that are not part of the ipv6 prefix furthermore, the ipv6 address is represented as defined in section 4 of rfc 5952 the definition of ipv6 prefix does not require that bits, which are not part of the prefix, are set to zero however, implementations have to return values in canonical format, which requires non prefix bits to be set to zero this means that 2001\ db8 1/64 must be accepted as a valid value but it will be converted into the canonical format 2001\ db8 /64 /?/interfaces/interface/ipv6/router advertisement/rdnsses path /?/interfaces/interface/ipv6/router advertisement/rdnsses node type list description support for an advertised prefix entry access read write /?/interfaces/interface/ipv6/router advertisement/rdnsses/rdnss path /?/interfaces/interface/ipv6/router advertisement/rdnsses/rdnss node type leaf description ipv6 address access read write data type constraints an ipv6 address without a zone index this type, derived from the type ipv6 address, may be used in situations where the zone is known from the context and no zone index is needed /?/interfaces/interface/ipv6/router advertisement/routes path /?/interfaces/interface/ipv6/router advertisement/routes node type list description support for an advertised prefix entry access read write /?/interfaces/interface/ipv6/router advertisement/routes/route path /?/interfaces/interface/ipv6/router advertisement/routes/route node type leaf description ipv6 address prefix access read write data type constraints the ipv6 prefix type represents an ipv6 prefix the prefix length is given by the number following the slash character and must be less than or equal to 128 a prefix length value of n corresponds to an ip address mask that has n contiguous 1 bits from the most significant bit (msb) and all other bits set to 0 the canonical format of an ipv6 prefix has all bits of the ipv6 address set to zero that are not part of the ipv6 prefix furthermore, the ipv6 address is represented as defined in section 4 of rfc 5952 the definition of ipv6 prefix does not require that bits, which are not part of the prefix, are set to zero however, implementations have to return values in canonical format, which requires non prefix bits to be set to zero this means that 2001\ db8 1/64 must be accepted as a valid value but it will be converted into the canonical format 2001\ db8 /64 /?/interfaces/interface/ipv6/router advertisement/routes/preferred path /?/interfaces/interface/ipv6/router advertisement/routes/preferred node type leaf description the value to be placed in the route preference in the route information option the preference associated with the default router, as either 'low', 'medium', or 'high' access read write data type constraints enumeration with options low medium high rpcs show ipv4 neighbor summary path access /show ipv4 neighbor summary/output read write /show ipv4 neighbor summary/output/data read write /show ipv4 neighbor summary/output path /show ipv4 neighbor summary/output node type container description no description available access read write /show ipv4 neighbor summary/output/data path /show ipv4 neighbor summary/output/data node type anydata description dispaly summary info of ipv4 neighbors access read write show ipv6 neighbor summary path access /show ipv6 neighbor summary/input read write /show ipv6 neighbor summary/input/ip read write /show ipv6 neighbor summary/input/interface read write /show ipv6 neighbor summary/output read write /show ipv6 neighbor summary/output/data read write /show ipv6 neighbor summary/input path /show ipv6 neighbor summary/input node type container description no description available access read write /show ipv6 neighbor summary/input/ip path /show ipv6 neighbor summary/input/ip node type leaf description the ipv6 address of the neighbor node access read write data type constraints an ipv6 address without a zone index this type, derived from the type ipv6 address, may be used in situations where the zone is known from the context and no zone index is needed /show ipv6 neighbor summary/input/interface path /show ipv6 neighbor summary/input/interface node type leaf description the name of the interface needs to show ipv6 neighbors access read write data type constraints leafref pointing to asternos ip\ show ipv6 neighbor summary/% input/union/leafref /show ipv6 neighbor summary/output path /show ipv6 neighbor summary/output node type container description no description available access read write /show ipv6 neighbor summary/output/data path /show ipv6 neighbor summary/output/data node type anydata description dispaly summary info of ipv6 neighbors access read write
