20 Active Sessions

20.1 Get-anynodeActiveSessions

Returns the the list of active sessions.

Required Permissions

  • API

  • Monitoring Mode Read Access

Request parameters

  • Address

    mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.

    Type: String

  • Port

    mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.

    Type: Integer

  • APIVersion = 0

    This parameter states which version of the request should be used.

    Type: Integer

  • string: DateFormat

    Determines the format of dates. Default is XZWO.

    Type: String

    Possible Values:

    • ISO-8601

    • XZWO

  • Count

    Limits the amount of sessions that will be returned by the request.

    Type: Integer

  • NodeFilter

    The name of the incoming or outgoing node of the sessions that will be returned by the request.

    Type: String

  • RouteFilter

    The name of the route of the sessions that will be returned by the request.

    Type: String

  • NumberFilter

    The number of the caller or callee of the sessions that will be returned by the request.

    Type: String

  • NumberFilterMode

    Determines how the number is matched with the "numberFilter".

    Type: NumberFilterMode

    Possible values:

    • equal

    • startswith

    • endswith

    • contains