Gateways

Gateway cluster VLAN mismatch summary

Retrieves VLAN mismatch information categorized as good or poor for the entire gateway-cluster or individual gateways within the gateway-cluster.

get/network-monitoring/v1/clusters/{cluster-name}/vlan-mismatch

Request

Base URL
https://sso.common.cloud.hpe.com
Auth
OAuth 2
Client credentials
Token URLhttps://sso.common.cloud.hpe.com/as/token.oauth2
TypeScript
https://skmtc.dev/arubanetworks/apis/authorization/docs/network-monitoring/v1/clusters/:cluster-name/vlan-mismatch/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

cluster-namestring const required

The name of the cluster to which the device belongs. If the device is not part of any cluster then the cluster name will be null.

Example:cluster 1

The name of the cluster formed by the gateway.

Query parameters

filterstring

OData Version 4.0 filter string (limited functionality). Supported fields and operators are in the below given table.

Field	Operators
serialNumber	eq

The operators are implemented as follows:

eq: Only values exactly matching the given value are returned.

Response

Object containing information about the good and poor VLANs, either for the entire gateway-cluster or for individual gateways within the gateway-cluster.

goodinteger

The number of VLANs that are good in health.

poorinteger

The number of VLANs that are configured improperly.

idstring required

Primary identifier for the resource.

typestring required

The type of the resource.

Example response

{
  "good": 4,
  "poor": 2,
  "id": "gw-cluster-1",
  "type": "network-monitoring/gateway-monitoring"
}

Changes

No recorded changes to this operation across all 1 revision of this API.