purge-timeout (programmable-rpd)

Syntax

Hierarchy Level

Description

Set the time, in seconds, after which a disconnected client times-out. Upon disconnect, the client state remains available but no operations occur. If the disconnected client reconnects before the set time has elapsed, the states are restored on the router. If it does not, all client operations are reverted and the programmable routing protocol process (prpd) server notifies any other modules of the disconnect so they can purge any other client operations.

When the purge-timeout is set to never, the prpd-client-added routes are not deleted when the client disconnects and does not reconnect back. The routes are deleted only when the client explicitly deletes the routes. If routing is restarted, then the client-added routes are lost.

The prpd provides public APIs to program routing systems, making it possible for users to directly access the APIs to customize, create and modify behavior of their network.

Options

Values:

never—When this option is configured purge timeout is infinite (that is, client added routes never time out) for the BGP route service.

timeout seconds —(Optional) Set the time, in seconds, after which disconnected clients time-out on the prpd server and the routes added by the client are purged.

• Default: 120

• Range: 1 through 604,800

  Note:

  Starting in Junos OS Releases 18.4R1, the maximum purge-timeout value is 604,800 seconds (7 days). Prior to this release, the maximum value was 1000 seconds.

Required Privilege Level

routing and trace—To view this statement in the configuration.

routing-control and trace-control—To add this statement to the configuration.

Release Information

Statement introduced in Junos OS Release 16.2.

never option introduced in Junos OS Release 18.4.