Cisco ASR 9000 Series Aggregation Services Router Broadband Network Gateway Command Reference, Release 4.2.x
Address Pool Service Commands
Downloads: This chapterpdf (PDF - 1.35MB) The complete bookPDF (PDF - 3.6MB) | Feedback

Address Pool Service Commands

Address Pool Service Commands

This chapter describes the Cisco IOS XR software Address Pool Service commands for Broadband Network Gateway (BNG). For details regarding related configurations, refer to the Cisco ASR 9000 Series Aggregation Services Router Broadband Network Gateway Configuration Guide.

address-range

To specify address range for allocation, use the address-range command in Pool IPv4 configuration submode. To remove the address range, use the no form of this command.

address-range first_range last_range

no address-range first_range last_range

Syntax Description

first_range

Specifies the first address in range from which the IP addresses can be assigned to clients.

last_range

Specifies the last address in range until which the IP addresses can be assigned to clients.

Command Default

None

Command Modes

Pool IPv4 configuration

Command History

Release Modification

Release 4.2.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

You should only specify the addresses that are assignable to clients in a particular subnet. The interface and broadcast addresses should not be included in the address-range configuration.

Use the pool ipv4 command to enter IPv4 pool configuration submode.

Multiple address-ranges are allowed within a pool.

Task ID

Task ID Operation

ip-services

read, write

Examples

This is an example of configuring the address-range command for IPv4 in the global configuration mode:

RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# pool vrf vrf1 ipv4 pool2
RP/0/RSP0/CPU0:router(config-pool-ipv4)# address-range 11.11.11.11 14.14.14.14

Related Commands

Command

Description

pool ipv4

Enables distributed address pool service on ipv4.

pool vrf

Enables distributed address pool service on vrf.

exclude

Specifies a range of IP addresses that distributed address pool service should not assign to clients.

exclude

To specify a range of IPv4 addresses that distributed address pool service (DAPS) must not assign to clients, use the exclude command in Pool IPv4 configuration submode. To remove the excluded IP addresses, use the no form of this command.

exclude { first_address | last_address }

no exclude { first_address | last_address }

Syntax Description

first_address

Specifies the first address in the range that needs to be excluded for IPv4 and specifies the first address or prefix in the range for IPv6.

last_address

Specifies the last address in the range that needs to be excluded and specifies the last address or prefix in the range for IPv6.

Command Default

None

Command Modes

Pool IPv4 configuration

Command History

Release Modification

Release 4.2.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the pool ipv4 command to enter IPv4 pool configuration submode.

The low IP address cannot overlap with the IP address of a reserved address command. Multiple exclude commands are allowed within a pool. To exclude a single address, <highIpAddress> can be omitted.


Note


The exclude command can be configured along with the network, address-range, and the prefix-range commands.


Task ID

Task ID Operation

ip-services

read, write

Examples

This is an example to configure the exclude command for IPv4:

RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# pool vrf vrf1 ipv4 pool2
RP/0/RSP0/CPU0:router(config-pool-ipv4)# exclude 10.10.10.1 10.10.10.10 

Related Commands

Command

Description

pool ipv4

Enables distributed address pool service on IPv4.

pool vrf

Enables distributed address pool service on vrf.

network (BNG)

Specifies a set of addresses or prefixes inside a subnet.

network (BNG)

To specify a set of addresses or prefixes inside a subnet, use the network command in Pool IPv4 configuration submode. To remove the addresses or prefixes, use the no form of this command.

network { IPv4_subnet/length }

no network { IPv4_subnet/length }

Syntax Description

IPv4_subnet

Specifies the decimal representation of the IPv4 subnet mask.

length
Specifies the length of the prefix.
Note   

The prefix length must be a maximum of 16 bit more than the subnet mask.

Command Default

None

Command Modes

Pool IPv4 configuration

Command History

Release Modification

Release 4.2.0

This command was introduced.

Release 4.3.0

Support for IPv6 was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the pool ipv4 command to enter IPv4 pool configuration submode and pool ipv6 command to enter IPv6 pool configuration submode.

The prefix-length command must be configured whenever the network command is used. The prefix-length must be configured to 128 to signify singleton addresses and a smaller value to signify IPv6 prefixes. The number of addresses or prefixes that can be allocated by DAPS can become huge when this command is used. The prefix-length command should be configured to a number that limits the number of addresses or prefixes for each pool to 64K.

The prefix is written as the first address of a network, followed by a slash character (/) , and ends with the bit-length of the prefix. For example, 192.168.1.0/24 is the prefix of the IPv4 network starting at the given address, having 24 bits allocated for the network prefix, and the remaining 8 bits reserved for host addressing. The IPv6 address specification 2001:db8::/32 is a large network with 2 96 addresses, having a 32-bit routing prefix. In IPv4 the routing prefix is also specified in the form of the subnet mask, which is expressed in quad-dotted decimal representation like an address. For example, 255.255.255.0 is the network mask for the 192.168.1.0/24 prefix.

Task ID

Task ID Operation

ip-services

