af_templates

Configuration for AF Templates resource.

Read/write properties

observationPointId<Integer>

Observation Point ID.

template_field_length<Integer>

Template Field Length.

template_field_name<String>

Templates field names..
Minimum length = 1
Maximum length = 255

template_rx_time<Double>

Start Time.

template_field_id<Integer>

Protocol.

template_id<Integer>

AF Template ID.

exporter_id<Double>

The exporter ID mapping back to the af_exporter table.

Operations

NOTE: In request payload, Mandatory parameters are marked red and bold.

The following parameters can be used in the nitro request :

onerror   <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE

modifyget (all)

modify

URL:https://<MGMT-IP>/nitro/v2/config/af_templates/

Query-parameters:

HTTPS Method:PUT

HTTPS Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"af_templates":{
      "template_id":<Integer_value>,
      "exporter_id":<Double_value>,
      "observationPointId":<Integer_value>,
      "template_field_length":<Integer_value>,
      "template_field_id":<Integer_value>,
      "template_field_name":<String_value>,
      "template_rx_time":<Double_value>}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "af_templates":[{
      "observationPointId":<Integer_value>,
      "template_field_length":<Integer_value>,
      "template_field_name":<String_value>,
      "template_rx_time":<Double_value>,
      "template_field_id":<Integer_value>,
      "template_id":<Integer_value>,
      "exporter_id":<Double_value>}]}

get (all)

URL:https://<MGMT-IP>/nitro/v2/config/af_templates

Query-parameters:

HTTPS Method:GET

HTTPS Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "af_templates":[{
      "observationPointId":<Integer_value>,
      "template_field_length":<Integer_value>,
      "template_field_name":<String_value>,
      "template_rx_time":<Double_value>,
      "template_field_id":<Integer_value>,
      "template_id":<Integer_value>,
      "exporter_id":<Double_value>}]}