Skip to main content

Configuration Element Reference

This section is a reference guide for the elements of the User Interface.

The Configuration Element Reference guide provides reference information about the individual configuration commands, elements, and context used to build your SSR configuration. To learn the basics of the configuration workflow, refer to Configuration Management for more information.

access-control

Path:

authority > router > system > services > snmp-server > access-control

Description:

Access-Control governs access to the SSR's SNMP server. Each source that polls this device must be configured within its own access-control.

note

If SNMP queries are traversing a KNI to reach the SSR's SNMP server, then the access-control setting must be the SSR address for the KNI (e.g., for the build-in KNI254, this is 169.254.127.126). In this case, access control is governed by the host-service on the ingress network-interface.

ElementTypeDescription
communitystringThe SNMP community string for this policy.
namestringA unique identifier for this access-control.
sourceipv4-addressThe IP address of the device polling the SSR.

access-policy (service)

Path:

authority > service > access-policy

Description:

Service access policies are a multiple instance sub-element within a service configuration. Conceptually similar to an access control list (ACL), service access-policy objects are configured to explicitly grant or deny access to a service and a service route. The user or group of users are specified by an address block or a Qualified Service Name (QSN).

ElementTypeDescription
permissionenumerationValid values: allow, deny. Default: allow. This setting determines whether or not the address(es) or QSN defined in the "source" field should be allowed access to this service.
sourcesource-specKey field. This field contains either an IP prefix, or a QSN, or a combination of the two, and represents the "user population" subjected to this access policy.
note

QSNs are entered without the qsn:// scheme, using only dotted name notation (e.g., "engineering.128technology").

Version History

ReleaseModification
1.0.0This feature was introduced.
2.0.0Added the ability to specify a specific subnet within a tenant as a source (e.g., tenantName@192.168.1.0/24).

access-policy (host-service)

Path:

authority > router > node > device-interface > network-interface > address > host-service > access-policy

Description:

Access policies are a multiple instance sub-element within a host-service configuration. Much as they're used within SSR defined services, when defined within host-service elements they explicitly grant or deny access to an underlying Linux service, to the group of users specified by either an address block or a Qualified Service Name (QSN).

ElementTypeDescription
permissionenumerationValid values: allow, deny. Default: allow. This setting determines whether or not the address(es) or QSN defined in the "source" field should be allowed access to this service.
sourcesource-specKey field. This field contains either an IP prefix, or a QSN, or a combination of the two, and represents the "user population" subjected to this access policy.
note

QSNs are entered without the qsn:// scheme, using only dotted name notation (e.g., "engineering.128technology").

note

When adding IP prefixes to an access-policy within a host-service, take note of the fact that the syntax can be affected by whether or not there is a tenant assigned to the network-interface within which the host-service is configured. Specifically, if there is a tenant configured on the network-interface, any access-policy that refers to an IP prefix (such as 192.168.1.0/24) is presumed to be within that tenant. I.e., the access-policy will behave as though 192.168.1.0/24@tenant-name was configured in the access-policy.

When tenancy is determined through other means (e.g., via neighborhood membership), the access-policy can make no such assumption, and any tenant references must be explicitly identified. Configuring IP prefixes within an access-policy on a network-interface with no tenant assigned presumes that the prefix falls within the <global> tenant namespace.

More information on configuring tenancy via network-interface or via neighborhood membership can be found in the Administration section of our documentation.

Version History:

ReleaseModification
3.1.0This feature was introduced as part of the addition of host-service capabilities.

action

Path:

authority > routing > policy > statement > action

Description:

The action configuration element lets administrators define actions to take within route policy statement configuration.

ElementTypeDescription
typeenumerationKey field. Valid values: set-aggregator, modify-as-path, set-atomic-aggregate, set-community, remove-community, set-extended-community, set-next-hop, set-local-preference, modify-metric, set-originator-id, set-origin, set-tag, set-bgp-weight, continue, call. This governs the remaining configurable options for the action as described below.
adduint32Configurable when type is set-aggregator. This will add the specified value to the route's metric.
additivepresenceConfigurable when type is set-aggregator. When present, the action will merge the community attribute values with those specified in the action.
aggregator-addressipv4-addressConfigurable when type is set-aggregator. The IP address of the aggregator.
asuint32 (ASN)Configurable when type is set-aggregator. The ASN of the aggregator.
bgp-weightuint32Configurable when type is set-bgp-weight. The value to set for the BGP weight of the route.
community-attributeenumeration or stringValid values: internet, local-AS, no-advertise, no-export, or a freeform community string written as uint16:uint16. This sets the community-attribute of the route.
community-filterreferenceConfigurable when type is remove-community. The filter (of type community-filter) that will match all of the community strings to remove.
excludestringConfigurable when type is modify-as-path. This is a space separated list of autonomous system numbers to exclude from the route advertisement.
ip-addressipv4-addressThe new next-hop IP address to use for this route.
local-preferenceuint32Configurable when type is set-local-preference. This lets you specify the local preference value for the route.
nonepresenceWhen present, will remove all communities from the route advertisement.
originipv4-addressConfigurable when type is set-origin. This sets the BGP origin for the route.
originator-idipv4-addressConfigurable when type is set-originator-id. This sets the originator ID for the route.
peer-addressipv4-addressSet the next-hop IP address of the route to that of the peer.
policyreferenceConfigurable when type is call. This references another policy, and will cause the current policy statement to "branch" to that referenced policy.
prependstringConfigurable when type is modify-as-path. This is a space separated list of autonomous system numbers to prepend to the route advertisement.
route-targetstringConfigurable when type is set-extended-community. The new extended-community route target, in one of several formats.
setuint32This will set the route metric to the configured value.
site-of-originstringConfigurable when type is set-extended-community. The new site-of-origin value for an extended-community, configurable in one of several formats.
statementreferenceConfigurable when type is continue. This will progress on to the specified statement, which must be after the current statement. This lets you "jump over" intervening statements.
subtractuint32This will subtract the configured value from the route metric.
taguint32Configurable when type is set-tag. This sets the tag for the BGP route.

address

Path:

authority > router > node > device-interface > network-interface > address

Description:

The address sub-element within a network-interface defines the IP address and its associated properties.

ElementTypeDescription
gatewayaddressThe IP gateway for destinations that are not part of the subnet of this interface. This field is optional; a gateway may be learned through a routing protocol, for instance.
host-servicesub-elementHost services are node-specific services, such as enabling remote SSH access, HTTPS access, etc. to a specific platform on which SSR software is running.
ip-addressaddressThe IP address to assign to this interface.
prefix-lengthuint8The number of bits for the subnet mask on this interface. This is generally the number after the slash in CIDR notation; e.g., 24 is the prefix-length for the CIDR 192.168.1.128/24.
utility-ip-addressaddressThe utility address is a unique IP address assigned to a particular interface in a high availability pair. Unlike the ip-address, which is "owned" by the active interface in an interface pair and may migrate between two discrete systems, the utility-ip-address always remains fixed on a specific node, and ensures a unique target for that system irrespective of its role (active, standby).

Version History:

ReleaseModification
1.0.0Introduced
3.1.0Added host-service.

address-family (neighbor)

Path:

authority > router > routing > routing-protocol (bgp) > neighbor > address-family

Description:

The address-family sub-element within each neighbor controls the behavior of the SSR's interaction with its neighbor for the specified address-family (AFI/SAFI).

ElementTypeDescription
afi-safienumerationKey field. Valid value: ipv4-unicast.
as-path-optionssub-elementGives administrators the ability to manipulate the AS_PATH attribute for this address-family.
next-hop-selfbooleanWhen true, sets this SSR as the next hop for this neighbor for this address family.
prefix-limitsub-elementAllows administrators to control the number of prefixes received from this neighbor.
remove-private-asenumerationValid value: all. When set to "all", the SSR will remove private AS numbers from updates sent to this neighbor for this address-family.
route-reflectorsub-elementControls the behavior of the SSR when acting as a route reflector for this neighbor.
send-default-routebooleanWhen true, the SSR will send its default route to its neighbor. Note that this will occur even if the route is not present in the RIB.

Version History:

ReleaseModification
1.0.0Introduced

address-family (routing-protocol)

Path:

authority > router > routing > routing-protocol (bgp) > address-family

Description:

The address-family sub-element controls the behavior of the SSR's BGP tables, separated for each AFI/SAFI (Address Family Indicator, Subsequent Address Family Indicator). At this time, the SSR supports IPv4 unicast address family only.

ElementTypeDescription
afi-safienumerationKey field. Valid value: ipv4-unicast.
aggregate-addresssub-elementMultiple instance. Controls the SSR's behavior regarding address aggregation.
default-route-distancesub-elementSets default values for various routes learned through BGP for this address family.
graceful-restartsub-elementThe parameters and settings that control the SSR's BGP graceful restart behavior.
networksub-elementMultiple instance. One of these elements is configured for each prefix that the SSR should announce for this address family.
prefix-limitsub-elementAllows administrators to set prefix limits received from peers before the connection to that peer is torn down.
send-default-routebooleanWhen true, the SSR will send its default-route to neighbors, if one exists in its RIB for this address-family.
use-multiple-pathssub-elementAllows administrators to set various parameters related to multiple path support for the same Network Layer Reachability Information (NLRI).

Version History:

ReleaseModification
1.0.0Introduced

address-pool

Path:

authority > router > nat-pool > address-pool

Description:

The address-pool lets administrators replace one IP prefix with another as it forwards traffic. This can, for example, mask an entire CIDR block with another. As packets are forwarded, the least significant bits are replaced for traffic pertaining to that tenant with the prefix in the pool.

ElementTypeDescription
addressprefixThe IPv4 or IPv6 prefix to mask egress traffic.
tenant-namereferenceThe tenant to which the address masking should be applied.

adjacency

Path:

authority > router > node > device-interface > network-interface > adjacency

Description:

An adjacency is a multiple instance element that allows administrators to define the set of adjacent routers reachable via a given network-interface. The adjacencies are referenced as peers, which contain the attributes (BFD properties, security policies) to be used when communicating with these adjacencies.

Adjacencies are given an administrative cost that affects the routing plane. They are also given a "quality point" assignment allowing administrators to indicate path preference. This assignment is useful for ensuring that traffic flows to locations using links that meet service level agreement thresholds.

ElementTypeDescription
bfdsub-elementControls the properties of the BFD protocol used as keepalive/heartbeat signaling between this, and a remote SSR routing node.
costuint32Default: 0. The administrative cost of the link.
external-nat-addressaddressWhen the SSR node is deployed behind a NAT, this field specifies the address where the adjacency direct its packets. Due to the nature of the SSR communications, even if the NAT rewrites the destination address to match the local, NAT'ed IP address of the SSR's interface, the metadata within various packets still refers to a pre-NAT'ed address. This field allows a SSR node to identify the pre-NAT'ed address when it appears in metadata received from an adajacency.
generatedbooleanDefault value: false. Set to true when a conductor generates configuration based on two SSRs having interfaces in a common neighborhood. When set to true, the conductor will delete and regenerate this configuration element upon each commit. When an administrator makes persistent configuration changes to the object after it has been generated by a conductor, you must manually change this field to false.
inter-router-securityreferenceRefers to a configured security element, used for encrypting and decrypting packets when transmitting/receiving them to an adjacency.
ip-addressaddressKey field. The IP address or hostname of the adjacent router, or waypoint address of the peer router.
nat-keep-alivesub-elementGoverns whether the SSR will generate keepalive packets to remote peers. Used when there is a NAT device between the two peers, and should be set on the device behind the NAT.
path-mtu-discoverysub-elementControls the SSR's Path MTU Discovery (PMTUD) behavior for commuicating with the peer over this peer path.
peerreferenceA reference to a configured peer (from router:peer). The name of the peer router to which this waypoint address belongs.
peer-connectivityenumerationValid values: bidirectional, outbound-only. Set to outbound-only if the adjacency is behind a NAT device.
port-rangereferenceA reference to a port range to limit the far-end "waypoint" range to a defined set. Useful when working with peers that have strict firewall restrictions on which ports can be used for communicating between SSRs. The default range is 16384-65535. This field is only configurable when peer specifies another SSR element.
post-encryption-paddingsub-elementEnables padding of encrypted packets, allowing SVR traffic to traverse strict firewalls that may filter certain types of traffic.
qp-valueuint32An integer representing the quality points on the link between this node and its adjacent network element. Quality points are assigned to links from low values (representing bulk traffic links) to high values (representing managed, high-quality links). Used in conjunction with a service's service-class when deciding which path to use for a given service's traffic.
session-optimizationsub-elementGoverns whether session optimization should be enabled when communicating with the adjacency.
source-nat-addressCIDRMultiple instance. Each source-nat-address is set to the address and prefix of the far-end NAT between this adjacency, and the network-interface on this node used to reach that adjacency. For NATs that use a single address, the prefix should be set to /32. For NATs that use a pool, the prefix should be set accordingly. Note: extreme caution should be used when configuring 0.0.0.0/0 in an attempt to "wildcard" the source-nat-address; network-interface configuration elements that do not have tenants associated with them (or those that do, where the tenant has no configured prefixes) will potentially collide with this configuration and lead to undesirable behavior.
udp-transformsub-elementControls whether UDP transformation should be enabled when communicating with the adjacency. Used when there are strict firewalls (or other middleboxes) between the two SVR peers, that interfere with the SVR metadata exchange between the two SSR instances.
vectorstringMultiple instance. Represents the list of vector labels (variable cost elements) to be used when calculating the shortest path to a route target.

Version History:

ReleaseModification
1.0.0Introduced
2.0.0Added various NAT handlers.
3.1.0Supports hostnames in addition to IPv4 addresses in the ip-address field.
3.2.0Added generated and vector fields.

administrative

Path:

authority > router > system > audit > administrative

Description:

This sub-element gives administrators the ability to administratively enable or disable administrative events.

ElementTypeDescription
enabledbooleanDefault: true. When false, the system will not register any administrative events.

Version History:

ReleaseModification
3.2.0Introduced

Path:

authority > router > routing > ospf > advertise-default

Description:

The advertise-default sub-element controls whether and how the SSR's OSPF routing stack will advertise the default route into OSPF.

ElementTypeDescription
alwaysbooleanDefault: false. Controls whether the SSR should advertise a default route into OSPF even if the default route doesn't exist in its routing table.
metricuint32Valid values: 0-16777214. The metric to use when advertising the default route into OSPF.
metric-typeenumerationValid values: type-1, type-2. Default: type-2. Controls the type of metric redistributed into OSPF. Type 1 routes use metrics that include the sum of the internal OSPF cost and the external redistributed cost, and are preferred over Type 2 routes that only include the redistributed cost.
policyreferenceA reference to a configured policy to apply to the default route.

aggregate-address

Path:

authority > router > routing > routing-protocol (bgp) > address-family > aggregate-address

Description:

The aggregate-address sub-element affects the SSR's BGP behavior when it aggregates prefixes; whether it advertises those routes as aggregates, and whether or not it

ElementTypeDescription
as-setbooleanControls whether or not the SSR generates "AS set" information for the aggregate. An AS set is an unordered list of autonomous system numbers, collected from all the routes summarized by the aggregate.
prefixCIDRKey field. The IP prefix upon which the as-set and summary-only behaviors operate on.
summary-onlybooleanWhen true, the SSR will advertise Network Layer Reachability Information (NLRI) in aggregate only. When false, the SSR will not advertise aggregate NLRI.

Version History:

ReleaseModification
1.0.0Introduced

application-identification

Path:

authority > router > application-identification

Description:

This sub-element allows you to automatically generate category-based application identification services under a service.

ElementTypeDescription
modeenumerationValid values: module, tls, http, all.
When set to module, the SSR router uses an external module for application classification. The SSR expects classification modules to be installed on the system in /var/etc/128technology/application-modules. (These modules are provided in the SSR software.)
When set to tls, the system inspects X.509 certificates exchanged during the TLS handshake to look for Common Name elements to identify applications.
When set to http, the SSR will learn applications via HTTP host name parsing.
The option all includes all modes. application-identification must be set to all to use web filtering.
auto-updateconfiguration containerDefault is enabled. Enables automatic update of application-identification domain dataset. Contains configurable sub-elements.
update-timeuint8Range is 0-23. Default is 2 AM. Set the (local) time to update app-id dataset.
update-jitteruint8Range is 0-30. Default is 15. The max random jitter applied to the update-time.
update-frequencyeumumerationDefault is weekly. Choose Daily, Weekly, or Monthly.

See also web-filtering.

Version History:

ReleaseModification
3.2.0Introduced
5.4.0Added auto-update option

applies-to

Path:

authority > service > applies-to

Description:

The applies-to filter on a service lets administrators constrain which routers or groups of routers will receive configuration for a given service. This is extremely valuable for reducing the volume of configuration sent to any given router, particularly for large deployments with many services, if it is known a priori that a given router will never need reachability to a service.

For example, a service may exist at a branch site in a hub-and-spoke deployment, and there is only ever a need for reachability from devices at the hub location. Without constraining this service definition, by default all services are supplied to all routers within an authority; in this example, all branches would receive a definition of a service they will never need to reach -- creating unnecessary configuration, etc.

ElementTypeDescription
group-namestringMultiple instance. Available when type is router-group. This is the "group name" (label) for the service that is compared to the values for all router's group, to determine which routers should receive this service.
router-namereferenceMultiple instance. Available when type is router. This specifies individual routers that should receive a copy of this service.
typeenumerationValid values: authority, router, router-group. Default: authority. This controls whether the service should be applied to an individual router, a group of routers, or the entire population of routers (i.e., the "authority").

