Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

wisite_farmname_binding

August 17, 2023
Contributed by: 
C

Binding object showing the farmname that can be bound to wisite.

Properties

(click to see Operations )

Name Data Type Permissions Description
sitepath <String> Read-write Path to the Web Interface site.

Minimum length = 1

Maximum length = 250
groups <String> Read-write Active Directory groups that are permitted to enumerate resources from server farms. Including a setting for this parameter activates the user roaming feature. A maximum of 512 user groups can be specified for each farm defined with the Farm<n> parameter. The groups must be comma separated.
xmlport <Double> Read-write Port number at which to contact the XML service.
transport <String> Read-write Transport protocol to use for transferring data, related to the Web Interface site, between the Citrix ADC and the XML service.

Possible values = HTTP, HTTPS, SSLRELAY
sslrelayport <Double> Read-write TCP port at which the XenApp or XenDesktop servers listenfor SSL Relay traffic from the Citrix ADC. This parameter is required if you have set SSL Relay as the transport protocol. Web Interface uses root certificates when authenticating a server running SSL Relay. Make sure that all the servers running SSL Relay are configured to listen on the same port.
farmname <String> Read-write Name for the logical representation of a XenApp or XenDesktop farm to be bound to the Web Interface site. 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.
loadbalance <String> Read-write Use all the XML servers (load balancing mode) or only one server (failover mode).

Possible values = ON, OFF
recoveryfarm <String> Read-write Binded farm is set as a recovery farm.

Default value: OFF

Possible values = ON, OFF
xmlserveraddresses <String> Read-write Comma-separated IP addresses or host names of XenApp or XenDesktop servers providing XML services.
__count <Double> Read-write count parameter

Operations

(click to see Properties )

  • ADD
  • DELETE
  • GET
  • GET (ALL)
  • 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/wisite_farmname_binding

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{
"wisite_farmname_binding":{
<b>      "sitepath":<String_value>,
</b>      "farmname":<String_value>,
      "xmlserveraddresses":<String_value>,
      "groups":<String_value>,
      "recoveryfarm":<String_value>,
      "xmlport":<Double_value>,
      "transport":<String_value>,
      "sslrelayport":<Double_value>,
      "loadbalance":<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/wisite_farmname_binding/ sitepath_value<String>

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/config/wisite_farmname_binding/ sitepath_value<String> ? args=farmname: <String_value>

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

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/wisite_farmname_binding/ sitepath_value<String>

Query-parameters:

filter

http:// <netscaler-ip-address> /nitro/v1/config/wisite_farmname_binding/ sitepath_value<String> ? filter=property-name1:property-value1,property-name2:property-value2

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

pagination

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

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


{  "wisite_farmname_binding": [ {
      "sitepath":<String_value>,
      "groups":<String_value>,
      "xmlport":<Double_value>,
      "transport":<String_value>,
      "sslrelayport":<Double_value>,
      "farmname":<String_value>,
      "loadbalance":<String_value>,
      "recoveryfarm":<String_value>,
      "xmlserveraddresses":<String_value>
}]}

<!--NeedCopy-->

get (all)

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

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters:

bulkbindings

http:// <netscaler-ip-address> /nitro/v1/config/wisite_farmname_binding? bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

Note: get (all) method can be used only in conjuction with bulkbindings query parameter.

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: 


{  "wisite_farmname_binding": [ {
      "sitepath":<String_value>,
      "groups":<String_value>,
      "xmlport":<Double_value>,
      "transport":<String_value>,
      "sslrelayport":<Double_value>,
      "farmname":<String_value>,
      "loadbalance":<String_value>,
      "recoveryfarm":<String_value>,
      "xmlserveraddresses":<String_value>
}]}

<!--NeedCopy-->

count

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


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

<!--NeedCopy-->
wisite_farmname_binding
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.