Skip to content

nssurgeq

Configuration for surge queue resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
name<String>Read-writeName of a virtual server, service or service group for which the SurgeQ must be flushed.
servername<String>Read-writeName of a service group member. This argument is needed when you want to flush the SurgeQ of a service group.
port<Integer>Read-writeport on which server is bound to the entity(Servicegroup).
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API

Operations

(click to see Properties)

FLUSH

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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

flush

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nssurgeq?action=flush

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"nssurgeq":{
"name":<String_value>,
"servername":<String_value>,
"port":<Integer_value>
}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error