-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
gslbservicegroup_gslbservicegroupmember_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!
gslbservicegroup_gslbservicegroupmember_binding
Binding object showing the gslbservicegroupmember that can be bound to gslbservicegroup.
Properties
(click to see Operations)
Name | Data Type | Permissions | Description |
---|---|---|---|
state |
|
Read-write | Initial state of the GSLB service group. Default value: ENABLED Possible values = ENABLED, DISABLED |
publicport |
|
Read-write | The public port associated with the GSLB service’s public IP address. The port is mapped to the service’s private port number. Applicable to the local GSLB service. Optional. Minimum value = 1 |
weight |
|
Read-write | Weight 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 |
port |
|
Read-write | Server port number. Range 1 - 65535 * in CLI is represented as 65535 in NITRO API |
servername |
|
Read-write | Name of the server to which to bind the service group. Minimum length = 1 |
siteprefix |
|
Read-write | The site’s prefix string. When the GSLB service group is bound to a GSLB virtual server, a GSLB site domain is generated internally for each bound serviceitem-domain pair by concatenating the site prefix of the service item and the name of the domain. If the special string NONE is specified, the site-prefix string is unset. When implementing HTTP redirect site persistence, the Citrix ADC redirects GSLB requests to GSLB services by using their site domains. |
ip |
|
Read-write | IP Address. |
servicegroupname |
|
Read-write | Name of the GSLB service group. Minimum length = 1 |
hashid |
|
Read-write | The hash identifier for the service. This must be unique for each service. This parameter is used by hash based load balancing methods. Minimum value = 1 |
publicip |
|
Read-write | The public IP address that a NAT device translates to the GSLB service’s private IP address. Optional. Minimum length = 1 |
threshold |
|
Read-only | . Possible values = ABOVE, BELOW |
delay |
|
Read-only | The time allowed (in seconds) for a graceful shutdown. During this period, new connections or requests will continue to be sent to this service for clients who already have a persistent session on the system. Connections or requests from fresh or new clients who do not yet have a persistence sessions on the system will not be sent to the service. Instead, they will be load balanced among other available services. After the delay time expires, no new requests or connections will be sent to the service. |
statechangetimesec |
|
Read-only | Time when last state change occurred. Seconds part. |
preferredlocation |
|
Read-only | Prefered location. |
svrstate |
|
Read-only | The state of the GSLB 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 |
gslbthreshold |
|
Read-only | Indicates if gslb svc has reached threshold. |
tickssincelaststatechange |
|
Read-only | Time in 10 millisecond ticks since the last state change. |
graceful |
|
Read-only | Wait for all existing connections to the service to terminate before shutting down the service. Default value: NO Possible values = YES, NO |
__count |
|
Read-only | count 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/gslbservicegroup_gslbservicegroupmember_binding
HTTP Method:PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{
"gslbservicegroup_gslbservicegroupmember_binding":{
<b>"servicegroupname":<String_value>,
</b>"ip":<String_value>,
"servername":<String_value>,
"port":<Integer_value>,
"weight":<Double_value>,
"state":<String_value>,
"hashid":<Double_value>,
"publicip":<String_value>,
"publicport":<Integer_value>,
"siteprefix":<String_value>
}}
<!--NeedCopy-->
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/gslbservicegroup_gslbservicegroupmember_binding/servicegroupname_value<String>
Query-parameters:
args
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/gslbservicegroup_gslbservicegroupmember_binding/servicegroupname_value<String>?args=ip:<String_value>,servername:<String_value>,port:<Integer_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/gslbservicegroup_gslbservicegroupmember_binding/servicegroupname_value<String>
Query-parameters:
filter
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/gslbservicegroup_gslbservicegroupmember_binding/servicegroupname_value<String>?filter=property-name1:property-value1,property-name2:property-value2
Use this query-parameter to get the filtered set of gslbservicegroup_gslbservicegroupmember_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/gslbservicegroup_gslbservicegroupmember_binding/servicegroupname_value<String>?pagesize=#no;pageno=#no
Use this query-parameter to get the gslbservicegroup_gslbservicegroupmember_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:
{ "gslbservicegroup_gslbservicegroupmember_binding": [ {
"state":<String_value>,
"publicport":<Integer_value>,
"weight":<Double_value>,
"port":<Integer_value>,
"servername":<String_value>,
"siteprefix":<String_value>,
"ip":<String_value>,
"servicegroupname":<String_value>,
"hashid":<Double_value>,
"publicip":<String_value>,
"threshold":<String_value>,
"delay":<Double_value>,
"statechangetimesec":<String_value>,
"preferredlocation":<String_value>,
"svrstate":<String_value>,
"gslbthreshold":<Integer_value>,
"tickssincelaststatechange":<Double_value>,
"graceful":<String_value>
}]}
<!--NeedCopy-->
get (all)
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/gslbservicegroup_gslbservicegroupmember_binding
Query-parameters:
bulkbindings
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/gslbservicegroup_gslbservicegroupmember_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:
{ "gslbservicegroup_gslbservicegroupmember_binding": [ {
"state":<String_value>,
"publicport":<Integer_value>,
"weight":<Double_value>,
"port":<Integer_value>,
"servername":<String_value>,
"siteprefix":<String_value>,
"ip":<String_value>,
"servicegroupname":<String_value>,
"hashid":<Double_value>,
"publicip":<String_value>,
"threshold":<String_value>,
"delay":<Double_value>,
"statechangetimesec":<String_value>,
"preferredlocation":<String_value>,
"svrstate":<String_value>,
"gslbthreshold":<Integer_value>,
"tickssincelaststatechange":<Double_value>,
"graceful":<String_value>
}]}
<!--NeedCopy-->
count
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/gslbservicegroup_gslbservicegroupmember_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:
{"gslbservicegroup_gslbservicegroupmember_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.