Download full document:

lbmonbindings_service_binding

Binding object showing the service that can be bound to lbmonbindings.

Properties

(click to see Operations)

NameData TypePermissionsDescription
servicename<String>Read-writeThe name of the service.
monitorname<String>Read-writeThe name of the monitor.
Minimum length = 1
servicetype<String>Read-onlyThe type of service.
Possible values = HTTP, FTP, TCP, UDP, SSL, SSL_BRIDGE, SSL_TCP, DTLS, NNTP, RPCSVR, DNS, ADNS, SNMP, RTSP, DHCPRA, ANY, SIP_UDP, SIP_TCP, SIP_SSL, DNS_TCP, ADNS_TCP, MYSQL, MSSQL, ORACLE, RADIUS, RADIUSListener, RDP, DIAMETER, SSL_DIAMETER, TFTP, SMPP, PPTP, GRE, SYSLOGTCP, SYSLOGUDP, FIX, SSL_FIX, USER_TCP, USER_SSL_TCP, QUIC, IPFIX, LOGSTREAM
svrstate<String>Read-onlyThe state of the 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
monsvcstate<String>Read-onlyThe configured state (enable/disable) of Monitor on this service.
Possible values = ENABLED, DISABLED
port<Integer>Read-onlyThe port of the service.
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API
ipaddress<String>Read-onlyThe IPAddress of the service.
__count<Double>Read-onlycount parameter

Operations

(click to see Properties)

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 redand placeholder content is marked in <green>.

get

URL:http://<netscaler-ip-address>/nitro/v1/config/lbmonbindings_service_binding/monitorname_value<String>

Query-parameters:

filter

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

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

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

Content-Type:application/json

Response Payload:

{ "lbmonbindings_service_binding": [ {
"servicename":<String_value>,
"monitorname":<String_value>,
"servicetype":<String_value>,
"svrstate":<String_value>,
"monsvcstate":<String_value>,
"port":<Integer_value>,
"ipaddress":<String_value>
}]}

get (all)

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

Query-parameters:

bulkbindings

http://<netscaler-ip-address>/nitro/v1/config/lbmonbindings_service_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 NetScaler-specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "lbmonbindings_service_binding": [ {
"servicename":<String_value>,
"monitorname":<String_value>,
"servicetype":<String_value>,
"svrstate":<String_value>,
"monsvcstate":<String_value>,
"port":<Integer_value>,
"ipaddress":<String_value>
}]}

count

URL:http://<netscaler-ip-address>/nitro/v1/config/lbmonbindings_service_binding/monitorname_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 errorResponse Headers:

Content-Type:application/json

Response Payload:

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