Skip to content

RuleOption

Source code in docs_src/capo_network_firewall/types/rule_option.py 
14
15
16
17
18
class RuleOption(TypedDict, closed=True):
    keyword: "capo_network_firewall.types.keyword.Keyword"
    """<p>The keyword for the Suricata compatible rule option. You must include a <code>sid</code> (signature ID), and can optionally include other keywords. For information about Suricata compatible keywords, see <a href="https://suricata.readthedocs.io/en/suricata-7.0.8/rules/intro.html#rule-options">Rule options</a> in the Suricata documentation.</p>"""
    settings: NotRequired["capo_network_firewall.types.settings.Settings"]
    """<p>The settings of the Suricata compatible rule option. Rule options have zero or more setting values, and the number of possible and required settings depends on the <code>Keyword</code>. For more information about the settings for specific options, see <a href="https://suricata.readthedocs.io/en/suricata-7.0.8/rules/intro.html#rule-options">Rule options</a>.</p>"""

keyword instance-attribute 

keyword: Keyword

The keyword for the Suricata compatible rule option. You must include a sid (signature ID), and can optionally include other keywords. For information about Suricata compatible keywords, see Rule options in the Suricata documentation.

settings instance-attribute 

settings: NotRequired[Settings]

The settings of the Suricata compatible rule option. Rule options have zero or more setting values, and the number of possible and required settings depends on the Keyword. For more information about the settings for specific options, see Rule options.