servicegroup_servicegroupentitymonbindings_binding

Last published : Oct 30, 2026
Binding object showing the servicegroupentitymonbindings that can be bound to servicegroup.

Properties

(click to see Operations)
Name Data Type Permissions Description
servicegroupname <String> Read-write Name of the service group.
Minimum length = 1
servicegroupentname2 <String> Read-write .
port <Integer> Read-write Port number of the service. Each service must have a unique port number.
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API
nameserver <String> Read-write Specify the nameserver to which the query for bound domain needs to be sent. If not specified, use the global nameserver.
state <String> Read-write Initial state of the service after binding.
Default value: ENABLED
Possible values = ENABLED, DISABLED
hashid <Double> Read-write Unique numerical identifier used by hash based load balancing methods to identify a service.
Minimum value = 1
serverid <Double> Read-write The identifier for the service. This is used when the persistency type is set to Custom Server ID.
customserverid <String> Read-write Unique service identifier. Used when the persistency type for the virtual server is set to Custom Server ID.
Default value: "None"
weight <Double> Read-write .
Default value: 1
Minimum value = 1
Maximum value = 100
monitor_name <String> Read-write Monitor name.
dbsttl <Double> Read-write Specify the TTL for DNS record for domain based service.The default value of ttl is 0 which indicates to use the TTL received in DNS response for monitors.
Default value: 0
passive <Boolean> Read-write Indicates if load monitor is passive. A passive load monitor does not remove service from LB decision when threshold is breached.
lastresponse <String> Read-only The string form of monstatcode.
monitor_state <String> Read-only The running state of the monitor on this service.
Possible values = UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, DISABLED
monitortotalprobes <Double> Read-only Total number of probes sent to monitor this service.
monitortotalfailedprobes <Double> Read-only Total number of failed probes.
monitorcurrentfailedprobes <Double> Read-only Total number of currently failed probes.
__count <Double> Read-only count parameter

Operations

(click to see Properties)
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/servicegroup_servicegroupentitymonbindings_binding/servicegroupname_value<String>
Query-parameters:
filter
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/servicegroup_servicegroupentitymonbindings_binding/servicegroupname_value<String>?filter=property-name1:property-value1,property-name2:property-value2
Use this query-parameter to get the filtered set of servicegroup_servicegroupentitymonbindings_binding resources configured on Citrix ADC. Filtering can be done on any of the properties of the resource.
pagination
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/servicegroup_servicegroupentitymonbindings_binding/servicegroupname_value<String>?pagesize=#no;pageno=#no
Use this query-parameter to get the servicegroup_servicegroupentitymonbindings_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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:
Content-Type:application/json
Response Payload:

{ "servicegroup_servicegroupentitymonbindings_binding": [ {
"servicegroupname":<String_value>,
"servicegroupentname2":<String_value>,
"port":<Integer_value>,
"nameserver":<String_value>,
"state":<String_value>,
"hashid":<Double_value>,
"serverid":<Double_value>,
"customserverid":<String_value>,
"weight":<Double_value>,
"monitor_name":<String_value>,
"dbsttl":<Double_value>,
"passive":<Boolean_value>,
"lastresponse":<String_value>,
"monitor_state":<String_value>,
"monitortotalprobes":<Double_value>,
"monitortotalfailedprobes":<Double_value>,
"monitorcurrentfailedprobes":<Double_value>
}]}

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/servicegroup_servicegroupentitymonbindings_binding
Query-parameters:
bulkbindings
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/servicegroup_servicegroupentitymonbindings_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:

{ "servicegroup_servicegroupentitymonbindings_binding": [ {
"servicegroupname":<String_value>,
"servicegroupentname2":<String_value>,
"port":<Integer_value>,
"nameserver":<String_value>,
"state":<String_value>,
"hashid":<Double_value>,
"serverid":<Double_value>,
"customserverid":<String_value>,
"weight":<Double_value>,
"monitor_name":<String_value>,
"dbsttl":<Double_value>,
"passive":<Boolean_value>,
"lastresponse":<String_value>,
"monitor_state":<String_value>,
"monitortotalprobes":<Double_value>,
"monitortotalfailedprobes":<Double_value>,
"monitorcurrentfailedprobes":<Double_value>
}]}

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/servicegroup_servicegroupentitymonbindings_binding/servicegroupname_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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:
Content-Type:application/json
Response Payload:

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