Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

cspolicylabel

August 17, 2023
Contributed by: 
C

Configuration for CS policy label resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
labelname Read-write Name for the policy label. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters. The label name must be unique within the list of policy labels for content switching. The following requirement applies only to the Citrix ADC CLI If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my policylabel” or ‘my policylabel’).
cspolicylabeltype Read-write Protocol supported by the policy label. All policies bound to the policy label must either match the specified protocol or be a subtype of that protocol. Available settings function as follows
  • HTTP - Supports policies that process HTTP traffic. Used to access unencrypted Web sites. (The default.)
  • SSL - Supports policies that process HTTPS/SSL encrypted traffic. Used to access encrypted Web sites.
  • TCP - Supports policies that process any type of TCP traffic, including HTTP.
  • SSL_TCP - Supports policies that process SSL-encrypted TCP traffic, including SSL.
  • UDP - Supports policies that process any type of UDP-based traffic, including DNS.
  • DNS - Supports policies that process DNS traffic.
  • ANY - Supports all types of policies except HTTP, SSL, and TCP.
  • SIP_UDP - Supports policies that process UDP based Session Initiation Protocol (SIP) traffic. SIP initiates, manages, and terminates multimedia communications sessions, and has emerged as the standard for Internet telephony (VoIP).
  • RTSP - Supports policies that process Real Time Streaming Protocol (RTSP) traffic. RTSP provides delivery of multimedia and other streaming data, such as audio, video, and other types of streamed media.
  • RADIUS - Supports policies that process Remote Authentication Dial In User Service (RADIUS) traffic. RADIUS supports combined authentication, authorization, and auditing services for network management.
  • MYSQL - Supports policies that process MYSQL traffic.
  • MSSQL - Supports policies that process Microsoft SQL traffic. Possible values = HTTP, TCP, RTSP, SSL, SSL_TCP, UDP, DNS, SIP_UDP, SIP_TCP, ANY, RADIUS, RDP, MYSQL, MSSQL, ORACLE, DIAMETER, SSL_DIAMETER, FTP, DNS_TCP, SMPP
    		•
    newname Read-write The new name of the content switching policylabel.

    Minimum length = 1
    numpol Read-only number of polices bound to label.
    hits Read-only Number of times policy label was invoked.
    policyname Read-only Name of the content switching policy.
    priority Read-only Specifies the priority of the policy.
    targetvserver Read-only Name of the virtual server to which to forward requests that match the policy.
    gotopriorityexpression Read-only Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
    labeltype Read-only Type of policy label invocation.

    Possible values = policylabel
    invoke_labelname Read-only Name of the label to invoke if the current policy rule evaluates to TRUE.
    __count Read-only count parameter

    Operations

    (click to see Properties )

    • ADD
    • DELETE
    • GET (ALL)
    • GET
    • COUNT
    • RENAME

    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/cspolicylabel

    HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"cspolicylabel":{
<b>      "labelname":<String_value>,
</b><b>      "cspolicylabeltype":<String_value>
</b>}}

<!--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/cspolicylabel/ labelname_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

    rename

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

    HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"cspolicylabel":{
<b>      "labelname":<String_value>,
</b><b>      "newname":<String_value>
</b>}}

<!--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/cspolicylabel

    Query-parameters:

    attrs

    http:// <netscaler-ip-address> /nitro/v1/config/cspolicylabel? 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/cspolicylabel? filter=property-name1:property-val1,property-name2:property-val2

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

    view

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

    Use this query-parameter to get the summary output of cspolicylabel 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/cspolicylabel? pagesize=#no;pageno=#no

    Use this query-parameter to get the cspolicylabel 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: 

    
{ "cspolicylabel": [ {
      "labelname":<String_value>,
      "cspolicylabeltype":<String_value>,
      "numpol":<Double_value>,
      "hits":<Double_value>,
      "policyname":<String_value>,
      "priority":<Double_value>,
      "targetvserver":<String_value>,
      "gotopriorityexpression":<String_value>,
      "labeltype":<String_value>,
      "invoke_labelname":<String_value>
}]}

<!--NeedCopy-->

    get

    URL: http:// <netscaler-ip-address> /nitro/v1/config/cspolicylabel/ labelname_value<String>

    Query-parameters:

    attrs

    http:// <netscaler-ip-address> /nitro/v1/config/cspolicylabel/ labelname_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/cspolicylabel/ labelname_value<String> ? view=summary

    Use this query-parameter to get the summary output of cspolicylabel 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: 

    
{  "cspolicylabel": [ {
      "labelname":<String_value>,
      "cspolicylabeltype":<String_value>,
      "numpol":<Double_value>,
      "hits":<Double_value>,
      "policyname":<String_value>,
      "priority":<Double_value>,
      "targetvserver":<String_value>,
      "gotopriorityexpression":<String_value>,
      "labeltype":<String_value>,
      "invoke_labelname":<String_value>
}]}

<!--NeedCopy-->

    count

    URL: http:// <netscaler-ip-address> /nitro/v1/config/cspolicylabel? 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: 

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

<!--NeedCopy-->
    cspolicylabel
    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.