APM CLI Configuration Statements

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 doesn't complete it during the time 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

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

Specify when the window opens for evaluation and reclamation. This option requires that you set the active option 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.

Specify access credentials that the connection needs to access the BNG or external manager.

• certificate filename—Filename containing the APM certificate.
• private-key filename—Filename containing the APM's private key.
• ca-certificate filename—Filename containing the root certificate of the root certificate authority (CA) that is used to authenticate the entity.

Specify the system-id of the entity. The system-id is a unique string of up to 45 characters assigned to the managed BNG. It's used to identify the entity to APM upon successful connection.

The pool domain profile to use for this system.

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

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.

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.

• 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

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. If reclamation-hold-down is disabled (set to 0), APM compares the set reclaim threshold value to a computed threshold value and uses the larger value. The computed threshold value is derived from the equation computed threshold = apportion-threshold + (prefix-count * 2^(32 – preferred-prefix-len)) + 1.
• reclamation-hold-down—Set the duration in seconds for the entity to suspend any potential event for a pool domain after an apportion event. Configuring a non-zero reclamation-hold-down value allows you to set lower reclaim-threshold values which may be useful when the pool-domain is idle (results in fewer allocated pool prefixes left on the entity). As an apportion event containing reclaim multiple prefixes might temporarily push the number of free addresses above the reclamation threshold, suppressing reclamation events for a specified time allows the subscriber-login rate to catch up with the apportioned prefix set. If the apportion event adds addresses to a pool domain such that the pool domain’s free-address count is above the reclaim-threshold, you want to supress generating a reclaim event until the number of free addresses falls below the reclaim threshold.

  • Default: 0

    The hold-down timer is disabled if it has a value of 0.

  • Range: 1 to 3600

    Note:

    The reclamation-hold-down is enabled if it is set between 30 to 3600 seconds, and APM reverts the reclaim-threshold to the value you configured. Irrespective of whether the reclamation-hold-down is enabled or disabled, APM notifies the impacted entities of a change through a DOMAIN_THRESHOLDS_CHANGE trigger response.

(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 the 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

Specify the number of APMi entities allowed to connect to the APM server.

• Default: 0

• Range: 0 through 500