Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

servicegroup_servicegroupmemberlist_binding

May 23, 2024
Contributed by: 
C

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

Properties

(click to see Operations )

Name Data Type Permissions Description
servicegroupname Read-write Name of the service group.

Minimum length = 1
members <object[]> Read-write Desired servicegroupmember binding set. Any existing servicegroupmember which is not part of the input will be deleted or disabled based on graceful setting on servicegroup.
failedmembers <object[]> Read-only List of servicegroupmembers which couldn’t be bound.
Object Member Name Type Description
ip

port

weight

state

order











IP Address.

The port number of the service to be enabled. Range 1 - 65535
  • in CLI is represented as 65535 in NITRO API

    . Default value: 1 Minimum value = 1 Maximum value = 100

    Initial state of the service group. Default value: ENABLED Possible values = ENABLED, DISABLED

    Order number to be assigned to the servicegroup member. Minimum value = 1 Maximum value = 8192

    • ip

    port





    		IP Address.

    The port number of the service to be enabled. Range 1 - 65535
  • in CLI is represented as 65535 in NITRO API

    • Operations

    (click to see Properties )

    • ADD
    • DELETE

    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_servicegroupmemberlist_binding HTTP Method: PUT

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    {
"servicegroup_servicegroupmemberlist_binding":{
<b>"servicegroupname":<String_value>,
</b>"members":<object[]_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_servicegroupmemberlist_binding/ servicegroupname_value<String> 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

    servicegroup_servicegroupmemberlist_binding
    May 23, 2024
    Contributed by: 
    C
    May 23, 2024
    Contributed by: 
    C

    In this article

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