Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

APM CLI Configuration Statements

SUMMARY 

auto-reclamation (APM)

Syntax

Hierarchy Level

Description

Configure APM to automatically drain pools and recover their prefixes for use in other pools. When you enable auto-reclamation, APM requests monitoring updates for the domain every 5 seconds.

Note:

You must configure at least one option, even if it is with the default value, to enable automatic reclamation.

Note:

APM cancels all pending drain and recovery transactions when you remove auto-reclamation from the configuration.

Options

active (always | window)

Specify when automatic reclamation is active.

  • always—APM always evaluates pools that are critical or idle to determine whether to initiate reclamation.

  • window—APM evaluates pools for reclamation only during the time window that you define with the window-start and window-duration options. If either of these options is set to 0, APM acts as if you configured the always option.

    Note:

    A pool is reclaimed after the window expires if both of the following occur:

    • The pool begins draining but does not complete it during the window. This means that the pool still has some addresses and is therefore not idle.

    • The pool continues to drain and becomes idle after the window expires.

  • Default: always

reclaim-threshold-age

Specify the number of minutes APM waits before processing a reclaim alarm. If the reclaim alarm does not abate (no abatement alarm sent) at the end of the reclaim threshold age, the suggested pool in the reclaim alarm is drained.

  • Default: 0 (indicates an immediate drain).

window-duration minutes

Specify (in minutes) how long the window is open from the window-start time for APM to evaluate pools and initiate reclamation.

  • Default: 60 minutes

  • Range: 15 through 720 minutes

window-start time

Specify when the window opens for evaluation and reclamation. This option requires the active option to be set to window. You specify the time using a 24-hour clock in one of the following formats:

  • HH:MM+hhmm—Specify the time and indicate the positive offset from local time. For example, if you specify 15:21+01:00, the start time is 16:21, local time.

  • HH:MM-hhmm—Specify the time and indicate the negative offset from local time. For example, if you specify 15:21-01:00, the start time is 14:21, local time.

Release Information

Statement introduced in APM Release 3.0.0.

entity (APM)

Syntax

Hierarchy Level

Description

Define the attributes of the managed BNGs, also known generically as entities or devices.

Options

entity ip-address

Specify the primary IPv4 address of the BNG. This address must be usable regardless of the Routing Engine redundancy state of the router. Thus, the address must be a primary-only management address.

entity-name name

Set a fully qualified domain name for the managed BNG.

provisioning-profile provisioning-profile-name

Specify the name of a profile that interacts directly with the managed BNGs. The provisioning profile is configured using the profile configuration statement.

pool-domain-profile-name pool-domain-profile-name

Specify the name of the pool domain profile to use to complete the dynamic pool domain creation requests that are initiated by the entity.

See pool-domain-profile (APM) for information about configuring the pool domains on a managed BNG.

Release Information

Statement introduced in APM Release 3.0.0.

inet-pool (APM)

Syntax

Hierarchy Level

Description

Configure how APM partitions its global pool of IPv4 addresses and how it allocates addresses to individual BNG pool domains. The address pool defined by the inet-pool statement consists of multiple partitions that you create to define allocation contexts. You configure multiple root prefixes for each partition. You can specify the minimum and maximum size of root prefixes that are valid for the partition. You specify the smallest subnetwork that APM can subdivide from a particular root prefix. APM subdivides the root prefixes and allocates the resulting subnetworks to individual pool domains as needed to supplement the domain’s available addresses.

Options

partition partition-name Set the name of the partition.
free-prefix-utilization percentage

Set the minimum threshold percentage for unallocated prefixes in the partition. When the percentage drops below this value, a warning message is generated to indicate that the partition is running low on available addresses. The notification is only informative and triggers no other actions.

  • Default: 10

  • Range: 0 through 100

max-prefix-length max-prefix-length

Define the size of the root prefix that is valid in this partition. This configuration sets the upper limit on valid prefix lengths for the root prefixes in this partition. This upper limit defines the root prefix with the fewest host addresses to apportion. As the prefix length increases, APM can subdivide fewer subordinate prefixes from the root prefix.

  • Default: 24

  • Range: 1 through 31

The max-prefix-len value is the maximum number of bits used in definiting a subnetwork. It must be greater than or equal to the min-prefix-len value. Otherwise, APM does not add the prefix to the partition.

min-prefix-len min-prefix-length

Define the largest-sized subnetwork that is valid in this partition. This configuration sets the lower limit on valid prefix lengths for the root prefixes in this partition. This lower limit defines the root prefix with the most host addresses to apportion. As the prefix length decreases, APM can subdivide more subordinate prefixes from the root prefix.

  • Default: 8

  • Range: 1 through 31

The min-prefix-len value must be less than or equal to the max-prefix-len value. Otherwise, APM does not add the prefix to the partition.

