IRP Installation and Configuration Guide
5 Appendixes
5.1 Frontend labels for configuration parameters
Account ID pushd.sms.account_sid↑
Adaptive packets count explorer.probing.sendpkts.adaptive_max↑
Admin role groups directory.X.admin_role_groups↑
Allowed IP addresses global.frontend_acl_ips↑
Allowed latency worsening (ms) core.cost.worst_ms↑
Allowed loss worsening (%) core.commit_control.worst_loss↑
Analyzed prefixes collector.ournets↑
Announced communities bgpd.peer.X.master_communities↑, bgpd.peer.X.slave_communities↑
Announced localpref value bgpd.peer.X.master_localpref↑, bgpd.peer.X.slave_localpref↑
Announced MED value bgpd.peer.X.med↑
AS_PATH capability bgpd.peer.X.cap_4byte_as↑
AS-PATH restore priority bgpd.as_path↑
Autonomous System bgpd.peer.X.as↑
Avatar emoji pushd.webhook.avatar_emoji↑
Avatar icon URL pushd.webhook.avatar_url↑
Base DN directory.X.base_dn↑
BGP Internal Monitor SNMP Community peer.X.mon.snmp.community↑
BGP Internal Monitor SNMP IPv4 address peer.X.mon.snmp.ip↑
BGP Internal Monitor SNMP IPv6 address peer.X.mon.snmp.ipv6↑
BGP mode global.nonintrusive_bgp↑
BGP session monitoring IPv4 address peer.X.mon.ipv4.bgp_peer↑
BGP session password bgpd.peer.X.master_password↑, bgpd.peer.X.slave_password↑
BGPd monitoring guard time (sec) bgpd.mon.guardtime↑
BGPd monitoring holdtime (sec) bgpd.mon.holdtime↑
BGPd monitoring keepalive (sec) bgpd.mon.keepalive↑
BGPd monitoring long holdtime (sec) bgpd.mon.longholdtime↑
Bot name pushd.webhook.botname↑
CC allowed for core.commit_control.loss_override↑
CC probing queue slots core.commit_control.probing_queue_size↑
CC probing TTL (sec) core.commit_control.probe_ttl↑
CC provider precedence peer.X.precedence↑
Cascading policy max AS bgpd.policy.cascade.amount↑
Centile value peer.X.95th.centile↑
Certificate verification directory.X.verify_cert↑
Circuit issues detection peer.X.circuit.control↑
Commit Control core.commit_control↑
Commit Control for provider peer.X.cc_disable↑
Common name attribute directory.X.fullname↑
Community mark for local improvements bgpd.rd_local_mark↑
Control inbound.rule.X.full_control↑
Delete irrelevant CC improvements core.commit_control.del_irrelevant↑
Delta loss to restore core.circuit.recover_loss_diff↑
Delta loss to shutdown core.circuit.high_loss_diff↑
Delta loss to warn core.circuit.warn_loss_diff↑
Email attribute directory.X.email↑
Email server pushd.email.host↑
Explorer new algorithmsexplorer.algorithms↑
Explorer worker threads explorer.maxthreads↑
Exploring queue slots core.eventqueuelimit↑
Failed probe lifetime (sec) core.probes.ttl.failed↑
Failback timer (s) global.failover_timer_failback↑
Failover global.failover↑
Failover timer (s) global.failover_timer_fail↑
Flow agents peer.X.flow_agents↑
Flow Collector collector.flow.enabled↑
Flow sources collector.flow.sources↑
Flowspec PBR global.flowspec.pbr↑
From email pushd.email.from↑
From phone number pushd.sms.phone_number↑
Frontend access restriction global.frontend_acl↑
Global commit improvements core.global.allow_commit↑
Global latency/cost improvements core.global.allow_latency_cost↑
High volume precedence explorer.high_vol_precedence↑
Holdtime of BGP updates (sec) bgpd.db.timeout.withdraw↑
Hostname directory.X.hostname↑
ICMP & SNMP monitoring status peer.X.mon.enabled↑
ICMP timeout (ms) explorer.timeout↑
ICMP/UDP ping monitored IPv4 addresses peer.X.ipv4.mon↑
ICMP/UDP ping monitored IPv6 addresses peer.X.ipv6.mon↑
Ignored ASNs global.ignored.asn↑
Ignored communities global.ignored_communities↑
Ignored prefixes global.ignorednets↑
Improvement mode global.improve_mode↑
Inbound prefix control bgpd.full_control↑
Indirect probing precedence explorer.probe.indirect_priority↑
Infrastructure IPs explorer.infra_ips↑
Initial bind DN directory.X.initial_bind_dn↑
Initial bind Password directory.X.initial_bind_password↑
Internal monitor SNMP host peer.X.mon.snmp↑
IX auto re-configuration peer.X.auto_config↑
IX auto re-configuration interval (s) global.exchanges.auto_config_interval↑
IPv4 aggregate size global.agg_ipv4_max↑
IPv4 diagnostic hop peer.X.ipv4.diag_hop↑
IPv4 Redirect community peer.X.flowspec.ipv4.redirect_community↑
IPv6 aggregate size global.agg_ipv6_max↑
IPv6 diagnostic hop peer.X.ipv6.diag_hop↑
IPv6 External monitor peer.X.mon.ipv6.external.enabled↑
IPv6 Internal monitor peer.X.mon.ipv6.internal.enabled↑
IPv6 Redirect community peer.X.flowspec.ipv6.redirect_community↑
IPv6 support global.ipv6_enabled↑
Irpspand interfaces collector.span.interfaces↑
Issues time horizon (min) core.circuit.hist_interval↑
Keepalive interval (sec) bgpd.peer.X.keepalive↑
Load balancing peer.X.group_loadbalance↑
Local IPv4 address bgpd.peer.X.master_our_ip↑, bgpd.peer.X.slave_our_ip↑
Local router IPv6 address bgpd.peer.X.master_our_ipv6↑
Management interface global.master_management_interface↑
Master routing domain global.master_rd↑
Max collected IPs explorer.max_collector_ips↑
Max IPv4 Flowspec rules core.flowspec.max↑
Max IPv6 Flowspec rules core.flowspec.max_ipv6↑
Max IPv4 Improvements core.improvements.max↑
Max IPv6 Improvements core.improvements.max_ipv6↑
Max message size pushd.sms.message_size↑
Maximum load per interface peer.X.limit_load↑
Maximum probe lifetime (sec) core.probes.ttl.max↑
Min loss detection packets explorer.probing.sendpkts.min↑
min_delay status collector.span.min_delay↑
Mindelay probing queue slots collector.span.min_delay.probing_queue_size↑
Minimal prefix bandwidth (Mbps) core.commit_control.agg_bw_min↑
Minimal probe lifetime (sec) core.probes.ttl.min↑
Minimal traffic volume (%) collector.export.volume.min_pct↑
Minimal traffic volume (bytes) collector.export.volume.min↑
NetFlow UDP port collector.flow.listen.nf↑
Next hop inbound.rule.X.next_hop↑.
Order directory.X.order↑
Outage confirmation timeout (sec) core.problem.outage_timeout↑
Outage detection core.outage_detection↑
Outage prefix confirmation rate core.outage_detection.limit_pct↑
Outage round trip rate (%) core.problem.rtt.diff_pct↑
Overload by (%) trap.core_cc_overload.limit_pct↑
Overload by (Mbps) trap.core_cc_overload.limit_mbps↑
Overusage interval (sec)core.overusage.check_interval↑
Overusage policies global.bw_overusage↑
Overusage rule retention (sec) core.overusage.hold_timer↑
Overusage threshold multiplier core.overusage.out.threshold.trigger↑
Overusage throttle multiplier core.overusage.out.threshold.throttle↑
Peering Partner enable trace provider.X.rule.Y.pbr_check↑
Peering Partner name provider.X.rule.Y.shortname↑
Peering Partner next-hop provider.X.rule.Y.next_hop↑
Peering Partner status provider.X.rule.Y.enabled↑
Performance/Cost improvements within peer group peer.X.improve_in_group↑
Port directory.X.port↑
Prefix aggregation global.aggregate↑
Prefix announcement rate (%) trap.bgpd_announced_rate_low.limit_pct↑
Prefix BW average time (hours)core.overusage.out.average.period↑
Prefix latency limit (ms) trap.core_improvement_latency.limit_ms↑
Prefix loss limit (%) trap.core_improvement_loss.limit_pct↑
Prefix monitor polling (sec)bgpd.prefix.monitor.interval↑
Prefix monitor searching (sec)bgpd.prefix.monitor.search_interval↑
Prefix relevant BW (Mbps) core.overusage.out.average.relevant_min↑
Prepend inbound prefixes core.circuit.inbound↑
Prepend transit prefixes core.circuit.transit↑
Probing algorithm explorer.probe.algorithm↑
Probing DSCP provider.X.rule.Y.probing_dscp↑
Probing interface(s) global.master_probing_interface↑
Probing IP address provider.X.rule.Y.probing_ip↑
Probing IPv4 address peer.X.ipv4.master_probing↑, peer.X.ipv4.slave_probing↑
Provider 95th percentile peer.X.95th↑, peer.X.95th.in↑
Provider billing day peer.X.95th.bill_day↑
Provider cost per Mbps (USD) peer.X.cost↑
Provider description peer.X.description↑
Provider overload by (%) trap.core_cc_provider_overload.limit_pct↑
Provider overload by (Mbps) trap.core_cc_provider_overload.limit_mbps↑
Provider probing IPv6 address peer.X.ipv6.master_probing↑
Provider short name peer.X.shortname↑
Provider Shutdown peer.X.shutdown↑
Provider SNMP community peer.X.snmp.community↑
Provider SNMP interfaces peer.X.snmp.interfaces↑
Provider SNMP IPv4 address peer.X.snmp.ip↑
Provider SNMP IPv6 address peer.X.snmp.ipv6↑
Provider type peer.X.type↑
Provider’s bandwidth max deviation (%) core.commit_control.rate.group↑
Provider’s high load bandwidth limit (%) core.commit_control.rate.high↑
Provider’s low load bandwidth limit (%) core.commit_control.rate.low↑
Provider’s routing domain peer.X.rd↑
Providers inbound.rule.X.providers↑
Public IPv4 address for PBR tests explorer.ipv4_test↑
Public IPv6 address for PBR explorer.ipv6_test↑
RD community rd.X.community_worsening↑
RD shortname rd.X.shortname↑
Re-probe on new path change bgpd.retry_probing.new.bmp_path_change↑
Re-probe on old path change bgpd.retry_probing.old.bmp_path_change↑
Relevant loss (%) core.performance.loss_pct↑
Relevant RTT difference (%) core.performance.rtt.diff_pct↑
Relevant RTT difference (ms) core.performance.rtt.diff_ms↑
Relevant RTT: IX vs transit (ms) core.performance.rtt.ix_diff_ms↑
Relevant RTT: IX vs transit (%) core.performance.rtt.ix_diff_pct↑
Remote provider ASN peer.X.ipv4.next_hop_as↑
Remove next hop update bgpd.improvements.remove.next_hop_eq↑
Remove on aggregate withdrawal bgpd.improvements.remove.withdrawn↑
Restore after (sec) core.circuit.recover_monitored_intervals↑
Restore interval (min) core.circuit.recover_monitored_intervals↑
Route Server or Peering session BGP Router-ID provider.X.rule.Y.bgp_peer↑
Router peer.X.bgp_peer↑
Router ASN peer.X.ipv6.next_hop_as↑
Router IPv4 address bgpd.peer.X.peer_ip↑
Router IPv6 address bgpd.peer.X.peer_ipv6↑
Router next-hop address peer.X.ipv4.next_hop↑
Router next-hop IPv6 address peer.X.ipv6.next_hop↑
Routes configuration mode peer.X.routes_config↑
RTT between RDs global.rd_rtt↑
Scanning attemptsexplorer.scanning.sendpkts.factor↑
Secret pushd.sms.auth_token↑
Packet size from IP header collector.span.size_from_ip_header↑
Server port pushd.email.port↑
sFlow UDP port collector.flow.listen.sf↑
Shutdown bgpd.peer.X.shutdown↑
Slave IPv4 address global.failover_slave.ip↑
Slave routing domain global.slave_rd↑
Slave SSH port global.failover_slave.port↑
SMS gateway pushd.sms.gateway↑
SNMP authentication password snmp.X.auth_password↑
SNMP authentication password (monitor) peer.X.mon.snmp.auth_password↑
SNMP authentication password (stats) peer.X.snmp.auth_password↑
SNMP authentication password (traps) trap.destination.auth_password↑
SNMP authentication snmp.X.auth_protocol↑
SNMP authentication (monitor) peer.X.mon.snmp.auth_protocol↑
SNMP authentication (stats) peer.X.snmp.auth_protocol↑
SNMP authentication (traps) trap.destination.auth_protocol↑
SNMP encryption password snmp.X.priv_password↑
SNMP encryption password (monitor) peer.X.mon.snmp.priv_password↑
SNMP encryption password (stats) peer.X.snmp.priv_password↑
SNMP encryption password (traps) trap.destination.priv_password↑
SNMP encryption snmp.X.priv_protocol↑
SNMP encryption (monitor) peer.X.mon.snmp.priv_protocol↑
SNMP encryption (stats) peer.X.snmp.priv_protocol↑
SNMP encryption (traps) trap.destination.priv_protocol↑
SNMP host IP snmp.X.ip↑
SNMP host short name snmp.X.name↑
SNMP interface counters processing global.ifstats↑
SNMP security snmp.X.seclevel↑
SNMP security (monitor) peer.X.mon.snmp.seclevel↑
SNMP security (stats) peer.X.snmp.seclevel↑
SNMP security (traps) trap.destination.seclevel↑
SNMP Username snmp.X.auth_username↑
SNMP Username (monitor) peer.X.mon.snmp.auth_username↑
SNMP Username (stats) peer.X.snmp.auth_username↑
SNMP Username (traps) trap.destination.auth_username↑
SNMP version snmp.X.version↑
SNMP version (monitor) peer.X.mon.snmp.version↑
SNMP version (stats) peer.X.snmp.version↑
SNMP version (traps) trap.destination.version↑
SNMP Traps community trap.destination.community↑
SNMP Traps destination port trap.destination.port↑
SPAN Collector collector.span.enabled↑
Speaking IP responses for candidates explorer.scanning.replypkts.min↑
Speaking IPs RTT dispersion (ms) explorer.scanning.rtt.dispersion_ms↑
Speaking IPs to scan on loss explorer.scanning.confirm_ips↑
Spike size (%) trap.core_cc_improvements_spike.diff_pct↑
Spike preceeding interval (seconds) trap.core_cc_improvements_spike.period_sec↑
Split announcements to preserve original route attributes bgpd.updates.split↑
Standard reprobing period (sec) core.improvements.ttl.retry_probe↑
State directory.X.state↑
Strip non-IRP communities bgpd.improvements.strip_non_irp_communities↑
Timeout directory.X.timeout↑
TLS directory.X.tls↑
TLS CA Certificate file directory.X.tls_cacertfile↑
Top volume prefixes per cycle collector.export.volume.high.top_n↑
Top hosts per prefix collector.export.top_volume_ips↑
Top-N relevant volume prefixes core.improvements.retry_probe.volume_top_n↑
Trace all providers explorer.trace.all↑
Traceroute algorithm order explorer.trace.algorithms↑
Traceroute max hops explorer.traceroute.ttl.max↑
Traceroute min hops explorer.traceroute.ttl.min↑
Traceroute packets per hop explorer.traceroute.sendpkts↑
Traceroute retry packets explorer.traceroute.retrypkts↑
Transit ASNs bgpd.prefixlist.asn↑
Transit Improvements Max core.improvements.inbound_transit.max↑
Transit Improvement TTL max (sec) core.improvements.inbound_transit.ttl.max↑
Transit Improvement TTL min (sec) core.improvements.inbound_transit.ttl.min↑
Transit matching at egress collector.flow.process_transit_in_outbound↑
Transit prefixes bgpd.prefixlist.prefixes↑
Transit top N prefixes collector.flow.export.inbound_transit.topn↑
Transiting traffic global.inbound_transit↑
Traps SNMP community trap.destination.community↑
Type directory.X.type↑
Use BMP data peer.X.bmp↑
User directory name directory.X.name↑
User DN directory.X.user_dn↑
User role attribute directory.X.user_role_attr↑
Username attribute directory.X.username↑
VIP reprobing period (sec) core.vip.interval.probe↑
Webhook URL pushd.webhook.url↑
Withdraw improvements on warn core.circuit.withdraw_on_warn↑
5.2 Configuration parameter index
Global settings
global.bw_overusage, 198
global.exchanges, 198
global.failover.log, 199
global.failover_role, 199
global.failover_slave.ipv6, 199
global.frontend_acl, 200
global.ifstats, 201
global.inbound_conf, 203
global.ipv6_enabled, 203
global.outbound, 204
global.png.datadir, 204
global.policies, 204
global.rrd.age_max, 206
global.rrd.datadir, 206
global.slave_management_interface, 203
global.user_directories_conf, 206
Common database credentials
db.dbname, 197
BGPD SETTINGS 290
db.host, 197
db.ourhost, 197
db.password, 197
db.port, 197
db.username, 197
BGPd settings
bgpd.improvements.remove.hold_time, 209
bgpd.log, 208
bgpd.log.level, 208
bgpd.monitor.type, 210
bgpd.policy.cascade.amount, 211
bgpd.prefix.monitor.interval, 211
bgpd.prefix.monitor.search_interval, 211
bgpd.snmp.concurrent_requests, 213
bgpd.snmp.packets_interval, 213
bgpd.snmp.simultaneous, 214
bgpd.transit.monitor.election_interval, 214
bgpd.transit.monitor.fast_reconfirm_interval, 214
bgpd.transit.monitor.retries, 214
bgpd.transit.monitor.timeout, 214
BGP sessions settings
bgpd.peer.X.cap_4byte_as, 215
bgpd.peer.X.inbound.localpref, 216
bgpd.peer.X.listen, 217
bgpd.peer.X.origin, 218
bgpd.peer.X.shutdown, 220
bgpd.peer.X.transit.mib, 220
bgpd.peer.X.transit.snmp, 220
bgpd.peer.X.transit.status, 220
bgpd.peer.X.updates.limit.ps, 221
Collector settings
collector.detect.explorer_ips, 222
collector.export.ttl, 223
collector.flow.buffer.size, 224
collector.flow.log, 224
collector.flow.log.level, 225
collector.sessions.max, 226
collector.span.buffer.size, 226
collector.span.log, 226
collector.span.log.level, 227
collector.span.threshold.blackout, 227
collector.span.threshold.congestion, 228
collector.span.threshold.delay, 228
collector.span.threshold.excessive, 228
collector.speaking_ips, 228
Core settings
core.commit_control.del_irrelevant, 232
core.commit_control.inbound.rate.high, 233
core.commit_control.inbound.rate.low, 233
core.commit_control.inbound.volume_estimation, 233
core.commit_control.rate.high, 232–235
core.global.allow_commit, 236
core.global.allow_latency_cost, 236
core.log.level, 229
core.outage_detection.limit_pct, 239,
core.performance.rtt.ix_diff_ms, 241
core.performance.rtt.ix_diff_pct, 241
core.probes.ttl.failed, 242
core.problem.outage_timeout, 242
core.problem.rtt.diff_pct, 242
Explorer settings
explorer.aipi, 243
explorer.algorithms, 245
explorer.interval.infra, 244
explorer.interval.other, 244
explorer.interval.other.trace, 244
explorer.log, 243
explorer.log.level, 243
explorer.probe.indirect_priority, 246
explorer.probing.simultaneous, 246
explorer.scanning.confirm_ips, 246
explorer.scanning.replypkts.min, 247
explorer.scanning.rtt.dispersion_ms, 247
explorer.scanning.sendpkts.factor, 247
explorer.timeout.infra, 247
explorer.traceroute.simultaneous, 248
explorer.traceroute.simultaneous.infra, 249
Administrative settings
dbcron.api.log, 255
dbcron.api.socket, 255
dbcron.log, 256
dbcron.log.level, 256
irpstatd.log, 256
irpstatd.log.level, 256
irpstatd.snmp.enhanced.sec, 256
Upstream provider settings
peer.X.disable_pbr_confirmation, 260
peer.X.inbound.community_base, 261
peer.X.ipv4.route_server, 262
peer.X.ipv6.route_server, 264
peer.X.ipv6.slave_probing, 264
peer.X.mon.snmp, 266
peer.X.routes_config, 270
peer.X.snmp.enhanced, 271
peer.X.snmp.interfaces, 272
Routing Policies settings
asn/prefix, 275
cascade, 275
community, 275
enabled, 276
forcelocal, 276
notes, 276
policy, 276
priority, 274
providers, 276
vip, 276
Exchanges
provider.X.rule.Y.enabled, 277
provider.X.rule.Y.next_hop, 277
provider.X.rule.Y.pbr_check, 277
provider.X.rule.Y.probing_dscp, 277
provider.X.rule.Y.probing_ip, 277
provider.X.rule.Y.shortname, 277
Events parameters
pushd.email.from, 250
pushd.email.host, 250
pushd.email.port, 250
pushd.listen.port, 249
pushd.log, 249
pushd.log.level, 249
pushd.sms.account_sid, 250
pushd.sms.auth_token, 250
pushd.sms.gateway, 250
pushd.sms.message_size, 250
pushd.sms.phone_number, 251
pushd.sms.uri.plivo, 251
pushd.sms.uri.twilio, 251
pushd.templates.datadir, 251
pushd.webhook.botname, 252
pushd.webhook.url, 252
trap.bgpd_announced_rate_low.limit_pct, 254
trap.core_cc_improvements_spike.diff_pct, 254
trap.core_cc_improvements_spike.period_sec, 254
trap.core_cc_overload.limit_mbps, 254
trap.core_cc_overload.limit_pct, 254
trap.core_cc_provider_overload.limit_mbps, 255
trap.core_cc_provider_overload.limit_pct, 255
trap.core_improvement_latency.limit_ms, 255
trap.core_improvement_loss.limit_pct, 255
trap.destination.community, 253
trap.destination.port, 253
trap.destination.priv_password, 253
trap.destination.priv_protocol, 253
trap.destination.version, 252–254
API daemon settings
apid.listen.port, 207
apid.log, 206
apid.log.level, 206
apid.maxthreads, 207
apid.path.mtr, 207
apid.path.ping, 207
apid.path.ping6, 207
apid.path.traceroute, 207
Inbound settings
bgpd.peer.X.inbound.localpref, 216
core.commit_control.inbound.rate.high, 233
core.commit_control.inbound.rate.low, 233
core.commit_control.inbound.volume_estimation, 233
global.inbound_conf, 203
peer.X.inbound.community_base, 261
User Directories
directory.X.base_dn, 278–280
directory.X.email, 278
directory.X.fullname, 278
directory.X.hostname, 278
directory.X.initial_bind_dn, 278
directory.X.initial_bind_password, 278
directory.X.name, 278
directory.X.order, 278
directory.X.port, 279
directory.X.secret, 279
directory.X.state, 279
directory.X.timeout, 279
directory.X.type, 279
directory.X.user_dn, 278–280
directory.X.username, 278–280
SNMP Hosts
Routing Domains
rd.X.shortname, 282
BMP settings
irpbmpd.log, 222
irpbmpd.log.level, 222
irpbmpd.port, 222