Read Load Balancer Service Debug Info

API to download below information which will be used for debugging and troubleshooting.

Load balancer service
Load balancer associated virtual servers
Load balancer associated pools
Load balancer associated profiles such as persistence, SSL, application.
Load balancer associated monitors
Load balancer associated rules

Use the following Policy API -
GET /policy/api/v1/infra/lb-services/<lb-service-id>/debug-info

Request

URI

GET

https://nsxmanager.your.domain/api/v1/loadbalancer/services/{service-id}/debug-info

COPY

Path Parameters

string

service-id

Required

service-id

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns LbServiceDebugInfo of type(s) application/json

{
    "application_profiles": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {},
            "_revision": 0,
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_protection": "string",
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ]
        }
    ],
    "client_ssl_profiles": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {},
            "_revision": 0,
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_protection": "string",
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "cipher_group_label": "string",
            "ciphers": [
                "string"
            ],
            "is_fips": false,
            "is_secure": false,
            "prefer_server_ciphers": false,
            "protocols": [
                "string"
            ],
            "session_cache_enabled": false,
            "session_cache_timeout": 0
        }
    ],
    "monitors": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {},
            "_revision": 0,
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_protection": "string",
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ]
        }
    ],
    "persistence_profiles": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {},
            "_revision": 0,
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_protection": "string",
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "persistence_shared": false
        }
    ],
    "pools": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {},
            "_revision": 0,
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_protection": "string",
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "active_monitor_ids": [
                "string"
            ],
            "algorithm": "string",
            "member_group": {
                "customized_members": [
                    {
                        "admin_state": "string",
                        "display_name": "string",
                        "ip_address": "string",
                        "port": "string",
                        "weight": 0
                    }
                ],
                "grouping_object": {
                    "is_valid": false,
                    "target_display_name": "string",
                    "target_id": "string",
                    "target_type": "string"
                },
                "ip_revision_filter": "string",
                "max_ip_list_size": 0,
                "port": 0
            },
            "members": [
                {
                    "admin_state": "string",
                    "backup_member": false,
                    "display_name": "string",
                    "ip_address": "string",
                    "max_concurrent_connections": 0,
                    "port": "string",
                    "weight": 0
                }
            ],
            "min_active_members": 0,
            "passive_monitor_id": "string",
            "snat_translation": {
                "port_overload": 0,
                "type": "string"
            },
            "tcp_multiplexing_enabled": false,
            "tcp_multiplexing_number": 0
        }
    ],
    "rules": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {},
            "_revision": 0,
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_protection": "string",
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "actions": [
                {
                    "type": "string"
                }
            ],
            "match_conditions": [
                {
                    "inverse": false,
                    "type": "string"
                }
            ],
            "match_strategy": "string",
            "phase": "string"
        }
    ],
    "server_ssl_profiles": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {},
            "_revision": 0,
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_protection": "string",
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "cipher_group_label": "string",
            "ciphers": [
                "string"
            ],
            "is_fips": false,
            "is_secure": false,
            "protocols": [
                "string"
            ],
            "session_cache_enabled": false
        }
    ],
    "service": {
        "access_log_enabled": false,
        "attachment": {
            "is_valid": false,
            "target_display_name": "string",
            "target_id": "string",
            "target_type": "string"
        },
        "enabled": false,
        "error_log_level": "string",
        "relax_scale_validation": false,
        "size": "string",
        "virtual_server_ids": [
            "string"
        ]
    },
    "virtual_servers": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {},
            "_revision": 0,
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_protection": "string",
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "access_list_control": {
                "action": "string",
                "enabled": false,
                "group_id": "string"
            },
            "access_log_enabled": false,
            "application_profile_id": "string",
            "client_ssl_profile_binding": {
                "certificate_chain_depth": 0,
                "client_auth": "string",
                "client_auth_ca_ids": [
                    "string"
                ],
                "client_auth_crl_ids": [
                    "string"
                ],
                "default_certificate_id": "string",
                "sni_certificate_ids": [
                    "string"
                ],
                "ssl_profile_id": "string"
            },
            "default_pool_member_port": "string",
            "default_pool_member_ports": [
                "string"
            ],
            "enabled": false,
            "ip_address": "string",
            "ip_protocol": "string",
            "log_significant_event_only": false,
            "max_concurrent_connections": 0,
            "max_new_connection_rate": 0,
            "persistence_profile_id": "string",
            "pool_id": "string",
            "port": "string",
            "ports": [
                "string"
            ],
            "rule_ids": [
                "string"
            ],
            "server_ssl_profile_binding": {
                "certificate_chain_depth": 0,
                "client_certificate_id": "string",
                "server_auth": "string",
                "server_auth_ca_ids": [
                    "string"
                ],
                "server_auth_crl_ids": [
                    "string"
                ],
                "ssl_profile_id": "string"
            },
            "sorry_pool_id": "string"
        }
    ]
}

array of application_profiles

application_profiles

Optional

The application profiles are associated to virtual servers

array of client_ssl_profiles

client_ssl_profiles

Optional

The client SSL profiles are associated to virtual servers. The property is deprecated as NSX-T Load Balancer is deprecated.

array of monitors

monitors

Optional

The load balancer monitors are associated to pools. The property is deprecated as NSX-T Load Balancer is deprecated.

array of persistence_profiles

persistence_profiles

Optional

The persistence profiles are associated to virtual servers

array of pools

pools

Optional

The pools which are associated to the given load balancer service would be included. The pools could be defined in virtual server default pool, sorry pool or load balancer rule action.