How to Use the APM Utility and CLI Commands
APM Configuration Overview
You use the APM CLI when you configure APM to manage address pools in the network. The APM CLI is a simplified, limited, containerized version of Junos OS. To use the APM CLI, you should have basic knowledge of the Junos OS CLI. Day One: Exploring the Junos CLI provides a good overview of Junos OS CLI basics. The CLI User Guide provides more detailed information.
Before you begin configuring APM for a network, make sure that you know the following:
-
The system identifiers that APM will manage.
-
The names of the centralized address pool partitions.
- The apportion and reclaim threshold that you would like to use on the BNGs.
-
Your detailed strategy for partitioning APM’s centralized pool of addresses, including:
-
The size of the prefixes to partition from the address space; for example, whether the prefixes are /15, /22, /24, and so on.
-
The set of addresses for APM to allocate for each BNG.
-
Here are the primary operations you'll perform to configure APM:
-
Configure pool-domain-profiles that you use in the entity-match configuration to drive pool-domain creation and management. Each pool domain profile describes apportion and reclaim thresholds and auto-reclamation behavior. See Configure Pool Domain Profiles
-
Configure partitions to contain root prefixes for supplying pool-domains with pool prefixes. See Configure Prefix Partitions
-
Configure entity-match stanzas which match against known system Ids (BNGs) to enable communications with a BNG.
Access Configuration Mode from the APM Utility
Here's how to access the set of CLI commands for configuring APM:
Now you're ready to start configuring APM.
Access CLI Operational Commands
To monitor APM, view APM configuration and statistics, or run certain operations manually:
Configure Prefix Partitions
Partitions are a way to organize your root prefixes (those prefixes from which prefixes are used to supply entities with pools). Consider using multiple partitions for:
-
Wholesaling applications— Wholesale subscribers who need to have addresses assigned from pools with prefixes that are different from the native subscribers.
- Peering applications—Entities that need prefixes that align with the route aggregation policy for the network peering point they are associated with.
You can configure partitions (from which pool prefixes are drawn) from entities and BNG CUPS (individual user planes). Unless you have a reason for multiple partitions, a single partition results in a more efficient use of prefixes.
Configure the global pool of IPv4 addresses into partitions from which APM allocates addresses to individual BNG pools.
Configure Pool Domain Profiles
Configure a template with attributes that you can use to create dynamic pool domains.
Configure Attributes for Managing BNGs
Configure attributes that identify a managed BNG and define the pool domains on the BNG.
entity-match
command directs incoming APM entities to a
pool domain profile. APM reconciles it's pool domains with the BNG’s list
such that the APM list matches the BNGs list. If an APM entity (identified
by its system-id) is not present in the entity-match list, it's not allowed
to connect and the connection is aborted.
[edit apm entity-match system-id] root@jnpr-apm-mgmt# set pool-domain-profife domain-profile-name
Configure a Secure Incoming Connection for APM
With APM, you can secure an incoming connection by defining secrets and you can use the entity-match command to map valid entities to a pool-domain-profile.
Monitor APM Operations
Purpose
Use the APM show
commands to display status and address
utilization information about all BNGs that are under management. You can add
qualifiers to the commands to display information more specifically by partition
and pool domain.
From configuration mode, exit to the top-level CLI prompt, and then enter the
required show
commands.
[edit apm] root@jnpr-apm-mgmt# exit root@jnpr-apm-mgmt> show command-options
Action
-
Display the overall prefix utilization; that is, how many prefixes APM has available, reserved, or allocated, for all partitions.
root@jnpr-apm-mgmt> show apm inet-pool utilization Partition Prefixes Reserved Allocated new-england 7 0 4 wholesalers 3 0 2 vpn 15 0 7
-
Display the prefix utilization for a single partition.
root@jnpr-apm-mgmt> show apm inet-pool utilization partition new-england Partition Statistics Partition Name: new-england Prefixes: 7 Reserved: 0 Allocated: 4 Prefix Prefixes Reserved Allocated 203.0.113.0/24 7 0 4
-
Display the prefix utilization for a single partition and prefix.
root@jnpr-apm-mgmt> show apm inet-pool utilization partition new-england prefix 203.0.113.0/24 Partition Statistics: Partition Name: new-england Prefixes: 7 Reserved: 0 Allocated: 4 Prefix Statistics: Prefix: 203.0.113.0/24 Total sub-prefixes: 7 Total reserved: 0 Total allocated: 4 Prefix Length Free Allocated 24 0 1 25 1 1 26 2 2
-
Display information about all associated BNGs.
root@jnpr-apm-mgmt> show apm entity root@jnpr-apm-mgmt> show apm entity Entity ID APMi Ver Name Status Pool Domains test-002 1 reachable 1 10.9.164.40 0 yarmouth reachable 1
-
Display detailed information about a specific BNG.
root@jnpr-apm-mgmt> show apm entity id test-002 Entity Statistics ID : test-002 APMi Ver: 1 Name : test-002 Status : reachable Pool Domain Last Discovery Pools Last Allocation Allocations Last Reclamation Reclamations iroh-default 2022-03-29T22:11:55Z 1 2022-03-29T22:11:55Z 1 - 0 – 0
-
Display detailed information about a BNG’s pool domain.
root@jnpr-apm-mgmt> show apm entity id test-002 pool-domain iroh-default Entity Statistics: Entity ID: test-002 APMi Ver : 1 Name : test-002 Status : reachable Pool Domain Statistics: Pool Domain : iroh-default Source Partition: westford Free Addresses : 245 Pool Head : iroh-default Pools : 1 Thresholds: Apportion : 200 Reclamation: 457 Events: Last Discovery : 2022-03-28T13:05:27Z Last Allocation : 2022-03-28T13:05:27Z Last Reclamation: - Allocations : 1 Reclamations : 0 Alarms: Apportion : 1 Reclamation : 0 Pool-drained: 0 Abatement : 0 Pool Prefix Total Addrs Used Addrs iroh-default 192.168.41.0/24 255 10
-
Display the number of allocations made by each partition.
root@jnpr-apm-mgmt> show apm inet-pool allocation Partition Allocations new-england 4 wholesalers 2 vpn 7
-
Display information about how addresses are allocated for a specific partition across all BNGs.
root@jnpr-apm-mgmt> show apm inet-pool allocation partition wholesalers Filter fields: partition=wholesalers, entity= Source Partition Prefix Entity Address Pool Domain wholesalers 198.51.100.100/25 192.0.2.108 cust-a970 wholesalers 198.51.100.200/25 192.0.2.108 cust-a970 wholesalers 198.51.100.1/25 192.0.2.233 L3-001a
-
Display information about how addresses are allocated for all partitions on a specific BNG.
root@jnpr-apm-mgmt> show apm inet-pool allocation entity 192.0.2.108 Filter fields: partition=, entity=192.0.2.108 Source Partition Prefix Entity Address Pool Domain new-england 203.0.113.10/24 192.0.2.108 mx480-a3-default new-england 203.0.113.20/24 192.0.2.108 mx480-a3-default new-england 203.0.113.30/24 192.0.2.108 mx480-a3-default new-england 203.0.113.40/24 192.0.2.108 mx480-a3-default new-england 203.0.113.50/24 192.0.2.108 mx480-a3-red new-england 203.0.113.60/24 192.0.2.108 mx480-a3-red wholesalers 198.51.100.100/25 192.0.2.108 cust-a970 wholesalers 198.51.100.200/25 192.0.2.108 cust-a970 vpn 192.0.2.0/25 192.0.2.108 local56
-
Display information about how addresses are allocated for one partition on a specific BNG.
root@jnpr-apm-mgmt> show apm inet-pool allocation entity 192.0.2.108 partition new-england Filtered Partition Allocations Filter fields: partition=new-england, entity=192.0.2.108 Source Partition Prefix Entity Address Pool Domain new-england 203.0.113.10/24 192.0.2.108 mx480-a3-default new-england 203.0.113.20/24 192.0.2.108 mx480-a3-default new-england 203.0.113.30/24 192.0.2.108 mx480-a3-default new-england 203.0.113.40/24 192.0.2.108 mx480-a3-default new-england 203.0.113.50/24 192.0.2.108 mx480-a3-red new-england 203.0.113.60/24 192.0.2.108 mx480-a3-red