Product Documentation

Enabling NetScaler Features and Modes

Jun 14, 2016

Some NetScaler features and modes are disabled by default and therefore must be enabled before they can be configured. To enable a NetScaler feature or mode, specify the action as "enable" in the URL query string, and in the request payload, specify the feature or mode to be enabled.

For example, to enable the load balancing and content switching features:
  • Request:

    HTTP Method
    POST
    URL
    http://<netscaler-ip-address>/nitro/v1/config/nsfeature?action=enable
    Request Headers
    Cookie:NITRO_AUTH_TOKEN=<tokenvalue> 
    Content-Type:application/vnd.com.citrix.netscaler.nsfeature+json
    Request Payload
    { 
        "nsfeature":  
        { 
            "feature":  
            [ 
                "LB", 
                "CS" 
            ] 
        } 
    }
  • 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.
For example, to enable the L2 and fast ramp modes:
  • Request:

    HTTP Method
    POST
    URL
    http://<netscaler-ip-address>/nitro/v1/config/nsmode?action=enable
    Request Headers
    Cookie:NITRO_AUTH_TOKEN=<tokenvalue> 
    Content-Type:application/vnd.com.citrix.netscaler.nsmode+json
    Request Payload
    { 
        "nsmode": 
        { 
            "mode": 
            [ 
                "L2", 
                "FR" 
            ] 
        } 
    }
  • 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.
Note: To disable a feature or mode, in the URL query string, specify the action as "disable".