Download full document:

sla_doi

Configuration for AF SLA Domain of Interest Breaches Report table resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
hits_breach<Double>Read-writeHits breach values reported to this domain in the sampled timeframe..
__count<Double>Read-writecount..
miss_count<Double>Read-writeTotal time window breaches for this Domain in given sampled timeframe.
conf_miss_count<Double>Read-writeconfigured miss count breach to this domain.
open_connections_breach<Double>Read-writeopen connection breache value reported to this domain in the sampled timeframe..
num_of_hits_breaches<Double>Read-writeNo of times the timewindow breaches for hits to this domain in the sampled timeframe..
sla_sub_domain_name<String>Read-writeSub Domain Name..
Maximum length = 1500
id<String>Read-writeId is DomainName.
Maximum length = 255
num_of_bandwidth_mcb<Double>Read-writeNo of missed count breaches for bandwidth to this domain in the sampled timeframe..
bandwidth_breach<Double>Read-writebandwidth breach reported values to this domain in the sampled timeframe..
num_of_bandwidth_breaches<Double>Read-writeNo of times the timewindow breaches for bandwidth to this domain in the sampled timeframe..
num_of_open_connections_breaches<Double>Read-writeNo of times the timewindow breaches for open connections to this domain in the sampled timeframe..
response_time_breach<Double>Read-writeResponse time reported breach value to this domain in the sampled timeframe..
name<String>Read-writeDomain Name.
Maximum length = 255
rpt_sample_time<Double>Read-writeReport Sample time..
conf_time_window<Double>Read-writeconfigured time window breach to this domain.
miss_count_breaches<Double>Read-writeNo of times the timewindow breaches count exceeds the configured miss count breach threshold to this Domain.
conf_range<String>Read-writeSLA Meetric Range..
Maximum length = 255
num_of_hits_mcb<Double>Read-writeNo of missed count breaches breaches for hits to this domain in the sampled timeframe..
num_of_response_time_breaches<Double>Read-writeNo of times the timewindow breaches for response time to this domain in the sampled timeframe..
num_of_response_time_mcb<Double>Read-writeNo of missed count breaches for response time to this domain in the sampled timeframe..
num_of_open_connections_mcb<Double>Read-writeNo of missed count breaches for open connections to this domain in the sampled timeframe..

Operations

(click to see Properties)

GET (ALL)

Some options that you can use for each operations:

  • Getting warnings in response:NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations:NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in <green>.

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/sla_doi

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "sla_doi":[{
"hits_breach":<Double_value>,
"__count":<Double_value>,
"miss_count":<Double_value>,
"conf_miss_count":<Double_value>,
"open_connections_breach":<Double_value>,
"num_of_hits_breaches":<Double_value>,
"sla_sub_domain_name":<String_value>,
"id":<String_value>,
"num_of_bandwidth_mcb":<Double_value>,
"bandwidth_breach":<Double_value>,
"num_of_bandwidth_breaches":<Double_value>,
"num_of_open_connections_breaches":<Double_value>,
"response_time_breach":<Double_value>,
"name":<String_value>,
"rpt_sample_time":<Double_value>,
"conf_time_window":<Double_value>,
"miss_count_breaches":<Double_value>,
"exporter_id":<String_value>,
"conf_range":<String_value>,
"num_of_hits_mcb":<Double_value>,
"num_of_response_time_breaches":<Double_value>,
"num_of_response_time_mcb":<Double_value>,
"num_of_open_connections_mcb":<Double_value>}]}