prefix ip-address Specify the root prefix for the partition. APM subdivides subnetworks from this root to provision addresses for a BNG’s pool domains. The root prefix length must be within the range defined by the values of the partition-level min-prefix-len and max-prefix-len options. You typically configure more than one root prefix per partition.
  • max-prefix-length max-prefix-length—Define the granularity of the root prefix and the smallest prefix that APM can subdivide from the specified root prefix. As the prefix length increases, the size of the subnetwork decreases.
    • Default: 24

    • Range: 1 through 31

  • prefix-recycle-hold seconds—Specify the duration, in seconds, that APM will hold on to the reclaimed prefix before it can be made available for allocation.
  • reserved-prefix sub-prefix—Specify a subnetwork that cannot be allocated from this partition. You can optionally qualify the reservation by restricting it to a specified BNG or even to a specified pool domain on that BNG.
  • route-tag tag—Specify a list of numbers to be used as route tags that the router associates with the route when it creates a static discard route for the prefix. APM cycles through the route-tag list in a round-robin fashion each time a sub-prefix is allocated from the root prefix.
  • Range: 5 through 300

Release Information

Statement introduced in APM Release 3.0.0.

pool-domain-profile (APM)

Syntax

Hierarchy Level

Description

Configure the pool domain profiles that are used to create pool domains on BNGs during apportionment. The profile specifies the number of prefixes that will be apportioned, thresholds that the BNGs will monitor, and whether automatic reclamation is active.

Options

pool-domain-profile domain-profile-name
allocation

Configure the number of prefixes that are added to a pool domain during each apportioning event.

monitoring

Set the attributes for monitoring how a pool domain and the pools within a pool domain are using addresses. Thresholds for free (available) and used (allocated) addresses establish the points at which APM generates an alarm.

  • apportion-threshold apportion-threshold-count—Set the minimum number of available addresses in the pool domain that triggers a provisioning event.
  • reclaim-threshold reclaim-threshold-count—Set the reclaim threshold for pool domains created from this profile. APM compares the set reclaim threshold value to the computed threshold value and uses the larger value. You compute the threshold value using this equation: computed threshold = apportion-threshold + (prefix-count * 2^(32 – preferred-prefix-len)) + 1.

Some statements are explained separately. Click the linked statement in the Syntax section for details.

Release Information

Statement introduced in APM Release 3.0.0.

profile (APM)

Syntax

Hierarchy Level

Description

Configure a provisioning profile. Then, define the attributes associated with the APM plug-in on the BNG. You apply this profile in the entity configuration. The attributes are then conveyed to the plug-in when APM initializes.

Options

profile profile-name Name of a profile with provisioning attributes.
liveness Specify how APM manages the connectivity with a BNG when the connection fails.
  • initial-retry-interval seconds—Specify how long the plug-in waits, in seconds, after detecting a failure before it attempts to reconnect to the BNG. The interval doubles after each subsequent attempt. For example, using the default value of 3 second for the first attempt, the plug-in waits successively 6 seconds, then 12 seconds, and so on until an attempt is successful or all retries have been used.
    • Default: 3

    • Range: 1 through 300

  • max-retries number—Specify how many attempts the plug-in makes to reconnect to a BNG before declaring it to be unreachable. Thereafter, the plug-in continues attempting to reconnect forever, but the retry interval remains fixed at the calculated value used for the maximum retry attempts.
    • Default: 8

    • Range: 1 through 16

manager-address ip-address

IPv4 address of the APM manager.

other-plug-in-name name

Specify the name of an external plug-in’s executable file. Use this option only with the other plug-in name option.

Note:

The other option is used only for internal test purposes.

plug-in-name

Specify the name of the plug-in executable file (.py) for the profile’s plug-in.

  • jnprGrpc—Plug-in that communicates directly with managed BNGs for provisioning and deprovisioning.
  • other—Plug-in that is used only for external plug-ins for internal test purposes. Use this option only with the other-plug-in-name plug-in name option.
plug-in-type

Specify the type of the plug-in associated with the profile.

  • manager—Plug-in that interacts directly with an external manager that, in turn, directly monitors the managed BNGs.
  • entity—Plug-in that interacts directly with the managed BNGs.
port port-number

Specify the destination port number on the BNG.

  • Range: 0 to 65,536

secrets

Specify access credentials that the plug-in needs to access the BNG or external manager.

  • certificate filename—Filename containing the APM certificate.
  • password string—Password corresponding to the BNG username.
  • private-key filename—Filename containing APM's private key.
  • root-certificate filename—Filename containing the root certificate of the root certificate authority (CA) that is used to authenticate the entity.
  • username name—Valid user on the BNG router. The user must have administrative rights on the BNG.

Release Information

Statement introduced in APM Release 3.0.0.

system (APM)

Syntax

Hierarchy Level

Description

Configure the attributes that determine how APM behaves for alarms and transactions.

Options

transaction-time-out seconds

(Optional) Specify (in seconds) how long APM waits for a transaction to complete before it declares that the transaction has stalled (timed out). A transaction consists of a list of tasks. For example, an apportion transaction consists of a task to get an address, a task to provision the entity, and a task to update runtime state. If any task in a transaction fails, the previously executed tasks in the list are rolled back. For example, if the provisioning task fails, then the task to get the address is rolled back, and the address is returned to the partition.

  • Default: 240

  • Range: 60 through 900

Release Information

Statement introduced in APM Release 3.0.0.