Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

scpolicy

August 17, 2023
Contributed by: 
C

Configuration for SureConnect policy resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
name Read-write Name for the policy. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters.

Minimum length = 1

Maximum length = 31
url Read-write URL against which to match incoming client request.

Maximum length = 127
rule Read-write Expression against which the traffic is evaluated. Maximum length of a string literal in the expression is 255 characters. A longer string can be split into smaller strings of up to 255 characters each, and the smaller strings concatenated with the + operator. For example, you can create a 500-character string as follows: ‘“<string of 255 characters>” + “<string of 245 characters>”’ The following requirements apply only to the Citrix ADC CLI
  • If the expression includes one or more spaces, enclose the entire expression in double quotation marks.
  • If the expression itself includes double quotation marks, escape the quotations by using the character.
  • Alternatively, you can use single quotation marks to enclose the rule, in which case you do not have to escape the double quotation marks. Maximum length = 1499
    		•
    delay Read-write Delay threshold, in microseconds, for requests that match the policy’s URL or rule. If the delay statistics gathered for the matching request exceed the specified delay, SureConnect is triggered for that request.

    Minimum value = 1

    Maximum value = 599999999
    maxconn Read-write Maximum number of concurrent connections that can be open for requests that match the policy’s URL or rule.

    Minimum value = 1

    Maximum value = 4294967294
    action Read-write Action to be taken when the delay or maximum-connections threshold is reached. Available settings function as follows ACS - Serve content from an alternative content service. NS - Serve alternative content from the Citrix ADC. NO ACTION - Serve no alternative content. However, delay statistics are still collected for the configured URLs, and, if the Maximum Client Connections parameter is set, the number of connections is limited to the value specified by that parameter. (However, alternative content is not served even if the maxConn threshold is met). Possible values = ACS, NS, NOACTION
    altcontentsvcname Read-write Name of the alternative content service to be used in the ACS action.

    Minimum length = 1

    Maximum length = 127
    altcontentpath Read-write Path to the alternative content service to be used in the ACS action.

    Minimum length = 1

    Maximum length = 127
    __count Read-only count parameter

    Operations

    (click to see Properties )

    • ADD
    • DELETE
    • UPDATE
    • UNSET
    • GET (ALL)
    • GET
    • COUNT

    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

    add

    URL: http:// <netscaler-ip-address> /nitro/v1/config/scpolicy

    HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"scpolicy":{
<b>      "name":<String_value>,
</b>      "url":<String_value>,
      "rule":<String_value>,
      "delay":<Double_value>,
      "maxconn":<Double_value>,
      "action":<String_value>,
      "altcontentsvcname":<String_value>,
      "altcontentpath":<String_value>
}}

<!--NeedCopy-->

    Response:

    HTTP Status Code on Success: 201 Created

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

    delete

    URL: http:// <netscaler-ip-address> /nitro/v1/config/scpolicy/ name_value<String>

    HTTP Method: DELETE

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Response:

    HTTP Status Code on Success: 200 OK

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

    update

    URL: http:// <netscaler-ip-address> /nitro/v1/config/scpolicy

    HTTP Method: PUT

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"scpolicy":{
<b>      "name":<String_value>,
</b>      "url":<String_value>,
      "rule":<String_value>,
      "delay":<Double_value>,
      "maxconn":<Double_value>,
      "action":<String_value>,
      "altcontentsvcname":<String_value>,
      "altcontentpath":<String_value>
}}

<!--NeedCopy-->

    Response:

    HTTP Status Code on Success: 200 OK

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

    unset

    URL: http:// <netscaler-ip-address> /nitro/v1/config/scpolicy? action=unset

    HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"scpolicy":{
<b>      "name":<String_value>,
</b>      "delay":true,
      "maxconn":true
}}

<!--NeedCopy-->

    Response:

    HTTP Status Code on Success: 200 OK

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

    get (all)

    URL: http:// <netscaler-ip-address> /nitro/v1/config/scpolicy

    Query-parameters:

    attrs

    http:// <netscaler-ip-address> /nitro/v1/config/scpolicy? attrs=property-name1,property-name2

    Use this query parameter to specify the resource details that you want to retrieve.

    filter

    http:// <netscaler-ip-address> /nitro/v1/config/scpolicy? filter=property-name1:property-val1,property-name2:property-val2

    Use this query-parameter to get the filtered set of scpolicy resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

    view

    http:// <netscaler-ip-address> /nitro/v1/config/scpolicy? view=summary

    Use this query-parameter to get the summary output of scpolicy resources configured on NetScaler.

    Note: By default, the retrieved results are displayed in detail view (?view=detail).

    pagination

    http:// <netscaler-ip-address> /nitro/v1/config/scpolicy? pagesize=#no;pageno=#no

    Use this query-parameter to get the scpolicy resources in chunks.

    HTTP Method: GET

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Accept:application/json

    Response:

    HTTP Status Code on Success: 200 OK

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

    Response Header:

    Content-Type:application/json

    Response Payload: 

    
{ "scpolicy": [ {
      "name":<String_value>,
      "url":<String_value>,
      "rule":<String_value>,
      "delay":<Double_value>,
      "maxconn":<Double_value>,
      "action":<String_value>,
      "altcontentsvcname":<String_value>,
      "altcontentpath":<String_value>
}]}

<!--NeedCopy-->

    get

    URL: http:// <netscaler-ip-address> /nitro/v1/config/scpolicy/ name_value<String>

    Query-parameters:

    attrs

    http:// <netscaler-ip-address> /nitro/v1/config/scpolicy/ name_value<String> ? attrs=property-name1,property-name2

    Use this query parameter to specify the resource details that you want to retrieve.

    view

    http:// <netscaler-ip-address> /nitro/v1/config/scpolicy/ name_value<String> ? view=summary

    Use this query-parameter to get the summary output of scpolicy resources configured on NetScaler.

    Note: By default, the retrieved results are displayed in detail view (?view=detail).

    HTTP Method: GET

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Accept:application/json

    Response:

    HTTP Status Code on Success: 200 OK

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

    Response Header:

    Content-Type:application/json

    Response Payload: 

    
{  "scpolicy": [ {
      "name":<String_value>,
      "url":<String_value>,
      "rule":<String_value>,
      "delay":<Double_value>,
      "maxconn":<Double_value>,
      "action":<String_value>,
      "altcontentsvcname":<String_value>,
      "altcontentpath":<String_value>
}]}

<!--NeedCopy-->

    count

    URL: http:// <netscaler-ip-address> /nitro/v1/config/scpolicy? count=yes

    HTTP Method: GET

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Accept:application/json

    Response:

    HTTP Status Code on Success: 200 OK

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

    Response Header:

    Content-Type:application/json

    Response Payload: 

    
{ "scpolicy": [ { "__count": "#no"} ] }

<!--NeedCopy-->
    scpolicy
    August 17, 2023
    Contributed by: 
    C
    August 17, 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.