Query Settings
Each query type may be disabled, enabled, or customized. The display_name
parameter defines how the query type will be displayed in the UI's Query Type select element.
bgp_route
#
Parameter | Type | Default | Description |
---|---|---|---|
enable | Boolean | true | Enable or disable the BGP Route query type. |
display_name | String | 'BGP Route' | Text displayed for the BGP Route query type in the UI. |
#
Examplebgp_community
#
Parameter | Type | Default | Description |
---|---|---|---|
enable | Boolean | true | Enable or disable the BGP Community query type. |
display_name | String | 'BGP Community' | Text displayed for the BGP Community query type in the UI. |
mode | String | 'input' | input mode requires the user to type the community value in the target element. select mode allows the user to select a community from a preconfigured list of communities. |
communities | BGP Community Definitions for select mode. | ||
pattern | BGP Community Regular Expression Patterns for input mode. |
#
Community DefinitionsIf using select
mode, you may define a list of communities the users can choose from. Each community definition uses the following schema:
Parameter | Type | Description | Example |
---|---|---|---|
community | String | Community value | '64496:1001' |
display_name | String | Community display name | '64496:1001' |
description | String | Community description | 'North America Routes' |
#
Example#
Community PatternsIf using input
mode, hyperglass allows you to override the default regular expression patterns used to validate UI and API queries. hyperglass supports Decimal (well known) communities, Extended AS communities, and Large communities.
Parameter | Type | Default | Description |
---|---|---|---|
decimal | String | '^[0-9]{1,10}$' | Regular expression pattern for validating decimal type BGP Community strings. |
extended_as | String | '^([0-9]{0,5})\:([0-9]{1,5})$' | Regular expression pattern for validating extended AS type BGP Community strings, e.g. 65000:1 |
large | String | '^([0-9]{1,10})\:([0-9]{1,10})\:[0-9]{1,10}$' | Regular expression pattern for validating large community strings, e.g. 65000:65001:65002 |
#
Examplecaution
Regular expression patterns must be enclosed in single quotes, e.g. '^.*$'
bgp_aspath
#
Parameter | Type | Default | Description |
---|---|---|---|
enable | Boolean | true | Enable or disable the BGP AS Path query type. |
display_name | String | 'BGP AS Path' | Text displayed for the BGP AS Path query type in the UI. |
pattern | BGP AS Path Settings & Regular Expression Patterns |
#
Example#
AS Path PatternsAS Path regular expression patterns may also be customized, should you wish to more granularly control what your network considers a valid AS Path pattern. hyperglass makes two "modes" available for validation - asplain
and asdot
.
Parameter | Type | Default | Description |
---|---|---|---|
mode | String | 'asplain' | Set ASN display mode. This field is dependent on how your network devices are configured. Must be asplain or asdot |
asplain | String | '^(\^|^\_)(\d+\_|\d+\$|\d+\(\_\.\+\_\))+$' | Regular expression pattern for validating asplain type BGP AS Path queries. |
asdot | String | '^(\^|^\_)((\d+\.\d+)\_|(\d+\.\d+)\$|(\d+\.\d+)\(\_\.\+\_\))+$' | Regular expression pattern for validating asdot type BGP AS Path queries. |
ping
#
Parameter | Type | Default | Description |
---|---|---|---|
enable | Boolean | true | Enable or disable the Ping query type. |
display_name | String | 'Ping' | Text displayed for the Ping query type in the UI. |
#
Exampletraceroute
#
Parameter | Type | Default | Description |
---|---|---|---|
enable | Boolean | true | Enable or disable the Traceroute query type. |
display_name | String | 'Traceroute' | Text displayed for the Traceroute query type in the UI. |