Appendix H. Configuration Objects

Appendix H. Configuration Objects

Table of Contents

H.1. Top level

H.1.1. config: Top level config

H.2. Objects

H.2.1. system: System settings
H.2.2. link: Web links
H.2.3. user: Admin users
H.2.4. log: Log target controls
H.2.5. log-syslog: Syslog logger settings
H.2.6. log-email: Email logger settings
H.2.7. services: System services
H.2.8. snmp-service: SNMP service settings
H.2.9. ntp-service: NTP service settings
H.2.10. telnet-service: Telnet service settings
H.2.11. http-service: HTTP service settings
H.2.12. dns-service: DNS service settings
H.2.13. dns-host: Fixed local DNS host settings
H.2.14. dns-block: Fixed local DNS blocks
H.2.15. ethernet: Physical port controls
H.2.16. portdef: Port grouping and naming
H.2.17. interface: Port-group/VLAN interface settings
H.2.18. subnet: Subnet settings
H.2.19. vrrp: VRRP settings
H.2.20. dhcps: DHCP server settings
H.2.21. dhcp-attr-hex: DHCP server attributes (hex)
H.2.22. dhcp-attr-string: DHCP server attributes (string)
H.2.23. dhcp-attr-number: DHCP server attributes (numeric)
H.2.24. dhcp-attr-ip: DHCP server attributes (IP)
H.2.25. route: Static routes
H.2.26. blackhole: Dead end networks
H.2.27. loopback: Locally originated networks
H.2.28. cqm: Constant Quality Monitoring settings
H.2.29. ip-group: IP Group

H.3. Data types

H.3.1. autoloadtype: Type of s/w auto load
H.3.2. config-access: Type of access user has to config
H.3.3. user-level: User login level
H.3.4. syslog-severity: Syslog severity
H.3.5. syslog-facility: Syslog facility
H.3.6. month: Month name (3 letter)
H.3.7. day: Day name (3 letter)
H.3.8. port: Physical port
H.3.9. Crossover: Crossover configuration
H.3.10. LinkSpeed: Physical port speed
H.3.11. LinkDuplex: Physical port duplex setting
H.3.12. LinkFlow: Physical port flow control setting
H.3.13. LinkClock: Physical port Gigabit clock master/slave setting
H.3.14. LinkLED: LED settings
H.3.15. LinkPower: PHY power saving options
H.3.16. LinkFault: Link fault type to send
H.3.17. ramode: IPv6 route announce level
H.3.18. dhcpv6control: Control for RA and DHCPv6 bits
H.3.19. sfoption: Source filter option

H.4. Basic types

This appendix defines the object definitions used in the FireBrick Null (dummy application) configuration. Copyright © 2008-13 FireBrick Ltd.

H.1. Top level

H.1.1. config: Top level config

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

Table H.1. config: Attributes

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

Table H.2. config: Elements

Element	Type	Instances	Description
blackhole	blackhole	Optional, unlimited	Black hole (dropped packets) networks
cqm	cqm	Optional	Constant Quality Monitoring config
ethernet	ethernet	Optional, unlimited	Ethernet port settings
interface	interface	Optional, up to 8192	Ethernet interface (port-group/vlan) and subnets
ip-group	ip-group	Optional, unlimited	Named IP groups
log	log	Optional, up to 50	Log target controls
loopback	loopback	Optional, unlimited	Extra local addresses
nowhere	blackhole	Optional, unlimited	Dead end (icmp error) networks
port	portdef	Optional, up to 4	Port grouping and naming
route	route	Optional, unlimited	Static routes
services	services	Optional	General system services
system	system	Optional	System settings
user	user	Optional, unlimited	Admin users


G.5. Creating graphs, and graph names		H.2. Objects