-
-
-
-
-
-
-
-
server_servicegroup_binding
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
server_servicegroup_binding
Binding object showing the servicegroup that can be bound to server.
Properties
(click to see Operations)
Name | Data Type | Permissions | Description |
---|---|---|---|
name |
|
Read-write | Name of the server for which to display parameters. Minimum length = 1 |
servicegroupname |
|
Read-write | servicegroups bind to this server. |
sp |
|
Read-only | Enable surge protection for the service group. Default value: OFF Possible values = ON, OFF |
sc |
|
Read-only | State of the SureConnect feature for the service group. Default value: OFF Possible values = ON, OFF |
servicegroupentname2 |
|
Read-only | Used for show server of SRV type to indicate target FQDNs. |
svcitmpriority |
|
Read-only | Indicates the Priority of the SRV target FQDN. |
svrtimeout |
|
Read-only | Time, in seconds, after which to terminate an idle server connection. Minimum value = 0 Maximum value = 31536000 |
serviceipstr |
|
Read-only | This field has been intorduced to show the dbs services ip. |
tcpb |
|
Read-only | Enable TCP buffering for the service group. Possible values = YES, NO |
cip |
|
Read-only | Before forwarding a request to the service, insert an HTTP header with the client’s IPv4 or IPv6 address as its value. Used if the server needs the client’s IP address for security, accounting, or other purposes, and setting the Use Source IP parameter is not a viable option. Possible values = ENABLED, DISABLED |
dup_port |
|
Read-only | port of the service. Range 1 - 65535 * in CLI is represented as 65535 in NITRO API |
svcitmboundsvcs |
|
Read-only | Indicates the total number of bound IPs for the SRV target FQDN. |
customserverid |
|
Read-only | A positive integer to identify the service. Used when the persistency type is set to Custom Server ID. Default value: “None” |
weight |
|
Read-only | Indicates the weight of bound IPs. |
boundtd |
|
Read-only | Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0. Minimum value = 0 Maximum value = 4094 |
downstateflush |
|
Read-only | Perform delayed clean-up of connections to all services in the service group. Default value: ENABLED Possible values = ENABLED, DISABLED |
svctype |
|
Read-only | The type of bound 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 |
cka |
|
Read-only | Enable client keep-alive for the service group. Possible values = YES, NO |
svrstate |
|
Read-only | The state of the bound 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 |
appflowlog |
|
Read-only | Enable logging of AppFlow information for the specified service group. Default value: ENABLED Possible values = ENABLED, DISABLED |
cipheader |
|
Read-only | Name of the HTTP header whose value must be set to the IP address of the client. Used with the Client IP parameter. If client IP insertion is enabled, and the client IP header is not specified, the value of Client IP Header parameter or the value set by the set ns config command is used as client’s IP header name. Minimum length = 1 |
maxclient |
|
Read-only | Maximum number of simultaneous open connections for the service group. Minimum value = 0 Maximum value = 4294967294 |
clttimeout |
|
Read-only | Time, in seconds, after which to terminate an idle client connection. Minimum value = 0 Maximum value = 31536000 |
port |
|
Read-only | The port number to be used for the bound service. Range 1 - 65535 * in CLI is represented as 65535 in NITRO API |
dup_svctype |
|
Read-only | service type of the 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 |
cmp |
|
Read-only | Enable compression for the specified service. Possible values = YES, NO |
monthreshold |
|
Read-only | Minimum sum of weights of the monitors that are bound to this service. Used to determine whether to mark a service as UP or DOWN. Minimum value = 0 Maximum value = 65535 |
maxreq |
|
Read-only | Maximum number of requests that can be sent on a persistent connection to the service group. Note: Connection requests beyond this value are rejected. Minimum value = 0 Maximum value = 65535 |
serviceipaddress |
|
Read-only | The IP address of the bound service. |
svcitmactsvcs |
|
Read-only | Indicates the total number of active IPs for SRV target FQDN. |
usip |
|
Read-only | Use the client’s IP address as the source IP address when initiating a connection to the server. When creating a service, if you do not set this parameter, the service inherits the global Use Source IP setting (available in the enable ns mode and disable ns mode CLI commands, or in the System > Settings > Configure modes > Configure Modes dialog box). However, you can override this setting after you create the service. Possible values = YES, NO |
cacheable |
|
Read-only | Use the transparent cache redirection virtual server to forward the request to the cache server. Default value: NO Possible values = YES, NO |
maxbandwidth |
|
Read-only | Maximum bandwidth, in Kbps, allocated for all the services in the service group. Minimum value = 0 Maximum value = 4294967287 |
svrcfgflags |
|
Read-only | service flags to denote its a db enabled. |
__count |
|
Read-only | count 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 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/server_servicegroup_binding/name_value<String>
Query-parameters:
filter
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/server_servicegroup_binding/name_value<String>?filter=property-name1:property-value1,property-name2:property-value2
Use this query-parameter to get the filtered set of server_servicegroup_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/server_servicegroup_binding/name_value<String>?pagesize=#no;pageno=#no
Use this query-parameter to get the server_servicegroup_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:
{ "server_servicegroup_binding": [ {
"name":<String_value>,
"servicegroupname":<String_value>,
"sp":<String_value>,
"sc":<String_value>,
"servicegroupentname2":<String_value>,
"svcitmpriority":<Double_value>,
"svrtimeout":<Double_value>,
"serviceipstr":<String_value>,
"tcpb":<String_value>,
"cip":<String_value>,
"dup_port":<Integer_value>,
"svcitmboundsvcs":<Double_value>,
"customserverid":<String_value>,
"weight":<Double_value>,
"boundtd":<Double_value>,
"downstateflush":<String_value>,
"svctype":<String_value>,
"cka":<String_value>,
"svrstate":<String_value>,
"appflowlog":<String_value>,
"cipheader":<String_value>,
"maxclient":<Double_value>,
"clttimeout":<Double_value>,
"port":<Integer_value>,
"dup_svctype":<String_value>,
"cmp":<String_value>,
"monthreshold":<Double_value>,
"maxreq":<Double_value>,
"serviceipaddress":<String_value>,
"svcitmactsvcs":<Double_value>,
"usip":<String_value>,
"cacheable":<String_value>,
"maxbandwidth":<Double_value>,
"svrcfgflags":<Double_value>
}]}
<!--NeedCopy-->
get (all)
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/server_servicegroup_binding
Query-parameters:
bulkbindings
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/server_servicegroup_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:
{ "server_servicegroup_binding": [ {
"name":<String_value>,
"servicegroupname":<String_value>,
"sp":<String_value>,
"sc":<String_value>,
"servicegroupentname2":<String_value>,
"svcitmpriority":<Double_value>,
"svrtimeout":<Double_value>,
"serviceipstr":<String_value>,
"tcpb":<String_value>,
"cip":<String_value>,
"dup_port":<Integer_value>,
"svcitmboundsvcs":<Double_value>,
"customserverid":<String_value>,
"weight":<Double_value>,
"boundtd":<Double_value>,
"downstateflush":<String_value>,
"svctype":<String_value>,
"cka":<String_value>,
"svrstate":<String_value>,
"appflowlog":<String_value>,
"cipheader":<String_value>,
"maxclient":<Double_value>,
"clttimeout":<Double_value>,
"port":<Integer_value>,
"dup_svctype":<String_value>,
"cmp":<String_value>,
"monthreshold":<Double_value>,
"maxreq":<Double_value>,
"serviceipaddress":<String_value>,
"svcitmactsvcs":<Double_value>,
"usip":<String_value>,
"cacheable":<String_value>,
"maxbandwidth":<Double_value>,
"svrcfgflags":<Double_value>
}]}
<!--NeedCopy-->
count
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/server_servicegroup_binding/name_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:
{"server_servicegroup_binding": [ { "__count": "#no"} ] }
<!--NeedCopy-->
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.