Fields
Table of Contents
Classes
- Base64Field
- Defines a Field for storing Base64 encoded strings in the pfSense configuration. This field will store string values
internally as Base64 encoded strings, but represent them as plain text strings.
- BooleanField
- Defines a Field object for storing boolean values in the pfSense configuration.
- DateTimeField
- Defines a Field object for storing and validating DateTime values.
- FilterAddressField
- Defines a Field class that adds validation and representation for firewall filter addresses (e.g. firewall and
NAT rule source and destination addresses).
- FloatField
- Defines a Field object for validating and storing a floating point number.
- ForeignModelField
- Defines a Field that adds validation and representation for Fields that relate to a different Model object field.
- IntegerField
- Defines a Field object for validating and storing integer values in the pfSense configuration.
- InterfaceField
- Defines an Field object for storing interface values in the pfSense configuration. This field will also be responsible
for representing the interface according to the REST API `represent_interfaces_as` setting.
- NestedModelField
- Defines a Field object for storing nested Model objects in the pfSense configuration. This field allows certain
Model objects to be stored as field values for another Model object.
- PortField
- Defines a Field object for validating and storing TCP/UDP port values in the pfSense configuration. This includes
options for port aliases and port ranges.
- SpecialNetworkField
- Defines a Field that adds validation and representation for address and network Fields that support special
networks like interfaces, aliases, etc. This is similar to FilterAddressField except the values do not get
nested into arrays internally.
- StringField
- Defines a Field object for validating and storing string values.
- UIDField
- Defines a Field that contains a unique ID. This field will automatically populate a unique ID that is immutable.
- UnixTimeField
- Defines a Field object for validating and storing Unix timestamp values.