area

Path:

authority > router > routing > ospf > area

Description:

The area configuration element is where the properties of each OSPF area that the SSR is connected to are configured.

ElementTypeDescription
idarea-id-typeKey field. Configured as a dotted quad (e.g., 0.0.0.1). Areas are used to divide large routed networks into smaller subsets, to constrain route advertisements. Can be a set of network elements that have been administratively grouped together.
interfacesub-elementControls the properties of the interfaces on the SSR device that are in the OSPF area.
summary-rangesub-elementControls whether the SSR will summarize routes matching configured address/mask values. This only applies to Area Border Routers (ABRs).
typeenumerationValid values: normal, stub, nssa. Default: normal. Defines whether this area is a normal area, a stubby area, or a not-so-stubby-area (as specified in RFC 3101).

as-path-options

Path:

authority > router > routing > routing-protocol (bgp) > neighbor > address-family > as-path-options

Description:

This sub-element gives administrators the ability to manipulate the AS_PATH attribute for this address-family.

ElementTypeDescription
allow-own-asuint8Specifies the threshold of occurrences of the peer's AS that can occur within the AS_PATH attribute before it is rejected.

Version History:

ReleaseModification
1.0.0Introduced

audit

Path:

authority > router > system > audit

Description:

This sub-element gives administrators the ability to administratively enable or disable various event types.

ElementTypeDescription
administrativesub-elementControls whether or not the system registers various administrative events.
systemsub-elementControls whether or not the system registers various system events.
trafficsub-elementControls whether or not the system registers various traffic-related events.

Version History:

ReleaseModification
3.2.0Introduced

authority

Path:

authority

Description:

The authority configuration element is the top-most level in the SSR configuration hierarchy. Conceptually, an authority is a collection of instances of the SSR, managed by a single administrative body.

ElementTypeDescription
auto-installbooleanWhen true, this will automatically install the SSR software onto an asset once it connects to the conductor. When false, software will not be installed automatically and will require administrative intervention.
conductor-addressaddressThe IP address or hostname of your conductors. There can be at most two conductor addresses configured in an authority; note that the addresses here should be reachable by most/all of your authority's routers. (Routers that use different addresses to reach the same conductor can override this in their configuration.)
currencystringIndicates local monetary currency used in the system. Default is USD.
dscp-mapsub-elementLets administrators map the inbound DSCP values received in packet headers into priority values, for traffic engineering purposes.
dynamic-hostnamestringThis allows administrators to establish a templated pattern for how interfaces on routers will create "names" for their interfaces. These names, constructed using substitution variables in the dynamic-hostname syntax, can be used as (effectively) persistent labels for referring to the corresponding interface, rather than an IP address. This is particularly useful when an interface acquires its address using a dynamic protocol such as PPPoE or DHCP. Uses the following substitution variables: {interface-id} for Network Interface Global Identifier {router-name} for Router Name {authority-name} for Authority Name For example, \'interface-{interface-id}.{router-name}.{authority-name}\'.
ipfix-collectorsub-elementAllows administrators to configure authority-wide IPFIX (IP Flow Information Export) collectors, for flow-by-flow/session-by-session information.
ldap-serversub-elementConfiguration in support of an external authentication service for administrative logins.
namestringA text string that names the authority. This should be unique to an administrative domain, as devices that are configured with the same authority:name are presumed to be associated with each other. It is recommended that an authority name be something associated with an enterprise deploying the SSR; e.g., "128technology".
rekey-intervalunionValid values: 1-720, or 'never' (default). The number of minutes between security key renegotiation events, when communicating with other SSR devices within an Authority.
remote-loginsub-elementGoverns whether routers within the authority will be reachable using the "remote login" feature. This lets administrators log into the PCLI or shell of a remote router from the conductor's PCLI or shell.
routersub-elementThis is the branch of the configuration tree for defining all of the router-specific components and their properties. This includes things such as "nodes", the software instances that comprise the SSR solution, routing policy, and traffic management attributes.
securitysub-elementMultiple instance. The security elements represent security policies for governing how and when the SSR encrypts and/or authenticates packets.
servicesub-elementMultiple instance. These define the services that the SSR is configured to deliver.
service-classsub-elementMultiple instance. Service classes define the how the SSR marks packets (DSCP), what "quality preference" is given to flows that are part of this service, and how those flows are prioritized by the SSR's scheduling algorithm.
service-policysub-elementMultiple instance. Service policies associate services to service classes, and define the load balancing strategy that the SSR will employ for flows belonging to the referenced service.
session-typesub-elementMultiple instance. Session types are classifications, based on Layer 4 port and protocol. E.g., HTTP is (typically) TCP port 80. The SSR uses session-type configuration elements for assigning default traffic categorization policy when the flows are not explicitly associated with a configured service.
tenantsub-elementMultiple instance. Tenants are authority-wide categories of users (user populations) that are grouped for the purpose of service advertisement, service delivery, and security policy enforcement.
traffic-profilesub-elementA container for sets of traffic profiles, to prioritize traffic using the SSR's traffic engineering subsystem.

Version History:

ReleaseModification
1.0.0Introduced
3.0.0Added rekey-interval.
3.1.0Added dscp-map, ipfix-collector elements.
3.2.0Added dynamic-hostname and traffic-profile.

best-effort

Path:

authority > traffic-profile > best-effort

Description:

This element has one configurable field allowing administrators to specify the guaranteed (minimum) bandwidth for best-effort traffic.

ElementTypeDescription
distributionpercentageValid values: 0-100.

Version History:

ReleaseModification
3.2.0Introduced

bfd (adjacency)

Path:

authority > router > node > device-interface > network-interface > adjacency > bfd

Description:

The bfd sub-element within an adjacency is used to dictate how SSR routing nodes send BFD messages to counterparts in other routers and/or authorities. These values may be unique on a per-adjacency basis, but the configured values apply to all exchanges with a specific peer irrespective of the number of nodes exchanging BFD on either "side".

ElementTypeDescription
authentication-typeenumerationValid values: simple, sha256. This is the authentication type used in BFD packets sent to the other devices in the peer router.
desired-tx-intervaluint32Valid values: 50-600000. Default: 1000. Configured in milliseconds. Represents the frequency with which BFD asynchronous control packets are sent by a router to the remote router.
dscpuint8Valid values: 0-63. Default: 0. This controls the DSCP value that will be applied to BFD packets sent to the adjacency.
dynamic-dampingEnumerationDefault: Disabled. Enabling allows the router to dynamically adjust the minimum and maximum hold down times to ensure that BFD flaps are not affecting the system.
hold-down-timeuint32Default: 5. Range: 1-300. Minimum time BFD waits befor beginning notifications. Can be configured to any value less than the maximum-hold-down-time.
link-test-intervaluint32Valid values: 1-86400. Default: 10. Configured in seconds. This determines the frequency with which a router will perform link tests with the peer router, using BFD echo packets.
link-test-lengthuint8Default: 10. This is the number of packets sent in one link-test session between peers, used for determining latency and jitter.
maximum-hold-down-timeuint32Default: 3600 seconds (1 hour). Only configurable when dynamic-damping is enabled. Must be greater than hold-down-time.
multiplieruint8Valid values: 3-20. Default: 3. This represents the number of missed consecutive messages from a peer before treating that peer as unusable.
required-min-rx-intervaluint32Default: 500. This represents the lowest inter-packet arrival interval (i.e., the fastest rate) at which this router can support asynchronous BFD packets. During negotiation with a BFD peer, this router will transmit packets at the higher of its desired-tx-interval and its peer's required-min-rx-interval.
stateenumerationValid values: enabled, disabled. Default: enabled. When enabled, BFD will be exchanged with the peer router.

Version History:

ReleaseModification
3.1.0Introduced
5.0.0Modified. Added dynamic-damping, configurable hold-down-time, and maximum-hold-down-time.

bfd (neighborhood)

Path:

authority > router > device-interface > network-interface > neighborhood > bfd

Description:

The bfd sub-element within a peer is used to dictate how SSR nodes send BFD messages to counterparts in other routers and/or authorities. These values may be unique on a per-peer basis, but the configured values apply to all exchanges with a specific peer irrespective of the number of nodes exchanging BFD on either "side."

ElementTypeDescription
authentication-typeenumerationValid values: simple, sha256. This is the authentication type used in BFD packets sent to the other devices in the peer router.
desired-tx-intervaluint32Valid values: 50-600000. Default: 1000. Configured in milliseconds. Represents the frequency with which BFD asynchronous control packets are sent by a router to the remote router.
dscpuint8Valid values: 0-63. Default: 0. This is the DSCP value applied to BFD packets generated by the SSR for peer paths within this neighborhood. It will be copied to all generated adjacencies when configuration is committed on the conductor.
dynamic-dampingEnumerationDefault: Disabled. Enabling allows the router to dynamically adjust the minimum and maximum hold down times to ensure that BFD flaps are not affecting the system.
hold-down-timeuint32Default: 5. Range: 1-300. Minimum time BFD waits befor beginning notifications. Can be configured to any value less than the maximum-hold-down-time.
link-test-intervaluint32Valid values: 1-86400. Default: 10. Configured in seconds. This determines the frequency with which a router will perform link tests with the peer router, using BFD echo packets.
link-test-lengthuint8Default: 10. This is the number of packets sent in one link-test session between peers, used for determining latency and jitter.
maximum-hold-down-timeuint32Default: 3600 seconds (1 hour). Only configurable when dynamic-damping is enabled. Must be greater than hold-down-time.
multiplieruint8Valid values: 3-20. Default: 3. This represents the number of missed consecutive messages from a peer before treating that peer as unusable.
required-min-rx-intervaluint32Default: 500. This represents the lowest inter-packet arrival interval (i.e., the fastest rate) at which this router can support asynchronous BFD packets. During negotiation with a BFD peer, this router will transmit packets at the higher of its desired-tx-interval and its peer's required-min-rx-interval.
stateenumerationValid values: enabled, disabled. Default: enabled. When enabled, BFD will be exchanged with the peer router.

Version History:

ReleaseModification
3.1.0Introduced
5.0.0Modified. Added dynamic-damping, configurable hold-down-time, and maximum-hold-down-time.

bfd (peer)

Path:

authority > router > peer > bfd

Description:

The bfd sub-element within a peer is used to dictate how routers send BFD messages to counterparts in other routers and/or authorities. These values may be unique on a per-peer basis, but the configured values apply to all exchanges with a specific peer irrespective of the number of routers exchanging BFD on either "side".

ElementTypeDescription
authentication-typeenumerationValid values: simple, sha256. This is the authentication type used in BFD packets sent to the other devices in the peer router.
desired-tx-intervaluint32Valid values: 50-600000. Configured in milliseconds. Represents the frequency with which BFD asynchronous control packets are sent by a router to the remote router.
dscpuint8Valid values: 0-63. The DSCP marking to be applied to the BFD packets sent to the peer.
dynamic-dampingEnumerationDefault: Disabled. Enabling allows the router to dynamically adjust the minimum and maximum hold down times to ensure that BFD flaps are not affecting the system.
hold-down-timeuint32Default: 5. Range: 1-300. Minimum time BFD waits befor beginning notifications. Can be configured to any value less than the maximum-hold-down-time.
link-test-intervaluint32Valid values: 1-86400. Default: 1. Configured in seconds. This determines the frequency with which a router will perform link tests with the peer router, using BFD echo packets.
link-test-lengthuint8Valid values: 0-255. Default: 10. This is the number of packets sent in one link-test session between peers, used for determining latency and jitter.
maximum-hold-down-timeuint32Default: 3600 seconds (1 hour). Only configurable when dynamic-damping is enabled. Must be greater than hold-down-time.
multiplieruint8Valid values: 3-20. Default: 3. This represents the number of missed consecutive messages from a peer before treating that peer as unusable.
required-min-rx-intervaluint32Default: 500. This represents the lowest inter-packet arrival interval (i.e., the fastest rate) at which this router can support asynchronous BFD packets. During negotiation with a BFD peer, this router will transmit packets at the higher of its desired-tx-interval and its peer's required-min-rx-interval.
stateenumerationValid values: enabled, disabled. Default: enabled. When enabled, BFD will be exchanged with the peer router.

Version History:

ReleaseModification
1.0.0Introduced
3.0.0Updated
5.0.0Modified. Added dynamic-damping, configurable hold-down-time, and maximum-hold-down-time.

bfd (router)

Path:

authority > router > bfd

Description:

The bfd sub-element is used for configuring timers and behaviors associated with the Bidirectional Forwarding Detection protocol for nodes within the router. All SSR packet forwarding components will use BFD to report to one another, governed by these parameters.

ElementTypeDescription
authentication-typeenumerationValid values: simple, sha256. The authentication type used in BFD packets sent to the other devices within the router.
desired-tx-intervaluint32Valid values: 50-5000. Default: 1000. Configured in milliseconds, this represents the frequency with which BFD asynchronous control packets are sent by each node in a router to each other node within the same router.
dscpuint8Valid values: 0-63. The DSCP value to use for outbound BFD.
dynamic-dampingEnumerationDefault: Disabled. Enabling allows the router to dynamically adjust the minimum and maximum hold down times to ensure that BFD flaps are not affecting the system.
hold-down-timeuint32Default: 5. Range: 1-300. Minimum time BFD waits befor beginning notifications. Can be configured to any value less than the maximum-hold-down-time.
link-test-intervaluint32Valid values: 1-86400. Default: 1. Configured in seconds. Determines the frequency with which a node will perform link tests with other nodes in the router, using BFD echo packets.
link-test-lengthuint8Default: 10. The number of packets sent in one link-test session between peers, used for determining latency and jitter.
maximum-hold-down-timeuint32Default: 3600 seconds (1 hour). Only configurable when dynamic-damping is enabled. Must be greater than hold-down-time.
multiplieruint8Valid values: 3-20. Default: 3. The number of missed consecutive messages from a peer before treating that peer as unusable.
required-min-rx-intervaluint32Default: 500. The lowest inter-packet arrival interval (i.e., the fastest rate) at which this router can support asynchronous BFD packets. During negotiation with a BFD peer, this router will transmit packets at the higher of its desired-tx-interval and its peer's required-min-rx-interval.
stateenumerationValid values: enabled, disabled. Default: enabled. When enabled, BFD is exchanged among all nodes within this router.

Version History:

ReleaseModification
1.0.0Introduced
3.0.0Exposed required-min-rx-interval, which was previously fixed at 500ms, and required-min-echo-interval.
5.0.0Modified. Added dynamic-damping, configurable hold-down-time, and maximum-hold-down-time.

confederation

Path:

authority > router > routing > routing-protocol (bgp) > confederation

Description:

This has the options for allowing administrators to specify the behavior of the SSR when it is deployed into an autonomous system that is part of a BGP confederation.

ElementTypeDescription
identifieruint32The identifier for the confederation in the autonomous system.
member-asuint32Multiple instance. The remote autonomous system(s) that are to be treated as part of the local confederation.

Version History:

ReleaseModification
1.0.0Introduced

default-route-distance

Path:

authority > router > routing > routing-protocol (bgp) > address-family > default-route-distance

Description:

The default-route-distance element contains configuration fields that allow administrators to set administrative distance/preference for routes received by the SSR's BGP stack.

ElementTypeDescription
externaluint8The administrative distance for routes learned from external BGP (eBGP) peers.
internaluint8The administrative distance for routes learned from internal BGP (iBGP) peers.
localuint8The administrative distance for local routes.

Version History:

ReleaseModification
1.0.0Introduced

device-interface

Path:

authority > router > node > device-interface

Description:

A device-interface is what maps a physical interface (the "hardware-name") to one or more logical interfaces (the "network-interface") on a node. Each node may have multiple device-interfaces, each of which may house many network-interfaces, limited only by the number of unique VLAN tags (4,094).

