Perform Pool Member Action

For ADD_MEMBERS, pool members will be created and added to load balancer pool. This action is only valid for static pool members. For REMOVE_MEMBERS, pool members will be removed from load balancer pool via IP and port in pool member settings. This action is only valid for static pool members. For UPDATE_MEMBERS, pool members admin state will be updated. This action is valid for both static pool members and dynamic pool members. For dynamic pool members, this update will be stored in customized_members field in load balancer pool member group.

Request

URI

POST

https://nsxmanager.your.domain/api/v1/loadbalancer/pools/{pool-id}

COPY

Path Parameters

string

pool-id

Required

pool-id

Query Parameters

string

action

Required

Specifies addition, removal and modification action

Possible values are : ADD_MEMBERS, REMOVE_MEMBERS, UPDATE_MEMBERS,

Request Body

PoolMemberSettingList of type(s) application/json

Required

{
    "members": [
        {
            "admin_state": "string",
            "ip_address": "string",
            "port": "string",
            "weight": 0,
            "display_name": "string"
        }
    ]
}

array of PoolMemberSetting

members

Required

List of pool member settings to be passed to add, update and remove APIs

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns LbPool of type(s) application/json

This response body class contains all of the following: ManagedResource , InlineLbPool1

{
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_revision": 0,
    "_system_owned": false,
    "display_name": "string",
    "description": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "_create_user": "string",
    "_protection": "string",
    "_create_time": 0,
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "id": "string",
    "resource_type": "string",
    "member_group": {
        "grouping_object": {
            "target_display_name": "string",
            "is_valid": false,
            "target_id": "string",
            "target_type": "string"
        },
        "ip_revision_filter": "string",
        "max_ip_list_size": 0,
        "port": 0,
        "customized_members": [
            {
                "admin_state": "string",
                "ip_address": "string",
                "port": "string",
                "weight": 0,
                "display_name": "string"
            }
        ]
    },
    "snat_translation": {
        "type": "string",
        "port_overload": 0
    },
    "algorithm": "string",
    "members": [
        {
            "max_concurrent_connections": 0,
            "admin_state": "string",
            "backup_member": false,
            "weight": 0,
            "display_name": "string",
            "ip_address": "string",
            "port": "string"
        }
    ],
    "passive_monitor_id": "string",
    "tcp_multiplexing_number": 0,
    "active_monitor_ids": [
        "string"
    ],
    "tcp_multiplexing_enabled": false,
    "min_active_members": 0
}

400

Returns BadRequest of type(s) application/json