Citrix

Produktdokumentation



Ganzes Dokument herunterladen

alert_options

Oct. 21, 2015

Alert Options

Properties

Name Data Type Read-Only? Description
alertcondition
<String>
Yes

Condition on which the alert is generated.

alertname
<String>
Yes

Alert Name

thresholdvalue
<Integer>
No

Alert threshold value.

Minimum value = 0

Maximum value = 999

alertlevel
<String>
No

Alert level

Possible values = [disable, log, alert]

alertid
<Integer>
No

Alert ID.

Minimum value = 0

description
<String>
Yes

Alert description

helptext
<String>
Yes

Help Text

minimumalertlevel
<String>
Yes

Minimum configurable alert level supported for the specific alert ID.

Possible values = [disable, log, alert]

Operations

Note:

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

GET

Use this operation to get alert options

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/config/alert_options/

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Accept: application/vnd.com.citrix.cloudbridge.alert_options+json

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.alert_options+json

Response Payload: JSON

{"alert_options":{
"alertcondition": <string_value>,
"alertname": <string_value>,
"thresholdvalue": <integer_value>,
"alertlevel": <string_value>,
"alertid": <integer_value>,
"description": <string_value>,
"helptext": <string_value>,
"minimumalertlevel": <string_value>
}}

MODIFY

Use this operation to modify alert options

HTTP Method: PUT

URL: https://<cb_ip_address>/cb/nitro/v1/config/alert_options

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Content-Type: application/vnd.com.citrix.cloudbridge.alert_options+json

Request Payload: JSON

{"alert_options":{
"thresholdvalue": <integer_value>,
"alertlevel": <string_value>,
"alertid": <integer_value>
}}

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.alert_options+json

Response Payload: JSON

{"alert_options":{
"alertcondition": <string_value>,
"alertname": <string_value>,
"thresholdvalue": <integer_value>,
"alertlevel": <string_value>,
"alertid": <integer_value>,
"description": <string_value>,
"helptext": <string_value>,
"minimumalertlevel": <string_value>
}}

RESET

Use this operation to reset alert options

HTTP Method: POST

URL: https://<cb_ip_address>/cb/nitro/v1/config/alert_options?action=reset

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Content-Type: application/vnd.com.citrix.cloudbridge.alert_options+json

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.alert_options+json

Response Payload: JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>}
Back to Top