read, write

Examples

This is an example of configuring the network command for IPv4:

RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# pool vrf vrf1 ipv4 pool2
RP/0/RSP0/CPU0:router(config-pool-ipv4)# network 11.11.11.0/24
RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# pool vrf vrf1 ipv6 pool3
RP/0/RSP0/CPU0:router(config-pool-ipv6)# network 10:1:1::/50 

Related Commands

Command

Description

pool ipv4

Enables distributed address pool service on ipv4.

pool vrf

Enables distributed address pool service on vrf.

pool vrf

To enable distributed address pool service on a vrf and to enter the corresponding configuration submode, use the pool vrf command in the global configuration mode. To disable this feature, use the no form of this command.

pool vrf { vrf_name | all } { ipv4 | pool_name }

no pool vrf { vrf_name | all } { ipv4 | pool_name }

Syntax Description

vrf_name

Specifies the name of the vrf.

ipv4

Specifies IPv4 pool name. Each pool must have a unique name across all VRFs.

pool_name

Specifies the name of the pool for IPv4.

all

Specifies the global pool.

Command Default

None

Command Modes

Global configuration mode

Command History

Release Modification

Release 4.2.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the pool ipv4 command to enter IPv4 pool configuration submode.


Note


Each pool must have a unique name across all VRFs. For example, pool1 can not be created in both vrf1 and vrf2.


Some pools can be associated with all the VRFs and these pools are configured with the all keyword.

Task ID

Task ID Operation

ip-services

read, write

Examples

This is an example of configuring the pool vrf command for IPv4 in the global configuration mode:

RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# pool vrf vrf1 ipv4 pool2
RP/0/RSP0/CPU0:router(config-pool-ipv4)# 

Related Commands

Command

Description

pool ipv4

Enables distributed address pool service on IPv4.

pool ipv4

To enable distributed address pool service on IPv4 and to enter the pool IPv4 configuration submode, use the pool ipv4 command in the global configuration mode. To disable this feature, use the no form of this command.

pool ipv4 pool_name

no pool ipv4 pool_name

Syntax Description

pool_name

Specifies the name of the IPv4 pool.

Command Default

None

Command Modes

Global configuration mode

Command History

Release Modification

Release 4.2.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the pool ipv4 command to enter IPv4 pool configuration submode.

Task ID

Task ID Operation

ip-services

read, write

Examples

This is an example of configuring the pool ipv4 command in the global configuration mode:

RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# pool ipv4 pool1
RP/0/RSP0/CPU0:router(config-pool-ipv4)# address-range 10.10.10.1 10.10.10.254

Related Commands

Command

Description

pool vrf

Enables distributed address pool service on vrf.

exclude

Specifies a range of IP addresses that distributed address pool service should not assign to clients.

address-range

Specifies a range of IP addresses.

show pool ipv4 name

To display the status of an IPv4 pool, use the show pool ipv4 name command in the EXEC mode.

show pool ipv4 name pool_name { location | verbose | }

Syntax Description

pool_name

Specifies the name of the IPv4 pool.

location

Specifies the location of the IPv4 pool.

verbose

Displays all allocations for the pools.

|

Specifies the output modifiers.

Command Default

None

Command Modes

EXEC

Command History

Release Modification

Release 4.2.0

This command was introduced.

Release 4.3.0

Support for IPv6 was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. If you suspect user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use thepool ipv4 command to enter Pool IPv4 configuration submode.

Task ID

Task ID Operation

ip-services

read

Examples

This is the sample output of the show pool ipv4 name command:

RP/0/RSP0/CPU0:router# show pool ipv4 name POOL1

              Pool POOL1 Allocations
---------------------------------------------------
VRF: default
Pool Id: 30
Pool Scope: VRF Specific Pool
Prefix Length: 32

Used:           100
Excl:             0
Free:          7900
Total:         8000

Utilization:    1%

Range List: 
----------- 
Range Start        :  12.0.0.2 
Range End          :  12.0.31.65 
Used Addresses     :  100 
Excluded Addresses :  0 
Free Addresses     :  7900  

RP/0/RSP0/CPU0:router# show pool ipv4 name POOL1 verbose 

              Pool POOL1 Allocations
---------------------------------------------------
VRF: default
Pool Id: 30
Pool Scope: VRF Specific Pool
Prefix Length: 32

Used:           100
Excl:             0
Free:          7900
Total:         8000

Utilization:    1%

Range List: 
----------- 
Range Start        :  12.0.0.2 
Range End          :  12.0.31.65 
Used Addresses     :  100 
Excluded Addresses :  0 
Free Addresses     :  7900 
 
