swg_trans_details¶
Configuration for SWG Transaction Report resource.
Properties¶
(click to see Operations )
Name | Data Type | Permissions | Description |
---|---|---|---|
protocol | <String> | Read-write | protocol used. |
__count | <Double> | Read-write | count.. |
operating_system | <String> | Read-write | Client Operating System Name..
Maximum length = 255 |
total_ssl_intercepts | <Double> | Read-write | Total Intercepts. |
block_count_prev | <Double> | Read-write | BLOCK URL Count. |
url_repu_level_2_count_prev | <Double> | Read-write | URL reputation level 2 count prev. |
total_bytes_in | <Double> | Read-write | Total bytes in. |
clean_url_count_prev | <Double> | Read-write | Clean URL count Prev. |
url_reputation_prev | <Double> | Read-write | URL reputation. |
urlcategory | <String> | Read-write | URL Category. |
user_agent | <String> | Read-write | User Agent Name..
Maximum length = 255 |
total_bytes | <Double> | Read-write | Total bytes. |
url_repu_level_3_count | <Double> | Read-write | URL reputation level 3 count. |
total_bytes_in_prev | <Double> | Read-write | Total bytes in. |
port | <Double> | Read-write | prot used. |
total_bytes_prev | <Double> | Read-write | Total bytes prev. |
user_name | <String> | Read-write | User Name.
Maximum length = 255 |
total_requests_prev | <Double> | Read-write | Total transactions. |
url_reputation | <Double> | Read-write | URL reputation. |
url_category | <Double> | Read-write | URL Category. |
client_ip_address | <String> | Read-write | Client ip address.
Maximum length = 255 |
user_count | <Double> | Read-write | Users Count. |
url_repu_level_3_count_prev | <Double> | Read-write | URL reputation level 3 count prev. |
ssli_action_prev | <String> | Read-write | URL Action. |
url_repu_level_4_count | <Double> | Read-write | URL reputation level 4 count. |
http_req_method | <String> | Read-write | HTTP Request Method..
Maximum length = 255 |
ssli_action | <String> | Read-write | URL Action. |
http_rsp_status | <String> | Read-write | HTTP Response Status Method..
Maximum length = 255 |
block_count | <Double> | Read-write | Block URL Count. |
urlcategory_prev | <String> | Read-write | URL Category. |
url_repu_level_2_count | <Double> | Read-write | URL reputation level 2 count. |
url_group_category_prev | <String> | Read-write | URL Group Category. |
domain_name_prev | <String> | Read-write | HTTP Request URL..
Maximum length = 2000 |
url_group_category | <String> | Read-write | URL Group Category. |
total_bytes_out_prev | <Double> | Read-write | Total bytes out. |
url_repu_level_4_count_prev | <Double> | Read-write | URL reputation level 4 count prev. |
rpt_sample_time | <Double> | Read-write | Report Sample time.. |
user_count_prev | <Double> | Read-write | Users Count. |
domain_name | <String> | Read-write | HTTP Request URL..
Maximum length = 2000 |
total_bytes_out | <Double> | Read-write | Total bytes out. |
exporter_id | <String> | Read-write | Exporter ID.
Maximum length = 255 |
clean_url_count | <Double> | Read-write | Clean URL count. |
vserver_name | <String> | Read-write | AppName.
Maximum length = 255 |
total_requests | <Double> | Read-write | Total transactions. |
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
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
get (all)¶
URL: https://<MGMT-IP>/nitro/v2/config/swg_trans_details
Query-parameters:
HTTPS Method: GET
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:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "swg_trans_details":[{
"protocol":<String_value>,
"__count":<Double_value>,
"operating_system":<String_value>,
"total_ssl_intercepts":<Double_value>,
"block_count_prev":<Double_value>,
"url_repu_level_2_count_prev":<Double_value>,
"total_bytes_in":<Double_value>,
"clean_url_count_prev":<Double_value>,
"url_reputation_prev":<Double_value>,
"urlcategory":<String_value>,
"user_agent":<String_value>,
"total_bytes":<Double_value>,
"url_repu_level_3_count":<Double_value>,
"total_bytes_in_prev":<Double_value>,
"port":<Double_value>,
"total_bytes_prev":<Double_value>,
"user_name":<String_value>,
"total_requests_prev":<Double_value>,
"url_reputation":<Double_value>,
"url_category":<Double_value>,
"client_ip_address":<String_value>,
"user_count":<Double_value>,
"url_repu_level_3_count_prev":<Double_value>,
"ssli_action_prev":<String_value>,
"url_repu_level_4_count":<Double_value>,
"http_req_method":<String_value>,
"ssli_action":<String_value>,
"http_rsp_status":<String_value>,
"block_count":<Double_value>,
"urlcategory_prev":<String_value>,
"url_repu_level_2_count":<Double_value>,
"url_group_category_prev":<String_value>,
"domain_name_prev":<String_value>,
"url_group_category":<String_value>,
"total_bytes_out_prev":<Double_value>,
"url_repu_level_4_count_prev":<Double_value>,
"rpt_sample_time":<Double_value>,
"user_count_prev":<Double_value>,
"domain_name":<String_value>,
"total_bytes_out":<Double_value>,
"exporter_id":<String_value>,
"clean_url_count":<Double_value>,
"vserver_name":<String_value>,
"total_requests":<Double_value>}]}