Appendix J. Configuration Objects
Prev   Next

Appendix J. Configuration Objects

Table of Contents

J.1. Top level
J.1.1. config: Top level config
J.2. Objects
J.2.1. system: System settings
J.2.2. link: Web links
J.2.3. user: Admin users
J.2.4. eap: User access controlled by EAP
J.2.5. log: Log target controls
J.2.6. log-syslog: Syslog logger settings
J.2.7. log-email: Email logger settings
J.2.8. services: System services
J.2.9. http-service: Web service settings
J.2.10. dns-service: DNS service settings
J.2.11. dns-host: Fixed local DNS host settings
J.2.12. dns-block: Fixed local DNS blocks
J.2.13. radius-service: RADIUS service definition
J.2.14. radius-service-match: Matching rules for RADIUS service
J.2.15. radius-server: RADIUS server settings
J.2.16. telnet-service: Telnet service settings
J.2.17. snmp-service: SNMP service settings
J.2.18. ntp-service: NTP service settings
J.2.19. ethernet: Physical port controls
J.2.20. sampling: Packet sampling configuration
J.2.21. portdef: Port grouping and naming
J.2.22. interface: Port-group/VLAN interface settings
J.2.23. subnet: Subnet settings
J.2.24. vrrp: VRRP settings
J.2.25. dhcps: DHCP server settings
J.2.26. dhcp-attr-hex: DHCP server attributes (hex)
J.2.27. dhcp-attr-string: DHCP server attributes (string)
J.2.28. dhcp-attr-number: DHCP server attributes (numeric)
J.2.29. dhcp-attr-ip: DHCP server attributes (IP)
J.2.30. route: Static routes
J.2.31. network: Locally originated networks
J.2.32. blackhole: Dead end networks
J.2.33. loopback: Locally originated networks
J.2.34. namedbgpmap: Mapping and filtering rules of BGP prefixes
J.2.35. bgprule: Individual mapping/filtering rule
J.2.36. bgp: Overall BGP settings
J.2.37. bgppeer: BGP peer definitions
J.2.38. bgpmap: Mapping and filtering rules of BGP prefixes
J.2.39. cqm: Constant Quality Monitoring settings
J.2.40. profile: Control profile
J.2.41. profile-date: Test passes if within any of the time ranges specified
J.2.42. profile-time: Test passes if within any of the date/time ranges specified
J.2.43. profile-ping: Test passes if any addresses are pingable
J.2.44. ip-group: IP Group
J.2.45. voip: Voice over IP config
J.2.46. carrier: VoIP carrier details
J.2.47. telephone: VoIP telephone authentication user details
J.2.48. tone: Tone definitions
J.2.49. ringgroup: Ring groups
J.2.50. dhcp-relay: DHCP server settings for remote / relayed requests
J.3. Data types
J.3.1. autoloadtype: Type of s/w auto load
J.3.2. config-access: Type of access user has to config
J.3.3. user-level: User login level
J.3.4. eap-subsystem: Subsystem with EAP access control
J.3.5. eap-method: EAP access method
J.3.6. syslog-severity: Syslog severity
J.3.7. syslog-facility: Syslog facility
J.3.8. http-mode: HTTP/HTTPS security mode
J.3.9. radiuspriority: Options for controlling platform RADIUS response priority tagging
J.3.10. radiustype: Type of RADIUS server
J.3.11. month: Month name (3 letter)
J.3.12. day: Day name (3 letter)
J.3.13. port: Physical port
J.3.14. Crossover: Crossover configuration
J.3.15. LinkSpeed: Physical port speed
J.3.16. LinkDuplex: Physical port duplex setting
J.3.17. LinkFlow: Physical port flow control setting
J.3.18. LinkClock: Physical port Gigabit clock master/slave setting
J.3.19. LinkLED-g: Green LED setting
J.3.20. LinkLED-y: Yellow LED setting
J.3.21. LinkPower: PHY power saving options
J.3.22. LinkFault: Link fault type to send
J.3.23. sampling-protocol: Sampling protocol
J.3.24. trunk-mode: Trunk port mode
J.3.25. ramode: IPv6 route announce level
J.3.26. dhcpv6control: Control for RA and DHCPv6 bits
J.3.27. bgpmode: BGP announcement mode
J.3.28. sampling-mode: Sampling mode
J.3.29. sfoption: Source filter option
J.3.30. peertype: BGP peer type
J.3.31. switch: Profile manual setting
J.3.32. voip-format: Number presentation format
J.3.33. uknumberformat: Number formatting option
J.3.34. recordoption: Recording option
J.3.35. ring-group-order: Order of ring
J.3.36. ring-group-type: Type of ring when one call in queue
J.3.37. record-beep-option: Record beep option
J.4. Basic types

This appendix defines the object definitions used in the FireBrick FB6502 (VoIP) configuration. Copyright © 2008-16 FireBrick Ltd.

J.1. Top level

J.1.1. config: Top level config

The top level config element contains all of the FireBrick configuration data.

Table J.1. config: Attributes

AttributeTypeDefaultDescription
patch integer -Internal use, for s/w updates that change config syntax
timestamp dateTime -Config store time, set automatically when config is saved

Table J.2. config: Elements

ElementTypeInstancesDescription
bgp bgp Optional, up to 100BGP config
bgp-filter namedbgpmap Optional, unlimitedMapping and filtering rules for use with BGP peers
blackhole blackhole Optional, unlimitedBlack hole (dropped packets) networks
cqm cqm OptionalConstant Quality Monitoring config
dhcp-relay dhcp-relay Optional, unlimitedDHCP server settings for remote / relayed requests
eap eap Optional, unlimitedUser access control via EAP
ethernet ethernet Optional, unlimitedEthernet port settings
interface interface Optional, up to 8192Ethernet interface (port-group/vlan) and subnets
ip-group ip-group Optional, unlimitedNamed IP groups
log log Optional, up to 50Log target controls
loopback loopback Optional, unlimitedExtra local addresses
network network Optional, unlimitedLocally originated networks
nowhere blackhole Optional, unlimitedDead end (icmp error) networks
port portdef Optional, up to 2Port grouping and naming
profile profile Optional, unlimitedControl profiles
route route Optional, unlimitedStatic routes
sampling sampling OptionalSampling parameters
services services OptionalGeneral system services
system system OptionalSystem settings
user user Optional, unlimitedAdmin users
voip voip OptionalVoIP config

Prev   Next
I.2. One Time Password seed hashing Home J.2. Objects