Common

This lists contains all the common keys that are used across all generators (with a few highlighted exceptions).

Term Format

  • action: The action to take when matched. See Actions section for valid options.
  • comment: A text comment enclosed in double-quotes. The comment can extend over multiple lines if desired, until a closing quote is encountered.
  • destination-address: One or more destination address tokens
  • destination-port: One or more service definition tokens
  • expiration: Stop rendering this term after specified date in YYYY-MM-DD format. E.g. 2000-12-31
  • icmp-type: Specify icmp-type code to match, see ICMP types for list of valid arguments (Not supported on: aruba, gce, k8s)
  • name: Name of the term.
  • option: See platforms supported Options section. (Not supported on: k8s, gce, windows_advfirewall, windows_ipsec)
  • platform: one or more target platforms for which this term should ONLY be rendered. (Not supported on: aruba)
  • platform-exclude: one or more target platforms for which this term should NEVER be rendered. (Not supported on: aruba)
  • protocol: the network protocols this term will match, such as tcp, udp, icmp, or a numeric value.
  • source-address: one or more source address tokens.
  • source-port: one or more service definition tokens. (Note supported on: aruba, k8s)