ElementTypeDescription
capture-filterstringIn Berkeley Packet Filter (BPF) syntax. This is the filter to use when matching packets on this interface, using the SSR's packet capture feature.
descriptionstringA field for containing human-readable information. Has no impact on packet forwarding.
enabledbooleanDefault value: true. Setting this to false will administratively disable this device interface.
forwardingbooleanDefault value: true. This controls whether the SSR will consider this interface as viable for packet forwarding.
link-settingsenumerationValid values: auto, 10Mbps-half, 10Mbps-full, 100Mbps-half, 100Mbps-full. Default: auto. This lets administrators configure the speed and duplex for this interface (only configurable when type is ethernet).
load-balancingsub-elementThis contains parameters related to maximum link utilization before it is considered eligible/ineligible for new sessions by the SSR load balancing algorithm.
ltesub-elementContainer for properties related to the SSR's support for LTE interfaces. This field is only configurable when the type of the interface is set to lte.
modeenumerationValid values: host, bridged. Only configurable when type is kni. [These modes are superseded in software version 3.1 in favor of the values host and bridged under type.
namestringKey field. A text string that uniquely represents this interface, used to reference it in other parts of the SSR's configuration.
network-interfacesub-elementThe list of network interfaces associated with this device interface.
pci-addressstringThe PCI bus address of the physical, or virtual interface as it is known by the underlying operating system.
pppoesub-elementContainer for properties related to the SSR's support for PPP over Ethernet (PPPoE). This field is only configurable when the type of the interface is set to pppoe.
promiscuous-modebooleanDefault: false. When set to true, the SSR will accept and process packets that it receives that do not have its MAC address as the destination address. This is used in conjunction with the tap-multiplexing feature, when the SSR is the target of port-mirrored traffic that it needs to forward over SVR.
shared-phys-addressstringThe virtual MAC address that the interface will use (part of an interface's redundancy)
strip-vlanbooleanDefault: false. Set this to true when the system needs to strip a VLAN tag on packets ingressing this router. (Common in some cloud deployment models.)
target-interfacestringOnly configurable when type is kni and mode is bridged. This is set to the name of the operating system's interface, which "bridges" this KNI interface to an interface known by the operating system. (This is used when setting up an SSR in a cloud provider's network, for example.)
traffic-engineeringsub-elementThis sub-element is where administrators set the traffic engineering properties (e.g., a bandwidth limiter) for this device-interface.
typeenumerationValid values: ethernet, kni, pppoe, host, bridged, lte, t1.

Version History:

ReleaseModification
1.0.0Introduced
1.1.1hardware-name deprecated. Interfaces are now known by their PCI address (pci-address added). shared-phys-address added in support of device interface redundancy.
3.0.0Added transmit-cap.
3.1.0Added enabled, traffic-engineering elements. Added enumeration values to type. Added configuration properties for PPPoE and LTE elements. Moved modes host and bridged to the enumeration for type.
3.2.1Added name to replace id as the unique key for the interface; moved transmit-cap to traffic-engineering.

dscp-map

Path:

authority > dscp-map

Description:

This element allows administrators to map the DSCP (Differentiated Services Code Point) values into SSR traffic-class values, which will subsequently affect their treatment from a traffic engineering standpoint. Many networks use DSCP marking within packet headers to convey a sense of relative priority of these packets as compared to others. Mapping these DSCP values into SSR traffic classes can place certain packets into queues that have more bandwidth, or have more scheduling time, etc.

note

Versions of SSR software prior to 3.2.0 only allowed mapping of DSCP values to priority values (using the dscp-prioritization element). As of 3.2.0, and going forward, the preferred method for mapping DSCP values into the traffic engineering subsystem is to use dscp-traffic-class.

ElementTypeDescription
namestringKey field. The unique name of this map.
dscp-prioritizationsub-elementThe sub-element used to map DSCP values into priority groups.
dscp-traffic-classsub-elementMaps incoming DSCP into traffic-class.

Version History:

ReleaseModification
3.1.0Introduced
3.2.0Added dscp-traffic-class.

dscp-prioritization

Path:

authority > dscp-map > dscp-prioritzation

Description:

This element allows administrators to associate ranges of DSCP values to one of four priority values that the SSR uses to prioritize packets within its traffic engineering engine.

ElementTypeDescription
priorityintegerKey field. Valid range: 0-3. Priority 0 is the highest priority within the engine, and priority 3 is considered "best effort."
dscp-rangesub-elementThe range of DSCP values to map to the specified priority.

Version History:

ReleaseModification
3.1.0Introduced

dscp-range

Path:

authority > dscp-map > dscp-prioritzation > dscp-range\ authority > dscp-map > dscp-traffic-class > dscp-range

Description:

This element allows administrators to define a range of DSCP values that will map to a DSCP priority assignment. There may be more than one DSCP range associated with a single priority, to account for discontinuous ranges of DSCP values (e.g., 10, 13-15, 17 would be configured as three dscp-range elements within a single dscp-prioritization).

ElementTypeDescription
start-valueintegerKey field. Valid range: 0-63. The lower bound of the DSCP range. When only configuring a range of a single DSCP value, it is sufficient to only configure the start-value and leave the end-value unconfigured.
end-valueintegerValid range: 0-63 (and must be greater than start-value). The upper bound of the DSCP range.

Version History:

ReleaseModification
3.1.0Introduced
3.2.0Added as a sub-element of dscp-traffic-class

dscp-traffic-class

Path:

authority > dscp-map > dscp-traffic-class

Description:

This element allows administrators to associate ranges of DSCP values to one of four traffic-class values that the SSR uses to prioritize packets within its traffic engineering engine.

ElementTypeDescription
traffic-classenumerationValid values: high, medium, low, best-effort. This is the type of traffic to associate with the DSCP ranges configured in this element.
dscp-rangesub-elementThe range of DSCP values to map to the specified priority.

Version History:

ReleaseModification
3.2.0Introduced

ebgp

Path:

authority > router > routing > routing-protocol (bgp) > address-family > use-multiple-paths > ebgp

Description:

This element contains configuration parameters related to the SSR's multipath support for external BGP (eBGP).

ElementTypeDescription
maximum-pathsuint32Default: 1. The maximum number of parallel paths to consider when using multipath eBGP for this address family.

Version History:

ReleaseModification
1.0.0Introduced

entitlement

Path:

authority > router > entitlement

Description:

The entitlement is where you apply keys you received from Juniper, to license your SSR for carrying traffic.

ElementTypeDescription
descriptionstringA textual description of the entitlement.
idstringThe entitlement string, supplied to you by Juniper.
max-bandwidthuint64The purchased bandwidth for your SSR, expressed in bytes per second.

Version History:

ReleaseModification
1.1.0Introduced

filter

Path:

authority > routing > filter

Description:

This is where adminstrators configure the SSR's implementation of route filters, which are sets of conditions for matching specific patterns in route advertisements (inbound or outbound). These are used in conjunction with route policies to manipulate those route advertisements.

ElementTypeDescription
namestringKey field. The unique label assigned to this filter, used to reference it in other parts of the SSR's configuration.
rulesub-elementThe properties of the filter are configured in the rule sub-element.
typeenumerationValid values: prefix-filter, as-path-filter, community-filter, extended-community-filter. This specifies which portion of a BGP message is to be parsed to find a match: prefix-filter will look for matches based on advertised prefixes, as-path-filter will look for matches based on the AS PATH, community-filter based on the BGP community, and extended-community-filter based on the extended BGP community attribute.

graceful-restart

Path:

authority > router > routing > routing-protocol (bgp) > address-family > graceful-restart

Description:

This configuration element governs the behavior of the SSR's support for BGP's graceful restart. It is a BGP extension that is used when peer connections are interrupted, and was designed to minimize the disruption to a system's BGP behavior upon reconnection to the (formerly) unreachable peer.

ElementTypeDescription
restart-timeuint16Valid values: 0-4096. Described as the "Restart Time" in RFC 4724, this is the estimated time for the local BGP speaker to restart a session. The SSR will advertise this value with a BGP peer as part of its declared support for graceful restart. Per RFC 4724, the suggested default value is less than or equal to the hold-time value.
stale-routes-timeuint16This is what RFC 4724 refers to as the "Selection_Deferral_Timer", and represents the upper bound on how long stale routes are retained by the SSR after a BGP peering connection is restarted. If an EOR (End-of-RIB) marker is received from the peer before this timer expires, the stale routes are flushed.

Version History:

ReleaseModification
1.0.0Introduced
3.1.0Added restart-time

high

Path:

authority > traffic-profile > high

Description:

This element has one configurable field, that lets administrators specify the guaranteed (minimum) bandwidth for high priority traffic.

ElementTypeDescription
distributionpercentageValid values: 0-100.

Version History:

ReleaseModification
3.2.0Introduced

host

Path:

authority > router > service-route > host

Description:

The host option is used within a service-route when it is necessary to send traffic via the underlying Linux operating system.

ElementTypeDescription
node-namereferenceThe node that will be used to egress the traffic.
target-addressaddressThe IPv4 address or hostname that the SSR should direct the packets to. This will also perform a destination NAT of the address.

host-service

Path:

authority > router > node > device-interface > network-interface > host-service authority > router > node > device-interface > network-interface > address > host-service

Description:

Individual compute platforms that make up an SSR may each "host" their own services -- things such as remote access via SSH, HTTPS, etc. When an administrator wants to enable remote management of a specific node within an SSR, a host-service element is required. When an administrator creates a host-service, the SSR will "bridge" this service (defined by address, port, and protocol) to a corresponding application on the underlying Linux platform.

ElementTypeDescription
access-policysub-elementSelectively allows/denies access to the underlying host-service to collections of addresses.
descriptionstringAn optional textual description of the element, for configuration ease of readability.
service-typeenumerationKey field. Valid values: ssh, netconf, web, dhcp-server or custom. This identifies the underlying Linux service that will be bridged to the address on this specific node.
transportsub-elementThis is where port(s) and protocol(s) are defined, to match inbound packets to this host-service definition. Only configurable when service-type is custom.

Version History:

ReleaseModification
3.1.0Introduced

ibgp

Path:

authority > router > routing > routing-protocol (bgp) > address-family > use-multiple-paths > ibgp

Description:

This element contains configuration parameters related to the SSR's multipath support for internal BGP (iBGP).

ElementTypeDescription
maximum-pathsuint32Default: 1. The maximum number of parallel paths to consider when using multipath iBGP for this address family.

Version History:

ReleaseModification
1.0.0Introduced

inter-conductor-router-server

Path:

authority > router > node > ssh-keepalive > inter-conductor-router-server

Description:

This element contains configuration parameters related to SSH keepalive properties between this node and its conductor, where the router is the SSH server.

ElementTypeDescription
intervalintegerValid values: 1-10. Configured in seconds, the amount of idle time between keepalive messages.
max-attemptsintegerValid values: 1-20. The number of missed keepalive messages before a connection is declared dead and a reconnection attempt is initiated.

inter-node

Path:

authority > router > node > ssh-keepalive > inter-node

Description:

This element contains configuration parameters related to SSH keepalive properties between this node and other nodes within the same SSR.

ElementTypeDescription
intervalintegerValid values: 1-10. Configured in seconds, the amount of idle time between keepalive messages.
max-attemptsintegerValid values: 1-20. The number of missed keepalive messages before a connection is declared dead and a reconnection attempt is initiated.

Version History:

ReleaseModification
3.2.0Introduced

inter-node-server

Path:

authority > router > node > ssh-keepalive > inter-node-server

Description:

This element contains configuration parameters related to SSH keepalive properties between this node and other nodes within the same SSR, specifically when the node is the SSH server for the transaction..

ElementTypeDescription
intervalintegerValid values: 1-10. Configured in seconds, the amount of idle time between keepalive messages.
max-attemptsintegerValid values: 1-20. The number of missed keepalive messages before a connection is declared dead and a reconnection attempt is initiated.

Version History:

ReleaseModification
3.2.0Introduced

inter-router

Path:

authority > router > node > ssh-keepalive > inter-router

Description:

This element contains configuration parameters related to SSH keepalive properties between this node and other routers within the same SSR authority.

ElementTypeDescription
intervalintegerValid values: 1-10. Configured in seconds, the amount of idle time between keepalive messages from this node to other routers
max-attemptsintegerValid values: 1-20. The number of missed keepalive messages before a connection is declared dead and a reconnection attempt is initiated.

Version History:

ReleaseModification
3.2.0Introduced

interface (ospf)

Path:

authority > router > routing > ospf > area > interface

Description:

This sets the properties of the SSR interface within an OSPF area.

ElementTypeDescription
costuint16Valid values: 1-65535. Default: 10. The cost advertised for this interface into OSPF.
dead-intervaluint32Valid values: 1-2147483647. Default: 40. This controls the length of time the SSR will wait to receive hello packets from a neighbor before declaring it down. This value must be greater than hello-interval.
hello-intervaluint16Valid values: 1-65535. Default: 10. The number of seconds between hello packets.
interfacereferenceThe name of a network-interface on the SSR node that will be in the OSPF.
nodereferenceThe name of the node on which the network-interface resides.
passivebooleanDefault: false. When true, the interface's prefix will be advertised but no neighbor adjacencies will be formed.
priorityuint8Valid values: 0-255. The router's priority.

interface (routing)

Path:

authority > router > routing > interface

Description:

This defines the properties of a loopback interface to be used by the SSR's routing protocols (specifically, BGP). At present this interface is only used when configuring a system for the BGP over SVR (BGPoSVR) feature.

ElementTypeDescription
enabledbooleanDefault: true. This controls whether the loopback interface is enabled or not.
ip-addressipv4-addressThe IP address to be assigned to this interface. Note that this address must be unique such that no BGP speaker sees the same address from two different devices; but this address is not seen "on the wire," so it does not need to be routable otherwise.
namestringAn arbitrary, unique name used to reference this interface throughout other parts of the routing configuration hierarchy.

ipfix-collector

Path:

authority > ipfix-collector

Description:

This element contains information regarding externally reachable IPFIX (IP Flow Information eXport) collectors, for harvesting IPFIX data that is generated by the SSR during its operation.

ElementTypeDescription
interim-record-intervaluint32Valid values: 60-1800. The time (in seconds) for which the SSR will generate IPFIX records for active sessions that are still in progress.
ip-addressaddressThe IP address of the IPFIX collection device.
namestringKey field. The unique label assigned to this IPFIX collector, used to reference it in other parts of the SSR's configuration.
portl4-portThe Layer 4 (transport) port to which the SSR(s) should send their IPFIX records at the specified address.
protocoll4-protocolValid values: tcp, udp. The transport protocol to use for sending IPFIX records to the collector.
sampling-percentageenumerationValid values: dynamic (default) or a decimal value. This represents the percentage of traffic for which IPFIX traffic is generated and sent to the collector. (IPFIX records are rarely, if ever, collected on each flow in a networking device due to the volume of data this generates for both the sender and receiver.) When set to dynamic (or left at its default), the routers in the Authority will use a default algorithm for sampling based on the busyness of the system. For traffic volumes under 100Mbps, the system will generate IPFIX records for one in every 256 flows, up to 1Gbps, one in every 512 flows, up to 10Gbps, one in every 1,024 flows, up to 25Gbps, one in every 2,048 flows, and one in every 8,192 flows for traffic exceeding 25Gbps.
tenantlistThe tenants for which this IPFIX collector will receive records. When no tenants are configured, all traffic will be eligible.

Version History:

ReleaseModification
3.1.0Introduced
3.2.0Added tenant

ldap-server

Path:

authority > ldap-server

Description:

The ldap-server element lets you configure an external server that is used to authenticate administrative users.

ElementTypeDescription
addressaddressThe address of the LDAP server.
bind-typeenumerationValid values: anonymous, unauthenticated, password. This controls how the SSRs will bind to the LDAP server.
namestringKey field. This is the name of the LDAP server configuration element.
portenumerationValid values: server-type-default or a L4 port (0-65535). This is the TCP port that the SSR will use when connecting to the LDAP server. When set to server-type-default, the SSR will use 3269 for global-catalog, 636 for LDAPS, and 389 for StartTLS.
search-basestringThe search base defines the starting point for the search in the directory tree. For example, SSR might need to query the entire directory, in which case the search base must specify the root of the directory service. Or, SSR might need to query a specific organizational unit (OU) in the directory. Generally this is configured as a series of Domain Components, which are abbreviated "dc."
server-typeenumerationValid values: global-catalog, ldaps, starttls. Default value: ldaps. LDAPS is LDAP wrapped in SSL, and is a non-standard (yet popular) implementation. StartTLS is instead built into the LDAP protocol itself. Consult your LDAP server's documentation to determine the server-type most appropriate for your deployment.

See Also

Configuring LDAP

load-balancing

Path:

authority > router > node > device-interface > load-balancing

Description:

The load-balancing element lets administrators configure thresholds for a device-interface to be considered eligible/ineligible for load balancing purposes. When the SSR load balancing algorithm is choosing destinations, it will not choose an interface that has exceeded its configured "high water mark" (expressed as a percentage) until traffic has quieted down on that interface below its "low water mark," also configured as a percentage.

In order for the utilization based load-balancing to take effect, the device interface must have traffic-engineering enabled true. When the device-interface has a traffic-engineering transmit-cap set, the utilization percentages defined will be based on the rate defined in the transmit-cap. If no transmit-cap is set, it will be based on the set or negotiated link settings.

ElementTypeDescription
utilization-high-water-markpercentageValid values: 0-100. The value, in percent, of the link's capacity beyond which the interface will no longer be used as an egress point for new session assignments.
utilization-low-water-markpercentageValid values: 0-100. The value, in percent, of the link's capacity before a previously declared ineligible link must fall below before it will be marked as an eligible path for new session assignments.

Version History:

ReleaseModification
3.2.0Introduced

local-login

Path:

authority > router > system > local-login

Description:

The local-login configuration lets administrators control the number of concurrent logins on the system and what actions to take if that limit is exceeded.

ElementTypeDescription
netconfsub-elementControls around the number of concurrent NETCONF sessions.
note

The netconf configuration is not applicable to version 5.3 and later. NETCONF controls have been replaced with REST API controls, with no loss of functionality.

log-category

Path:

authority > router > system > log-category

Description:

The log-category element is what allows administrators to selectively increase/decrease the verbosity of logging for various subsystems within the SSR. At times, during troubleshooting (and in particular, at the specific request of a member of the Juniper Customer Support team), you may need to selectively increase the logging verbosity of a particular subsystem to isolate a fault or routing issue. To increase logging across all subsystems may overwhelm the system's resources (and potentially mask the issue you're trying to troubleshoot), so these subsystems can affect only a small portion of the overall system's logging behavior.

These logging subsystems will generally only be tuned at the direct request from a member of the technical support team at Juniper.

ElementTypeDescription
nameenumerationValid values: ATCS, DATA, DISC, USER, FLC, HWMC, IPC, LINK, PLAT, RDB, RTG, TEST, UTIL.
log-levelenumerationValid values (in increasing order of verbosity): fatal, error, warning, info, debug, trace.

Version History:

ReleaseModification
3.1.0Introduced

low

Path:

authority > traffic-profile > low

Description:

This element has one configurable field, that lets administrators specify the guaranteed (minimum) bandwidth for low priority traffic.

