Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

servicegroup_servicegroupmember_binding

August 17, 2023
Contributed by: 
C

Binding object showing the servicegroupmember 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
ip <String> Read-write IP Address.
port <Integer> Read-write Server 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 group.

Default value: ENABLED

Possible values = ENABLED, DISABLED
hashid <Double> 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
serverid <Double> Read-write The identifier for the service. This is used when the persistency type is set to Custom Server ID.
servername <String> Read-write Name of the server to which to bind the service group.

Minimum length = 1
customserverid <String> Read-write The identifier for this IP:Port pair. Used when the persistency type is set to Custom Server ID.

Default value: "None"
weight <Double> 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
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
svcitmpriority <Double> Read-only This gives the priority of the FQDN service items for SRV server binding.
delay <Double> Read-only Time, in seconds, allocated for a shutdown of the services in the service group. During this period, new requests are sent to the service only for clients who already have persistent sessions on the appliance. Requests from new clients are load balanced among other available services. After the delay time expires, no requests are sent to the service, and the service is marked as unavailable (OUT OF SERVICE).
statechangetimesec <String> Read-only Time when last state change occurred. Seconds part.
svrstate <String> Read-only The 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
tickssincelaststatechange <Double> Read-only Time in 10 millisecond ticks since the last state change.
trofsreason <String> Read-only Specify reason if service group member in TROFS.

Possible values = Trofs Because of Graceful Unbind, Trofs Because of Disable Cmd, Trofs Becasue of Autoscale IP not present in DNS Response, Trofs Because of Monitor Response has Trofs String
graceful <String> 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 <Double> 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 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 red and placeholder content is marked in green

add

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

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{
"servicegroup_servicegroupmember_binding":{
<b>      "servicegroupname":<String_value>,
</b>      "ip":<String_value>,
      "servername":<String_value>,
      "port":<Integer_value>,
      "weight":<Double_value>,
      "customserverid":<String_value>,
      "serverid":<Double_value>,
      "state":<String_value>,
      "hashid":<Double_value>,
      "nameserver":<String_value>,
      "dbsttl":<Double_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 NetScaler-specific errors). The response payload provides details of the error

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/servicegroup_servicegroupmember_binding/ servicegroupname_value<String>

Query-parameters:

args

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

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/servicegroup_servicegroupmember_binding/ servicegroupname_value<String>

Query-parameters:

filter

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

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

Use this query-parameter to get the servicegroup_servicegroupmember_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 error

Response Header:

Content-Type:application/json

Response Payload: 


{  "servicegroup_servicegroupmember_binding": [ {
      "servicegroupname":<String_value>,
      "ip":<String_value>,
      "port":<Integer_value>,
      "nameserver":<String_value>,
      "state":<String_value>,
      "hashid":<Double_value>,
      "serverid":<Double_value>,
      "servername":<String_value>,
      "customserverid":<String_value>,
      "weight":<Double_value>,
      "dbsttl":<Double_value>,
      "svcitmpriority":<Double_value>,
      "delay":<Double_value>,
      "statechangetimesec":<String_value>,
      "svrstate":<String_value>,
      "tickssincelaststatechange":<Double_value>,
      "trofsreason":<String_value>,
      "graceful":<String_value>
}]}

<!--NeedCopy-->

get (all)

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

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters:

bulkbindings

http:// <netscaler-ip-address> /nitro/v1/config/servicegroup_servicegroupmember_binding? bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

Note: get (all) method can be used only in conjuction with bulkbindings query parameter.

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 error

Response Header:

Content-Type:application/json

Response Payload: 


{  "servicegroup_servicegroupmember_binding": [ {
      "servicegroupname":<String_value>,
      "ip":<String_value>,
      "port":<Integer_value>,
      "nameserver":<String_value>,
      "state":<String_value>,
      "hashid":<Double_value>,
      "serverid":<Double_value>,
      "servername":<String_value>,
      "customserverid":<String_value>,
      "weight":<Double_value>,
      "dbsttl":<Double_value>,
      "svcitmpriority":<Double_value>,
      "delay":<Double_value>,
      "statechangetimesec":<String_value>,
      "svrstate":<String_value>,
      "tickssincelaststatechange":<Double_value>,
      "trofsreason":<String_value>,
      "graceful":<String_value>
}]}

<!--NeedCopy-->

count

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

Response Header:

Content-Type:application/json

Response Payload: 


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

<!--NeedCopy-->
servicegroup_servicegroupmember_binding
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.