Data Object - GatewayHealthInfo

Class
VMware.Hv.GatewayHealthInfo
Returned by
GatewayHealth_Get, GatewayHealth_List
See also
GatewayHealthConnectionData, GatewayId
Since
Horizon 7.7

Data Object Description

Gateway Health Information

Data Object Properties

Properties

Name Type Description
idGatewayId

Id for the gateway.
namexsd:string

Name of the gateway.
  • This property cannot be updated.
addressxsd:string

IP address of the gateway.
  • This property cannot be updated.
gatewayZoneInternalxsd:boolean

Flag to determine whether the gateway is internal.
  • This property cannot be updated.
versionxsd:string

Version of the gateway.
  • This property cannot be updated.
typexsd:string

Type of the gateway.
  • This property cannot be updated.
  • This property will be one of:
    Value Description
    "AP"AP type is for UAG.
    "F5"F5 type is for F5 server.
    "SG"SG type is for Security Server.
    "SG-cohosted"SG-cohosted type is for Cohosted CS as gateway.
    "Unknown"Unknown type is for unrecognized gateway type.
connectionDataGatewayHealthConnectionData

The connection data of the gateway.
gatewayStatusActivexsd:boolean

Flag to indicate gateway status.
  • This property cannot be updated.
gatewayStatusStalexsd:boolean

Flag to indicate whether gateway is staled or not.
  • This property cannot be updated.
gatewayContactedxsd:boolean

Flag to indicate whether gateway has contacted connection server.
  • This property cannot be updated.
refIdxsd:string

Reference ID of the gateway.

Since Horizon 7.10
  • This property need not be set.
lastUpdatedTimestampxsd:long

The timestamp in milliseconds when the last update was obtained. Measured as epoch time.

Since Horizon 7.12
  • This property need not be set.
  • This property cannot be updated.