XML Support for BNG Features
Most BNG features, such as AAA, DHCP, Policy Plane, PPPoE, DAPS, and Subscriber Database support XML based router configuration. The Cisco XML API can be used to configure routers or request information about configuration, management, and operation of the routers. For details about using the Cisco XML API, see the latest release of Cisco IOS XR XML API Guide listed at http://www.cisco.com/en/US/products/ps9853/ products_programming_reference_guides_list.html. The Cisco XML API uses XML commands to configure the router. The following sections list the supported XML commands for the BNG features. • AAA XML Support, on page 1 • DHCP XML Support, on page 4 • Control Policy XML Support, on page 7 • DAPS XML Support, on page 10 • PPPoE XML Support, on page 11 • Subscriber Database XML Support, on page 13 AAA XML Support The support for XML is available for RADIUS that retrieves the accounting and authorization request statistics. The mapping between CLI and XML entries for the AAA commands are as follows:
CLI XML
radius-server AAA.RADIUS. DeadCriteria.Time dead-criteria time
radius-server AAA.RADIUS. DeadCriteria.Tries dead-criteria tries
radius-server ipv4 AAA.RADIUS. IPv4.DSCP dscp
radius-server key AAA.RADIUS.Key {0 | 7 | LINE}
radius-server AAA.RADIUS.Retransmit retransmit
XML Support for BNG Features 1 XML Support for BNG Features XML Support for BNG Features
CLI XML
radius-server AAA.RADIUS.Timeout timeout
radius-server AAA.RADIUS.SourcePort.Extended source-port extended
radius-server AAA.RADIUS.DeadTime deadtime
radius-server AAA.RADIUS.LoadBalance.Method.LeastOutstanding load-balance method least-outstanding
radius-server AAA.RADIUS.AttributeListTable.AttributeList.Enable attribute list
radius-server AAA.RADIUS.AttributeListTable.AttributeList.Attribute attribute list
radius-server vsa AAA.RADIUS.VSA.Attribute.Ignore.Unknown attribute ignore unknown
Radius-server host AAA.RADIUS.HostTable.Host.Retransmit <> retransmit
Radius-server host AAA.RADIUS.HostTable.Host.Timeout <> timeout
radius-server host AAA.RADIUS.HostTable.Host.Key <> key {0 | 7 | LINE}
aaa server radius AAA.RADIUS.DynamicAuthorization.ClientTable.Client.ServerKey dynamic-author client
aaa server radius AAA.RADIUS.DynamicAuthorization.Ignore dynamic-author ignore {server key | session key }
aaa server radius AAA.RADIUS.DynamicAuthorization.Port dynamic-author port
XML Support for BNG Features 2 XML Support for BNG Features XML Support for BNG Features
CLI XML
aaa accounting AAA.AccountingTable.Accounting system default start-stop [broadcast] {group {radius | NAME1}} [group NAME2..] aaa accounting system rp-failover default start-stop [broadcast] {group {radius | NAME1}} [group NAME2..
aaa radius AAA.RADIUSAttribute.NASPortID.Format attribute nas-port-id format FORMAT_NAME
aaa group server AAA.ServerGroups.RADIUSServerGroupTable.RADIUSServerGroup.Authorization.Reply radius
aaa group server AAA.ServerGroups.RADIUSServerGroupTable.RADIUSServerGroup.Authorization.Request radius
aaa group server AAA.ServerGroups.RADIUSServerGroupTable.RADIUSServerGroup.Accounting.Request radius
aaa group server AAA.ServerGroups.RADIUSServerGroupTable.RADIUSServerGroup.Accounting.Reply radius
aaa group server AAA.ServerGroups.RADIUSServerGroupTable.RADIUSServerGroup.LoadBalance.Method. radius LeastBounding
XML Support for BNG Features 3 XML Support for BNG Features DHCP XML Support
CLI XML method least-bounding
aaa group server AAA.ServerGroups.RADIUSServerGroupTable.RADIUSServerGroup.SourceInterface radius group1 source-interface
aaa group server AAA.ServerGroups.RADIUSServerGroupTable.RADIUSServerGroup.VRF radius
aaa group server AAA.ServerGroups.RADIUSServerGroupTable.RADIUSServerGroup.DeadTime radius
aaa group server AAA.ServerGroups.RADIUSGroupTable.RADIUSGroup.PrivateServerTable.PrivateServer radius <> server-private
show radius RADIUS.Accounting accounting
show radius RADIUS.Authentication authentication
show radius client RADIUS.Client
show radius RADIUS.DynamicAuthorization dynamic-author
show radius RADIUS.DeadCriteria.HostTable.Host dead-criteria host
show radius RADIUS.ServerGroups server-groups
DHCP XML Support The support for XML is available for DHCP that retrieves the client bindings, profile information, and DHCPv4 proxy statistics. It allows the management clients to perform client bindings based on Circuit-ID, Remote-ID, Mac-Address, user profile information, and DHCPv4 proxy statistics. The mapping between CLI and XML entries for the DHCP commands are as follows:
CLI XML
dhcp ipv4 profile DHCPv4.ProfileTable.Profile.Proxy.RelayInformation.Check
XML Support for BNG Features 4 XML Support for BNG Features XML Support for BNG Features
CLI XML
dhcp ipv4 profile DHCPv4.ProfileTable.Profile.Proxy.RelayInformation.AllowUntrusted
dhcp ipv4 DHCPv4.InterfaceTable.Interface.Proxy.Profile interface GigabitEthernet
dhcp ipv4 profile DHCPv4.ProfileTable.Profile.Proxy.RelayInformation.Policy
dhcp ipv4 profile DHCPv4.ProfileTable.Profile.Proxy.VRFTable.VRF.HelperAddressTable.HelperAddress
dhcp ipv4 profile DHCPv4.ProfileTable.Profile.Proxy.BroadcastFlag.Policy
dhcp ipv4 profile DHCPv4.ProfileTable.Profile.Proxy.ClassTable.Class
dhcp ipv4 DHCPv4.InterfaceTable.Interface.None interface
XML Support for BNG Features 5 XML Support for BNG Features XML Support for BNG Features
CLI XML
dhcp ipv4 DHCPv4.InterfaceTable.Interface.Proxy.CircuitID interface
dhcp ipv4 vrf DHCPv4.VRFTable.VRF vrfname proxy profile
show dhcp ipv4 DHCPv4.NodeTable.Node.Proxy.Binding.ClientTable[DHCPv4ProxyCircuitIDFilter(Naming CircuitID)] proxy binding circuit-id
show dhcp ipv4 DHCPv4.NodeTable.Node.Proxy.Binding.ClientTable[DHCPv4ProxyRemoteIDFilter(Naming RemoteID)] proxy binding remote-id
show dhcp ipv4 DHCPv4.NodeTable.Node.Proxy.Binding.ClientTable[DHCPv4ProxyInterfaceFilter(Naming InterfaceName)] proxy binding interface
show dhcp ipv4 DHCPv4.NodeTable.Node.Proxy.Binding.ClientTable[DHCPv4ProxyMACAddressFilter(Naming MACAddress)] proxy binding mac-address
show dhcp ipv4 DHCPv4.NodeTable.Node.Proxy.Binding.ClientTable[DHCPv4ProxyBriefFilter] proxy binding location
show dhcp ipv4 DHCPv4.NodeTable.Node.Proxy.Binding.ClientTable.Client proxy binding detail location
show dhcp ipv4 DHCPv4.NodeTable.Node.Proxy.Binding.Summary proxy binding summary location
show dhcp ipv4 DHCPv4.NodeTable.Node.Proxy.Binding.ClientTable[DHCPv4PProxyVRFFilter(Naming VRFName)] proxy binding vrf
XML Support for BNG Features 6 XML Support for BNG Features Control Policy XML Support
CLI XML
show dhcp ipv4 DHCPv4.NodeTable.Node.Proxy.ProfileTable.Profile proxy profile name
show dhcp vrf DHCPv4.NodeTable.Node.Proxy.VRFTable.VRF.Statistics
show dhcp ipv4 DHCPv4.NodeTable.Node.Proxy.Statistics proxy statistics [ location < loc > ]
Control Policy XML Support The support for XML is available for policy plane that retrieves subscriber management and subscriber session related information. The mapping between CLI and XML entries for the control policy commands are as follows:
CLI XML
interface InterfaceConfigurationTable.InterfaceConfiguration.ControlSubscriber.ServicePolicy
sh sub sess all Subscriber.Session.NodeTable.Node.SessionTable loc
sh sub sess all Subscriber.Session.NodeTable.Node.SessionTable(SubscriberDetailAllSessionFilter) detail loc
sh sub sess all Subscriber.Session.NodeTable.Node.Summary summary loc
sh sub sess all Subscriber.Session.NodeTable.Node.SessionTable(SubscriberAllUsenameFilter) username loc
sh sub sess Subscriber.Session.NodeTable.Node.SessionTable(SubscriberInterfaceBriefFilter) {Naming filter InterfaceName} interface
XML Support for BNG Features 7 XML Support for BNG Features XML Support for BNG Features
CLI XML
sh sub sess Subscriber.Session.NodeTable.Node.SessionTable(SubscriberInterfaceDetailFilter) filter {Naming InterfaceName} interface
sh sub sess Subscriber.Session.NodeTable.Node.SessionTable(SubscriberIPv4AddressVRFDetailFilter) filter {Naming VRF Name, Address} ipv4-address
sh sub sess Subscriber.Session.NodeTable.Node.SessionTable(SubscriberIPv4AddressVRFBriefFilter) filter {Naming VRF Name, Address} ipv4-address
sh sub sess Subscriber.Session.NodeTable.Node.SessionTable(SubscriberMACAddressBriefFilter) filter {Naming MACAddress} mac-address
sh sub sess Subscriber.Session.NodeTable.Node.SessionTable(SubscriberMACAddressDetailFilter) filter {Naming MACAddress} mac-address
sh sub sess Subscriber.Session.NodeTable.Node.SessionTable(SubscriberStateBriefFilter) {Naming filter state State}
sh sub sess Subscriber.Session.NodeTable.Node.SessionTable(SubscriberStateDetailFilter) {Naming filter state State}
sh sub sess Subscriber.Session.NodeTable.Node.SessionTable(SubscriberUsernameBriefFilter) {Naming filter Username} username
sh sub sess Subscriber.Session.NodeTable.Node.SessionTable(SubscriberUsernameDetailFilter) {Naming filter Username}
XML Support for BNG Features 8 XML Support for BNG Features XML Support for BNG Features
CLI XML username
sh sub sess Subscriber.Session.NodeTable.Node.SessionTable(SubscriberIPv4AddressVRFBriefFilter) filter {Naming VRF Name, Address} ipv4-address
sh sub sess Subscriber.Session.NodeTable.Node.SessionTable(SubscriberIPv4AddressVRFDetailFilter) filter {Naming VRF Name, Address} ipv4-address
sh sub sess Subscriber.Session.NodeTable.Node.SessionTable(SubscriberIPv4AddressVRFBriefFilter) filter vrf {Naming VRF Name, Address }
sh sub sess Subscriber.Session.NodeTable.Node.SessionTable(SubscriberIPv4AddressVRFDetailFilter) filter vrf {Naming VRF Name, Address }
sh sub sess Subscriber.Session.NodeTable.Node.SessionTable.Session{Naming SessionID} sub-label <0-ffffffff> loc
sh sub man Subscriber.Manager.NodeTable.Node.Statistics.AAA.Accounting stat AAA accounting loc
sh sub man Subscriber.Manager.NodeTable.Node.Statistics.AAA.AggregateAccounting stat AAA accounting total loc
sh sub man Subscriber.Manager.NodeTable.Node.Statistics.AAA.Authentication stat AAA authentication loc
sh sub man Subscriber.Manager.NodeTable.Node.Statistics.AAA.AggregateAuthentication stat AAA
XML Support for BNG Features 9 XML Support for BNG Features DAPS XML Support
CLI XML authentication total loc
sh sub man Subscriber.Manager.NodeTable.Node.Statistics.AAA.Authorization stat AAA authorization loc
sh sub man Subscriber.Manager.NodeTable.Node.Statistics.AAA.AggregateAuthorization stat AAA authorization total loc
sh sub man Subscriber.Manager.NodeTable.Node.Statistics.AAA.ChangeOfAuthorization stat AAA COA loc
sh sub man Subscriber.Manager.NodeTable.Node.Statistics.AAA.AggregateChangeOfAuthorization stat AAA COA total loc
sh sub man Subscriber.Manager.NodeTable.Node.Statistics.AAA stat AAA all loc
sh sub man Subscriber.Manager.NodeTable.Node.Statistics.AAA stat AAA all total loc
sh sub man Subscriber.Manager.NodeTable.Node.Statistics.AggregateSummary stats summary total
DAPS XML Support The support for XML is available for distributed address pool service (DAPS) that retrieves the pool parameters for distributed address pool services, and allows the management clients to get number of free, allocated and excluded addresses based on VRF and pool name. The mapping between CLI and XML entries for the DAPS commands are as follows:
CLI XML
pool vrf
pool vrf
XML Support for BNG Features 10 XML Support for BNG Features PPPoE XML Support
CLI XML
pool vrf
Pool vrf
Pool vrf
show pool vrf
show pool ipv4 name
show pool ipv4 name
show pool ipv4show pool vrf all ipv4 PoolService.NodeTable.Node.VRFTable
PPPoE XML Support XML support is available for PPP over Ethernet (PPPoE) sessions. The mapping between CLI and XML entries for the PPPoE feature commands are:
CLI XML
pado delay {
pado delay circuit-id {
pado delay remote-id {
pado delay circuit-id string {
pado delay circuit-id contains {
pado delay remote-id string {
pado delay remote-id contains {
pado delay service-name string {
pado delay service-name contains set PadoDelay.ServiceNameSubString{
pppoe session-id space flat set SessionIDSpaceFlat {TRUE}
pppoe bba-group {
XML Support for BNG Features 11 XML Support for BNG Features XML Support for BNG Features
CLI XML
pppoe enable bba-group {
ac name {
service name {
service selection disable set Tags.ServiceSelectionDisable
tag ppp-max-payload deny set Tags.PPPMaxPayloadDeny
tag ppp-max-payload minimum {
mtu {
sessions max limit {limit} threshold set Sessions.MaxLimit {
sessions access-interface limit {
sessions mac limit {
sessions mac-iwf limit {
sessions mac access-interface limit set Sessions.MacAccessInterfaceLimit {
sessions mac-iwf access-interface limit set Sessions.MacIWFAccessInterfaceLimit {
sessions circuit-id limit {
sessions remote-id limit {
sessions circuit-id-and-remote-id limit set Sessions.CircuitIDAndRemoteIDLimit {
sessions inner-vlan limit {
sessions mac throttle {
sessions mac access-interface throttle set Sessions.MacAccessInterfaceThrottle {
sessions mac-iwf access-interface throttle set Sessions.MacIWFAccessInterfaceThrottle {
sessions circuit-id throttle set Sessions.CircuitIDThrottle {
XML Support for BNG Features 12 XML Support for BNG Features Subscriber Database XML Support
CLI XML
sessions remote-id throttle set Sessions.RemoteIDThrottle {
sessions circuit-id-and-remote-id throttle set Sessions.CircuitIDAndRemoteIDThrottle {
sessions inner-vlan throttle set Sessions.InnerVLANThrottle {
control-packets priority {
invalid-session-id drop set InvalidSessionID {DROP}
invalid-session-id log set InvalidSessionID {LOG}
Subscriber Database XML Support The support for XML is available for subscriber database that retrieves the subscriber association and session information and allows the management clients to get subscriber session state, subscriber session information based on unique subscriber label, subscriber association information based on unique subscriber label or interface name or dynamic template name or type. The mapping between CLI and XML entries for the subscriber database commands are as follows:
CLI XML
show subscriber database Subscriber.Database.NodeTable.Node.Association.LabelTable.Label{Naming association br location <> SubscriberLabel}
show subscriber database Subscriber.Database.NodeTable.Node.Association.LabelTable.Label{Naming association subscriber-label SubscriberLabel} <> br location<>
show subscriber database Subscriber.Database.NodeTable.Node.Association(SubscriberDatabaseLabelDetailFilter) association location <>
show subscriber database Subscriber.Database.NodeTable.Node.Association(SubscriberDatabaseInterfaceBriefFilter){Naming association interface-name InterfaceName} <> br location<>
show subscriber database Subscriber.Database.NodeTable.Node.Association(SubscriberDatabaseInterfaceFilter){Naming association interface-name InterfaceName} <> location<>
show subscriber database Subscriber.Database.NodeTable.Node.Association(SubscriberDatabaseTemplateTypeBriefFilter){Naming association type < TemplateType} ipsubscriber |ppp |service-profile |subscriber-service> br location <>
XML Support for BNG Features 13 XML Support for BNG Features XML Support for BNG Features
CLI XML
show subscriber database Subscriber.Database.NodeTable.Node.Association(SubscriberDatabaseTemplateTypeFilter){Naming association type < TemplateType} ipsubscriber |ppp |service-profile |subscriber-service> location <>
show subscriber database Subscriber.Database.NodeTable.Node.Session(SubscriberDatabaseSessionStateFilter){Naming session state
show subscriber database Subscriber.Database.NodeTable.Node.Session.LabelTable.Label{Naming session subscriber-label <> SubscriberLabel} location <>
association subscriber-label Subscriber.Database.NodeTable.Node.Association.LabelTable.Label <0x0-0xffffffff> brief location R/S/M
association subscriber-label Subscriber.Database.NodeTable.Node.Association.LabelTable.Label <0x0-0xffffffff> brief
association subscriber-label Subscriber.Database.NodeTable.Node.Association.LabelTable.Label <0x0-0xffffffff> location R/S/M
association subscriber-label Subscriber.Database.NodeTable.Node.Association.LabelTable.Label <0x0-0xffffffff>
association interface-name Subscriber.Database.NodeTable.Node.Association[SubscriberInterfaceBriefFilter(Naming
association interface-name Subscriber.Database.NodeTable.Node.Association[SubscriberInterfaceBriefFilter(Naming
association interface-name Subscriber.Database.NodeTable.Node.Association[SubscriberInterfaceFilter(Naming
association interface-name Subscriber.Database.NodeTable.Node.Association[SubscriberInterfaceFilter(Naming
association type ppp brief Subscriber.Database.NodeTable.Node.Association[SubscriberTemplateType(Naming location R/S/M TemplateType]
association type ppp brief Subscriber.Database.NodeTable.Node.Association[SubscriberTemplateType(Naming TemplateType]
association type ppp Subscriber.Database.NodeTable.Node.Association[SubscriberTemplateType(Naming location R/S/M TemplateType]
association type ppp Subscriber.Database.NodeTable.Node.Association[SubscriberTemplateType(Naming TemplateType]
XML Support for BNG Features 14 XML Support for BNG Features XML Support for BNG Features
CLI XML
association type Subscriber.Database.NodeTable.Node.Association[SubscriberTemplateType(Naming ipsubscriber brief location TemplateType] R/S/M
association type Subscriber.Database.NodeTable.Node.Association[SubscriberTemplateType(Naming ipsubscriber brief TemplateType]
association type Subscriber.Database.NodeTable.Node.Association[SubscriberTemplateType(Naming ipsubscriber location R/S/M TemplateType]
association type Subscriber.Database.NodeTable.Node.Association[SubscriberTemplateType(Naming ipsubscriber TemplateType]
association type Subscriber.Database.NodeTable.Node.Association[SubscriberTemplateType(Naming subscriber-service brief TemplateType] location R/S/M
association type Subscriber.Database.NodeTable.Node.Association[SubscriberTemplateType(Naming subscriber-service brief TemplateType]
association type Subscriber.Database.NodeTable.Node.Association[SubscriberTemplateType(Naming subscriber-service location TemplateType] R/S/M
association type Subscriber.Database.NodeTable.Node.Association[SubscriberTemplateType(Naming subscriber-service TemplateType]
association type Subscriber.Database.NodeTable.Node.Association[SubscriberTemplateType(Naming service-profile brief TemplateType] location R/S/M
association type Subscriber.Database.NodeTable.Node.Association[SubscriberTemplateType(Naming service-profile brief TemplateType]
association type Subscriber.Database.NodeTable.Node.Association[SubscriberTemplateType(Naming service-profile location TemplateType] R/S/M
association type Subscriber.Database.NodeTable.Node.Association[SubscriberTemplateType(Naming service-profile TemplateType]
association type user-profile Subscriber.Database.NodeTable.Node.Association[SubscriberTemplateType(Naming brief location R/S/M TemplateType]
association type user-profile Subscriber.Database.NodeTable.Node.Association[SubscriberTemplateType(Naming brief TemplateType]
association type user-profile Subscriber.Database.NodeTable.Node.Association[SubscriberTemplateType(Naming location R/S/M TemplateType]
association type user-profile Subscriber.Database.NodeTable.Node.Association[SubscriberTemplateType(Naming TemplateType]
association brief location Subscriber.Database.NodeTable.Node.Association.LabelTable.Label R/S/M
association brief Subscriber.Database.NodeTable.Node.Association.LabelTable.Label
XML Support for BNG Features 15 XML Support for BNG Features XML Support for BNG Features
CLI XML
association location R/S/M Subscriber.Database.NodeTable.Node.Association.LabelTable.Label
association Subscriber.Database.NodeTable.Node.Association.LabelTable.Label
session subscriber-label Subscriber.Database.NodeTable.Node.Session.LabelTable.Label <0x0-0xffffffff> location R/S/M
session subscriber-label Subscriber.Database.NodeTable.Node.Session.LabelTable.Label <0x0-0xffffffff>
session state init location Subscriber.Database.NodeTable.Node.Session[SubscriberSessionStateFilter(Naming R/S/M State]
session state init Subscriber.Database.NodeTable.Node.Session[SubscriberSessionStateFilter(Naming State]
session state destroying Subscriber.Database.NodeTable.Node.Session[SubscriberSessionStateFilter(Naming location R/S/M State]
session state destroying Subscriber.Database.NodeTable.Node.Session[SubscriberSessionStateFilter(Naming State]
session state cfggen location Subscriber.Database.NodeTable.Node.Session[SubscriberSessionStateFilter(Naming R/S/M State]
session state cfggen Subscriber.Database.NodeTable.Node.Session[SubscriberSessionStateFilter(Naming State]
session state fatgen location Subscriber.Database.NodeTable.Node.Session[SubscriberSessionStateFilter(Naming R/S/M State]
session state fatgen Subscriber.Database.NodeTable.Node.Session[SubscriberSessionStateFilter(Naming State]
session state cfgapply Subscriber.Database.NodeTable.Node.Session[SubscriberSessionStateFilter(Naming location R/S/M State]
session state cfgapply Subscriber.Database.NodeTable.Node.Session[SubscriberSessionStateFilter(Naming State]
session state cfgdone Subscriber.Database.NodeTable.Node.Session[SubscriberSessionStateFilter(Naming location R/S/M State]
session state cfgdone Subscriber.Database.NodeTable.Node.Session[SubscriberSessionStateFilter(Naming State]
session state cfgunapply Subscriber.Database.NodeTable.Node.Session[SubscriberSessionStateFilter(Naming location R/S/M State]
session state cfgunapply Subscriber.Database.NodeTable.Node.Session[SubscriberSessionStateFilter(Naming State]
session state cfgerror Subscriber.Database.NodeTable.Node.Session[SubscriberSessionStateFilter(Naming location R/S/M State]
session state cfgerror Subscriber.Database.NodeTable.Node.Session[SubscriberSessionStateFilter(Naming State]
XML Support for BNG Features 16 XML Support for BNG Features XML Support for BNG Features
CLI XML
session state error location Subscriber.Database.NodeTable.Node.Session[SubscriberSessionStateFilter(Naming R/S/M State]
session state error Subscriber.Database.NodeTable.Node.Session[SubscriberSessionStateFilter(Naming State]
session state sync location Subscriber.Database.NodeTable.Node.Session[SubscriberSessionStateFilter(Naming R/S/M State]
session state sync Subscriber.Database.NodeTable.Node.Session[SubscriberSessionStateFilter(Naming State]
session state all location Subscriber.Database.NodeTable.Node.Session[SubscriberSessionStateFilter(Naming R/S/M State]
session state all Subscriber.Database.NodeTable.Node.Session[SubscriberSessionStateFilter(Naming State]
XML Support for BNG Features 17 XML Support for BNG Features XML Support for BNG Features
XML Support for BNG Features 18