Skip to content

clusternodegroup_binding

Binding object which returns the resources bound to clusternodegroup.

Properties

(click to see Operations)

NameData TypePermissionsDescription
name<String>Read-writeName of the nodegroup to be displayed. If a name is not provided, information about all nodegroups is displayed.
Minimum length = 1
clusternodegroup_csvserver_binding<clusternodegroup_csvserver_binding[]>Read-onlycsvserver that can be bound to clusternodegroup.
clusternodegroup_gslbsite_binding<clusternodegroup_gslbsite_binding[]>Read-onlygslbsite that can be bound to clusternodegroup.
clusternodegroup_nslimitidentifier_binding<clusternodegroup_nslimitidentifier_binding[]>Read-onlynslimitidentifier that can be bound to clusternodegroup.
clusternodegroup_clusternode_binding<clusternodegroup_clusternode_binding[]>Read-onlyclusternode that can be bound to clusternodegroup.
clusternodegroup_lbvserver_binding<clusternodegroup_lbvserver_binding[]>Read-onlylbvserver that can be bound to clusternodegroup.
clusternodegroup_vpnvserver_binding<clusternodegroup_vpnvserver_binding[]>Read-onlyvpnvserver that can be bound to clusternodegroup.
clusternodegroup_service_binding<clusternodegroup_service_binding[]>Read-onlyservice that can be bound to clusternodegroup.
clusternodegroup_streamidentifier_binding<clusternodegroup_streamidentifier_binding[]>Read-onlystreamidentifier that can be bound to clusternodegroup.
clusternodegroup_gslbvserver_binding<clusternodegroup_gslbvserver_binding[]>Read-onlygslbvserver that can be bound to clusternodegroup.
clusternodegroup_authenticationvserver_binding<clusternodegroup_authenticationvserver_binding[]>Read-onlyauthenticationvserver that can be bound to clusternodegroup.
clusternodegroup_crvserver_binding<clusternodegroup_crvserver_binding[]>Read-onlycrvserver that can be bound to clusternodegroup.

Operations

(click to see Properties)

GET| GET (ALL)

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>.

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/clusternodegroup_binding/name_value<String>

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "clusternodegroup_binding": [ {
"name":<String_value>,
"clusternodegroup_csvserver_binding":<clusternodegroup_csvserver_binding[]_value>,
"clusternodegroup_vpnvserver_binding":<clusternodegroup_vpnvserver_binding[]_value>,
"clusternodegroup_crvserver_binding":<clusternodegroup_crvserver_binding[]_value>,
"clusternodegroup_nslimitidentifier_binding":<clusternodegroup_nslimitidentifier_binding[]_value>,
"clusternodegroup_gslbsite_binding":<clusternodegroup_gslbsite_binding[]_value>,
"clusternodegroup_clusternode_binding":<clusternodegroup_clusternode_binding[]_value>,
"clusternodegroup_authenticationvserver_binding":<clusternodegroup_authenticationvserver_binding[]_value>,
"clusternodegroup_lbvserver_binding":<clusternodegroup_lbvserver_binding[]_value>,
"clusternodegroup_gslbvserver_binding":<clusternodegroup_gslbvserver_binding[]_value>,
"clusternodegroup_streamidentifier_binding":<clusternodegroup_streamidentifier_binding[]_value>,
"clusternodegroup_service_binding":<clusternodegroup_service_binding[]_value>
}]}

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/clusternodegroup_binding

Query-parameters:

bulkbindings

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/clusternodegroup_binding?bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "clusternodegroup_binding": [ {
"name":<String_value>,
"clusternodegroup_csvserver_binding":<clusternodegroup_csvserver_binding[]_value>,
"clusternodegroup_vpnvserver_binding":<clusternodegroup_vpnvserver_binding[]_value>,
"clusternodegroup_crvserver_binding":<clusternodegroup_crvserver_binding[]_value>,
"clusternodegroup_nslimitidentifier_binding":<clusternodegroup_nslimitidentifier_binding[]_value>,
"clusternodegroup_gslbsite_binding":<clusternodegroup_gslbsite_binding[]_value>,
"clusternodegroup_clusternode_binding":<clusternodegroup_clusternode_binding[]_value>,
"clusternodegroup_authenticationvserver_binding":<clusternodegroup_authenticationvserver_binding[]_value>,
"clusternodegroup_lbvserver_binding":<clusternodegroup_lbvserver_binding[]_value>,
"clusternodegroup_gslbvserver_binding":<clusternodegroup_gslbvserver_binding[]_value>,
"clusternodegroup_streamidentifier_binding":<clusternodegroup_streamidentifier_binding[]_value>,
"clusternodegroup_service_binding":<clusternodegroup_service_binding[]_value>
}]}