QueryData type

The following table describes the elements in the QueryData type object:

Element

Type

Description

  
QueryDescriptionMandatory

String

Description of query.

QueryHTMLPath

Mandatory

String

URL to the results in the UI.

Results

 Explanation
  • Unreachable
 Blocked
  • SameZone
 Allowed
  • Routed
 Depends on the devices' single TSQ result*
  • PartiallyRouted
 Depends on the devices' single TSQ result*
  • NotExecuted
 Failure
  • Unknown
 Not known
finalResult
Mandatory

String

One of the following:

  • allowed
  • blocked
  • partially allowed
  • not routed
QueryItem
Mandatory 		List of DeviceResult

List of device results. See DeviceResult type below.

*If FIPResult is Routed or PartiallyRouted:

  • If all devices are allowed- overall group TSQ result is allowed.
  • If at least 1 device is allowed and at least 1 other device has another QueryResult (blocked, partial, etc.) overall group TSQ result is partial.
  • If all devices are blocked- overall group TSQ result is blocked.
  • If all devices are partial- overall group TSQ result is partial.
  • If some devices are partial (1 or more) and at least 1 other device has another QueryResult blocked or not routed- overall group TSQ result is partial.
  • If devices are empty (source and destination reside in the same network).
  • If devices are empty (source and destination reside in a cloud).

DeviceResult Type

The following table describes the elements in the DeviceResult type object:

Element

Type

Description
IsAllowedMandatory

String

Status information and the number of rules that support it. For example: Allowed (x1), Blocked (x4), Partially allowed (x4).
DeviceNameMandatory

String

Name of the device in the database.
RulesMandatory

List of QueryRules objects

List of rules. See QueryRules type below.
DisplayNameMandatory String Display name of the device in the interface.

QueryRules Type

The following table describes the elements in the QueryRules type object.

Note: All elements are optional.

Element

Type

Description
RuleId

String

Internal AlgoSec Rule ID. To retrieve the rule ID, call one of the rule APIs, such as get_rules_by_device (see Retrieving a List of a Device's Rules) or search_rules (see Searching for Rules).
RuleName String Name of rule.
Service

List of strings

List of services.
Source

List of strings

List of sources.
SourceNat

List of strings

List of NAT sources.
Destination

List of strings

List of destinations.
DestinationNat

List of strings

List of NAT destinations.
Install

List of strings

List of installs.
Action

String

Action.
ACL

String

ACL.

 

â See also: