getpolicydatasetResult Structure Definition

The getpolicydatasetResult structure defines the return type for getpolicydataset API.

Syntax



Members

rc

If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

message

If the method succeeds, message is NULL else message contains Error/Warning message.

policydatasetList

List of policydatasets


policydataset Structure Definition

The policydataset structure defines the actual return type values for getpolicydataset API.

Syntax



Members

name

Name of the dataset.

dynamiconly

Shows only dynamic datasets when set true.

value

Value of the specified type that is associated with the dataset. For ipv4 and ipv6, value can be a subnet using the slash notation address/n, where address is the beginning of the subnet and n is the number of left-most bits set in the subnet mask, defining the end of the subnet. The start address will be masked by the subnet mask if necessary, for example for 192.128.128.0/10, the start address will be 192.128.0.0.

endrange

The dataset entry is a range from through , inclusive. endRange cannot be used if value is an ipv4 or ipv6 subnet and endRange cannot itself be a subnet.

index

The index of the value (ipv4, ipv6, number) associated with the set.

type

Type of value to bind to the dataset.

comment

Any comments to preserve information about this dataset or a data bound to this dataset.

patsetfile

File which contains list of patterns that needs to be bound to the dataset. A patsetfile cannot be associated with multiple datasets.

dynamic

This is used to populate internal dataset information so that the dataset can also be used dynamically in an expression. Here dynamically means the dataset name can also be derived using an expression. For example for a given dataset name "allow_test" it can be used dynamically as client.ip.src.equals_any("allow_" + http.req.url.path.get(1)). This cannot be used with default datasets.

_nextgenapiresource


See Also