========================================================
`pyfixbuf.cert` --- Information Elements for NetSA Tools
========================================================

.. automodule:: pyfixbuf.cert

The `pyfixbuf.cert` module provides functions to update an
:class:`pyfixbuf.InfoModel` with the `Information Elements defined by CERT`_
and used by the NetSA tools such as YAF_ and super_mediator_.  These functions
load the information elements from the ``cert_ipfix.xml`` file, which is
included as a resource in the pyfixbuf distribution.  To load these elements
into your Information Model, use::

  import pyfixbuf
  import pyfixbuf.cert

  model = pyfixbuf.InfoModel()
  pyfixbuf.cert.add_elements_to_model(model)

.. _Information Elements defined by CERT: https://tools.netsa.cert.org/cert-ipfix-registry/cert_ipfix_formatted.html
.. _YAF: https://tools.netsa.cert.org/yaf/index.html
.. _super_mediator: https://tools.netsa.cert.org/super_mediator/index.html

  .. autofunction:: add_elements_to_model(model: InfoModel)

  .. autofunction:: info_element_xml() -> str



..
  Local Variables:
  fill-column:78
  End:
