ADM NITRO APIs

swg_ssl_details

Configuration for swg_ssl_details resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
ssli_executed_action Read-write SSL Executed Action..

Maximum length = 255
__count Read-write count..
total_not_attempted_prev Read-write total_not_attempted_prev.
rpt_sample_time Read-write Report Sample time..
total_not_intercepted_prev Read-write total_not_intercepted_prev.
ssli_reason_for_action Read-write SSL REASON Codes..

Maximum length = 255
user_name Read-write User Name.

Maximum length = 255
domain_name Read-write HTTP Request URL..

Maximum length = 2000
exporter_id Read-write Exporter ID.
total_not_intercepted Read-write total_not_intercepted.
ssli_policy_action Read-write ssli_policy_action.
total_not_attempted Read-write total_not_attempted.

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_ssl_details 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: rpt_sample_time 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_ssl_details":[{
"ssli_executed_action":<String_value>,
"__count":<Double_value>,
"total_not_attempted_prev":<Double_value>,
"rpt_sample_time":<Double_value>,
"total_not_intercepted_prev":<Double_value>,
"ssli_reason_for_action":<String_value>,
"user_name":<String_value>,
"domain_name":<String_value>,
"exporter_id":<Double_value>,
"total_not_intercepted":<Double_value>,
"ssli_policy_action":<Double_value>,
"total_not_attempted":<Double_value>}]}

<!--NeedCopy-->
swg_ssl_details