swg_user_summary¶
Configuration for SWG Transaction Report resource.
Properties¶
(click to see Operations )
Name | Data Type | Permissions | Description |
---|---|---|---|
total_ssl_intercepts_prev | <Double> | Read-write | Total Intercepts. |
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. |
total_bytes_in | <Double> | Read-write | Total bytes in. |
url_group_category | <String> | Read-write | URL Group Category. |
total_bytes_out_prev | <Double> | Read-write | Total bytes out. |
user_agent | <String> | Read-write | User Agent Name..
Maximum length = 255 |
total_bytes | <Double> | Read-write | Total bytes . |
rpt_sample_time | <Double> | Read-write | Report Sample time.. |
total_bytes_in_prev | <Double> | Read-write | Total bytes in. |
port | <Double> | Read-write | protocol used. |
user_count_prev | <Double> | Read-write | User Count Prev. |
total_bytes_prev | <Double> | Read-write | Total bytes out. |
user_name | <String> | Read-write | User Name.
Maximum length = 255 |
exporter_id | <Double> | Read-write | Exporter ID. |
total_bytes_out | <Double> | Read-write | Total bytes out. |
url_reputation | <Double> | Read-write | URL reputation. |
total_requests_prev | <Double> | Read-write | Total transactions. |
user_count | <Double> | Read-write | User Count. |
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_user_summary
Query-parameters:
asc Use this query-parameter to specify whether the results should be in ascending order or not.
Possible Values: yes, no
order_by Use this query-parameter to get the result that is ordered by the given property.
Possible Values: rpt_sample_time
group_by Use this query-parameter to get the result that is grouped by according total_not_attempted the given property.
Possible Values: url_reputation, user_agent, rpt_sample_time, url_group_category
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_user_summary":[{
"total_ssl_intercepts_prev":<Double_value>,
"protocol":<String_value>,
"__count":<Double_value>,
"operating_system":<String_value>,
"total_ssl_intercepts":<Double_value>,
"total_bytes_in":<Double_value>,
"url_group_category":<String_value>,
"total_bytes_out_prev":<Double_value>,
"user_agent":<String_value>,
"total_bytes":<Double_value>,
"rpt_sample_time":<Double_value>,
"total_bytes_in_prev":<Double_value>,
"port":<Double_value>,
"user_count_prev":<Double_value>,
"total_bytes_prev":<Double_value>,
"user_name":<String_value>,
"exporter_id":<Double_value>,
"total_bytes_out":<Double_value>,
"url_reputation":<Double_value>,
"total_requests_prev":<Double_value>,
"user_count":<Double_value>,
"total_requests":<Double_value>}]}