REST API - get

vcenter nsx clusters networking status: get

Returns information about the overall configuration status of the cluster, status of the VDS which was used for the overlay network configuration of the cluster, configuration status and health status of the NSX Edge node(s) in the cluster, configuration status and health status of ESXi hosts in the cluster and information about the logical router in the NSX Edge node(s). Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

GET https://{server}/api/vcenter/nsx/clusters/{cluster}/networking-status

Path Parameters

Name Type Description
Required
cluster string Identifier for the vSphere cluster on which NSX networking is enabled.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "cluster"{
        "logical_router"{
            "name""string",
            "edge_cluster_name""string",
            "type""string",
            "config"{
                "messages"[
                    {
                        "severity""INFO",
                        "details"{
                            "args"[
                                "string",
                                "string"
                            ],
                            "default_message""string",
                            "localized""string",
                            "id""string",
                            "params"{
                                "<string>"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"{
                                            "<string>"{
                                                "dt""2015-01-01T22:13:05.651Z",
                                                "s""string",
                                                "d"1.5,
                                                "precision"1,
                                                "format""SHORT_DATE",
                                                "i"1,
                                                "l"{
                                                    "id""string",
                                                    "params"{}
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    {
                        "severity""INFO",
                        "details"{
                            "args"[
                                "string",
                                "string"
                            ],
                            "default_message""string",
                            "localized""string",
                            "id""string",
                            "params"{
                                "<string>"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"{
                                            "<string>"{
                                                "dt""2015-01-01T22:13:05.651Z",
                                                "s""string",
                                                "d"1.5,
                                                "precision"1,
                                                "format""SHORT_DATE",
                                                "i"1,
                                                "l"{
                                                    "id""string",
                                                    "params"{}
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                ],
                "status""NOT_STARTED"
            },
            "uplink_edges"[
                {
                    "node""obj-103",
                    "availability_status"{
                        "messages"[
                            {
                                "severity""INFO",
                                "details"{
                                    "args"[
                                        "string",
                                        "string"
                                    ],
                                    "default_message""string",
                                    "localized""string",
                                    "id""string",
                                    "params"{
                                        "<string>"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"{
                                                    "<string>"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"{}
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            {
                                "severity""INFO",
                                "details"{
                                    "args"[
                                        "string",
                                        "string"
                                    ],
                                    "default_message""string",
                                    "localized""string",
                                    "id""string",
                                    "params"{
                                        "<string>"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"{
                                                    "<string>"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"{}
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        ],
                        "state""ACTIVE"
                    },
                    "name""string"
                },
                {
                    "node""obj-103",
                    "availability_status"{
                        "messages"[
                            {
                                "severity""INFO",
                                "details"{
                                    "args"[
                                        "string",
                                        "string"
                                    ],
                                    "default_message""string",
                                    "localized""string",
                                    "id""string",
                                    "params"{
                                        "<string>"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"{
                                                    "<string>"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"{}
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            {
                                "severity""INFO",
                                "details"{
                                    "args"[
                                        "string",
                                        "string"
                                    ],
                                    "default_message""string",
                                    "localized""string",
                                    "id""string",
                                    "params"{
                                        "<string>"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"{
                                                    "<string>"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"{}
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        ],
                        "state""ACTIVE"
                    },
                    "name""string"
                }
            ]
        },
        "esx_host_cluster"{
            "esx_hosts"[
                {
                    "host""obj-103",
                    "name""string",
                    "health"{
                        "warnings"[
                            {
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "localized""string",
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{
                                                "<string>"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"{}
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            {
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "localized""string",
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{
                                                "<string>"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"{}
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        ],
                        "errors"[
                            {
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "localized""string",
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{
                                                "<string>"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"{}
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            {
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "localized""string",
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{
                                                "<string>"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"{}
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        ],
                        "status""HEALTHY"
                    },
                    "config"{
                        "messages"[
                            {
                                "severity""INFO",
                                "details"{
                                    "args"[
                                        "string",
                                        "string"
                                    ],
                                    "default_message""string",
                                    "localized""string",
                                    "id""string",
                                    "params"{
                                        "<string>"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"{
                                                    "<string>"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"{}
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            {
                                "severity""INFO",
                                "details"{
                                    "args"[
                                        "string",
                                        "string"
                                    ],
                                    "default_message""string",
                                    "localized""string",
                                    "id""string",
                                    "params"{
                                        "<string>"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"{
                                                    "<string>"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"{}
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        ],
                        "status""NOT_STARTED"
                    }
                },
                {
                    "host""obj-103",
                    "name""string",
                    "health"{
                        "warnings"[
                            {
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "localized""string",
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{
                                                "<string>"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"{}
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            {
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "localized""string",
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{
                                                "<string>"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"{}
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        ],
                        "errors"[
                            {
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "localized""string",
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{
                                                "<string>"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"{}
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            {
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "localized""string",
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{
                                                "<string>"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"{}
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        ],
                        "status""HEALTHY"
                    },
                    "config"{
                        "messages"[
                            {
                                "severity""INFO",
                                "details"{
                                    "args"[
                                        "string",
                                        "string"
                                    ],
                                    "default_message""string",
                                    "localized""string",
                                    "id""string",
                                    "params"{
                                        "<string>"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"{
                                                    "<string>"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"{}
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            {
                                "severity""INFO",
                                "details"{
                                    "args"[
                                        "string",
                                        "string"
                                    ],
                                    "default_message""string",
                                    "localized""string",
                                    "id""string",
                                    "params"{
                                        "<string>"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"{
                                                    "<string>"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"{}
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        ],
                        "status""NOT_STARTED"
                    }
                }
            ]
        },
        "edge_cluster"{
            "name""string",
            "health""UP",
            "config"{
                "messages"[
                    {
                        "severity""INFO",
                        "details"{
                            "args"[
                                "string",
                                "string"
                            ],
                            "default_message""string",
                            "localized""string",
                            "id""string",
                            "params"{
                                "<string>"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"{
                                            "<string>"{
                                                "dt""2015-01-01T22:13:05.651Z",
                                                "s""string",
                                                "d"1.5,
                                                "precision"1,
                                                "format""SHORT_DATE",
                                                "i"1,
                                                "l"{
                                                    "id""string",
                                                    "params"{}
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    {
                        "severity""INFO",
                        "details"{
                            "args"[
                                "string",
                                "string"
                            ],
                            "default_message""string",
                            "localized""string",
                            "id""string",
                            "params"{
                                "<string>"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"{
                                            "<string>"{
                                                "dt""2015-01-01T22:13:05.651Z",
                                                "s""string",
                                                "d"1.5,
                                                "precision"1,
                                                "format""SHORT_DATE",
                                                "i"1,
                                                "l"{
                                                    "id""string",
                                                    "params"{}
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                ],
                "status""NOT_STARTED"
            },
            "edge_nodes"[
                {
                    "node""obj-103",
                    "uplink_name""string",
                    "name""string",
                    "health"{
                        "warnings"[
                            {
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "localized""string",
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{
                                                "<string>"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"{}
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            {
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "localized""string",
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{
                                                "<string>"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"{}
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        ],
                        "errors"[
                            {
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "localized""string",
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{
                                                "<string>"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"{}
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            {
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "localized""string",
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{
                                                "<string>"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"{}
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        ],
                        "status""HEALTHY"
                    },
                    "config"{
                        "messages"[
                            {
                                "severity""INFO",
                                "details"{
                                    "args"[
                                        "string",
                                        "string"
                                    ],
                                    "default_message""string",
                                    "localized""string",
                                    "id""string",
                                    "params"{
                                        "<string>"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"{
                                                    "<string>"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"{}
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            {
                                "severity""INFO",
                                "details"{
                                    "args"[
                                        "string",
                                        "string"
                                    ],
                                    "default_message""string",
                                    "localized""string",
                                    "id""string",
                                    "params"{
                                        "<string>"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"{
                                                    "<string>"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"{}
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        ],
                        "status""NOT_STARTED"
                    }
                },
                {
                    "node""obj-103",
                    "uplink_name""string",
                    "name""string",
                    "health"{
                        "warnings"[
                            {
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "localized""string",
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{
                                                "<string>"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"{}
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            {
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "localized""string",
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{
                                                "<string>"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"{}
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        ],
                        "errors"[
                            {
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "localized""string",
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{
                                                "<string>"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"{}
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            {
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "localized""string",
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{
                                                "<string>"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"{}
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        ],
                        "status""HEALTHY"
                    },
                    "config"{
                        "messages"[
                            {
                                "severity""INFO",
                                "details"{
                                    "args"[
                                        "string",
                                        "string"
                                    ],
                                    "default_message""string",
                                    "localized""string",
                                    "id""string",
                                    "params"{
                                        "<string>"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"{
                                                    "<string>"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"{}
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            {
                                "severity""INFO",
                                "details"{
                                    "args"[
                                        "string",
                                        "string"
                                    ],
                                    "default_message""string",
                                    "localized""string",
                                    "id""string",
                                    "params"{
                                        "<string>"{
                                            "dt""2015-01-01T22:13:05.651Z",
                                            "s""string",
                                            "d"1.5,
                                            "precision"1,
                                            "format""SHORT_DATE",
                                            "i"1,
                                            "l"{
                                                "id""string",
                                                "params"{
                                                    "<string>"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"{}
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        ],
                        "status""NOT_STARTED"
                    }
                }
            ]
        }
    },
    "vds"{
        "dv_switch""obj-103",
        "name""string",
        "health"{
            "warnings"[
                {
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                {
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            ],
            "errors"[
                {
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                {
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            ],
            "status""HEALTHY"
        }
    },
    "config"{
        "messages"[
            {
                "severity""INFO",
                "details"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            },
            {
                "severity""INFO",
                "details"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        ],
        "status""NOT_STARTED"
    }
}

Headers:

None

Type:

Name Type Description
bold = required
- info Info structure containing the aggregate configuration and health information about different entities in the cluster.
-.config config Overall NSX networking configuration. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.config.status string Configuration status of the entity. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Defines the possible values for the configuration status of an entity. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of:
NOT_STARTED: Configuration has not started yet. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
CONFIGURING: Configuration is in progress. This represents the state of the configuration when Clusters# enable, EdgeClusters# enable or EdgeClusters# update API is in progress. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
PARTIALLY_CONFIGURED: Configuration was partially successful. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
CONFIGURED: Configuration was successful. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
INDETERMINATE: Configuration status cannot be determined. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
FAILED: Configuration failed. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
DISABLING: Configuration is being disabled. This represents the state of the configuration when Clusters# disable or EdgeClusters# disable API is in progress. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
DISABLED: Configuration has been disabled. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.config.messages message[] List of messages indicating the issues, if any, with the configuration status of the entity. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This field will be empty if there are no additional details.

-.config.messages[].severity string Severity of the message. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Represents the severity of the message. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of:
INFO: Informational message. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
WARNING: Warning message. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
ERROR: Error message. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.config.messages[].details localizable_message Details about the message. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.config.messages[].details.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.

-.config.messages[].details.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.

-.config.messages[].details.args string[] Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments.

-.cluster cluster Configuration and health information about the entities in the cluster. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.cluster.edge_cluster edge_cluster Information about the NSX Edge node(s) in the cluster. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.cluster.edge_cluster.name string Name of the NSX Edge cluster. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. This field will be empty when the name is not present.

-.cluster.edge_cluster.config config Configuration information about the NSX Edge cluster. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.cluster.edge_cluster.config.status string Configuration status of the entity. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Defines the possible values for the configuration status of an entity. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of:
NOT_STARTED: Configuration has not started yet. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
CONFIGURING: Configuration is in progress. This represents the state of the configuration when Clusters# enable, EdgeClusters# enable or EdgeClusters# update API is in progress. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
PARTIALLY_CONFIGURED: Configuration was partially successful. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
CONFIGURED: Configuration was successful. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
INDETERMINATE: Configuration status cannot be determined. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
FAILED: Configuration failed. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
DISABLING: Configuration is being disabled. This represents the state of the configuration when Clusters# disable or EdgeClusters# disable API is in progress. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
DISABLED: Configuration has been disabled. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.cluster.edge_cluster.config.messages message[] List of messages indicating the issues, if any, with the configuration status of the entity. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This field will be empty if there are no additional details.

-.cluster.edge_cluster.health string Health status information about the NSX Edge cluster. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Defines the possible values for the health status of the NSX Edge cluster. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of:
UP: The NSX Edge cluster is healthy and status is up. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
DEGRADED: The NSX Edge cluster has one or more issues that require attention and status is degraded. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
INDETERMINATE: The NSX Edge cluster status cannot be determined. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
DOWN: The NSX Edge cluster is unhealthy and status is down. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.cluster.edge_cluster.edge_nodes edge_node[] Status information about the NSX Edge node(s) in the NSX Edge cluster. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.cluster.esx_host_cluster esx_host_cluster Information about the ESXi hosts in the cluster. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.cluster.esx_host_cluster.esx_hosts esx_host[] Status information about the ESXi hosts in the cluster. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.cluster.logical_router logical_router Information about the logical router in the NSX Edge node(s). Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.cluster.logical_router.name string Name of the logical router. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. To be unset when name is not present.

-.cluster.logical_router.type string Type of the logical router. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. To be unset when type is not present.

-.cluster.logical_router.config config Configuration information about the logical router. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.cluster.logical_router.config.status string Configuration status of the entity. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Defines the possible values for the configuration status of an entity. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of:
NOT_STARTED: Configuration has not started yet. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
CONFIGURING: Configuration is in progress. This represents the state of the configuration when Clusters# enable, EdgeClusters# enable or EdgeClusters# update API is in progress. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
PARTIALLY_CONFIGURED: Configuration was partially successful. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
CONFIGURED: Configuration was successful. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
INDETERMINATE: Configuration status cannot be determined. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
FAILED: Configuration failed. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
DISABLING: Configuration is being disabled. This represents the state of the configuration when Clusters# disable or EdgeClusters# disable API is in progress. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
DISABLED: Configuration has been disabled. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.cluster.logical_router.config.messages message[] List of messages indicating the issues, if any, with the configuration status of the entity. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This field will be empty if there are no additional details.

-.cluster.logical_router.edge_cluster_name string Name of the NSX Edge cluster. This field should be the same as the name field in the EdgeCluster structure. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. This field will be empty when the name is not present.

-.cluster.logical_router.uplink_edges uplink_edge[] Information about the uplink NSX Edge node(s). Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.vds vds Status information about the VDS. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.vds.dv_switch string Identifier for the VDS. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: DistributedVirtualSwitch. When operations return a value of this structure as a result, the field will be an identifier for the resource type: DistributedVirtualSwitch.

-.vds.name string Name of the VDS. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.vds.health health Health information of the VDS. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.vds.health.status string Health status of the entity. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Defines the possible values for the health status of an entity. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of:
HEALTHY: Status is healthy. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
HEALTHY_WITH_WARNINGS: Status is healthy, however there might be an issue that requires attention. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
INDETERMINATE: Status cannot be determined. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
UNHEALTHY: Status is not healthy. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.vds.health.errors localizable_message[] List of error messages indicating the issues with the health of the entity. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when status has value [INDETERMINATE, UNHEALTHY]. This field is optional and it is only relevant when the value of status is one of INDETERMINATE or UNHEALTHY.

-.vds.health.warnings localizable_message[] List of warning messages indicating the issues with the health of the entity that may require attention. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when status has value [HEALTHY_WITH_WARNINGS, INDETERMINATE]. This field is optional and it is only relevant when the value of status is one of HEALTHY_WITH_WARNINGS or INDETERMINATE.

Errors:

HTTP Status Code Type Description
400 not_allowed_in_current_state if NSX Edge capabilities are not currently enabled on this vSphere cluster or another conflicting operation is in progress.
404 not_found if cluster is not a valid identifier for a compute resource configured for NSX networking.
500 error if the system reports an error while responding to the request.