Developer Documentation
Citrix ADM NITRO API Reference

si_device

June 20, 2023
Contributed by: 
C

Configuration for AF Safety Device Report table resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
threat_index Read-write Threat Index.
low_threat Read-write Low Threat Count.
medium_threat Read-write Medium Threat Count.
medium_safety Read-write Medium Safety Count..
name Read-write Name of Citrix ADC Instance.

Minimum length = 1

Maximum length = 128
high_safety Read-write High Safety Count.
high_threat Read-write Hig Threat Count.
__count Read-write Number of records.
index_summary Read-write index_summary 0 or 1..
safety_index Read-write safety index..
ip_address Read-write Citrix ADC IP Address..

Minimum length = 1

Maximum length = 64
total_attacks Read-write total attacks..
low_safety Read-write Low Safety Count.

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/si_device Query-parameters:

cr_enabled Use this query-parameter to indicate cr is enabled or not.

Possible Values: 0, 1 report_start_time Use this query-parameter to specify the start time from which the summary for report is considered.

Possible Values: time in milli seconds report_end_time Use this query-parameter to specify the end time until where summary for report is considered.

Possible Values: time in milli seconds asc Use this query-parameter to specify whether the results should be in ascending order or not.

Possible Values: yes, no sla_enabled Use this query-parameter to indicate sla is enabled or not.

Possible Values: 0, 1 order_by Use this query-parameter to get the result that is ordered by the given property.

Possible Values: total_attacks type Use this query-parameter to specify the type.

Possible Values: total_attacks 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, "si_device":[{
"threat_index":<Double_value>,
"low_threat":<Double_value>,
"medium_threat":<Double_value>,
"medium_safety":<Double_value>,
"name":<String_value>,
"high_safety":<Double_value>,
"high_threat":<Double_value>,
"__count":<Double_value>,
"index_summary":<Double_value>,
"safety_index":<Double_value>,
"ip_address":<String_value>,
"total_attacks":<Double_value>,
"low_safety":<Double_value>}]}

<!--NeedCopy-->
si_device
June 20, 2023
Contributed by: 
C
June 20, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.