In-Use Address List:
   12.0.0.2  PPP
   12.0.0.3  PPP
   12.0.0.4  PPP
   12.0.0.5  PPP
   12.0.0.6  PPP
   12.0.0.7  PPP
   12.0.0.8  PPP
   12.0.0.9  PPP
   12.0.0.10  PPP
   12.0.0.11  PPP
   12.0.0.12  PPP
   12.0.0.13  PPP
   12.0.0.14  PPP
   12.0.0.15  PPP
   12.0.0.16  PPP
   12.0.0.17  PPP
   12.0.0.18  PPP
   12.0.0.19  PPP
   12.0.0.20  PPP
   12.0.0.21  PPP
   12.0.0.22  PPP
   12.0.0.23  PPP
   12.0.0.24  PPP
   12.0.0.25  PPP
   12.0.0.26  PPP
   12.0.0.27  PPP
   12.0.0.28  PPP
   12.0.0.29  PPP
   12.0.0.30  PPP
   12.0.0.31  PPP
   12.0.0.32  PPP
   12.0.0.33  PPP
   12.0.0.34  PPP
   12.0.0.35  PPP
   12.0.0.36  PPP
   12.0.0.37  PPP
   12.0.0.38  PPP
   12.0.0.39  PPP
   12.0.0.40  PPP
   12.0.0.41  PPP
   12.0.0.42  PPP
   12.0.0.43  PPP
   12.0.0.44  PPP
   12.0.0.45  PPP
   12.0.0.46  PPP
   12.0.0.47  PPP
   12.0.0.48  PPP
   12.0.0.49  PPP
   12.0.0.50  PPP
   12.0.0.51  PPP
   12.0.0.52  PPP
   12.0.0.53  PPP
   12.0.0.54  PPP
   12.0.0.55  PPP
   12.0.0.56  PPP
   12.0.0.57  PPP
   12.0.0.58  PPP
   12.0.0.59  PPP
   12.0.0.60  PPP
   12.0.0.61  PPP
   12.0.0.62  PPP
   12.0.0.63  PPP
   12.0.0.64  PPP
   12.0.0.65  PPP
   12.0.0.66  PPP
   12.0.0.67  PPP
   12.0.0.68  PPP
   12.0.0.69  PPP
   12.0.0.70  PPP
   12.0.0.71  PPP
   12.0.0.72  PPP
   12.0.0.73  PPP
   12.0.0.74  PPP
   12.0.0.75  PPP
   12.0.0.76  PPP
   12.0.0.77  PPP
   12.0.0.78  PPP
   12.0.0.79  PPP
   12.0.0.80  PPP
   12.0.0.81  PPP
   12.0.0.82  PPP
   12.0.0.83  PPP
   12.0.0.84  PPP
   12.0.0.85  PPP
   12.0.0.86  PPP
   12.0.0.87  PPP
   12.0.0.88  PPP
   12.0.0.89  PPP
   12.0.0.90  PPP
   12.0.0.91  PPP
   12.0.0.92  PPP
   12.0.0.93  PPP
   12.0.0.94  PPP
   12.0.0.95  PPP
   12.0.0.96  PPP
   12.0.0.97  PPP
   12.0.0.98  PPP
   12.0.0.99  PPP
   12.0.0.100  PPP
   12.0.0.101  PPP

This table describes the significant fields shown in the display.

Table 1 show pool ipv4 name Field Descriptions

Field

Description

VRF

Specifies the VRF the pool is associated with.

Pool ID

The unique pool ID of a specific pool.

Pool Scope

Pool scope belongs to the VRF specific pool.

Prefix Length

Length of the prefix specified.

Related Commands

Command

Description

pool vrf

Enables distributed address pool service on vrf.

pool ipv4

Enables distributed address pool service on ipv4.

exclude

Specifies a range of IP addresses that distributed address pool service should not assign to clients.

address-range

Specifies a range of IP addresses.

show pool vrf

To show the status of VRF pool, use the show pool vrf command in the EXEC mode.

show pool vrf vrf_nameipv4

Syntax Description

vrf_name

Specifies the vrf name.

all

Displays all vrfs.

ipv4

Specifies the IPv4 pool.

|

Specifies the output modifiers.

Command Default

None

Command Modes

EXEC

Command History

Release Modification

Release 4.2.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. If you suspect user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the pool ipv4 command to enter IPv4 pool configuration submode.

Task ID

Task ID Operation

ip-services

read

Examples

This is the sample output of the show pool vrf command for IPv4:

RP/0/RSP0/CPU0:router# show pool vrf vrf1 ipv4

                   Allocation Summary
---------------------------------------------------

Used: 0
Excl: 0
Free: 254
Total: 254
Utilization: 0%


 Pool Name    Pool ID      VRF      Used    Excl    Free   Total
-----------  ---------  ---------  ------  ------  ------ -------
     test1      4        vrf2           0      0    254    254

This table describes the significant fields shown in the display.

Table 2 show pool ipv4 name Field Descriptions

Field

Description

VRF

Specifies the VRF the pool is associated with.

Pool ID

The unique pool ID of a specific pool.

Pool Name

The name of the IPv6 pool.

Related Commands

Command

Description

pool vrf

Enables distributed address pool service on vrf.

pool ipv4

Enables distributed address pool service on ipv4.

exclude

Specifies a range of IP addresses that distributed address pool service should not assign to clients.

address-range

Specifies a range of IP addresses.