QueryData type

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

Element

Type

Description

QueryDescriptionMandatory

String

Description of query.

QueryHTMLPathMandatory

String

URL to the results in the UI.

FIPResultMandatory

String

One of the following:

  • Unreachable
  • SameZone
  • Routed
  • PartiallyRouted
  • NotExecuted
  • Unknown
QueryResultMandatory

String

One of the following:

  • allowed
  • blocked
  • partially allowed
  • not routed
QueryItemMandatory QueryValueResults

List of query value results. See QueryValueResults type below.

QueryValueResults Type

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

Element

Type

Description

DeviceMandatory

List of DeviceResult objects

List of device results. See DeviceResult type below.

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

Display name of the device.

RulesMandatory

List of QueryRules objects

List of rules. See QueryRules type below.

QueryRules Type

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

Note: All elements are optional.

Element

Type

Description

Rule

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).

Service

String

List of services.

Source

String

List of sources.

Source_Nat

String

List of NAT sources.

Destination

String

List of destinations.

Destination_Nat

String

List of NAT destinations.

Install

String

List of installs.

Action

String

Action.

ACL

String

ACL.

 

â See also: