Skip to content

servicegroup_lbmonitor_binding

Binding object showing the lbmonitor that can be bound to servicegroup.

Properties

(click to see Operations)

NameData TypePermissionsDescription
servicegroupname<String>Read-writeName of the service group.
Minimum length = 1
port<Integer>Read-writePort 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-writeSpecify the nameserver to which the query for bound domain needs to be sent. If not specified, use the global nameserver.
state<String>Read-writeInitial state of the service after binding.
Default value: ENABLED
Possible values = ENABLED, DISABLED
hashid<Double>Read-writeUnique numerical identifier used by hash based load balancing methods to identify a service.
Minimum value = 1
serverid<Double>Read-writeThe identifier for the service. This is used when the persistency type is set to Custom Server ID.
customserverid<String>Read-writeUnique service identifier. Used when the persistency type for the virtual server is set to Custom Server ID.
Default value: "None"
weight<Double>Read-writeWeight to assign to the servers in the service group. Specifies the capacity of the servers relative to the other servers in the load balancing configuration. The higher the weight, the higher the percentage of requests sent to the service.
Minimum value = 1
Maximum value = 100
monitor_name<String>Read-writeMonitor name.
dbsttl<Double>Read-writeSpecify 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-writeIndicates if load monitor is passive. A passive load monitor does not remove service from LB decision when threshold is breached.
monstate<String>Read-writeMonitor state.
Possible values = ENABLED, DISABLED
monweight<Double>Read-onlyweight of the monitor that is bound to servicegroup.
__count<Double>Read-onlycount 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 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>.

add:

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

HTTP Method:PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{
"servicegroup_lbmonitor_binding":{
<b>"servicegroupname":<String_value>,
</b>"port":<Integer_value>,
"monitor_name":<String_value>,
"monstate":<String_value>,
"passive":<Boolean_value>,
"weight":<Double_value>,
"customserverid":<String_value>,
"serverid":<Double_value>,
"state":<String_value>,
"hashid":<Double_value>,
"nameserver":<String_value>,
"dbsttl":<Double_value>
}}

Response:

HTTP Status Code on Success: 201 Created 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 error

delete:

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

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/servicegroup_lbmonitor_binding/servicegroupname_value<String>?args=port:<Integer_value>,monitor_name:<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 Citrix ADC specific errors). The response payload provides details of the error

get

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

Query-parameters:

filter

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/servicegroup_lbmonitor_binding/servicegroupname_value<String>?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of servicegroup_lbmonitor_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_lbmonitor_binding/servicegroupname_value<String>?pagesize=#no;pageno=#no

Use this query-parameter to get the servicegroup_lbmonitor_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_lbmonitor_binding": [ {
"servicegroupname":<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>,
"monstate":<String_value>,
"monweight":<Double_value>
}]}

get (all)

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

Query-parameters:

bulkbindings

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/servicegroup_lbmonitor_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_lbmonitor_binding": [ {
"servicegroupname":<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>,
"monstate":<String_value>,
"monweight":<Double_value>
}]}

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/servicegroup_lbmonitor_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_lbmonitor_binding": [ { "__count": "#no"} ] }