📚 API Documentation & Navigation
📋 Module Metadata
Namespace: http://cisco.com/ns/yang/Cisco-IOS-XE-mobileip
Prefix: mobileip
Related Modules:
CISCO-AAL5-MIB
CISCO-ATM-EXT-MIB
Cisco-IOS-XE-aaa
Cisco-IOS-XE-acl
Cisco-IOS-XE-adsl
💡 Example Usage
# GET module data curl -X GET \ -H "Accept: application/yang-data+json" \ -u admin:password \ --insecure \ https://device-ip/restconf/data/Cisco-IOS-XE-mobileip
📚 External Documentation
module: Cisco-IOS-XE-mobileip
augment /ios:native/ios:ipv6:
+--rw mobile
+--rw pmipv6-domain* [domain]
| +--rw domain string
| +--rw domain-options
| +--rw auth-option
| | +--rw spi
| | +--rw (spi-option)?
| | | +--:(hex-val)
| | | | +--rw hex-val? string
| | | +--:(decimal)
| | | +--rw decimal? uint32
| | +--rw key
| | +--rw (key-options)?
| | +--:(key-opts)
| | | +--rw key-opts
| | | +--rw enc-type? uint8
| | | +--rw ascii? string
| | +--:(hex)
| | +--rw hex? string
| +--rw encap
| | +--rw encap_type? enumeration
| +--rw lma* [identifier]
| | +--rw identifier string
| | +--rw ipv4-address? inet:ipv4-address
| | +--rw ipv6-address? inet:ipv6-address
| +--rw local-routing-mag? empty
| +--rw mag* [identifier]
| | +--rw identifier string
| | +--rw ipv4-address? inet:ipv4-address
| | +--rw ipv6-address? inet:ipv6-address
| +--rw mn-profile-load-aaa? empty
| +--rw mobile-map* [map-name sequence]
| | +--rw map-name string
| | +--rw sequence uint8
| | +--rw ip
| | | +--rw df? uint8
| | +--rw loadbalance? empty
| | +--rw match
| | | +--rw access-list? string
| | +--rw setlink
| | | +--rw link-type
| | | +--rw link1? string
| | | +--rw link2? string
| | | +--rw link3? string
| | | +--rw link4? enumeration
| | +--rw traffic-profile
| | +--rw prof-name? string
| +--rw nai* [realm]
| | +--rw realm string
| | +--rw apn? string
| | +--rw auth-option
| | | +--rw spi
| | | +--rw (spi-option)?
| | | | +--:(hex-val)
| | | | | +--rw hex-val? string
| | | | +--:(decimal)
| | | | +--rw decimal? uint32
| | | +--rw key
| | | +--rw (key-options)?
| | | +--:(key-opts)
| | | | +--rw key-opts
| | | | +--rw enc-type? uint8
| | | | +--rw ascii? string
| | | +--:(hex)
| | | +--rw hex? string
| | +--rw customer? string
| | +--rw gre-encap-key
| | | +--rw down? uint32
| | | +--rw up? uint32
| | +--rw lma? string
| | +--rw mobility-service
| | | +--rw mobile-local-loop? empty
| | +--rw network? string
| | +--rw service
| | +--rw service-type? enumeration
| +--rw replay-protection
| +--rw timestamp
| +--rw window? uint8
+--rw pmipv6-lma* [lma-name domain]
| +--rw lma-name string
| +--rw domain string
| +--rw ani? empty
| +--rw bri
| | +--rw delay
| | | +--rw min? uint16
| | | +--rw max? uint16
| | +--rw retries? uint8
| +--rw generate
| | +--rw grekey? boolean
| +--rw heartbeat-default
| | +--rw heartbeat
| | +--rw interval? uint16
| | +--rw retries? uint8
| | +--rw timeout? uint16
| +--rw heartbeat* [label]
| | +--rw interval? uint16
| | +--rw retries? uint8
| | +--rw label string
| | +--rw natreboot? empty
| | +--rw timeout uint16
| +--rw ignore
| | +--rw grekey? empty
| | +--rw home-address? empty
| +--rw multipath? empty
| +--rw dscp
| | +--rw control-plane? uint8
| | +--rw force? empty
| +--rw address
| | +--rw ipv4* [address]
| | | +--rw address inet:ipv4-address
| | +--rw ipv6* [address]
| | +--rw address inet:ipv6-address
| +--rw mobile-route
| | +--rw admin-distance? uint8
| +--rw bce
| | +--rw create-wait-time? uint16
| | +--rw delete-wait-time? uint16
| | +--rw lifetime? uint16
| | +--rw maximum? uint32
| +--rw default
| | +--rw profile? string
| +--rw dynamic
| | +--rw mag
| | +--rw learning? empty
| +--rw enable
| | +--rw aaa
| | +--rw accounting? empty
| +--rw enforce
| | +--rw heartbeat-to-mag? empty
| +--rw interface* [interface-name]
| | +--rw interface-name string
| +--rw mobile-map? string
| +--rw mobile-network
| | +--rw mobile-network-type? enumeration
| +--rw rat* [rat-type]
| | +--rw rat-type enumeration
| | +--rw priority? uint8
| +--rw replay-protection
| | +--rw timestamp
| | +--rw window? union
| +--rw tunnel
| | +--rw acl? string
| | +--rw mtu? uint16
| +--rw mag* [mag-id domain-name]
| | +--rw mag-id string
| | +--rw domain-name string
| | +--rw auth-option
| | | +--rw spi
| | | +--rw (spi-option)?
| | | | +--:(hex-val)
| | | | | +--rw hex-val? string
| | | | +--:(decimal)
| | | | +--rw decimal? uint32
| | | +--rw key
| | | +--rw (key-options)?
| | | +--:(key-opts)
| | | | +--rw key-opts
| | | | +--rw enc-type? uint8
| | | | +--rw ascii? string
| | | +--:(hex)
| | | +--rw hex? string
| | +--rw dscp
| | | +--rw control-plane? uint8
| | | +--rw force? empty
| | +--rw encap
| | | +--rw (encap-type)?
| | | +--:(gre-ipv4)
| | | | +--rw gre-ipv4? empty
| | | +--:(gre-ipv6)
| | | +--rw gre-ipv6? empty
| | +--rw ipv4-address? inet:ipv4-address
| | +--rw ipv6-address? inet:ipv6-address
| +--rw network* [nw-name]
| | +--rw nw-name string
| | +--rw pool
| | | +--rw ipv4
| | | | +--rw name? string
| | | | +--rw pfxlen? uint8
| | | +--rw ipv6
| | | +--rw name? string
| | | +--rw pfxlen? uint8
| | +--rw mobile-network
| | | +--rw pool* [pool-ip-add]
| | | | +--rw pool-ip-add inet:ipv4-address
| | | | +--rw pool-prefix? uint8
| | | | +--rw network-prefix? uint8
| | | +--rw v6pool* [pool-ipv6-add]
| | | +--rw pool-ipv6-add inet:ipv6-address
| | | +--rw pool-prefix? uint8
| | | +--rw network-prefix? uint8
| | +--rw dns
| | +--rw ip
| | +--rw pri-ip-add? inet:ipv4-address
| | +--rw sec-ip-add? inet:ipv4-address
| +--rw mobility-service
| +--rw hybrid-access!
| | +--rw disable-sla? boolean
| | +--rw enable-sla* [sla-type name]
| | | +--rw sla-type enumeration
| | | +--rw name string
| | | +--rw frequency? uint32
| | | +--rw interval? uint16
| | | +--rw num-packets? uint32
| | +--rw sla
| | | +--rw frequency? uint32
| | | +--rw interval? uint16
| | | +--rw num-packets? uint32
| | +--rw bandwidth-ratio!
| | | +--rw label* [label-name]
| | | | +--rw label-name string
| | | | +--rw bandwidth-ratio? uint8
| | | +--rw mag* [mag-name]
| | | +--rw mag-name string
| | | +--rw label* [label-name]
| | | +--rw label-name string
| | | +--rw bandwidth-ratio? uint8
| | +--rw profile-definition* [name]
| | +--rw name string
| | +--rw loadbalance? empty
| | +--rw jitter
| | | +--rw value? uint16
| | | +--rw low-threshold? uint16
| | +--rw mos
| | | +--rw value? uint16
| | | +--rw low-threshold? uint16
| | +--rw packet-loss
| | | +--rw value? uint16
| | | +--rw low-threshold? uint16
| | +--rw rtt
| | +--rw value? uint16
| | +--rw low-threshold? uint16
| +--rw mobile-local-loop!
| +--rw customer* [name vrf]
| | +--rw name string
| | +--rw vrf string
| | +--rw auth-option
| | | +--rw spi
| | | +--rw (spi-option)?
| | | | +--:(hex-val)
| | | | | +--rw hex-val? string
| | | | +--:(decimal)
| | | | +--rw decimal? uint32
| | | +--rw key
| | | +--rw (key-options)?
| | | +--:(key-opts)
| | | | +--rw key-opts
| | | | +--rw enc-type? uint8
| | | | +--rw ascii? string
| | | +--:(hex)
| | | +--rw hex? string
| | +--rw gre-key-default
| | | +--rw gre-key
| | | +--rw symmetric? uint32
| | +--rw gre-key* [label]
| | | +--rw symmetric? uint32
| | | +--rw label string
| | +--rw heartbeat-default
| | | +--rw heartbeat
| | | +--rw interval? uint16
| | | +--rw retries? uint8
| | | +--rw timeout? uint16
| | +--rw interface* [interface-name]
| | | +--rw interface-name string
| | +--rw mnp
| | | +--rw afi-all
| | | | +--rw customer
| | | | | +--rw maximum? uint32
| | | | +--rw logical-mn
| | | | +--rw maximum? uint8
| | | +--rw ipv4
| | | | +--rw customer
| | | | | +--rw maximum? uint32
| | | | +--rw logical-mn
| | | | +--rw maximum? uint8
| | | +--rw ipv6
| | | +--rw customer
| | | | +--rw maximum? uint32
| | | +--rw logical-mn
| | | +--rw maximum? uint8
| | +--rw mobile-map? string
| | +--rw mobile-route
| | | +--rw admin-distance? uint8
| | +--rw network
| | | +--rw authorized* [name]
| | | | +--rw name string
| | | | +--rw mobile-network
| | | | | +--rw pool* [pool-ip-add]
| | | | | | +--rw pool-ip-add inet:ipv4-address
| | | | | | +--rw pool-prefix? uint8
| | | | | | +--rw network-prefix? uint8
| | | | | +--rw v6pool* [pool-ipv6-add]
| | | | | +--rw pool-ipv6-add inet:ipv6-address
| | | | | +--rw pool-prefix? uint8
| | | | | +--rw network-prefix? uint8
| | | | +--rw pool
| | | | +--rw ipv4
| | | | | +--rw name? string
| | | | | +--rw pfxlen? uint8
| | | | +--rw ipv6
| | | | +--rw name? string
| | | | +--rw pfxlen? uint8
| | | +--rw unauthorized? empty
| | +--rw transport-default
| | | +--rw transport!
| | | +--rw ipv4-address? inet:ipv4-address
| | | +--rw ipv6-address? inet:ipv6-address
| | +--rw transport-vrf
| | +--rw transport* [vrf-name]
| | +--rw vrf-name string
| | +--rw ipv4-address? inet:ipv4-address
| | +--rw ipv6-address? inet:ipv6-address
| +--rw mnp
| +--rw afi-all
| | +--rw customer
| | | +--rw maximum? uint32
| | +--rw logical-mn
| | +--rw maximum? uint8
| +--rw ipv4
| | +--rw customer
| | | +--rw maximum? uint32
| | +--rw logical-mn
| | +--rw maximum? uint8
| +--rw ipv6
| +--rw customer
| | +--rw maximum? uint32
| +--rw logical-mn
| +--rw maximum? uint8
+--rw pmipv6-mag* [mag-name domain]
+--rw mag-name string
+--rw domain string
+--rw address
| +--rw dynamic!
| | +--rw roaming* [interface]
| | +--rw interface string
| | +--rw priority? uint8
| | +--rw egress-att? enumeration
| | +--rw label? string
| +--rw static
| +--rw ipv4? inet:ipv4-address
| +--rw ipv6? inet:ipv6-address
+--rw apn? string
+--rw binding
| +--rw lifetime? uint16
| +--rw init-retx-time? uint16
| +--rw max-retx-time? uint16
| +--rw maximum? uint32
| +--rw refresh-time? uint32
+--rw sessionmgr? boolean
+--rw discover-mn-detach
| +--rw poll
| +--rw interval? uint16
| +--rw timeout? uint8
| +--rw retries? uint8
+--rw ssmo-format
| +--rw label? empty
+--rw tunnel
| +--rw mtu? uint16
| +--rw nat? enumeration
+--rw tunnel-template-only
| +--rw tunnel-template
| +--rw Tunnel? string
+--rw multipath? empty
+--rw mobile-map? string
+--rw interface* [interface-name]
| +--rw interface-name string
+--rw mobility-service
| +--rw hybrid-access!
| | +--rw disable-sla? boolean
| | +--rw sla
| | | +--rw frequency? uint32
| | | +--rw interval? uint16
| | | +--rw num-packets? uint32
| | +--rw sla-responder-stats
| | | +--rw disable? empty
| | +--rw bandwidth-ratio!
| | | +--rw label* [label-name]
| | | +--rw label-name string
| | | +--rw bandwidth-ratio? uint8
| | +--rw profile-definition
| | +--rw profile-definition* [name]
| | +--rw name string
| | +--rw loadbalance? empty
| | +--rw jitter
| | | +--rw value? uint16
| | | +--rw low-threshold? uint16
| | +--rw mos
| | | +--rw value? uint16
| | | +--rw low-threshold? uint16
| | +--rw packet-loss
| | | +--rw value? uint8
| | | +--rw low-threshold? uint8
| | +--rw rtt
| | +--rw value? uint16
| | +--rw low-threshold? uint16
| +--rw mobile-local-loop!
| +--rw ignore
| | +--rw home-address? empty
| +--rw reverse-tunnel
| | +--rw default-route? empty
| | +--rw value? uint8
| +--rw egress
| +--rw interface? string
+--rw logical-mn* [mn-id]
| +--rw mn-id string
| +--rw home
| | +--rw interface? string
| +--rw mobile
| | +--rw network* [interface]
| | +--rw interface string
| | +--rw label? string
| | +--rw learn-prefix? empty
| | +--rw skip-register? empty
| +--rw address
| | +--rw dynamic? empty
| +--rw fixed
| | +--rw interface? string
| | +--rw watch
| | +--rw ipv4? inet:ipv4-address
| | +--rw length? uint8
| +--rw mobile-map? string
| +--rw service
| | +--rw (service-types)?
| | +--:(dual)
| | | +--rw dual? empty
| | +--:(ipv6)
| | | +--rw ipv6? empty
| | +--:(ipv4)
| | +--rw ipv4? empty
| +--rw reverse-tunnel
| +--rw route
| +--rw ipv4* [address prefix-len]
| | +--rw address inet:ipv4-address
| | +--rw prefix-len uint8
| | +--rw distance-metric? uint8
| +--rw ipv6* [address prefix-len]
| +--rw address inet:ipv6-address
| +--rw prefix-len uint8
| +--rw distance-metric? uint8
+--rw local-routing-mag!
| +--rw acl-name? string
+--rw role? enumeration
+--rw replay-protection
| +--rw timestamp
| +--rw window? uint8
+--rw heartbeat-default
| +--rw heartbeat
| +--rw interval? uint16
| +--rw retries? uint8
| +--rw timeout? uint16
+--rw heartbeat* [label]
| +--rw interval? uint16
| +--rw retries? uint8
| +--rw label string
| +--rw natreboot? empty
| +--rw timeout uint16
+--rw ani? empty
+--rw bri
| +--rw delay
| | +--rw min? uint16
| | +--rw max? uint16
| +--rw retries? uint8
+--rw dscp
| +--rw control-plane? uint8
| +--rw force? empty
+--rw generate
| +--rw grekey? boolean
+--rw ignore
| +--rw grekey? empty
| +--rw home-address? empty
+--rw lma* [lma-id domain]
+--rw lma-id string
+--rw domain string
+--rw auth-option
| +--rw spi
| +--rw (spi-option)?
| | +--:(hex-val)
| | | +--rw hex-val? string
| | +--:(decimal)
| | +--rw decimal? uint32
| +--rw key
| +--rw (key-options)?
| +--:(key-opts)
| | +--rw key-opts
| | +--rw enc-type? uint8
| | +--rw ascii? string
| +--:(hex)
| +--rw hex? string
+--rw dscp
| +--rw control-plane? uint8
| +--rw force? empty
+--rw heartbeat-default
| +--rw heartbeat
| +--rw interval? uint16
| +--rw retries? uint8
| +--rw timeout? uint16
+--rw ipv4-address* inet:ipv4-address
+--rw ipv6-address* inet:ipv6-address
+--rw encap
| +--rw (encap-type)?
| +--:(gre-ipv4)
| | +--rw gre-ipv4? empty
| +--:(gre-ipv6)
| +--rw gre-ipv6? empty
+--rw vrfid? string
+--rw tunnel-template-only
| +--rw tunnel-template
| +--rw Tunnel? string
+--rw tunnel-template* [label]
+--rw Tunnel? string
+--rw label string