=========
Changelog
=========

.. currentmodule:: activelogic

.. ****************************************************************************
.. Starting with "Upcoming release", add Added and Changed for each new release.
..
.. Before release, change "Upcoming release" to a release number. First change
.. after release is added under a new "Upcoming release" section.
..
.. Bug-fixes goes into release notes rather than changelog.
.. ****************************************************************************

Upcoming release
================

Added
-----

* :doc:`/resource`

    * Support for :func:`Resource.wait_for_commit`.
    * Support for :class:`PLDBDetached` exception, that is raised when a session is getting detached.

* :doc:`/sysdiag`

    * Support for debug values in :func:`SysDiag.register_zone`.

25.01.00
================

Added
-----

* :doc:`/statsfs`

    * Support for legacy module :doc:`/statsfs`.

24.40.00
================

Added
-----

* Support for the following modules:

    * :doc:`/logs`

* :doc:`/liveview`

    * Support for custom columns in :func:`View.add_columns`.

* :doc:`/ruleset`

    * Support for :class:`AccelerateRule` and :class:`AccelerateObject`.

24.20.00
===============

Added
-----

* :doc:`/users`

    * New method to change a user's password :func:`Users.change_user_password`. This must be used when communicating with systems running version 24.20 or newer.

* :doc:`/channels`

    * New channel role `Layer3-Shunt` added.

* :doc:`/hosttriggers`

    * detection_interval, recovery_interval, abortedconns and abortedconns_percent fields in :class:`HostTrigger`.

* :doc:`/ruleset`

    * Support for :class:`ConnectionClassObject`.

24.02.00
================

Added
-----

* :doc:`/sysdiag`

    * Timestamps for min/values in :class:`SysDiagValue` and :class:`SysDiagAggregatedValue`.

24.01.00
========

Added
-----

* :doc:`/channels`

    * Extended argument list for :func:`Channels.update_channel`: subchannels, internal, external, channel_type, caps, fabric, location, intpci and extpci.

23.40.00
========

Added
-----

* :doc:`/liveview`

    * WebSocket Secure support.

* :doc:`/ruleset`

    * Support for SYSLOG in :class:`FlowObjectFlags`.

* :doc:`/hosttriggers`

    * Support for VIEW_SCEVENT in :class:`HostTriggerType`.
    * sc_event fields in :class:`HostTrigger`.
    * :class:`HostTriggerScEventFlags`.

23.24.00.3
==========

Added
-----

* Essentials

    * :func:`Resource.list` for listing services and flags. This also makes :func:`Resource.services` deprecated.

* :doc:`/ruleset`

    * Support for SKIP_QSYNC in :class:`ShapingObjectFlags`.

Changed
-------

* Setup

    * API variants for Linux and OS X are merged into one Python Wheel that supports both platforms.

23.24.00.1
==========

Added
-----

* Essentials

    * New method to close a connection, using :func:`Connection.close()`.
    * Optional use of a context manager to connect.

* :doc:`/channels`

    * LACP feature support.

* :doc:`/ruleset`

    * :func:`Ruleset.attr_list`, :func:`Ruleset.attr_get`, :func:`Ruleset.attr_set` and :func:`Ruleset.attr_remove` for attribute handling on objects and rules.
    * Support for :class:`GeoLogicObject`.
    * Support to list :class:`MonitorInterface`.

Changed
-------

* :doc:`/channels`

    * Interface addresses are stored as IPv4/6Interface rather than IPv4/6Network.

* :doc:`/ruleset`

    * Remove "attributes" attribute from :class:`Object`.
    * :class:`ConditionType`: rename XFBOBJECTS to FLAGOBJECT.
    * :class:`TrafficObject`: dimensions, partitions and metrics are strings rather than list of objects.
    * :class:`FlowObject`: flags is mandatory field.

* :doc:`/liveview`

    * Relocate into a stand-alone module within activelogic package.
    * Split ViewFilter into two separate classes: :class:`liveview.ViewIncludeFilter` and :class:`liveview.ViewExcludeFilter`.
    * Return view values as a dict, where each key is a string rather than just an integer.

23.23.00.2
==========

Added
-----

* Support for the following modules:

    * :doc:`/ruleset` (full)
    * :doc:`/liveview`

* Support for :class:`StatisticsRule`.

* Support for the following ruleset objects:

    * :class:`TunnelTypeObject`
    * :class:`TunnelLevelObject`
    * :class:`StatisticsObject`
    * :class:`VlanIDObject`
    * :class:`FlagObject`
    * :class:`VlanPriorityObject`
    * :class:`VXLANIDObject`
    * :class:`MPLSObject`
    * :class:`ProtocolObject`
    * :class:`RewriteObject`
    * :class:`DSCPObject`
    * :class:`EnrichObject`
    * :class:`HoplimitObject`
    * :class:`BGPObject`
    * :class:`TimeObject`

23.22.00.3
==========

Added
-----

* Support for the following modules:

    * :doc:`/backup`
    * :doc:`/fileserv`
    * :doc:`/hosttriggers`
    * :doc:`/ruleset` (partial)
    * :doc:`/system_overview`
    * :doc:`/users`

* Support for :class:`FilteringRule`, :class:`ShapingRule` and :class:`Condition`.

* Support for the following ruleset objects:

    * :class:`SystemObject`
    * :class:`PropertyObject`
    * :class:`ChannelObject`
    * :class:`NetObject`
    * :class:`ServiceObject`
    * :class:`PortObject`
    * :class:`ContentLogicObject`
    * :class:`SessionContextObject`
    * :class:`TrafficObject`
    * :class:`FlowObject`
    * :class:`ShapingObject`

23.21.00.6
==========

Added
-----

* Initial version with support for the following modules:

    * :doc:`/channels`
    * :doc:`/config`
    * :doc:`/resource_edit`
    * :doc:`/sysdiag`