ElementTypeDescription
distributionpercentageValid values: 0-100.

Version History:

ReleaseModification
3.2.0Introduced

lte

Path:

authority > router > node > device-interface > lte

Description:

This element contains information regarding the configuration attributes for device-interfaces that support LTE (Long-Term Evolution), a 4G mobile communications standard. Note that this interface type requires that specific hardware is installed on your SSR routing element to communicate with the mobile network.

ElementTypeDescription
apn-namestringMobile networks register devices using Access Point Names, abbreviated as "APN." The apn-name field is where you put the apn-name as specified to you by your mobile carrier. This will be used by the SSR to connect to the LTE network.

Version History:

ReleaseModification
3.1.0Introduced

management-vector

Path:

authority > router > node > device-interface > network-interface > management-vector

Description:

The management-vector configuration is used to influence administrative preference over multiple possible paths for management traffic. This is typically used with the "Conductor Service" feature, wherein an SSR sends traffic to the conductor using the forwarding plane of the SSR, as opposed to a dedicated (Linux-managed) interface.

ElementTypeDescription
namestringThe name of the vector label. This references vector labels configured elsewhere in the configuration.
priorityuint32The value to ascribe to the vector. Lower costed vectors are preferred over higher costed vectors.

max-inter-node-way-points

Path: authority > router

Description: The max-inter-node-way-points field is configurable at the router level for all inter-node paths. Previously this number was set at 50,000 and was not configurable. Having access to more than 50,000 waypoints is useful in cases where the number of concurrent sessions are greater than 50,000 and each of those sessions are required to survive a node failover.

note

A router restart is required for this change to be applied.

ElementTypeDescription
valuestringValid values: 50,000-1,000,000.

Version History:

ReleaseModification
4.5.3Introduced

max-way-points

Path: authority > router > device-interface > network-interface > adjacency

Description: The max-way-points field is configurable at the adjacency/neighborhood level for each associated inter-router path. Previously this number was set at 50,000 and was not configurable. Having access to more than 50,000 waypoints is useful in cases where the number of concurrent sessions are greater than 50,000 and each of those sessions are required to survive a node failover.

note

A router restart is required for this change to be applied.

ElementTypeDescription
valuestringValid values: 50,000-1,000,000.

Version History:

ReleaseModification
4.5.3Introduced

medium

Path:

authority > traffic-profile > medium

Description:

This element has one configurable field, that lets administrators specify the guaranteed (minimum) bandwidth for medium priority traffic.

ElementTypeDescription
distributionpercentageValid values: 0-100.

Version History:

ReleaseModification
3.2.0Introduced

member (redundancy-group)

Path:

authority > router > redundancy-group > member

Description:

The member sub-element is configured for each member interface to share fate in a redundancy-group.

ElementTypeDescription
device-idstringKey field. The node's device-interface > name to be a member of this redundancy-group.
nodereferenceKey field. A reference to a configured node's name field.

Version History:

ReleaseModification
2.0.0Introduced
3.2.0Changed device-id to refer to the device-interface's name rather than id

member (tenant)

Path:

authority > tenant > member

Description:

The member sub-element is configured to describe prefix-to-neighborhood mappings for membership to the tenant.

ElementTypeDescription
addressCIDRMultiple instance. The CIDR block of addresses that -- within a neighborhood -- are said to belong to this tenant.
neighborhoodstringKey field. The neighborhood for which the prefixes are to be treated as members of the tenant.

Version History:

ReleaseModification
3.0.0Introduced

metrics

Path:

authority > router > system > metrics

Description:

The metrics sub-element governs various aspects of the SSR's data sampling for analytics purposes.

ElementTypeDescription
sample-perioduint8Valid values: 1-60. Default is 5. Configured in seconds.

Version History:

ReleaseModification
3.0.0Introduced
3.2.0Revised range from 1-10

multicast-sender-policy

Path:

authority > service > multicast-sender-policy

Description:

For service elements that refer to multicast addresses, this lets administrators control which sources of traffic can receive that multicast.

ElementTypeDescription
permissionenumerationValid values: allow, deny. Default: allow. Controls permissions for the specified source.
sourcesource-specKey field. This field contains either an IP prefix, or a QSN, or a combination of the two, and represents the "user population" subjected to this access policy.
note

QSNs are entered without the qsn:// scheme, using only dotted name notation (e.g., "engineering.128technology").

multihop

Path:

authority > router > routing > routing-protocol (bgp) > neighbor > multihop

Description:

The multihop sub-element lets administrators set properties related to the SSR's eBGP multihop behavior when sending BGP messages to its neighbor.

ElementTypeDescription
ttluint8The time-to-live (TTL) value to use when packets are sent to the neighbor. Only applicable when eBGP multihop is also enabled.

Version History:

ReleaseModification
1.0.0Introduced

nat-keep-alive

Path:

authority > router > node > device-interface > network-interface > neighborhood > nat-keep-alive authority > router > node > device-interface > network-interface > adjacency > nat-keep-alive

Description:

The nat-keep-alive function is used when an SSR is sitting behind a NAT device that has short time-to-live values for the NAT bindings it creates. When configured, the SSR will periodically generate small keepalive packets and send them to its peer to refresh the NAT pinhole on the intermediary NAT device. This can be configured for either UDP sessions, TCP sessions, or both.

ElementTypeDescription
modeenumerationValid values: auto, disabled. Default value: disabled. When set to auto, the SSR will use its session-type configuration to determine whether to send keepalive packets for a given session.
tcp-inactivity-timeoutuint32Valid values: 1-86400. This controls how frequently the SSR will send keepalive packets for TCP-based sessions. Note that this value must be lower than the binding time-to-live on the NAT device in front of the SSR, but should be kept as close as possible to reduce the overhead of the keepalive packets.
udp-inactivity-timeoutuint32Valid values: 1-86400. This controls how frequently the SSR will send keepalive packets for UDP-based sessions. Note that this value must be lower than the binding time-to-live on the NAT device in front of the SSR, but should be kept as close as possible to reduce the overhead of the keepalive packets.

nat-pool

Path:

authority > router > nat-pool

Description:

The nat-pool is used for masking one network range into another by changing the least significant bits.

ElementTypeDescription
address-poolsub-elementThe address pool to NAT to. This can be either an IPv4 or IPv6 prefix.
namestringA unique identifier for this nat-pool.

neighbor (network-interface)

Path:

authority > router > node > device-interface > network-interface > neighbor

Description:

The neighbor sub-element (within a network-interface) defines the IP-to-MAC binding for all directly connected neighbors that the network-interface is capable of reaching.

ElementTypeDescription
ip-addressaddressKey field. The IP address of the neighboring device.
phys-addressphys-addressThe MAC address of the neighboring device.

Version History:

ReleaseModification
1.0.0Introduced

neighbor (routing-protocol)

Path:

authority > router > routing > routing-protocol (bgp) > neighbor

Description:

The neighbor sub-element defines the IP address and Autonomous System (AS) number for remote BGP peers to which this SSR instance will peer.

ElementTypeDescription
address-familysub-elementMultiple instance. This configures the various options and attributes for the behavior the SSR should assume when speaking with this neighbor, per address-family. At this time only ipv4-unicast is supported.
auth-passwordstringAn MD5 authentication password to use with this neighbor.
descriptionstringA field for containing human-readable information. Has no impact on packet forwarding.
local-asuint32The local autonomous system number (AS) that is to be used when establishing sessions with this neighbor. (If not configured, the value from the routing-protocol will be used.)
multihopsub-elementThis sub-element contains configuration parameters that govern the SSR's behavior for multihop BGP sessions to this neighbor.
neighbor-addressaddressKey field.
neighbor-asuint32The autonomous system number of the BGP peer.
neighbor-policysub-elementAllows for configuring the policy statements to use when exchanging routes with this BGP neighbor.
outbound-policy-advertisebooleanWhen false, this SSR will not advertise any routes to its BGP peer.
shutdownbooleanWhen true, the neighbor connection is considered administratively shut down, and the connection will not be established.
timerssub-elementThis sub-element controls timers associated with the BGP behavior when communicating with this neighbor.
transportsub-elementThis sub-element controls transport layer behavior when communicating with this BGP neighbor.

Version History:

ReleaseModification
1.0.0Introduced
3.0.0Removed inbound-policy and outbound-policy references
3.2.0Added neighbor-policy

neighbor-policy

Path:

authority > router > routing > routing-protocol (bgp) > neighbor > neighbor-policy

Description:

The neighbor-policy sub-element defines how/whether certain types of routes get advertised to the applicable neighbor.

ElementTypeDescription
outbound-policy-advertisebooleanWhen false, this SSR will not advertise any routes to its BGP peer.
transit-policy-advertisebooleanWhen false, this SSR will not advertise any transit routes to its BGP peer.

Version History:

ReleaseModification
3.2.0Introduced

neighborhood

Path:

authority > router > node > device-interface > network-interface > neighborhood

Description:

The neighborhood multiple-instance sub-element describes the network connectivity between the interface on which this neighborhood is configured and other SSRs that share the same neighborhood. (It merely describes the intent of connectivity; it does not guarantee that all links are up between the two interfaces, etc.) This is what an SSR uses to construct a logical map of the network topology between all interfaces on all SSRs within an Authority.

ElementTypeDescription
bfdsub-elementDefines the BFD properties and parameters to use with all routers within the neighborhood (unless specifically overridden on a given adjacency).
external-nat-addressaddressThis should be configured with the IP address that adjacent routers in this neighborhood will observe when this interface is used to send them packets.
namestringKey field.
nat-keep-alivesub-elementGoverns the nat-keep-alive properties that will be copied to adjacencies generated by this neighborhood configuration.
path-mtu-discoverysub-elementGoverns the Path MTU Discovery (PMTUD) properties that will be copied to adjacencies generated by this neighborhood configuration.
peer-connectivityenumerationValid values: bidirectional, outbound-only. Default: bidirectional. This should be set to outbound-only when the interface is behind a NAT device. This will be copied to the generated adjacency setting on all SVR peers in the neighborhood, to inform them to use a NAT traversal technique for establishing sessions to the NATted SSR interface.
port-rangesub-elementThis lets administrators specify the port range this router will use to construct SVR sessions with peers. This is used when the router is behind a firewall, for example, and the range of ports needs to be constrained.
post-encryption-paddingsub-elementGoverns whether the SSR will pad packets after encryption, useful for bypassing some middleboxes that restrict encrypted traffic.
qp-valueuint32The number of Quality Points that this interface can support. Used for route determination.
session-optimizationsub-elementControls whether session-optimization will be enabled for peers in this neighborhood.
topologyenumerationValid values: mesh, hub, spoke. Default: mesh. This describes the relationship that this interface has with other interfaces in the same neighborhood. When the value is mesh, all other interfaces within the neighborhood are considered adjacencies. When the value is hub, this router is said to peer with other spoke and mesh members within the same neighborhood. When the value is spoke, this router is said to peer with other hub and mesh members of the neighborhood.
ttl-paddingenumerationValid values: 0-255, automatic, false. Default is 0. A numeric value is used to adjust the TTL of each packet destined to the next SSR. All subsequent routers continue to decrement the TTL value, but seeding at a higher value at each SSR hop minimizes the risk of TTL expiring mid-route. Automatic allows BFD traffic to help determine hops between SSR's and adjusts padding automatically. False disables the feature.
udp-transformsub-elementConfiguration settings related to the SSR's UDP transformation feature, which transforms L4 protocols to UDP in order to avoid middleboxes that filter/mangle/manage TCP sessions.
vectorstringThe vector (variable cost) that will be used for path selection when transmitting traffic that has a commensurate service-policy.

Version History:

ReleaseModification
3.0.0Introduced
3.1.0Added the ability to specify neighborhood-wide bfd properties
3.2.0Added external-nat-address, port-range, udp-transform, and vector elements
6.0.0Added ttl-padding

netconf

Path:

authority > router > system > local-login > netconf

Description:

This lets an administrator control the number of concurrent NETCONF logins (each PCLI session consumes a NETCONF login).

ElementTypeDescription
session-limituint32Valid values: 0-100. Default: 4. The number of concurrent NETCONF logins permitted.
session-limit-actionenumerationValid values: no-action, issue-warning. Default: issue-warning. To suppress the warning messages regarding concurrent logins, you can set this to no-action.
note

The netconf configuration is not applicable to version 5.3 and later. NETCONF controls have been replaced with REST API controls, with no loss of functionality.

network

Path:

authority > router > routing > routing-protocol (bgp) > address-family > network

Description:

The network multiple-instance sub-element describes the networks that this SSR will advertise to the specified BGP peer(s).

ElementTypeDescription
network-addressCIDRKey field.

Version History:

ReleaseModification
1.0.0Introduced
3.0.0Removed policy

network-interface

Path:

authority > router > node > device-interface > network-interface

Description:

The network-interface element represents a logical interface on a node.

ElementTypeDescription
addresssub-elementThe IP address assigned to this network-interface, and its various properties.
adjacencysub-elementThis multiple-instance sub-element references neighboring routers.
billing-ratedecimal64Indicates the amount billed for the interface. Measured per day for metered, and per byte for flat. See authority to set currency type.
billing-typeenumerationIndicates the billing type associated with the interface: none - default, no billing is associated with the interface; flat - the network interface is billed flat amount over a period of time; metered - the network interface is billed flat amount based on data usage. See authority to set currency type.
carrierstringIndicates the carrier associated with the network-interface.
conductorbooleanDefault: false. Governs whether this interface should be used to reach the router's conductor. Reference Conductor Deployment Patterns.
descriptionstringA field for containing human-readable information. Has no impact on packet forwarding.
dhcpenumerationValid values: disabled, v4. Default value: disabled. When set to v4, this interface will attempt to acquire an IPv4 address using DHCP (Dynamic Host Configuration Protocol). When disabled, the address on the interface should be administratively set to a static IP.
dscp-mapreferenceThis specifies the particular dscp-map configuration (via its name) to use on this interface for inbound packets. A dscp-map represents a set of DSCP values that map to SSR priority values (0-3) to indicate the relative priority of the traffic within the SSR's traffic engineering subsystem.
dscp-preservebooleanDefault: false. When enabled, the original DSCP value received on the interface is preserved across SVR. See DSCP Preservation for more information.
enforced-mssenumerationValid values: disabled, 64-8960, automatic. Default: disabled. When set to a value, the SSR will replace the advertised MSS in TCP packets it forwards out of this interface. This is typically done to avoid fragmentation. When set to ‘automatic’, the MSS of the network-interface is calculated from that interface’s session MTU, which may be the interface MTU or the path MTU for an SVR session.
global-iduint32This represents the "Global Interface ID" (a.k.a., the "GIID") of an interface. Two network-interface configurations on distinct nodes are configured to be redundant with each other through the use of a common GIID.
host-servicesub-elementAllows for configuring "hosted services" (i.e., services provided by the node's Linux operating system) on this interface; this is configured at the network-interface level of the hierarchy (as opposed to the address level) when the interface uses a dynamic means of acquiring an IP address, such as DHCP.
hostnamestringA hostname by which external parties can use DNS to resolve to this interface's IP address.
icmpenumerationValid values: drop, allow. Governs whether this interface will block ICMP requests or allow them.
ingress-source-nat-poolreferenceThe name of the nat-pool to use for traffic ingressing this interface. This will cause source NATting to be performed by the ingress SSR.
inter-router-securityreferenceA reference to a configured security element, used when exchanging packets/sessions with other SSRs on this interface.
management-vectorsub-elementThe vector values to use for management traffic sent over this interface.
mtuuint32The maximum transmission unit (MTU) for packets sent by this interfaces. Packets larger than this MTU will be fragmented upon egress.
multicast-listenersenumerationValid values: disabled, automatic, enabled. Default: automatic. This controls whether the SSR will send IGMP/MLD queries on this interface. When set to automatic, the SSR will send IGMP/MLD queries based on whether there are any multicast services with tenant-based access policies.
multicast-report-proxybooleanDefault: false. When set to true, this SSR will forward IGMP and MLD joins/leaves/reports from valid multicast services via this network interface. (These originate on other network interfaces which allow multicast listeners.)
namestringKey field. The unique label assigned to this interface, used to reference it in other parts of the SSR's configuration.
neighborsub-elementSingle instance. This lets administrators set the IP:MAC associations for a neighboring device.
neighborhoodsub-elementThis is where neighborhood labels are applied, to indicate connectivity to other SSRs within the Authority. When two routers both have an interface within the same neighborhood (i.e., they share a common label), they are intended to be mutually reachable.
off-subnet-arp-prefixipv4-prefixThis is a multple instance element within a network-interface, that causes the SSR to send ARP replies with its own MAC address for address that fall within the IPv4 prefix(es) specified.
off-subnet-reverse-arp-mac-learningbooleanDefault: False. When true, reverse arp learning for off-subnet IP addresses is supported. The reverse flow uses the source MAC address from the incoming packet as the subnet source IP address.
prioritization-modeenumerationValid values: local, dscp. Default value: local. When set to local, the SSR will use its local classification configuration to assign priorities to inbound flows (for traffic engineering purposes). When set to dscp, the SSR will use inbound DSCP values to map to priorities (based on the dscp-map referenced in this element).
qp-valueuint32The number of Quality Points that this interface can support. Used for route determination.
reverse-arp-mac-learningbooleanDefault: false. When true, the SSR will use the source MAC address of packets it receives to populate its ARP table for unresolved ARP entries.
rewrite-dscpbooleanWhen true, packet classification is performed (to look for known/configured session-types, etc.). When false, the classification step is not performed.
source-natbooleanWhen set to "true", the SSR will perform network address and port translation (NAPT) for all flows egressing the interface. When set to "false", the original IP:port are preserved.
tenantreferenceWhen configured, all packets arriving on this interface are considered to be part of the named tenant. When empty, the tenant for ingress traffic will be determined using other techniques (matching the source table, derived from inbound metadata, matching a source prefix on a tenant's configuration, etc.).
typeenumerationValid values: fabric, external, shared. This enumeration is used by the SSR to identify the interfaces it can use for inter-node (a.k.a. "fabric") traffic, or for interfaces that communicate with traditional networking equipment (a.k.a. "external"). When interfaces are used for both inter-node traffic as well as normal, ambient traffic the value "shared" should be used.
vlanuint16Valid values: 0-4094. The L2 VLAN tag to use when sending packets, and the L2 tag to expect when receiving packets.

Version History:

ReleaseModification
1.0.0Introduced
1.1.0Deprecated "fabric-type" and replaced it with "type"; removed "gateway"; added global-id in support of network-interface redundancy
2.0.0classify renamed to rewrite-dscp
3.0.0Added neighborhood
3.1.0auto removed as an eligible value for type. Added classify, dhcp, dscp-map, and prioritization-mode configuration elements for features added in this software release.
3.2.0Added hostname, removed enabled.

next-hop (service-route)

Path:

authority > router > service-route > next-hop

Description:

This specifies the next-hop for reaching a service-route.

ElementTypeDescription
gateway-ipaddressThe IPv4 address for the gateway for the interface.
interfacereferenceThe name of a configured network-interface used to reach the service-route.
node-namereferenceThe name of the node where the interface lives.
source-nat-poolreferenceThe name of a configured nat-pool to use when invoking this next-hop.
target-addressaddressThe IPv4, IPv6, or hostname to be used as the destination address for this service-route. This will cause the SSR to perform a destination NAT.

Version History:

ReleaseModification
1.0.0Introduced

next-hop (static-route)

Path:

authority > router > routing > static-route > next-hop

Description:

This specifies the next-hop for an administratively-configured static route.

ElementTypeDescription
ip-addressaddressThe IP address of the next hop.
distanceuint8Valid values: 1-255. The administrative distance for this static-route; the higher the value, the less preferred.

Version History:

ReleaseModification
1.0.0Introduced
3.0.0Removed outgoing
3.2.0Added distance

next-hop-interface

Path:

authority > router > routing > static-route > next-hop-interface

Description:

Allows administrators to set the egress interfaces to be used for reaching the next-hop.

ElementTypeDescription
interfacereferenceRefers to a network-interface configuration element.
nodereferenceRefers to the node on which the egress interface exists.

node

Path:

authority > router > node

Description:

A node is a single software instance, one that comprises a whole or part of an SSR or conductor.

ElementTypeDescription
asset-idstringThe asset-id is a unique identifier for a node within an SSR, which is used with the Conductor's "automated provisioning" feature. The asset-id, configured within a router's node in an Authority-wide configuration managed by a Conductor, is matched to an asset-id supplied by an unprovisioned node. Once an asset-id match is established and accepted at the Conductor, the Conductor can definitively install and configure the appropriate software on that node.
asset-validation-enabledbooleanWhen true, the system will check to ensure it meets minimum hardware requirements prior to launching SSR software. When false, this check is bypassed. This should not be bypassed unless it is recommended by the Juniper Customer Support team.
clean-after-failed-installbooleanObsolete. Default value: true. This governs whether all traces of the SSR will be removed if an installation fails on this asset.
clean-before-installbooleanObsolete. Default value: true. When true, this will remove all traces of previous installed versions of SSR when the installer process launches.
descriptionstringA field for containing human-readable information. Has no impact on packet forwarding.
device-interfacesub-elementMultiple instance. This list contains all of the physical devices that this node has configured.
enabledbooleanTrue or false (default: true). Setting this field to disabled will administratively disable the node from participating in the SSR.
forwarding-core-countuint8The number of CPU cores that will be reserved on the underlying hardware platform for running SSR software.
forwarding-core-modeenumerationValid values: automatic, manual. Default: automatic. When set to automatic, the SSR will assess the number of cores it will need to "isolate" (allocation exclusively) for packet forwarding. This is based on the number of cores available on the system. When set to manual, you can administratively specify the forwarding-core-count to override the algorithmically determined values. You can check the number of cores the system has allocated by using the command show platform.
locationstringA text description of this node's physical location. Used as descriptive text, only.
namestringKey field. The unique label assigned to this interface, used to reference it in other parts of the SSR configuration.
power-saverbooleanWhen true, SSR will intelligently reduce the CPU utilization during quiet periods, and dynamically ramp CPU utilization back up as traffic necessitates. This is recommended only on lower-end platforms with small traffic forwarding requirements.
reachability-detectionsub-elementControls how the SSR does Layer 2 reachability detection to connected gateways.
roleenumerationValid values: combo, conductor, control, slice. This defines the role of the node in the SSR; combo is a single logical software deployment that behaves as both a Control and a Slice. For a standalone Control or Slice, select "control" or "slice", respectively. The "conductor" type refers to the SSR management platform. Note: only combo and conductor are supported at this time.
ssh-keepalivesub-elementProperties applied to the SSH sessions initiated by this node to other nodes, routers, and its conductor(s).
software-update-bandwidthunionRange 1-999999999999, or "unlimited." Default: unlimited. Configured in bits/second, this lets you govern the amount of bandwidth that this SSR node will use when retrieving software download images during its upgrade operation. This is useful on slower links, to avoid congestion with production traffic.
ssh-keepalivesub-elementGoverns whether or not this system will support SSH keepalives.
usage-reporter-enabledbooleanWhen true, this node will report anonymous usage statistics back to Juniper for continuous improvement of our software.

Version History:

ReleaseModification
1.0.0Introduced
1.1.0The role enumeration values changed to reflect the new element names
3.0.0Added conductor to enumeration for role
3.1.0Added asset-id as part of the Automated Provisioning feature
3.2.0Added software-update-bandwidth, ssh-keepalive, asset-validation-enabled, forwarding-core-count

notification-receiver

Path:

authority > router > system > services > snmp-server > notification-receiver

Description:

These are the SNMP notification receivers to which the SSR will send traps as events occur.

ElementTypeDescription
ip-addressipv4-addressThe IP address of the notification receiver.
portl4-portDefault: 162. The UDP port to send the notifications to.
typeenumerationValid values: trap, inform. The type of notification to send.

ntp

Path:

authority > router > system > ntp

Description:

The ntp sub-element (within the system configuration) lets administrators configure information about the NTP servers within their management network. Configuring external NTP servers will cause all nodes within the SSR to attempt to use them as a clock source.

ElementTypeDescription
serversub-elementThe NTP server and its properties.

Version History:

ReleaseModification
2.0.0Introduced

ospf

Path:

authority > router > routing > ospf

Description:

The configuration in the ospf hierarchy is used to control the behavior of the SSR's implementation of the OSPF (Open Shortest Path First) routing protocol. The SSR supports OPSFv2.

ElementTypeDescription
advertise-defaultsub-elementControls how/whether the SSR advertises the default route into OSPF, including metric values and type.
areasub-elementMultiple instance. A list of OSPF areas in which this SSR participates. The area sub-element is for configuring the properties of that OSPF area.
instanceuint8Key field. A unique identifier for the OSPF instance.
redistributesub-elementControls which routes get redistributed into OSPF by this SSR.
router-iddotted-quadAs defined in RFC 2328, a 32-bit number expressed as a dotted quad (four octets separated by ., akin to an IPv4 address).

path-mtu-discovery

Path:

authority > router > path-mtu-discovery authority > router > node > device-interface > network-interface > neighborhood > path-mtu-discovery authority > router > node > device-interface > network-interface > adjacency > path-mtu-discovery

Description:

Each SSR that peers with another SSR can periodically perform a Path MTU Discovery (PMTUD) test to determine when/whether fragmentation is necessary. This element controls the behavior of the PMTUD testing.

ElementTypeDescription
enabledbooleanDefault value: true. Controls whether PMTUD is performed between this device and its adjacency.
intervaluint32Valid values: 1-86400. Default value: 600. Controls the number of seconds between PMTUD tests.

peer

Path:

authority > router > peer

Description:

A peer object models a remote router (in this system's authority or in a remote authority) that this SSR will bridge to via STEP (the Juniper routing protocol) to share services.

ElementTypeDescription
authority-namestringThis is the value configured as the authority > name of the SSR peer that this configuration element represents.
bfdsub-elementDefines the BFD properties and parameters to use with the peer router.
descriptionstringMultiple instance.
generatedbooleanDefault value: false. This field is set to true when a conductor generates configuration based on two SSRs having interfaces in a common neighborhood. When this field is set to true, the conductor will delete and regenerate this configuration element upon each commit. Thus, when an administrator wants to make persistent configuration changes to this object after it has been generated by a conductor, it is important to manually change this field to false.
namestringKey field. An arbitrary name that represents the properties associated with the STEP bridge/connection to the peer router. This is typically set to be the name of the authority name or router name of the peer.
router-namestringThis is the value configured as the router > name of the SSR peer router that this configuration element represents.

Version History:

ReleaseModification
1.0.0Introduced
1.1.0core-address renamed to control-address, to reflect new naming conventions
2.0.0Added tenant, removed role
3.0.0Removed unused fields, removed tenant
3.2.0Removed id, added generated

performance-monitoring-profile

Path

authority > performance monitoring profile

Description

The inline flow performance profile provides flow statistics collected on a per path, traffic class, and protocol (TCP or UDP) level.

ElementTypeDescription
namestringThe name of the performance monitoring profile.
marking-countuint16The number of packets to mark within a given interval.
interval-durationuint32The duration of a packet marking interval in milliseconds.
monitor-onlybooleanDefault is false. Generates metrics and provides those metrics for calculating SLA and making load balancing decisions. Set monitor-only to true to generate metrics, but will not influence load balancing decisions or traffic flow.
resource-groupstringAssociate this performance monitoring profile with a top-level resource-group.

Version History:

ReleaseModification
5.0.0Introduced
5.1.0Added monitor-only

policy

Path:

authority > routing > policy

Description:

The policy element represents SSR's implementation of BGP route policies. A route policy lets administrators manipulate BGP messages based on criteria (as specified in filter configuration) to perform specific steps, each of which is contained within a statement.

ElementTypeDescription
namestringA unique identifier for this routing policy. This will be referenced by other configuration elements.
statementsub-elementThe actions to be taken as a part of the routing policy.

port-range

Path:

authority > router > node > device-interface > network-interface > adjacency > port‑range authority > router > node > device-interface > network-interface > neighborhood > port‑range authority > service > transport > port-range

Description:

When an SSR sends vectored sessions to another SSR (that is, when it uses its SSR-specific routing technique), the device transmitting the packet to its peer chooses the L4 ports for itself as well as for the far end. Occasionally, SSRs are deployed behind firewalls with only specific ranges of ports allowed through; by default, the SSR will choose ports between 16,384 and 65,535. The port-range attribute (within an adjacency) defines the start and end ports that a local SSR instead of the defaults, to account for any firewall rules that may exist between this SSR and the far end SSR (protecting the latter).

ElementTypeDescription
end-portl4-portThe ending port for the range.
start-portl4-portKey field. Valid values: 1025-16383. The starting port for the range.

Version History:

ReleaseModification
2.0.0Introduced

port-range (host-service)

Path:

authority > router > node > device-interface > network-interface > address > host-service > transport > port-range

Description:

This is the range of ports (which may be as narrow as a single port) that are in use by the host-service that contains this sub-element.

ElementTypeDescription
end-portl4-portThe ending port for the range.
start-portl4-portKey field. The starting port for the range.

Version History:

ReleaseModification
3.1.0Introduced as part of the host-service feature

post-encryption-padding

Path:

authority > router > node > device-interface > network-interface > adjacency > post-encryption-padding authority > router > node > device-interface > network-interface > neighborhood > post-encryption-padding

Description:

The post-encryption-padding feature will cause the SSR to pad encrypted packets that it sends to SVR peers, to avoid middleboxes that drop encrypted payloads. The receiving SSR device will strip the padding from the packet.

ElementTypeDescription
modeenumerationValid values: disabled, enabled. Default: disabled. When enabled, the SSR will pad any encrypted packets sent to peers.

pppoe

Path:

authority > router > node > device-interface > pppoe

Description:

This is the container for the configurable attributes about an SSR's support for PPPoE. The SSR acts as a PPPoE client, and can retrieve information for this interface based upon the authentication protocol, password, and username elements configured here.

ElementTypeDescription
authentication-protocolenumerationValid values: chap, pap. The authentication protocol in use by the PPPoE server with which this SSR will communicate.
passwordstringThe password to use when communicating with the PPPoE server.
user-namestringThe username to use when communicating with the PPPoE server.

Version History:

ReleaseModification
3.1.0Introduced

prefix-limit (neighbor)

Path:

authority > router > routing > routing-protocol (bgp) > neighbor > address-family > prefix-limit

Description:

This configuration element governs the number of prefixes that will be accepted for this specific neighbor.

ElementTypeDescription
max-prefixesuint32The number of prefixes accepted from each neighbor in this address-family.
restart-timeruint16This controls the time (in seconds) after a connection is torn down with a peer due to excessive prefix limiting, before the SSR will attempt to reconnect with the peer.
shutdown-threshold-pctuint8Valid values: 0-100. Expressed as a percentage (of max-prefixes), the threshold before the SSR generates log messages warning that a peer is approaching its max-prefix limit.

Version History:

ReleaseModification
1.0.0Introduced

prefix-limit (routing-protocol)

Path:

authority > router > routing > routing-protocol (bgp) > address-family > prefix-limit

Description:

This configuration element governs the number of prefixes that will be accepted for each BGP peer, for each address family.

ElementTypeDescription
max-prefixesuint32The number of prefixes accepted from each neighbor in this address-family.
restart-timeruint16This controls the time (in seconds) after a connection is torn down with a peer due to excessive prefix limiting, before the SSR will attempt to reconnect with the peer.
shutdown-threshold-pctuint8Valid values: 0-100. Expressed as a percentage (of max-prefixes), the threshold before the SSR generates log messages warning that a peer is approaching its max-prefix limit.

Version History:

ReleaseModification
1.0.0Introduced

reachability-detection

Path:

authority > router > node > reachability-detection

Description:

The reachability-detection feature will periodically refresh ARP entries and can provide indicators if a gateway becomes unreachable. This configuration element lets you govern the reachability properties for all interaces on a given node.

ElementTypeDescription
arp-cache-timeoutuint32Valid values: 0-86400. Default: 0. Duration (in seconds) that an arp entry will be preserved in the system after it is no longer in use.
arp-refresh-intervaluint32Valid values: 1-86400. Default 1200. Represents the frequency (in seconds) that an arp entry is refreshed.
expired-refresh-countuint8Valid values: 3-20. Default: 10. Represents the number of attempts to resolve an ARP before declaring it to be expired.
expired-refresh-intervaluint32Valid values: 500-60000. Default: 500. Represents the retry frequency (in milliseconds) of ARPs in an expired state.
gateway-refresh-intervaluint32Valid values: 1-86400. Default: 5. Represents the frequency in seconds that a gateway ARP entry is refreshed.

redistribute

Path:

authority > router > routing > ospf > redistribute

Description:

The redistribute element allows administrators to control which sources of routes will get redistributed into OSPF by the SSR.

ElementTypeDescription
metricuint32Valid values: 0-16777214. This is the metric the SSR will use for routes it redistributes into OSPF.
metric-typeenumerationValid values: type-1, type-2. Default: type-2. Controls whether the routes are redistributed as Type 1 or Type 2 routes. This affects how other routers will treat the advertisement.
policyreferenceThe policy that should get applied to routes that are redistributed.
protocolenumerationKey field. Valid values: bgp, connected, service, static. This controls which types of routes the redistribution will include. The service value will control whether this router will advertise SSR's service routes into OSPF.

redundancy-group

Path:

authority > router > redundancy-group

Description:

The redundancy-group sub-element lets users specify device-interface elements (via their "id") that will share fate -- if any of them fail, the complements listed in the group will also be switched to their counterparts.

ElementTypeDescription
descriptionstringA human-readable description of the redundancy group.
membersub-elementThe member interfaces in a redundancy group.
namestringKey field. This is a unique label used to identify the redundancy-group.
priorityuint8Valid values: 0-100. A number to indicate the preference of this group relative to other groups. The higher the number, the more preferred.

Version History:

ReleaseModification
2.0.0Introduced

remote-login

Path:

authority > remote-login authority > router > system > remote-login

Description:

The remote-login feature creates management connections between the conductor and the routers it manages, allowing administrators to remotely log into the PCLI (or a Linux shell) from the conductor's PCLI or Linux shell.

ElementTypeDescription
enabledbooleanWhether the remote-login feature is enabled for routers in this authority.

See Also

Connecting to Routers

repository

Path:

authority > router > system > software-update > repository

Description:

This controls which repository or repositories a router will use to retrieve software updates and dependent packages.

ElementTypeDescription
offline-modebooleanDefault: false. Controls whether the router will only be able to retrieve software upgrade images via its conductor.
source-typeenumerationValid values: conductor-only, prefer-conductor, internet-only. Default: internet-only. To use the conductor as a proxy server to reach the SSR public internet repository, set this to conductor-only or prefer-conductor. To reach it via the public internet and not use the conductor as a proxy, set it to internet-only.

reverse-packet-session-resiliency

Path

authority > router > reverse-packet-session-resiliency

Description

Parameters for setting session failover behavior without presence of forward traffic.

ElementTypeDescription
enabledbooleanDefault: true. Controls whether reverse packet triggered failover is enabled on this router when session resiliency is set.
detection-intervaluint32Default: 5. Range: 1-30.
minimum-packet-countuint32Default: 3. Range: 1-999999. Minimum number of packets received on the flow to activate the feature.

Version History:

ReleaseModification
5.6.3Introduced

route-reflector

Path:

authority > router > routing > routing-protocol (bgp) > neighbor > address-family > route-reflector

Description:

This governs whether or not the SSR should act as a route reflector for this neighbor, for this address family.

ElementTypeDescription
clientbooleanWhen true, the neighbor is considered a route reflector client for this address family.

Version History:

ReleaseModification
1.0.0Introduced

route-selection-options

Path:

authority > router > routing > routing-protocol (bgp) > route-selection-options

Description:

A sub-element within the BGP configuration that governs how the SSR performs its best path selection.

ElementTypeDescription
always-compare-medbooleanDefault: false. When true, the SSR will compare multi-exit discriminator (MED) values from different ASes when selecting the best route. The default behavior only compares MED values received from the same AS.
external-compare-router-idbooleanWhen true, the ID of the peer is a criteria for selecting the active path for external BGP neighbors.
ignore-as-path-lengthbooleanDefault: false. When true, the SSR ignores the AS path length when choosing the best path. By default the SSR will prefer paths with shorter lengths.

Version History:

ReleaseModification
1.0.0Introduced

router

Path:

authority > router

Description:

The router configuration element represents an SSR or conductor; these are typically either one node (for standalone systems) or two nodes (for highly available systems).

The router element serves as a container for holding the nodes of a single deployed router, along with their associated services and policies.

ElementTypeDescription
administrative-groupstringA tag that identifies this router as belonging to an administrative group for management purposes.
application-identificationsub-elementAllows administrators to configure the SSR's behavior for application identification (understanding the applications based on the payload of packets).
bfdsub-elementAllows administrators to configure the router-wide default BFD timers that all routers will use when sending exchanges among themselves.
conductor-addresshostnameMaximum two. This allows administrators to override the authority-wide addresses used to reach conductor for this specific router. This is typically used when a router is collocated with conductor and has access over a different network than the remaining router population. See Conductor Deployment Patterns for more information.
descriptionstringA field for containing human-readable information. Has no impact on packet forwarding.
dhcp-server-generated-address-poolipv4-prefixThis lets you configure the (internal) address prefix that will be used for the system's DHCP servers. By default it will use a link-local address block of 169.254.130.0/24. This should only be configured if you've already allocated that block for other purposes in your configuration.
entitlementsub-elementAn entitlement represents a purchased amount of bandwidth, licensing your SSR. Each SSR may only have one entitlement.
groupstringA label that is used to identify this router as belonging to a specific collection of one or more routers, for administrative access. E.g., administrators can group routers together with a common label configured here, and selectively show/hide groups within the SSR graphical user interface.
inter-node-securityreferenceRefers to a configured security element (i.e., a security policy).
locationstringA field for containing human-readable information. Has no impact on packet forwarding.
location-coordinatesgeolocationThe router's location (coordinates), used for rendering it on the topology map in the Conductor's GUI. The coordinates should be entered in ISO-6709 format.
maintenance-modebooleanDefault: false. When true, alarms generated by this router will be shelved (not active). This is helpful when staging configuration for routers that have not yet been deployed.
namestringKey field. A text string that names the router. Each distinct router within an authority must be named uniquely.
nat-poolsub-elementA range of addresses (mask) that this router will use when forwarding traffic.
nodesub-elementA list of nodes that comprise this router.
path-mtu-discoverysub-elementControls the overall settings for Path MTU Discovery behavior on this router. This can subsequently be overridden on specific interfaces or adjacencies.
peersub-elementEach peer defines the properties of another router (within this router's authority, or not) for bridging/connecting to via STEP.
redundancy-groupreferenceA multiple instance sub-element for defining groups of interfaces that will all fail over in conjunction. (This supports what is known as a "shared fate" model of failover.)
reverse-flow-enforcementenumerationValid values: none, strict. Default: none. This configuration element determines whether or not the SSR requires that the egress interface for a reverse flow is the same as the ingress interface for a forward flow. In practice, when set to "strict", a router will perform a uRPF (Unicast Reverse Path Forwarding) check on the reverse flow to see if the interfaces match. If they do not match, the session will not be established.
router-groupstringMultiple instance. This defines which "groups" the router belongs to. Router groups are used for filtering the services that are pushed to a router by the conductor. Each service can specify which routers and/or router groups should receive a copy of that service, and for router-group distribution the group name is compared to the elements configured here.
routingsub-elementThis is a single instance sub-element for defining this router's routing properties.
service-routesub-elementMultiple instance. The service-routes within this router are each defined as a sub-element within the router.
service-route-policysub-elementMultiple instance. The policies for distributing traffic to service-routes are defined as policies local to this router.
systemsub-elementSingle instance, a reference to this SSR instance's system-wide properties.
udp-transformsub-elementThe system settings for the SSR's UDP transform function.

Version History:

ReleaseModification
1.0.0Introduced
1.1.0Added entitlement sub-element
3.0.0Removed priority, added location-coordinates
3.1.0Added group
3.2.0Added application-classification, maintenance-mode, and udp-tranform

routing (authority-wide)

Path:

authority > routing

Description:

The routing element within an authority lets administrators configure policies and filters that are available to every router managed by a conductor.

ElementTypeDescription
filtersub-elementA field for containing human-readable information. Has no impact on packet forwarding.
policysub-elementAt this time, the SSR only supports the BGPv4 routing protocol.

routing (per-router)

Path:

authority > router > routing

Description:

The routing element is a router-level container for all of the routing policies associated with a given SSR deployment. Each routing element may have one and only one routing-instance.

ElementTypeDescription
descriptionstringA field for containing human-readable information. Has no impact on packet forwarding.
interfacesub-elementDefines an internal loopback interface to be used with routing protocols.
ospfsub-elementGoverns the SSR's routing behavior with regard to the OSPF protocol.
routing-protocolsub-elementThe configuration hierarchy for BGPv4.
static-routesub-elementWhere administrators define static routes for their router.
typeenumerationValid values: default-instance. At this time, the SSR only supports the "default-instance" type.

Version History:

ReleaseModification
1.0.0Introduced

routing-protocol (bgp)

Path:

authority > router > routing > routing-protocol (bgp)

Description:

The routing-protocol configuration element contains configuration properties related to each routing protocol. The fields shown in this element will vary based on the type chosen. (At this time, the only valid type is "bgp".)

ElementTypeDescription
address-familysub-elementA container for the behaviors, timers, and attributes related to each address family (AFI/SAFI) on the SSR.
confederationsub-elementThis configuration sub-element controls the SSR's behavior when it is within an autonomous system that is part of a BGP confederation.
descriptionstringA field for containing human-readable information. Has no impact on packet forwarding.
graceful-restartsub-elementProvides the ability to be configured as disabled, helper mode (default), or enabled. graceful-restart mode on BGP neighbors can be configured differently than on the BGP instance.
local-asuint32The local autonomous system number of this SSR.
neighborsub-elementMultiple instance.
route-selection-optionssub-elementThis is a set of configuration options that control how the SSR chooses the best path.
router-idaddressThe ID of the SSR, expressed as an IPv4 address.
timerssub-elementGlobal timers related to the SSR's BGP behavior.
typeenumerationValid value: bgp.

Version History:

ReleaseModification
1.0.0Introduced

rule

Path:

authority > routing > filter > rule

Description:

The rule sub-element within a route filter will describe the matching criteria for the filter; note, the rule will attempt to match the attributes specified in the filter's type.

ElementTypeDescription
as-pathregexWhen the filter's type is set to as-path-filter, this allows you to specify a regex pattern to match the AS PATH in the BGP message.
communityregexWhen the filter's type is community-filter, this lets you configure a regular expression pattern for matching the community of interest.
extended-communityregexWhen the filter's type is extended-community-filter, this lets you configure a regular expression pattern for matching the BGP extended community attribute of interest.
filterenumerationValid values: accept, reject. This will accept or reject the rule based on its name.
geuint8When the filter's type is prefix-filter, this lets you match prefixes greater than or equal to the prefix length specified.
leuint8When the filter's type is set to prefix-filter, this lets you match prefixes less than the length of the prefix specified.
namestringA unique identifier for this rule.
prefixaddress prefixWhen the filter's type is set to prefix-filter, this allows you to specify the prefix of interest.

security

Path:

authority > security

Description:

This is a security policy that is attached to various other objects within the SSR configuration hierarchy to govern how it interacts with its peers (within the router or inter-router). This includes the ciphers to use, when packets should be encrypted, when packets should include authentication information (so that a recipient may validate the sender), and which packets are considered permissible.

Generally, security policies are applied within routers, tenants, or services. When security policies are configured at several points within a hierarchy, only the most specific security policy is enforced. E.g., if traffic is sent within a router that has a configured security-policy within a tenant that has a security-policy, the tenant's security policy is enforced.

ElementTypeDescription
adaptive-encryptionbooleanDefault: true. When set to true, a router will not encrypt traffic that is already encrypted, irrespective of the setting of encrypt (below). E.g., if a session is already secured with IPsec or TLS, the SSR will not re-encrypt this session, saving processing horsepower.
descriptionstringA field for containing human-readable information. Has no impact on packet forwarding.
encryptbooleanDefault: true. This field affects whether information is encrypted when transmitted between SSRs and/or SSR nodes. Depending on where this security policy is applied, it will affect whether an SSR's metadata is encrypted (if applied to router > inter-node-security or peer > inter-router-security), or the payload of packets is encrypted (if applied to a service or tenant).
encryption-cipherenumerationValid values: aes-cbc-128, aes-cbc-256. Defaults to aes-cbc-128.
encryption-ivstringThe initialization vector (IV) for encryption.
encryption-keystringThe encryption key for this security policy.
hmacbooleanDefault: true. When true, the SSR will insert an HMAC value into packets.
hmac-cipherenumerationValid values: sha1, sha256, sha256-128. The cipher used for generating the HMAC value inserted into metadata.
hmac-keystringThe HMAC key for this security policy.
hmac-modeenumerationValid values: disabled, regular, time-based. Default: time-based. This governs whether and how the SSR adds HMAC information to packets it transmits to an SVR peer. HMAC is used for peer-to-peer authentication of packets. When set to disabled, no HMAC is added to packets. When set to regular, a standard HMAC authentication pattern is included in all packets. When set to time-based, the HMAC authentication header will include timestamp information, as a replay attack mitigation. Note: including HMAC authentication headers in packets may impact performance.
namestringKey field. This is a unique name used by other configuration elements to refer to this security-policy.

Version History:

ReleaseModification
1.0.0Introduced
1.1.0Eliminated unimplemented ciphers. Removed unnecessary modes for encrypt and hmac and set them as booleans. Moved transport-state-enforcement to service-policy.
3.0.0Added hmac-cipher

server (ntp)

Path:

authority > router > system > ntp > server

Description:

This configuration defines external NTP timing sources that the SSR's nodes will all attempt to clock from.

ElementTypeDescription
ip-addressaddressThe IP address or hostname of the external NTP server.

Version History:

ReleaseModification
2.0.0Introduced
3.1.0Supports hostnames in addition to IPv4 addresses

server (syslog)

Path:

authority > router > system > syslog > server

Description:

This configuration defines external syslog servers that the SSR will send syslog messages to.

ElementTypeDescription
ip-addressaddressThe IP address or hostname of the external syslog server.
portl4-portThe L4 (UDP) port that the syslog server is listening on; this is typically 514.

Version History:

ReleaseModification
2.0.0Introduced
3.1.0Added support for hostnames in the ip-address field

server (webserver)

Path:

authority > router > system > services > webserver > server

Description:

This configuration defines the listening address for running the SSR's web GUI on a specific Control (or Combo) node.

ElementTypeDescription
ip-addressaddressThe IP address to use for binding the SSR's webserver. (The port will be taken from the webserver element.)
node-namereferenceKey field. The name field of the node that will use the IP address specified within this sub-element.

Version History:

ReleaseModification
2.0.0Introduced

service

Path:

authority > service

Description:

The SSR solution is deployed to facilitate the delivery of new applications; as such, the service configuration is at the heart of the SSR data model. It is where you define the services (such as web services, database services, etc.) that reside within the authority's tenants, as well as the properties of, and policies to apply to those services.

ElementTypeDescription
access-policysub-elementThis is a multiple instance sub-element that allows administrators to define groups of users (by address, address prefix, or QSN) that can be explicitly allowed or denied access to this service. See access-policy.
access-policy-generatedbooleanDefault: false. Controls whether the access-policy of this service was generated by the conductor at the time of commit. As with all other "generated" configuration, this is destroyed and regenerated with every commit. Therefore, to make any persistent changes to this service's generated access-policy, this field must be set to false.
addressaddressMultiple instance. When the SSR receives packets matching the address(es) listed here, it considers those packets to be destined for this service and will follow its service routing logic.
application-namestringThe value configured here will be matched against the Common Name learned via application classification techniques for application identification purposes.
application-typeenumerationValid values: generic, dhcp-relay, dns-proxy, ftp-control, or ftp-data. Default: generic. Certain types of traffic require special treatment by the SSR. For example, when forwarding FTP traffic, the FTP protocol can exchange addresses that may not be reachable if there are NAT devices between the source and destination; thus, the use of ftp-control and ftp-data can look for, and replace, those unreachable addresses and act as an FTP Application Layer Gateway. See also: DNS Proxy.
applies-tosub-elementControls which devices will receive copies of this service from the conductor when configuration is committed.
descriptionstringA field for containing human-readable information. Has no impact on packet forwarding.
domain-namestringDomain name that identifies a service. Traffic matching this domain name is assigned to this service.
domain-name-categorystringDomain name categorization of this service. This is matched against the imported categories using the domain pulled from the data stream.
enabledbooleanWhen false, this service is administratively disabled. Packets addressed to this service's address(es) will not be processed.
fqdn-resolution-typeenumerationValid values: v4, v6. Default: v4. This controls which type of DNS query will be issued when trying to resolve address values that are configured as hostnames.
generatedbooleanDefault: false. When a conductor generates traffic it sets this field to true. In order to make any modifications to generated configuration elements, it is necessary to set the generated flag to false to have those changes persist.
multicast-sender-policysub-elementThis controls access to multicast services, i.e., which sources will have permission to participate in the multicast.
namestringKey field. The name of the service, and used as the key for other objects needing to reference this service.
scopeenumerationValid values: public, private.
securityreferenceRefers to a configured security instance by its name.
service-groupstringOptional. Placing a string here treats this service as belonging to a group with other services that share the same service-group string. This collection of services can be referred to en masse by the QSN that includes this service-group name.
service-policyreferenceRefers to a configured service-policy instance by its name.
share-service-routesbooleanDefault: true. When true, this will cause a conductor managing multiple routers in this router's Authority to create a service-route to point to any neighboring SSR that contains a (non-peer) service-route for this service's traffic.
source-natenumerationValid values: network-interface, disabled. Default: network-interface. This allows administrators to override the default source NAT treatment for traffic egressing a network-interface and prevent the SSR from applying any source NAT treatment to the packets.
tap-multiplexingbooleanSetting this to true will cause the SSR to treat the sessions for this traffic differently than the default behavior. Traffic that matches a FIB entry for the service will create two local sessions: one that matches the forward flow and one that matches the reverse flow with the source and destination addresses flipped. When the router sends this traffic over SVR to the remote router, it inserts a small piece of metadata into each packet which identifies whether it is for the forward or reverse flow. This is used by the remote router to undo the NAT and ensure the IP address and port are replaced correctly with the original source or destination information. The purpose of this is to ensure that both the forward and reverse flows are NATted to the same address and port combination over SVR, thus ensuring they follow the same path over the internet and do not arrive out of order at the capture receiver.
tenantreferenceRefers to a configured tenant instance by its name.
transportsub-elementThe transport protocol(s) and port(s) for the service.
urlstringURL that identifies a service. Traffic matching this URL will be considered to belong to this service.

Version History:

ReleaseModification
1.0.0Introduced
2.0.0Added transport to replace the deprecated protocol
3.0.0Removed protocol
3.1.0Removed id
3.2.0Added application-name and share-service-routes

service-class

Path:

authority > service-class

Description:

The service-class configuration is used to define the outbound treatment through the traffic engineering subsystem for sessions traversing an SSR. The SSR's term "service class" is used as defined in RFC 4594, "Configuration Guidelines for DiffServ Service Classes", which states:

A "service class" represents a set of traffic that requires specific delay, loss, and jitter characteristics from the network. Conceptually, a service class pertains to applications with similar characteristics and performance requirements, such as a "High-Throughput Data" service class for applications like the web and electronic mail, or a \"Telephony\" service class for real-time traffic such as voice and other telephony services. Such a service class may be defined locally in a Differentiated Services (DS) domain, or across multiple DS domains, possibly extending end to end.

The SSR uses service classes to prioritize session flows through its traffic management subsystem. Service classes are assigned to traffic classes, which are in turn assigned to services, and each service class is mapped to one of four built-in traffic classes (high, medium, low, or best-effort). The SSR's traffic management subsystem uses these traffic-classes when scheduling packets for delivery to reserve bandwidth for each class, per egress interface.

ElementTypeDescription
descriptionstringA field for containing human-readable information. Has no impact on packet forwarding.
dscpuint8The DSCP value to mark egress packets with for this service.
max-flow-burstuint32Configured in bytes. Each flow using this service-class may be limited to bandwidth bursts by setting this field.
max-flow-rateuint64Configured in bytes per second. This limits the maximum rate of each flow referencing this service class.
namestringKey field. A unique label for this service-class that will be used by other objects to refer to a specific configured instance.
priorityintegerValid values: 0-3. Deprecated in favor of traffic-class (below). The priority values govern the treatment for the traffic. Priority 0 is the highest priority, priority 3 is "best effort".
rate-limitbooleanDefault: false. When set to true, the SSR will enforce the properties configured in max-flow-burst and max-flow-rate.
traffic-classenumerationValid values: high, medium, low, best-effort. Working in concert with the SSR's traffic engineering subsystem, this lets administrators determine which traffic queues the traffic that references this service class will use, and therefore how much guaranteed bandwidth will be reserved for that class.

Version History:

ReleaseModification
1.0.0Introduced
1.1.0max-jitter, max-latency, max-loss, path-quality-filter, qp-preference, required-qp all moved to service-policy
3.0.0priority is no longer a reference, but maps to one of four hardcoded priorities
3.2.0added traffic-class

service-policy

Path:

authority > service-policy

Description:

These are policy parameters that may be applied to service traffic to affect its packet marking, rate limiting, load balancing strategy, etc.

ElementTypeDescription
best-effortbooleanDefault: true. Typically, when paths are below the specified SLA (loss/jitter/latency/MOS), those paths will not be considered for forwarding traffic. This may not be desirable in situations where the primary goal would be to forward traffic when no path satisfies the specified SLA. When true, the SSR will continue to forward traffic if all paths fail SLA thresholds using the best path available (according to administrative preference). When false, this traffic will instead be dropped.
best-pathenumerationValid values: vector, average latency, MoS. Default: vector. Average latency is calculated using BFD or performance monitoring. MoS is calculated based on the running average of latency and Loss measured for each peer path.
descriptionstringA field for containing human-readable information. Has no impact on packet forwarding.
generatedbooleanDefault: false. The conductor will set this value to true when it generates the configuration based on other settings in the SSR. In order to modify generated configuration and have those settings persist, set generated to false.
ingress-source-natenumerationValid values: network-interface, disabled. Default: network-interface. Disabling this attribute will prevent the SSR from using the ingress-source-nat value from the network-interface, and not perform any source NAT treatment at all.
lb-strategyenumerationValid values: hunt, proportional. This is the load balancing strategy to use for traffic that references this service-policy.
max-jitteruint32Default: 100. Configured in milliseconds, the maximum acceptable jitter for services that use this service-class.
max-latencyuint32Default 250. Configured in milliseconds, the maximum acceptable latency for services that use this service class.
max-lossdecimal64Expressed as a percentage. Valid values: 0-100. Default 0.5 (0.05%). As a percentage of total packets, the acceptable threshold of packet loss for services that use this service class.
min-mosunionValid values: disabled or a decimal value from 1.00-5.00. When set to a decimal value, this will filter out paths that fall below the calculated MOS (Mean Opinion Score) based on the observed jitter, latency, and loss on the paths.
namestringKey field. A unique label for this service-policy that will be used by other objects to refer to a specific configured instance.
path-quality-filterbooleanSetting this to "true" causes the SSR to enforce the configured values in max-jitter, max-latency, and max-loss when choosing paths for traffic forwarding. I.e., paths that do not meet the thresholds configured in these fields are filtered out and not considered viable. When set to false, the values configured in max-jitter, max-latency, and max-loss are ignored.
qp-preferenceenumerationValid values: highest, lowest. After filtering out next hops that do not meet this service-class's required-qp value, the SSR will order them from highest to lowest (when this is set to highest), or lowest to highest (when this is set to lowest). This determines whether a service's traffic will take the best quality link available, or the minimum viable link available.
required-qpuint32The required number of Quality Points for this service. Interfaces not meeting this threshold are not considered as valid next hops.
service-classreferenceA reference to a configured service-class.
session-resiliencyenumerationValid values: none, failover, revertible-failover, packet-duplication. Default: none. This governs how the SSR provides resilience for sessions in the event of network issues that would cause it to choose a new path for active traffic processing. The default "none" will take no action in the event of failure. The value "failover" will cause the SSR to seek another path for traffic when a failure is detected. The value "revertible-failover" will seek another path, but return to the previous path when the disruption is deemed to be restored. The value "packet-duplication" causes the SSR to generate two sets of packets and sends them on multiple, distinct paths to the destination -- where the recipient SSR filters the duplicates out prior to forwarding the traffic.
transport-state-enforcementenumerationValid values: allow, block, reset. Default: reset. This governs the behavior of a router's TCP state machine when receiving unexpected packets. When set to 'reset', if a router receives a TCP packet that does not match any session-in progress and the SYN flag is not set, or it receives a packet that does match a session in progress but it does not conform to the router's TCP state machine (e.g., the sequence number is outside the expected window), the router will send a RST back to the sender. Setting this field to 'allow' causes the router to pass non-SYN first packets and non-conforming packets (per the TCP state machine's expectations). The 'block' setting causes the router to silently discard non-SYN first packets and non-conformant packets (again, per the state machine).
vectorsub-elementThe vector sub-element is where administrators assign costs to vector labels (which are associated with neighborhoods on egress interfaces), to assist in choosing the most appropriate path for traffic that references this service-policy. Each service-policy can independently assign costs to these vector variables, and therefore the same topology of SSRs can route distinct service traffic uniquely.

Version History:

ReleaseModification
1.0.0Introduced
1.1.0Many fields from service-class reorganized into service-policy; transport-state-enforcement moved from security to service-policy
3.0.0Added session-resiliency
3.1.0Added min-mos
3.2.0Added vector

service-route

Path:

authority > router > service-route

Description:

A service-route is a target route for handling traffic for a given service.

ElementTypeDescription
generatedbooleanDefault value: false. This field is set to true when a conductor generates configuration based on two SSRs having interfaces in a common neighborhood. When this field is set to true, the conductor will delete and regenerate this configuration element upon each commit. Thus, when an administrator wants to make persistent configuration changes to this object after it has been generated by a conductor, it is important to manually change this field to false.
hostsub-elementThis is used to direct packets to the host operating system of a specified node.
namestringKey field. A unique name to represent this service-route.
nat-targetaddressThe target address for this service-route.
next-hopsub-elementThis specifies the fully qualified interface (node, interface, gateway) to use to reach this service-route.
next-peerreferenceThe name of a configured peer element to use for this service-route. Unlike peer, this allows for the configuration of multiple peer elements.
peerreferenceThe name of a configured peer element to use for this service-route.
service-namereferenceThe name of the service to which this service-route belongs.
service-route-policyreferenceThe service-route-policy to use when handling traffic for this service-route.
use-learned-routesN/AWhen present, the SSR will consult its RIB for next-hop resolution. This configuration is typically used when you wish to use dynamic routing (which the SSR will do by default without a service-route), but also require a conductor to generate peer and adjacency configuration on behalf of this router (which requires a service-route) to share this service-route to other SVR peers.

Version History:

ReleaseModification
1.0.0Introduced
1.1.0Renamed to service-route (was service-agent). Version 03: fixed old reference (server-ip should be destination)
3.0.0Added peer
3.1.0Renamed destination as nat-target; removed remote-tenant-id
3.2.0Added generated

service-route-policy

Path:

authority > router > service-route-policy

Description:

Service route policies are used to define the properties of individual service routes for things such as capacity and rate-limiting. This in turn affects the selection process for an SSR when determining the most appropriate service route for a new inbound session request.

ElementTypeDescription
descriptionstringA field for containing human-readable information. Has no impact on packet forwarding.
max-sessionsenumerationValid values: unlimited, or a number ranging from 0-999999999999. When set to "unlimited", there will be no limit to the number of new sessions that can be sent to service-routes configured with this service-route-policy. When configured with a numerical value, once the service-route using this service-route-policy reaches the configured threshold, no new sessions will be sent to it.
namestringKey field. An arbitrary, unique name for the service route policy.
packet-replicationbooleanDefault: false. When configured, the SSR will replicate packets to all next-hops configured in the service route(s) referencing this policy.
session-high-water-markuint8Expressed as a percentage. Valid values: 1-100. Percentage of maximum sessions above which the route will no longer be considered for load balancing. The denominator for the percentage considers the max-sessions value configured in this policy.
session-low-water-markuint8Expressed as a percentage. Valid values: 1-100. Percentage of maximum sessions below which the route will be reconsidered for load balancing. The denominator for the percentage considers the max-sessions value configured in this policy.
session-rateenumerationValid values: unlimited, or uint32. This represents the maximum rate at which sessions can be sent to a service-route that references this service-route-policy. The configured value is expressed in sessions per second. When set to "unlimited", there will be no rate limiting of new session assignments that can be sent to service-routes configured with this service-route-policy. When configured with a numerical value, once the service-route using this service-route-policy reaches the configured rate limit threshold, no new sessions will be sent to it until the rate drops below the configured value.

Version History:

ReleaseModification
1.0.0Introduced
1.1.0Renamed to service-route-policy (was service-agent-policy)

services

Path:

authority > router > system > services

Description:

This represents the set of system services offered by the SSR platform.

ElementTypeDescription
snmp-serversub-elementThe SNMP server(s) the SSR will communicate with.
webserversub-elementThe SSR's web server.

Version History:

ReleaseModification
1.0.0Introduced
2.0.0Removed most internal elements

session-optimization (adjacency/neighborhood)

Path:

authority > router > node > device-interface > network-interface > adjacency > session-optimization authority > router > node > device-interface > network-interface > neighborhood > session-optimization

Description:

Controls whether session-optimization is enabled for connections egressing this neighborhood.

ElementTypeDescription
modeenumerationValid values: auto, never-on. Default: auto. By default the SSR will detect whether session-optimization needs to be enabled based on current network behavior (latency). To disable session-optimization, set this to never-on.

session-optimization (device-interface)

Path:

authority > router > node > device-interface > session-optimization

Description:

This controls whether the SSR will attempt to detect when session-optimization is necessary for traffic egressing this device-interface.

ElementTypeValue
enable-detectionbooleanDefault: true. When true, the SSR will track latency for traffic on the interface to identify the need for session-optimization. When false, no session-optimization will occur for traffic on this interface.

session-type

Path:

authority > session-type

Description:

The session-type sub-element lets administrators specify custom applications, for classification purposes, based on their Layer 4 port and transport. The SSR is shipped with a series of default classification types for well-known port/protocol combinations (e.g., TCP:80 is HTTP).

Administrators may also re-classify any of the defaults if the values are different in their environment.

ElementTypeDescription
descriptionstringA field for containing human-readable information. Has no impact on packet forwarding.
namestringKey field
nat-keep-alivebooleanDefault: false. When enabled, the SSR will periodically generate and transmit empty packets between SSR devices over the active peer path for sessions matching this session-type to ensure any intermediary NAT pinholes are kept refreshed.
service-classreferenceThe service-class to use for flows matching this session-type.
timeoutuint64Expressed in milliseconds. The inactivity timer for sessions of this type; administrators can set this value to free SSR resources if a protocol goes idle for an amount of time equal to this timeout value.
transportsub-elementThe transport protocol and port(s) that are used to match inbound requests to this session-type.

snmp-server

Path:

authority > router > system > services > snmp-server

Description:

This is the configuration associated with the SNMP behavior of the SSR, including which systems should be capable of polling this system for data, and which systems will receive SNMP traps from this router.

ElementNameDescription
access-controlsub-elementFor defining the access-control to this router's SNMP, for polling purposes.
enabledbooleanGoverns whether SNMP is enabled on this router or not.
notification-receiversub-elementThe SSR will send SNMP traps to configured notification-receiver elements.
portl4-portDefault: 161. The L4 port on which the SSR listens for SNMP requests.
versionenumerationDefault: v2c. The SSR supports SNMPv2c only.

software-update

Path:

authority > router > system > software-update

Description:

By default, an SSR retrieves software from a public software repository hosted by Juniper. However, in some deployments access to the public internet may be restricted. The software-update configuration allows administrative controls over how and from where the SSR will retrieve software.

ElementTypeDescription
max-bandwidthenumerationValid values: unlimited, 1-999999999999. This value is in bits/second. This represents the bandwidth limiter applied to software downloads.
repositorysub-elementWhich repository/repositories the SSR will use.

ssh-keepalive

Path:

authority > router > node > ssh-keepalive

Description:

The ssh-keepalive sub-element lets administrators control how often it sends keepalives on SSH connections and how many consecutive missed keepalives indicate a connection failure/reconnection attempt.

ElementTypeDescription
inter-conductor-router-serversub-elementThe SSH keepalive parameters between this router and its conductor.
inter-nodesub-elementThe SSH keepalive parameters for other nodes within this router.
inter-node-serversub-elementThe server-side SSH keepalive parameters for other nodes within this router.
inter-routersub-elementThe SSH keepalive parameters for other routers within this authority.

Version History:

ReleaseModification
3.2.0Introduced

static-route

Path:

authority > router > routing > static-route

Description:

This is the sub-element that allows administrators to configure static routes, that will be entered into the SSR's Routing Information Base (RIB).

ElementTypeDescription
descriptionstringA field for containing human-readable information. Has no impact on packet forwarding.
destination-prefixCIDRKey field.
distanceuint8Key field. The administrative distance for this static-route; used in calculating route preference when multiple possible paths exist learned via different sources.
next-hopsub-elementSpecifies the next-hop for this static route.
next-hop-interfacesub-elementSpecifies the interface to be used to reach the next-hop.

Version History:

ReleaseModification
1.0.0Introduced
3.0.0Added blackhole, distance

statement

Path:

authoritng > routing > policy > statement

Description:

The statement is the programmatic step of a routing policy. Routing policies are comprised of one or more statements, which combine to take action (e.g., accept or reject routes based on criteria, or modify routes). Each statement will evaluate all of its condition elements. If all conditions match (including the case where there are no condition elements configured), the policy for that statement will govern whether the policy will accept or reject that route.

An accept will then execute each action in the statement and then terminate the policy returning, accept. A reject means do not execute the actions and terminate the policy returning reject.

note

If a policy reaches the end of the statement list and no statement has been executed there is an implicit reject.

ElementTypeDescription
actionsub-elementThe action to take based when this statement is executed.
conditionsub-elementThe condition that must be satisfied in order to enforce the policy action of accept or reject.
namestringKey field. A unique name for this statement.
policyenumerationValid values: accept, reject. Governs whether the statement will accept or reject, typically based on a condition.

step-peer-path-advertisement (adjacency)

Path:

authority > router > node > device-interface > network-interface > adjacency

Description

Update frequency and timeliness of the STEP peer path advertisement for the adjacency.

ElementTypeDescription
sla-metricssub-commandSettings for SLA metrics advertisements.
moving-average-sample-sizeuint16Range 1-10000, default 3. Sample size for calculating the weighted moving average of peer path SLA metrics to be advertised into STEP.
significance-thresholdconfiguration containerIncludes the min-loss, min-latency and min-jitter attributes.
min-lossdecimal64Range 0-100. Default: 0.1. Sub-element of significance-threshold. The threshold of packet loss considered significant enough for advertising into STEP.
min-latencyuint32Units: Milliseconds. Default: 5. Sub-element of significance-threshold. The threshold latency value considered significant enough for advertising into STEP.
min-jitteruint32Units: Milliseconds. Default: 2. Sub-element of significance-threshold. The threshold jitter value considered significant enough for advertising into STEP.
increase-report-delayconfiguration containerSub-elements are percentage and delay. Multiple increase-report-delay statements may be configured.
percentageuint16Units: percent. Largest percentage increase seen among all of the metric values. Sub-element of increase-report-delay.
delayuint32Units: seconds. Reporting delay for the given percentage increase. Sub-element of increase-report-delay.
decrease-report-delayconfiguration containerSub-elements are percentage and delay. Multiple decrease-report-delay statements may be configured.
percentageuint16Units: percent. Largest percentage increase seen among all of the metric values. Sub-element of decrease-report-delay.
delayuint32Units: seconds. Reporting delay for the given percentage increase. Sub-element of decrease-report-delay.

If moving-average-sample-size or significance-threshold is not configured, the default values will be used. Likewise, if increase-report-delay or decrease-report-delay is not configured, the default configuration is in effect.

Version History:

ReleaseModification
5.0.0Introduced

step-peer-path-advertisement (neighborhood)

Path:

authority > router > node > device-interface > network-interface > neighborhood

Description

Update frequency and timeliness of the STEP peer path advertisement for the neighborhood.

ElementTypeDescription
sla-metricssub-commandSettings for SLA metrics advertisements.
moving-average-sample-sizeuint16Range 1-10000, default 3. Sample size for calculating the weighted moving average of peer path SLA metrics to be advertised into STEP.
significance-thresholdconfiguration containerIncludes the min-loss, min-latency and min-jitter attributes.
min-lossdecimal64Range 0-100. Default: 0.1. Sub-element of significance-threshold. The threshold of packet loss considered significant enough for advertising into STEP.
min-latencyuint32Units: Milliseconds. Default: 5. Sub-element of significance-threshold. The threshold latency value considered significant enough for advertising into STEP.
min-jitteruint32Units: Milliseconds. Default: 2. Sub-element of significance-threshold. The threshold jitter value considered significant enough for advertising into STEP.
increase-report-delayconfiguration containerSub-elements are percentage and delay. Multiple increase-report-delay statements may be configured.
percentageuint16Units: percent. Largest percentage increase seen among all of the metric values. Sub-element of increase-report-delay.
delayuint32Units: seconds. Reporting delay for the given percentage increase. Sub-element of increase-report-delay.
decrease-report-delayconfiguration containerSub-elements are percentage and delay. Multiple decrease-report-delay statements may be configured.
percentageuint16Units: percent. Largest percentage increase seen among all of the metric values. Sub-element of decrease-report-delay.
delayuint32Units: seconds. Reporting delay for the given percentage increase. Sub-element of decrease-report-delay.

If moving-average-sample-size or significance-threshold is not configured, the default values will be used. Likewise, if increase-report-delay or decrease-report-delay is not configured, the default configuration is in effect.

Version History:

ReleaseModification
5.0.0Introduced

step-peer-path-sla-metrics-advertisement (district-setting)

Path

authority > router > district-setting

Description

STEP peer path advertisement settings for SLA related metrics.

ElementTypeDescription
update-rate-limitunit32Units: Seconds. Default: 180. Range 1-86400. Rate limit interval between updating peer path SLA metric values advertised in STEP.
minimum-update-intervaluint32Units: Seconds. Default: 30. Range 1-86400. Minimum (burst) interval in between updating peer path SLA metric values advertised in STEP.
update-burst-sizeuint8Default: 2. Range: 1-100. Limit on the number of peer path SLA metric value updates advertised in STEP at the minimum (burst) update interval.

Only the default-district parameters are in effect. If no district-settings are configured, or if any of the step-peer-path-advertisement values are not provided, the default values are used.

Version History:

ReleaseModification
5.0.0Introduced

summary-range

Path:

authority > router > routing > ospf > area > summary-range

Description:

This controls whether the SSR will advertise summary routes into OSPF. This only applies when the SSR is acting as an Area Border Router (ABR).

ElementTypeDescription
advertisebooleanDefault: true. Controls whether the SSR will advertise the specified prefix or not.
prefixip-prefixSpecifies the summarization prefix to advertise.
costuint32Valid values: 0-16777214. Specifies the cost of the summarized route.

syslog

Path:

authority > router > system > syslog

Description:

The syslog sub-element lets administrators configure the SSR's interaction with external syslog services.

ElementTypeDescription
facilitystringValid values: local0, local1, local2, local3, local4, local5, local6, local7. This indicates the facility value (per RFC 5424) that the SSR will use when sending syslog messages to external servers.
serversub-elementThe syslog server(s) that the SSR will send messages to is/are configured here.
severityenumerationValid values: emergency, alert, critical, error, warning, notice, info, debug, trace. This sets the level at which messages will be sent to the syslog server.

Version History:

ReleaseModification
2.0.0Introduced

system

Path:

authority > router > system

Description:

The system sub-element lets administrators configure system-wide properties for their SSR deployment.

ElementTypeDescription
auditsub-elementThe router's properties for audit-type events.
contactstringThe administrative contact for this SSR deployment.
inactivity-timeruint32Valid values: 300-86400. The number of seconds that a CLI session can be inactive before the SSR closes it.
local-loginsub-elementGoverns the behavior of the system around the number of concurrent local logins.
log-categorysub-elementAllows administrators to selectively affect the logging verbosity of various SSR routing subsystems.
log-levelenumerationValid values: debug, error, fatal, info, trace, warning.
metricssub-elementFor configuring aspects of the SSR's data sampling for its analytics.
ntpsub-elementFor configuring external NTP time sources.
remote-loginsub-elementWhether the conductor will be able to remotely log in to this router.
servicessub-elementInternal system services that the SSR launches.
software-updatesub-elementAffects how and where this router will retrieve software updates.
syslogsub-elementThe SSR's configuration for communication with external syslog services.

Version History:

ReleaseModification
1.0.0Introduced
1.1.0ntp added
2.0.0Added inactivity-timer and syslog
3.0.0Added metrics
3.1.0Removed location, added log-category

system (audit)

Path:

authority > router > system > audit > system

Description:

This sub-element gives administrators the ability to administratively enable or disable system events.

ElementTypeDescription
enabledbooleanDefault: true. When false, the system will not register any system events.

Version History:

ReleaseModification
3.2.0Introduced

tenant

Path:

authority > tenant

Description:

Tenancy is the logical partitioning of a network's resources, done in the interest of restricting access to network services to only the users and groups for which they're intended. Tenants are defined within an authority, and can span one or more routers within that authority. I.e., the services made available to that tenant can exist anywhere within the authority, irrespective of router, and the SSR propagates routing information throughout the tenant to advertise the service's availability irrespective of the client's location. Essentially, tenants are intended to provide complete network segregation. Traffic from one tenant will not be allowed to traverse through another tenant's network, unless explicitly configured to do so.

An example for how tenants could be used would be segregating engineering from accounting within an organization. Another example would be multiple customers within the AWS infrastructure. Each tenant would be a different customer.

In the absence of any configured tenants (that is, no logical partitioning in the configuration), all services are said to belong to the implicit tenant within the authority, referred to as tenant zero. Tenant zero always exists; provisioning any tenant does not remove tenant zero.

The SSR includes the ability to construct hierarchical tenancies, where a "parent" tenant may have zero or more "child" tenants. The hierarchical tenant model allows administrators to create arbitrary groups of tenants and apply policies to that group as a whole, rather than piecemeal. Furthermore, tenants are not restricted to a single hierarchy; two separate parent tenants can both reference the same child tenant, and policies applied to those parent tenants can have different attributes (referred to as "service policies"). Creating these groups of tenants affords the maximum flexibility and minimizes the amount of redundant configuration.

The SSR uses a dotted notation naming scheme for grouping hierarchies of tenants. For example, a tenant named engineering.128technology is a child of the tenant 128technology. When other configuration objects refer to tenants, the effective scope can be controlled by specifying only a portion of a tenant's name. For example, a service that specifies 128technology as the tenant is available to engineering.128technology, finance.128technology, and 128technology.

It is not necessary for an administrator to explicitly create a "parent" tenant prior to creating a "child" tenant (the UI will perform validation and warn an administrator that their action of creating a child tenant will also create a parent tenant). The UI will prevent the deletion of a parent tenant if it has any child tenants.

ElementTypeDescription
descriptionstringA field for containing human-readable information. Has no impact on packet forwarding.
generatedbooleanThis is set to true when the configuration element has been automatically generated by a conductor. In order to make changes to a generated element persist, this field must be set to false.
membersub-elementThis replaces address in previous software versions, and lets administrators define address blocks within neighborhoods to describe tenant membership.
namestringKey field. It is an arbitrary, unique name that other configuration sections will refer to.
securityreferenceThis is a reference to the default security-policy to use for traffic within this tenancy. Note that this will be used only when a more specific service-policy (e.g., one within a service) is not specified.

Version History:

ReleaseModification
1.0.0Introduced
3.0.0Added member, removed (obsoleted) address
3.1.0Removed id

timers (neighbor)

Path:

authority > router > routing > routing-protocol (bgp) > neighbor > timers

Description:

This sub-element allows administrators to control various BGP timers used when connecting to a specific neighbor.

ElementTypeDescription
connect-retryuint16This controls how long, in seconds, the SSR waits between connection attempts to the neighbor.
hold-timeuint16The hold time is the amount of time a connection is considered active, when no messages (keepalive or otherwise) are received from the neighbor. This timer is reset upon each message received from the neighbor. The typical and recommended configuration is three times the keepalive-interval.
keepalive-intervaluint16The time interval (in seconds) that governs how often the SSR sends keepalive messages to the neighbor.
minimum-advertisement-intervaluint16Referred to as the MinRouteAdvertisementIntervalTimer by RFC 4721, this is the minimum time between UPDATE messages sent to the neighbor. It is used to reduce traffic to the neighbor when NLRI exhibits instability.

Version History:

ReleaseModification
1.0.0Introduced

timers (routing-protocol)

Path:

authority > router > routing > routing-protocol (bgp) > timers

Description:

This sub-element allows administrators to control the default BGP timers the SSR will use when connecting to any neighbor.

ElementTypeDescription
hold-timeuint16The hold time is the amount of time a connection is considered active, when no messages (keepalive or otherwise) are received from a neighbor. This timer is reset upon each message received from a neighbor. The typical and recommended configuration is three times the keepalive-interval.
keepalive-intervaluint16The time interval (in seconds) that governs how often the SSR sends keepalive messages to a neighbor.

Version History:

ReleaseModification
1.0.0Introduced

traffic

Path:

authority > router > system > audit > traffic

Description:

This sub-element gives administrators the ability to administratively enable or disable traffic events.

ElementTypeDescription
enabledbooleanDefault: true. When false, the system will not register any traffic events.

Version History:

ReleaseModification
3.2.0Introduced

traffic-engineering

Path:

authority > router > node > device-interface > traffic-engineering

Description:

This sub-element allows administrators to adjust properties of this device-interface related to traffic engineering.

ElementTypeDescription
enabledbooleanDefault: false. Setting this to true applies the configured properties of this traffic-engineering element.
traffic-profilereferenceThis refers to a configured traffic-profile element used to adjust the relative percentages given for high, medium, low, and best-effort traffic classes.
transmit-capenumerationValid values: unlimited or an integer from 0-999999999999. This sets the maximum transmission rate of this interface in bits per second (bps).

Version History:

ReleaseModification
3.1.0The transmit-cap configuration field was previously located within the device-interface, and was moved to its own sub-element
3.2.0Added traffic-profile

traffic-profile

Path:

authority > traffic-profile

Description:

This sub-element allows administrators to adjust properties of how much guaranteed bandwidth is allocated for various traffic categories. Note that the values within best-effort, high, medium, and low are percentage values and must add up to 100 (percent).

ElementTypeDescription
namestringKey field. The name of this traffic-profile.
best-effortsub-elementSets the percentage of bandwidth reserved for best-effort priority traffic.
highsub-elementSets the percentage of bandwidth reserved for high priority traffic.
lowsub-elementSets the percentage of bandwidth reserved for low priority traffic.
mediumsub-elementSets the percentage of bandwidth reserved for medium priority traffic.

Version History:

ReleaseModification
3.2.0Introduced

transport (BGP neighbor)

Path:

authority > router > routing > routing-protocol (bgp) > neighbor > transport

Description:

This sub-element governs the transport protocol parameters for a BGP connection to this neighbor.

ElementTypeDescription
local-addressaddressor reference This is the local address to use for the BGP session with the neighbor. It may be an IPv4 address, or a reference to an interface configured on the SSR.
passive-modebooleanWhen set to true, the SSR will wait for its neighbor to initiate a BGP peering connection.

Version History:

ReleaseModification
1.0.0Introduced

transport (host-service)

Path:

authority > router > node > device-interface > network-interface > address > host-service > transport

Description:

This sub-element defines the port range and transport protocol for matching to inbound packets, to associate them with a configured host-service. Packets matching the address of a node's network-interface, as well as a port and protocol defined within this sub-element, will be bridged to a corresponding service on the underlying Linux platform.

ElementTypeDescription
port-rangesub-elementThe port(s) that the host-service uses.
protocolenumerationValid values: tcp, udp, icmp. The transport protocol(s) that the host-service uses.

Version History:

ReleaseModification
3.1.0Introduced as part of the host-service feature

transport (service)

Path:

authority > service > transport

Description:

This sub-element defines the port range and transport protocol for the service.

ElementTypeDescription
port-rangesub-elementThe port(s) that the service uses.
protocolenumerationValid values: tcp, udp, icmp. The transport protocol(s) that the service uses.

Version History:

ReleaseModification
2.0.0Introduced
3.1.0Removed any as a valid enumeration value for protocol

transport (session-type)

Path:

authority > session-type

Description:

This sub-element defines the port range and transport protocol that are used to match inbound packets to the properties associated with a session-type.

ElementTypeDescription
port-rangesub-elementThe port(s) that the service uses.
protocolenumerationValid values: tcp, udp, icmp. The transport protocol(s) that the service uses.

Version History:

ReleaseModification
2.0.0Introduced
3.1.0Removed any as a valid enumeration value for protocol

udp-transform

Path:

authority > router > node > device-interface > network-interface > adjacency > udp-transform authority > router > node > device-interface > network-interface > neighborhood > udp-transform authority > router > udp-transform

Description:

This sub-element defines the port range and transport protocol that are used to match inbound packets to the properties associated with a session-type.

ElementTypeDescription
detect-intervaluint32Valid values: 1-86400. The time, in seconds, between tests of the TCP firewall detector to see if UDP transform needs to be enabled on an interface.
modeenumerationValid values: auto-detect, always-transform. Default: auto-detect. This governs whether the UDP transformation behavior is triggered upon detection of an interfering TCP middlebox or whether the UDP transformation should be applied even when no detection has occurred.
nat-keep-alive-modebooleanDefault: false. Governs whether this router will generate and transmit keepalive packets to SVR peers.

Version History:

ReleaseModification
3.2.0Introduced

use-multiple-paths

Path:

authority > router > routing > routing-protocol (bgp) > address-family > use-multiple-paths

Description:

The use-multiple-paths container has sub-elements for allowing administrators to configure the SSR's behavior for multipath support for both eBGP and iBGP.

ElementTypeDescription
ebgpsub-elementThis sub-element contains multipath parameters for external BGP (eBGP).
ibgpsub-elementThis sub-element contains multipath parameters for internal BGP (iBGP).

Version History:

ReleaseModification
1.0.0Introduced

vector

Path:

authority > service-policy > vector

Description:

The vector sub-element lets administrators choose cost values for the vector labels that are assigned to neighborhoods on egress SSR forwarding interfaces. As part of the SSR's secure vector routing model, each vector can have a variable cost that is configured within the context of a service-policy, and these service-policy objects may have unique values for the same vectors -- effecting different traffic treatment over the same topology.

ElementTypeDescription
namestringThe name associated with the vector. This must match a vector assigned to a neighborhood on a network-interface for it to have any impact on path selection.
priorityunion(uint32, enumeration) The priority field can either be an explicit cost, ranging from 1-999999, or one of two keywords: ordered or never. When set to ordered, the vector will have an implicit cost, based on its configured order. (The vector elements may be manually reordered via the web UI or the PCLI.) When using ordered, the cost will default to the power of 10 in its list order, starting with 0 (i.e., the costs for a list of ordered items will be 1, 10, 100, ...). When set to never, the interface with the vector will never be used for traffic referencing this service-policy.

Version History:

ReleaseModification
3.2.0Introduced

web-filtering

Path:

authority > router > application-identification > web-filtering

Description:

Enables and configures URL filtering. In order to configure web-filtering, application-identification must be enabled, and the mode must be set to all. For additional information, see application-identification.

ElementTypeDescription
enabledbooleanTrue/False. Default: false. Enable enhanced URL filtering. This requires application-identification to be enabled.
max-retransmission-attempts-before-allowuint8Default: 4. Max number of retransmission packet attempts before allowing session to continue.
classify-sessioncontainer
timeoutsecondsDefault: 5. The amount of time the SSR will wait for a response from Websense.
retriesuint8Default: 3. The max attempts to the Websense server when no response is received within the timeout duration.

webserver

Path:

authority > router > system > services > webserver

Description:

The webserver element defines the address(es) and port upon which the SSR's GUI listens. The SSR's GUI is enabled by default, and will (by default) use the management address(es), on port 443.1 Thus, in the majority of deployment scenarios, this configuration is unused, despite the fact that the GUI is the primary mode of administrative interfacing with the SSR.

Generally, this is only touched if an administrator wants to use either a nonstandard port, or to use an address distinct from the management address established (specified) during software installation.

ElementTypeDescription
enabledbooleanDefault: true. When set to true, the webserver is enabled and will respond to inbound HTTPS requests on the specified address and port.
portuint16The listening port for the SSR's web server.
serversub-elementThe server element binds the SSR's GUI to specific nodes at specific addresses using a series of these configuration elements.

Version History:

ReleaseModification
1.0.0Introduced

Configuration Type Definitions

The items here reflect the base definition for each data type; specific field definitions may limit input for a data type to a more restrictive range than the base definition would allow. For example, the session-high-water-mark field within a service-route-policy is defined as a uint8, yet is expressed in the configuration as a percentage -- which limits its input to values between 0 and 100. The specific field definitions listed in the Configuration Element Reference section of this document list the validation rules for the values, when applicable.

Data TypeDescription
uint8An unsigned, 8-bit integer. The range of an unsigned 8-bit integer is 0-255.
uint16An unsigned, 16-bit integer. The range of an unsigned 16-bit integer is 0-65,535.
uint32An unsigned, 32-bit integer. The range of an unsigned 32-bit integer is 0-4,294,967,295.
stringA sequence of up to 64 alphanumeric characters.
source-specThe source-spec is used to represent either an IPv4 address or a Qualified Service Name (QSN). The SSR validates a source-spec using the address type or the string type, as applicable.
addressAn IPv4 address, ranging from 0.0.0.0 to 255.255.255.255.
booleanTrue or false.
CIDRAn IPv4 address plus subnet mask, expressed in the form aaa.bbb.ccc.ddd/ee.
base64A binary-to-text encoding that represents binary data in ASCII format. The SSR uses MIME's Base64 implementation.
decimal64A 64-bit positive real number.
uint64An unsigned, 64-bit integer. The range of an unsigned 64-bit integer is 0-18,446,744,073,709,551,615.
geolocationGeographic coordinates in ISO-6709 format.