{"swagger":"2.0","info":{"description":"Welcome to the Horizon Server API Reference documentation. This API reference provides comprehensive information about status of all Horizon Server components and resources.","version":"1.0.0","title":"Horizon Server API","license":{"name":"Copyright © 1998 - 2019 VMware, Inc. All rights reserved."}},"host":"localhost","basePath":"/rest","tags":[{"name":"Auth","description":"APIs for Authentication and Authorization"},{"name":"Config","description":"APIs for configuration."},{"name":"External","description":"APIs for resources that are external to Horizon environment."},{"name":"Monitor","description":"APIs for monitoring services"}],"paths":{"/config/v1/ic-domain-accounts":{"get":{"tags":["Config"],"summary":"Lists instant clone domain accounts of the environment.","operationId":"listICDomainAccounts","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/InstantCloneDomainAccountInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false},"post":{"tags":["Config"],"summary":"Creates instant clone domain account.","operationId":"createICDomainAccount","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"spec","description":"spec","required":true,"schema":{"$ref":"#/definitions/InstantCloneDomainAccountCreateSpec"}}],"responses":{"201":{"description":"Created","schema":{"type":"object"}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"409":{"description":"Conflict"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/ic-domain-accounts/{id}":{"get":{"tags":["Config"],"summary":"Gets instant clone domain account.","operationId":"getICDomainAccount","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InstantCloneDomainAccountInfo"}},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"put":{"tags":["Config"],"summary":"Updates instant clone domain account.","operationId":"updateICDomainAccount","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"},{"in":"body","name":"updateSpec","description":"updateSpec","required":true,"schema":{"$ref":"#/definitions/InstantCloneDomainAccountUpdateSpec"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false},"delete":{"tags":["Config"],"summary":"Deletes instant clone domain account.","operationId":"deleteICDomainAccount","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"},"404":{"description":"Not Found"}},"security":[{"Bearer":[]}],"deprecated":false}},"/config/v1/virtual-centers":{"get":{"tags":["Config"],"summary":"Lists Virtual Centers configured in the environment.","operationId":"listVCInfo","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/VirtualCenterInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/external/v1/ad-domains":{"get":{"tags":["External"],"summary":"Lists information related to AD Domains of the environment.","operationId":"listADDomains","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ADDomainInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/login":{"post":{"tags":["Auth"],"summary":"Logs in a user. Returns access token and refresh token.","description":"Note: UPN(e.g. testadmin@example.com) based login is not supported.
Only Administrators on Root access group are allowed to login.","operationId":"loginUser","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Login credentials needed for Authentication","required":true,"schema":{"$ref":"#/definitions/AuthLogin"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AuthTokens"}},"400":{"description":"Bad Request"},"401":{"description":"User is not authenticated"}},"deprecated":false}},"/logout":{"post":{"tags":["Auth"],"summary":"Logs out a user.","operationId":"logoutUser","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Refresh token needed for Logout","required":true,"schema":{"$ref":"#/definitions/RefreshToken"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/monitor/ad-domains":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to AD Domains of the environment.","operationId":"listADDomainMonitors","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ADDomainMonitorInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/connection-servers":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to Connection Servers of the environment.","operationId":"listConnectionServerMonitors","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ConnectionServerMonitorInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/event-database":{"get":{"tags":["Monitor"],"summary":"Returns monitoring information related to Event database of the environment.","operationId":"getEventDatabaseMonitor","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EventDatabaseMonitorInfo"}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/farms":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to Farms of the environment.","operationId":"listFarmMonitors","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/FarmMonitorInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/gateways":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to Gateways registered in the environment.","operationId":"listGatewayMonitors","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/GatewayMonitorInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/rds-servers":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to RDS Servers of the environment.","operationId":"listRDSServerMonitors","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/RDSServerMonitorInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/saml-authenticators":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to SAML Authenticators of the environment.","operationId":"listSAMLAuthenticatorMonitors","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/SAMLAuthenticatorMonitorInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v1/pods":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to the remote pods.","operationId":"listPodMonitors","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PodMonitorInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/v1/true-sso":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to True SSO connectors.","operationId":"listTrueSSOMonitorInfos","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/TrueSSOMonitorInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/view-composers":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to View Composers of the environment.","operationId":"listViewComposerMonitors","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ViewComposerMonitorInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/monitor/virtual-centers":{"get":{"tags":["Monitor"],"summary":"Lists monitoring information related to Virtual Centers of the environment.","operationId":"listVirtualCenterMonitors","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/VirtualCenterMonitorInfo"}}},"401":{"description":"User is not authenticated"}},"security":[{"Bearer":[]}],"deprecated":false}},"/refresh":{"post":{"tags":["Auth"],"summary":"Refreshes access token from refresh token.","operationId":"refreshAccessToken","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"body","description":"Refresh token needed to generate new Access Token","required":true,"schema":{"$ref":"#/definitions/RefreshToken"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AccessToken"}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}},"deprecated":false}}},"securityDefinitions":{"Bearer":{"type":"apiKey","name":"Authorization","in":"header"}},"definitions":{"ADDomainInfo":{"type":"object","required":["dns_name","id","netbios_name"],"properties":{"dns_name":{"type":"string","example":"example.com","description":"DNS name of the AD Domain."},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Unique ID representing AD Domain."},"netbios_name":{"type":"string","example":"AD-EXAMPLE1","description":"NetBIOS name of the AD Domain."}},"title":"ADDomainInfo","description":"Information related to AD Domains of the environment."},"ADDomainMonitorConnectionServer":{"type":"object","required":["id","name","status","trust_relationship"],"properties":{"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the connection server."},"name":{"type":"string","example":"cs1.example.com","description":"Connection server host name or IP address."},"status":{"type":"string","example":"FULLY_ACCESSIBLE","description":"Status of the connection to the domain.\n* UNCONTACTABLE: No domain controllers appear to be present on the network for this domain.\n* FULLY_ACCESSIBLE: The domain controller(s) are accepting bind operations.\n* CANNOT_BIND: The domain controller(s) are only accepting LDAP ping operations.\n* UNKNOWN: Cannot determine accessibility.","enum":["UNCONTACTABLE","FULLY_ACCESSIBLE","CANNOT_BIND","UNKNOWN"]},"trust_relationship":{"type":"string","example":"TWO_WAY","description":"The trust relationship for the domain.\n* PRIMARY_DOMAIN: The domain is the domain that the broker is present in.\n* FROM_BROKER: The domain is trusted by the domain that the broker is in.\n* TO_BROKER: The domain trusts the broker's domain (this is for completeness and generally will not be used).\n* TWO_WAY: The domain has a two way trust relationship with the broker's domain.\n* TWO_WAY_FOREST: The domain is in the same forest as the broker's domain, implies two way trust.\n* MANUAL: The domain was manually configured (the trust has not been detected).\n* UNKNOWN: The trust relationship could not be determined.","enum":["PRIMARY_DOMAIN","FROM_BROKER","TO_BROKER","TWO_WAY","TWO_WAY_FOREST","MANUAL","UNKNOWN"]}},"title":"ADDomainMonitorConnectionServer","description":"Information about the AD Domain connection from connection server."},"ADDomainMonitorInfo":{"type":"object","required":["dns_name","netbios_name","nt4_domain"],"properties":{"connection_servers":{"type":"array","description":"Information about the AD Domain connections from each of the connection servers.","items":{"$ref":"#/definitions/ADDomainMonitorConnectionServer"}},"dns_name":{"type":"string","example":"ad-example1.example.com","description":"The DNS name for the domain."},"netbios_name":{"type":"string","example":"AD-EXAMPLE1","description":"The NetBIOS name for the domain."},"nt4_domain":{"type":"boolean","example":true,"description":"If this is an NT4 domain or not."}},"title":"ADDomainMonitorInfo","description":"Monitoring information related to AD Domain."},"AccessToken":{"type":"object","required":["access_token"],"properties":{"access_token":{"type":"string","example":"","description":"Access Token to be used in API calls."}},"title":"AccessToken","description":"Access Token"},"AuthLogin":{"type":"object","required":["domain","password","username"],"properties":{"domain":{"type":"string","example":"AD-TEST-DOMAIN","description":"Domain"},"password":{"type":"array","example":"","description":"User password","items":{"type":"string"}},"username":{"type":"string","example":"Administrator","description":"User Name"}},"title":"AuthLogin","description":"Login Request"},"AuthTokens":{"type":"object","required":["access_token","refresh_token"],"properties":{"access_token":{"type":"string","example":"","description":"Access Token to be used in API calls."},"refresh_token":{"type":"string","example":"","description":"Refresh Token to be used to get a new Access token."}},"title":"AuthTokens","description":"Authentication Tokens"},"CertificateMonitorInfo":{"type":"object","required":["valid","valid_from","valid_to"],"properties":{"valid":{"type":"boolean","example":true,"description":"Indicates if the certificate is valid."},"valid_from":{"type":"integer","format":"int64","example":1561939200000,"description":"Start time of the certificate validity in milliseconds. Measured as epoch time."},"valid_to":{"type":"integer","format":"int64","example":1561939200000,"description":"Expiration time of the certificate validity in milliseconds. Measured as epoch time."}},"title":"CertificateMonitorInfo","description":"Monitoring data about server's certificate."},"CertificateOverrideData":{"type":"object","properties":{"certificate":{"type":"string","description":"Virtual Center certificate"},"type":{"type":"string","example":"PEM","description":"Type of Certificate.\n* PEM: PEM encoded certificate type","enum":["PEM"]}},"title":"CertificateOverrideData","description":"Certificate details and type information, which can be used to override thumbprint details."},"CertificateServerDetails":{"type":"object","required":["name","status"],"properties":{"name":{"type":"string","example":"SSOConnector","description":"Certificate Server name."},"status":{"type":"string","example":"OK","description":"Certificate Server status.\n* OK: The state of the certificate server is OK as reported by the enrollment servers.\n* WARN: At least one enrollment server reports a warning on this certificate server.\n* ERROR: At least one enrollment server reports an error on this certificate server.","enum":["OK","WARN","ERROR"]}},"title":"CertificateServerDetails"},"ConnectionServerMonitorCSReplication":{"type":"object","required":["server_name","status"],"properties":{"server_name":{"type":"string","example":"cs1.example.com","description":"Connection Server host name or IP address."},"status":{"type":"string","example":"OK","description":"LDAP replication status.\n* OK: The connection to the Connection Server is working properly.\n* ERROR: There is a problem with LDAP replication to the Connection Server.","enum":["OK","ERROR"]}},"title":"ConnectionServerMonitorCSReplication","description":"Replication status with respect to Peer Connection Servers in the same cluster."},"ConnectionServerMonitorDetails":{"type":"object","required":["build","version"],"properties":{"build":{"type":"string","example":"12345678.0.1","description":"Connection Server build number."},"version":{"type":"string","example":"7.9.0","description":"Connection Server version number."}},"title":"ConnectionServerMonitorDetails","description":"Details of the Connection Server."},"ConnectionServerMonitorInfo":{"type":"object","required":["certificate","details","id","name","status"],"properties":{"certificate":{"description":"Connection Server certificate information.","$ref":"#/definitions/CertificateMonitorInfo"},"connection_count":{"type":"integer","format":"int32","example":1234,"description":"Number of connections to this Connection Server."},"cs_replications":{"type":"array","description":"Connection Server replication status with respect to the Peer Connection Servers in the same cluster.","items":{"$ref":"#/definitions/ConnectionServerMonitorCSReplication"}},"default_certificate":{"type":"boolean","example":false,"description":"Indicates whether server has the default certificate."},"details":{"description":"Details about the Connection Server.","$ref":"#/definitions/ConnectionServerMonitorDetails"},"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the Connection Server."},"name":{"type":"string","example":"cs1.example.com","description":"Connection Server host name or IP address."},"services":{"type":"array","description":"Connection Server related Windows services information.","items":{"$ref":"#/definitions/ConnectionServerMonitorServiceStatus"}},"session_protocol_data":{"type":"array","description":"PCoIP, RDP or BLAST protocol sessions details when clients connect directly to the connection server.","items":{"$ref":"#/definitions/ConnectionServerSessionProtocolData"}},"session_threshold":{"type":"integer","format":"int32","example":2000,"description":"The maximum number of connections allowed for the connection server through the Horizon client. If all of the secure gateways (HTTP(S)/PCOIP/BLAST) are enabled, this field denotes the maximum number of connections allowed for the connection server.If none of the secure gateways(HTTP(S)/PCOIP/BLAST) are enabled, sessionThreshold value will not be set."},"status":{"type":"string","example":"OK","description":"Status of the Connection Server.\n* OK: The Connection Server is working properly.\n* ERROR: Error occurred when connecting to Connection Server.\n* NOT_RESPONDING: The Connection Server is not responding.\n* UNKNOWN: Status of Connection Server is unknown.","enum":["OK","ERROR","NOT_RESPONDING","UNKNOWN"]},"tunnel_connection_count":{"type":"integer","format":"int32","example":1234,"description":"Number of connections tunneled through this Connection Server."}},"title":"ConnectionServerMonitorInfo","description":"Monitoring information related to Connection Server."},"ConnectionServerMonitorServiceStatus":{"type":"object","required":["service_name","status"],"properties":{"service_name":{"type":"string","example":"BLAST_SECURE_GATEWAY","description":"Service name of the Connection Server.\n* PCOIP_SECURE_GATEWAY: PCoIP Secure Gateway service.\n* BLAST_SECURE_GATEWAY: BLAST Secure Gateway service.\n* SECURITY_GATEWAY_COMPONENT: Security Gateway Component service.","enum":["PCOIP_SECURE_GATEWAY","BLAST_SECURE_GATEWAY","SECURITY_GATEWAY_COMPONENT"]},"status":{"type":"string","example":"UP","description":"Status of the service.\n* UP: The Windows service is UP and running.\n* DOWN: The Windows service is not UP.","enum":["UP","DOWN"]}},"title":"ConnectionServerMonitorServiceStatus","description":"Status of Connection Server related Windows service."},"ConnectionServerSessionProtocolData":{"type":"object","required":["session_count","session_protocol"],"properties":{"session_count":{"type":"integer","format":"int32","example":341,"description":"Number of active sessions launched using the protocol."},"session_protocol":{"type":"string","example":"BLAST","description":"Protocol used in launching the sessions through gateway service.\n* PCOIP: The session display protocol is PCoIP.\n* RDP: The session display protocol is RDP.\n* BLAST: The session display protocol is BLAST.","enum":["PCOIP","RDP","BLAST"]}},"title":"ConnectionServerSessionProtocolData","description":"Details of sessions launched using given protocol with Connection Server's gateway services."},"EnrollmentServerDetails":{"type":"object","required":["dns_name","id","status"],"properties":{"dns_name":{"type":"string","example":"enrollment-server.example.com","description":"Enrollment server dns name."},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50","description":"Unique ID of the Enrollment Server."},"status":{"type":"string","example":"OK","description":"Enrollment server status.\n* OK: The state of enrollment server is OK.\n* ERROR: The enrollment server has an error.","enum":["OK","ERROR"]}},"title":"EnrollmentServerDetails"},"EventDatabaseMonitorDetails":{"type":"object","required":["database_name","port","prefix","server_name","type","user_name"],"properties":{"database_name":{"type":"string","example":"HorizonEventDB","description":"The name of the database."},"port":{"type":"integer","format":"int32","example":1433,"description":"The port of the database server."},"prefix":{"type":"string","example":"view_","description":"The prefix for event tables in the database."},"server_name":{"type":"string","example":"event-db.example.com","description":"The name or ip address of the database server."},"type":{"type":"string","example":"SQL_SERVER","description":"The type of the database.\n* ORACLE: An Oracle database.\n* SQL_SERVER: A SQL server database.","enum":["ORACLE","SQL_SERVER"]},"user_name":{"type":"string","example":"sa","description":"The username used to connect to the database."}},"title":"EventDatabaseMonitorDetails"},"EventDatabaseMonitorInfo":{"type":"object","properties":{"details":{"description":"The basic details of the event database","$ref":"#/definitions/EventDatabaseMonitorDetails"},"event_count":{"type":"integer","format":"int32","example":10000,"description":"Number of events recorded in the database"},"status":{"type":"string","example":"CONNECTED","description":"State of the database.\n* CONNECTED: Connection Server is connected to the database.\n* CONNECTING: Connection Server is connecting to the database.\n* DISCONNECTED: Connection Server is disconnected from the database.\n* RECONNECTING: Connection Server is reconnecting to the database.\n* ERROR: Error in connecting to the database from Connection Server.\n* NOT_CONFIGURED: Database is not configured.","enum":["CONNECTED","CONNECTING","DISCONNECTED","RECONNECTING","ERROR","NOT_CONFIGURED"]}},"title":"EventDatabaseMonitorInfo","description":"Event Database Monitor Information"},"FarmMonitorDetails":{"type":"object","required":["type"],"properties":{"source":{"type":"string","example":"LINKED_CLONE","description":"Source of farm machines.\nThis property is required if type is set to \"AUTOMATED\".\n* LINKED_CLONE: Linked clone share the same base image and use less storage space than full RDS Servers.\n* INSTANT_CLONE: Instant clone engine uses vmfork technology to create the instant clones. These clones take much less time for provisioning.","enum":["LINKED_CLONE","INSTANT_CLONE"]},"type":{"type":"string","example":"AUTOMATED","description":"Farm type.\n* AUTOMATED: Automated Farm.\n* MANUAL: Manual farm.","enum":["AUTOMATED","MANUAL"]}},"title":"FarmMonitorDetails","description":"Details of the Farm."},"FarmMonitorInfo":{"type":"object","required":["details","id","name","status"],"properties":{"application_count":{"type":"integer","format":"int32","example":12,"description":"Number of Applications published from the farm."},"details":{"description":"Details of Farm.","$ref":"#/definitions/FarmMonitorDetails"},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50","description":"Unique ID of the Farm."},"name":{"type":"string","example":"farm1","description":"Farm name."},"rds_server_count":{"type":"integer","format":"int32","example":123,"description":"Number of RDS Servers in the farm."},"status":{"type":"string","example":"OK","description":"Status of Farm.\n* OK: Farm is enabled and no servers are in WARNING or ERROR state. One or more server(s) may be DISABLED (including the case where all of them are DISABLED).\n* WARNING: Farm is enabled. One or more of the following is true:\n1) One or more server(s) is either in WARNING or ERROR (not exceeding the predefined threshold) state.\n2) The RDS Servers in this Farm present a mix of both known and unknown load preferences.\n* ERROR: Farm is enabled. One or more server(s) (exceeding the predefined threshold) is in ERROR state, or, for Automated Farms, there could be a provisioning error.\n* DISABLED: Farm is disabled.","enum":["OK","WARNING","ERROR","DISABLED"]}},"title":"FarmMonitorInfo","description":"Monitoring information related to Farm."},"GatewayMonitorDetails":{"type":"object","required":["address","internal","type","version"],"properties":{"address":{"type":"string","example":"uag1.example.com","description":"Gateway host name or IP address."},"internal":{"type":"boolean","example":false,"description":"Indicates if the Gateway is internal."},"type":{"type":"string","example":"UAG","description":"Type of the Gateway.\n* UAG: Unified Access Gateway type.\n* F5: F5 Gateway type.\n* UNKNOWN: Unknown type.","enum":["UAG","F5","UNKNOWN"]},"version":{"type":"string","example":"3.5.0","description":"Version of the Gateway."}},"title":"GatewayMonitorDetails","description":"Details of the Gateway."},"GatewayMonitorInfo":{"type":"object","required":["details","id","name","status"],"properties":{"active_connection_count":{"type":"integer","format":"int32","example":1234,"description":"Number of active connections for the gateway. Includes PCoIP and BLAST connection counts."},"blast_connection_count":{"type":"integer","format":"int32","example":10,"description":"Number of BLAST connections for the gateway."},"details":{"description":"Details of the gateway.","$ref":"#/definitions/GatewayMonitorDetails"},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Unique ID of the Gateway."},"name":{"type":"string","example":"uag1","description":"Gateway name."},"pcoip_connection_count":{"type":"integer","format":"int32","example":90,"description":"Number of PCoIP connections for the gateway."},"status":{"type":"string","example":"OK","description":"Status of the Gateway.\n* NOT_CONTACTED: There has been no contact from the gateway.\n* PROBLEM: The gateway has reported a problem.\n* STALE: Gateway is stale. Gateway will be marked as stale when Connection Server does not receive any request from the Gateway in last two successive intervals.\n* OK: The Gateway is working as expected.","enum":["NOT_CONTACTED","PROBLEM","STALE","OK"]}},"title":"GatewayMonitorInfo","description":"Monitoring information related to Gateways registered in the environment."},"HostOverrideData":{"type":"object","properties":{"cache_size_mb":{"type":"integer","format":"int32","example":2048,"description":"Size of the cache in megabytes. This property has a minimum value of 100. This property has a maximum value of 2048."},"path":{"type":"string","example":"/path/host","description":"The path of the host that supports View Storage Accelerator."}},"title":"HostOverrideData","description":"Details of the Hypervisor hosts involved in Content Based Read Caching (CBRC)"},"InstantCloneDomainAccountCreateSpec":{"type":"object","required":["ad_domain_id","password","username"],"properties":{"ad_domain_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"ID of the AD Domain that this account user belongs to."},"password":{"type":"array","example":"","description":"Password of the account.","items":{"type":"string"}},"username":{"type":"string","example":"testuser","description":"User name of the account."}},"title":"InstantCloneDomainAccountCreateSpec","description":"Specification of the instant clone domain account."},"InstantCloneDomainAccountInfo":{"type":"object","required":["ad_domain_id","id","username"],"properties":{"ad_domain_id":{"type":"string","example":"6f8543a5-a7a0-4ab8-b3e3-37164dd1ed53","description":"ID of the AD Domain that this account user belongs to."},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51","description":"Unique ID representing instant clone domain account."},"username":{"type":"string","example":"testuser","description":"User name of the account."}},"title":"InstantCloneDomainAccountInfo","description":"Information related to instant clone domain accounts of the environment."},"InstantCloneDomainAccountUpdateSpec":{"type":"object","required":["password"],"properties":{"password":{"type":"array","example":"","description":"Password of the account.","items":{"type":"string"}}},"title":"InstantCloneDomainAccountUpdateSpec","description":"Update specification for the instant clone domain account."},"PodEndPointData":{"type":"object","required":["enabled","id","name","status","url"],"properties":{"enabled":{"type":"boolean","example":true,"description":"Indicates whether an endpoint is enabled. A disabled endpoint will be excluded from participating inter-pod communication."},"id":{"type":"string","example":"c5337d77-2bf1-4fa4-b027-c301114f2d1e","description":"Unique ID for a pod endpoint."},"name":{"type":"string","example":"connection-server1.example.com","description":"Name for the pod endpoint."},"roundtrip_time":{"type":"integer","format":"int64","example":1234,"description":"Round trip time (in milliseconds) for ping request between the local pod endpoint and the remote pod."},"status":{"type":"string","example":"ONLINE","description":"Status of the pod endpoint.\n* ONLINE: Pod endpoint is online and functional.\n* UNCHECKED: Pod endpoint was offline and it just came back online but the system has not verified that it is functional.\n* OFFLINE: Pod endpoint is offline or unreachable.","enum":["ONLINE","UNCHECKED","OFFLINE"]},"url":{"type":"string","example":"https://connection-server1.example.com:8742","description":"The URL for the pod endpoint. This address and special port will be used for inter-pod communication."}},"title":"PodEndPointData"},"PodMonitorInfo":{"type":"object","required":["id","name","site_id"],"properties":{"endpoints":{"type":"array","description":"The list of pod endpoints within this pod. An endpoint is basically a connection server in that pod.","items":{"$ref":"#/definitions/PodEndPointData"}},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50","description":"Unique ID of the pod."},"name":{"type":"string","example":"Cluster-SITE1-POD1","description":"Display name for the pod."},"site_id":{"type":"string","example":"a5882e23-3bf4-1ba6-c128-e780004f2d1e","description":"The Id of the site this pod belongs to."}},"title":"PodMonitorInfo","description":"Monitoring information related to a pod."},"RDSServerMonitorDetails":{"type":"object","required":["agent_build","agent_version","operating_system","state"],"properties":{"agent_build":{"type":"string","example":4445678,"description":"Agent build number."},"agent_version":{"type":"string","example":"7.9.0","description":"Agent version."},"max_sessions_count_configured":{"type":"integer","format":"int32","example":123,"description":"Maximum number of sessions for RDS server as configured by administrator. Will be unset if the value is not configured."},"operating_system":{"type":"string","example":"WINDOWS_SERVER_2016","description":"Operating System version.\n* UNKNOWN: Unknown\n* WINDOWS_SERVER_2003: Windows Server 2003\n* WINDOWS_SERVER_2008: Windows Server 2008\n* WINDOWS_SERVER_2008_R2: Windows Server 2008 R2\n* WINDOWS_SERVER_2012: Windows Server 2012\n* WINDOWS_SERVER_2012_R2: Windows Server 2012 R2\n* WINDOWS_SERVER_2016: Windows Server 2016\n* LINUX_SERVER_OTHER: Linux Server (other)","enum":["UNKNOWN","WINDOWS_SERVER_2003","WINDOWS_SERVER_2008","WINDOWS_SERVER_2008_R2","WINDOWS_SERVER_2012","WINDOWS_SERVER_2012_R2","WINDOWS_SERVER_2016","LINUX_SERVER_OTHER"]},"state":{"type":"string","example":"AVAILABLE","description":"State of RDS Server.\n* WAIT_FOR_AGENT: Connection Server is waiting to establish communication with View Agent on a RDS Server.\n* AGENT_UNREACHABLE: Connection Server cannot establish communication with View Agent on a RDS Server.\n* AGENT_CONFIG_ERROR: The RDS Server has configuration error. Ex: Remote Desktop Service role is not enabled.\n* AVAILABLE: The RDS Server is powered on and ready for an active connection.\n* DISABLED: The RDS Server is disabled.\n* DISABLE_IN_PROGRESS: Disabled RDS server still has some brokered sessions. It can still accept re-connections.\n* PROVISIONING: The RDS Server is being provisioned.\n* PROVISIONING_ERROR: An error occurred during provisioning.\n* CUSTOMIZING: The RDS Server is being customized.\n* DELETING: The RDS Server is marked for deletion. It will be deleted soon.\n* MAINTENANCE: The RDS Server is in maintenance mode.\n* ERROR: An unknown error occurred in the RDS Server.\n* PROVISIONED: The RDS Server has been provisioned.\n* CONNECTED: The RDS Server is in an active session.\n* DISCONNECTED: The RDS Server is in an active session but is disconnected.\n* AGENT_ERR_STARTUP_IN_PROGRESS: The Horizon Agent has started on the virtual machine, but other required services such as the display protocol are still starting.\n* AGENT_ERR_DISABLED: The Horizon Agent is disabled.\n* AGENT_ERR_INVALID_IP: The Horizon Agent has an invalid IP.\n* AGENT_ERR_NEED_REBOOT: The Horizon Agent needs reboot.\n* AGENT_ERR_PROTOCOL_FAILURE: Protocol such as RDP or PCoIP is not enabled.\n* AGENT_ERR_DOMAIN_FAILURE: The RDS Server has an invalid domain.\n* AGENT_DRAIN_MODE: The RDS Server is configured for drain mode.\n* AGENT_DRAIN_UNTIL_RESTART: The RDS Server is configured a mode to drain until restart.\n* ALREADY_USED: The RDS Server cannot accept new sessions.\n* IN_PROGRESS: There is a RDS Server operation in progress.\n* VALIDATING: The connection server is synchronizing state information with the agent.\n* UNKNOWN: Could not determine the state of the RDS Server.","enum":["WAIT_FOR_AGENT","AGENT_UNREACHABLE","AGENT_CONFIG_ERROR","AVAILABLE","DISABLED","DISABLE_IN_PROGRESS","PROVISIONING","PROVISIONING_ERROR","CUSTOMIZING","DELETING","MAINTENANCE","ERROR","PROVISIONED","CONNECTED","DISCONNECTED","AGENT_ERR_STARTUP_IN_PROGRESS","AGENT_ERR_DISABLED","AGENT_ERR_INVALID_IP","AGENT_ERR_NEED_REBOOT","AGENT_ERR_PROTOCOL_FAILURE","AGENT_ERR_DOMAIN_FAILURE","AGENT_DRAIN_MODE","AGENT_DRAIN_UNTIL_RESTART","ALREADY_USED","IN_PROGRESS","VALIDATING","UNKNOWN"]}},"title":"RDSServerMonitorDetails","description":"Details of RDS Server."},"RDSServerMonitorInfo":{"type":"object","required":["details","enabled","farm_id","id","name","status"],"properties":{"details":{"description":"Server details of RDS Server.","$ref":"#/definitions/RDSServerMonitorDetails"},"enabled":{"type":"boolean","example":true,"description":"Indicates if RDS server is enabled."},"farm_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50","description":"Indicates the Farm ID to which the RDS Server belongs to."},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50","description":"Unique ID of the RDS server."},"load_index":{"type":"integer","format":"int32","example":60,"description":"This value is similar to load_preference and represents the load on RDS Server in the range of 0 to 100.","minimum":0,"maximum":100,"exclusiveMinimum":false,"exclusiveMaximum":false},"load_preference":{"type":"string","example":"NORMAL","description":"Based on the current load of this RDS Server, gives a measure of how preferential this server is to be chosen for new application sessions.\n* BLOCK: RDS Server is blocked and new sessions will not be accepted.\n* HEAVY: RDS Server is experiencing heavy load and should likely not be chosen for new sessions.\n* NORMAL: RDS Server is experiencing normal load and is okay to be chosen for new sessions.\n* LIGHT: RDS Server is experiencing light load and is okay to be chosen for new sessions.\n* UNKNOWN: RDS Server did not report a load preference. This is potentially a configuration issue if other RDS Servers in the same Farm do report load preferences.","enum":["BLOCK","HEAVY","NORMAL","LIGHT","UNKNOWN"]},"name":{"type":"string","example":"rds-server.example.com","description":"RDS Server name."},"session_count":{"type":"integer","format":"int32","example":35,"description":"RDS server session count."},"status":{"type":"string","example":"OK","description":"RDS server status.\n* OK: RDS Server is reachable. All applications (defined on its farm) are verified installed on the RDS Server.\n* WARNING: RDS Server is reachable. Some applications are detected as not installed on the RDS Server.\n* ERROR: RDS Server is unreachable, or, none of the applications are installed.\n* DISABLED: RDS Server is disabled.","enum":["OK","WARNING","ERROR","DISABLED"]}},"title":"RDSServerMonitorInfo","description":"RDS Server Monitor Information."},"RefreshToken":{"type":"object","required":["refresh_token"],"properties":{"refresh_token":{"type":"string","example":"","description":"Refresh Token to be used to get a new Access token."}},"title":"RefreshToken","description":"Refresh Token"},"SAMLAuthMonitorDetails":{"type":"object","required":["label","metadata_url"],"properties":{"administrator_url":{"type":"string","example":"https://vidm.example.com/saas/api/1.0/GET/admindata","description":"The administrator URL for the SAML authenticator."},"label":{"type":"string","example":"vidm.example.com","description":"The label of the SAML Authenticator."},"metadata_url":{"type":"string","example":"https://vidm.example.com/saas/api/1.0/GET/metadata/idp.xml","description":"The metadata URL of the SAML Authenticator."}},"title":"SAMLAuthMonitorDetails","description":"Details of the SAML authenticator."},"SAMLAuthenticatorMonitorConnectionServer":{"type":"object","required":["id","name","status","thumbprint_accepted"],"properties":{"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the Connection Server."},"name":{"type":"string","example":"cs1.example.com","description":"Connection server host name or IP address."},"status":{"type":"string","example":"OK","description":"Status of the SAML authenticator with respect to this Connection Server.\n* OK: The connection to SAML authenticator is working properly.\n* ERROR: Error occurred when connecting to SAML authenticator.\n* WARN: The connection to SAML authenticator has minor issues.\n* UNKNOWN: State of SAML authenticator is unknown.","enum":["OK","ERROR","WARN","UNKNOWN"]},"thumbprint_accepted":{"type":"boolean","example":false,"description":"Indicates if the thumbprint of the SAML authenticator was accepted."}},"title":"SAMLAuthenticatorMonitorConnectionServer","description":"Information about the SAML authenticator connection from a connection server."},"SAMLAuthenticatorMonitorInfo":{"type":"object","required":["connection_servers","details","id"],"properties":{"connection_servers":{"type":"array","description":"Information about the SAML authenticator connections from each of the connection servers.","items":{"$ref":"#/definitions/SAMLAuthenticatorMonitorConnectionServer"}},"details":{"description":"Details about the SAML authenticator.","$ref":"#/definitions/SAMLAuthMonitorDetails"},"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the SAML Authenticator."}},"title":"SAMLAuthenticatorMonitorInfo","description":"Monitoring information related to SAML Authenticator."},"StorageAcceleratorData":{"type":"object","required":["enabled"],"properties":{"default_cache_size_mb":{"type":"integer","format":"int32","example":1024,"description":"Default size of the cache in megabytes. This property has a default value of 1024. This property has a minimum value of 100. This property has a maximum value of 2048. "},"enabled":{"type":"boolean","example":false,"description":"Is View Storage Accelerator enabled? This property has a default value of false."},"host_overrides":{"type":"array","description":"Cache size overrides for hosts which support View Storage Accelerator.","items":{"$ref":"#/definitions/HostOverrideData"}}},"title":"StorageAcceleratorData","description":"Information about the Storage Accelerator Data"},"TrueSSOMonitorInfo":{"type":"object","required":["ad_domain_dns_name","ad_domain_id","ad_domain_status","certificate_server_details","enabled","id","name","primary_enrollment_server","status","template_name","template_status"],"properties":{"ad_domain_dns_name":{"type":"string","example":"ad-domain.example.com","description":"The DNS name of the domain."},"ad_domain_id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50","description":"Unique ID of the AD Domain."},"ad_domain_status":{"type":"string","example":"OK","description":"The state of the domain health, taken as the most severe reported by one of the enrollment servers.\n* OK: The state of the domain is OK as reported by the enrollment servers.\n* WARN: At least one of the enrollment servers has a warning.\n* ERROR: At least one of the enrollment servers is in an error state.","enum":["OK","WARN","ERROR"]},"certificate_server_details":{"type":"array","description":"Details of each certificate server.","items":{"$ref":"#/definitions/CertificateServerDetails"}},"enabled":{"type":"boolean","example":true,"description":"Indicates if the True SSO connector is enabled."},"id":{"type":"string","example":"6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50","description":"Unique ID of the True SSO Connector."},"name":{"type":"string","example":"true-sso.example.com","description":"True SSO connector name."},"primary_enrollment_server":{"description":"The primary enrollment server details.","$ref":"#/definitions/EnrollmentServerDetails"},"secondary_enrollment_server":{"description":"The secondary enrollment server details.","$ref":"#/definitions/EnrollmentServerDetails"},"status":{"type":"string","example":"OK","description":"Overall status of the True SSO connector.\n* OK: All the components of the True SSO connector are fine.\n* WARN: At least one component of the True SSO connector has a warning.\n* ERROR: At least one component of the True SSO connector has an error.","enum":["OK","WARN","ERROR"]},"template_name":{"type":"string","example":"TrueSSO Template","description":"Unique name for the True SSO template."},"template_status":{"type":"string","example":"OK","description":"The state of the template health, taken as the most severe reported by one of the enrollment servers.\n* OK: The state of the template is OK as reported by the enrollment servers.\n* WARN: At least one enrollment server reports a warning on this template.\n* ERROR: At least one enrollment server reports an error on this template.","enum":["OK","WARN","ERROR"]}},"title":"TrueSSOMonitorInfo","description":"Monitoring information related to the True SSO Connector."},"VCLimits":{"type":"object","required":["instant_clone_engine_provisioning_limit","power_operations_limit","provisioning_limit"],"properties":{"instant_clone_engine_provisioning_limit":{"type":"integer","format":"int32","example":20,"description":"Maximum concurrent instant clone engine provisioning operations. This property has a default value of 20. This property has a minimum value of 1."},"power_operations_limit":{"type":"integer","format":"int32","example":50,"description":"Maximum concurrent virtual center power operations. This property has a default value of 50. This property has a minimum value of 1."},"provisioning_limit":{"type":"integer","format":"int32","example":20,"description":"Maximum concurrent virtual center provisioning operations. This property has a default value of 20. This property has a minimum value of 1."}},"title":"VCLimits","description":"Information about the limits configured for Virtual Center"},"VCMonitorConnectionServer":{"type":"object","required":["id","name","status","thumbprint_accepted"],"properties":{"certificate":{"description":"The certificate data.","$ref":"#/definitions/CertificateMonitorInfo"},"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the Connection Server."},"name":{"type":"string","example":"cs1.example.com","description":"Connection server host name or IP address."},"status":{"type":"string","example":"OK","description":"Status of the Virtual Center Connection with respect to this Connection Server.\n* OK: The connection to Virtual Center server is working properly.\n* DOWN: The connection to Virtual Center server is down.\n* RECONNECTING: The connection to Virtual Center server was lost and is being reconnected to.\n* UNKNOWN: Connection state to Virtual Center server is unknown.\n* INVALID_CREDENTIALS: The supplied credentials cannot be used to authenticate to the Virtual Center server.\n* CANNOT_LOGIN: The connection server cannot login to the Virtual Center server.\n* NOT_YET_CONNECTED: Connection server has not yet connected to Virtual Center server.","enum":["OK","DOWN","RECONNECTING","UNKNOWN","INVALID_CREDENTIALS","CANNOT_LOGIN","NOT_YET_CONNECTED"]},"thumbprint_accepted":{"type":"boolean","example":true,"description":"Indicates if the thumbprints of the Virtual Center was accepted."}},"title":"VCMonitorConnectionServer","description":"Information about the Virtual Center connection from connection server."},"VCMonitorDatastore":{"type":"object","required":["capacity_mb","details","free_space_mb","status","type"],"properties":{"capacity_mb":{"type":"integer","format":"int32","example":12345,"description":"The capacity of the datastore in megabytes."},"details":{"description":"Details about the datastore.","$ref":"#/definitions/VCMonitorDatastoreDetails"},"free_space_mb":{"type":"integer","format":"int32","example":12345,"description":"The free space on the datastore in megabytes."},"status":{"type":"string","example":"ACCESSIBLE","description":"Status of the datastore.\n* ACCESSIBLE: The datastore is accessible.\n* NOT_ACCESSIBLE: The datastore is not accessible.","enum":["ACCESSIBLE","NOT_ACCESSIBLE"]},"type":{"type":"string","example":"VSAN","description":"Type of the datastore.\n* VMFS: VMFS datastore.\n* VSAN: VSAN datastore.","enum":["VMFS","VSAN"]}},"title":"VCMonitorDatastore","description":"Information about the datastore of the host(s) connected to the given Virtual Center."},"VCMonitorDatastoreDetails":{"type":"object","required":["name","path","url"],"properties":{"name":{"type":"string","example":"vsandatastore","description":"Datastore name."},"path":{"type":"string","example":"/datacenter1/vsandatastore","description":"Path to the datastore."},"url":{"type":"string","example":"ds:///vmfs/volumes/vsan:52654c2aa8e79416-8ea7a3309e82c7b7/","description":"Unique locator for datastore."}},"title":"VCMonitorDatastoreDetails","description":"Details about the datastore."},"VCMonitorDetails":{"type":"object","required":["api_version","build","version"],"properties":{"api_version":{"type":"string","example":6.5,"description":"API Version of the Virtual Center."},"build":{"type":"string","example":"12345678.0.1","description":"Build number of the Virtual Center."},"version":{"type":"string","example":"6.5.0","description":"Version of the Virtual Center."}},"title":"VCMonitorDetails","description":"Details about the Virtual Center."},"VCMonitorHost":{"type":"object","required":["details","status"],"properties":{"cpu_core_count":{"type":"integer","format":"int32","example":16,"description":"Number of physical CPU cores on the host."},"cpu_mhz":{"type":"integer","format":"int32","example":2194,"description":"CPU speed per core in Mhz. This might be an averaged value if the speed is not uniform across all cores."},"details":{"description":"Details of the ESX Host.","$ref":"#/definitions/VCMonitorHostDetails"},"memory_size_mb":{"type":"integer","format":"int32","example":12345,"description":"The physical memory size in mega bytes."},"status":{"type":"string","example":"CONNECTED","description":"Status of the host connection.\n* CONNECTED: The host is successfully connected to Virtual Center server.\n* DISCONNECTED: The host is disconnected from Virtual Center server.\n* NOT_RESPONDING: The host is not responding.","enum":["CONNECTED","DISCONNECTED","NOT_RESPONDING"]}},"title":"VCMonitorHost","description":"Information about the host connected to a Virtual Center."},"VCMonitorHostDetails":{"type":"object","required":["api_version","cluster_name","name","version"],"properties":{"api_version":{"type":"string","example":6.5,"description":"API Version of the ESX Host."},"cluster_name":{"type":"string","example":"cluster-1","description":"Name of the cluster of the ESX Host in the Virtual Center."},"name":{"type":"string","example":"host1.example.com","description":"ESX Host name or IP address."},"version":{"type":"string","example":"6.5.0","description":"ESX Host version."},"vgpu_types":{"type":"array","description":"Types of vGPUs supported by this host.","items":{"type":"string"}}},"title":"VCMonitorHostDetails","description":"Details of the ESX host of the Virtual Center."},"ViewComposerMonitorConnectionServer":{"type":"object","required":["id","name","status","thumbprint_accepted"],"properties":{"certificate":{"description":"Information related to certificate.","$ref":"#/definitions/CertificateMonitorInfo"},"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the Connection Server."},"name":{"type":"string","example":"cs1.example.com","description":"Connection server host name or IP address."},"status":{"type":"string","example":"OK","description":"Status of the View Composer with respect to this Connection Server.\n* OK: The connection to View Composer server is working properly.\n* MALFORMED_URL: The connection to View Composer server was not possible due to a malformed URL.\n* ERROR: Error occurred when connecting to View Composer server.\n* CERT_ERROR: Certificate validation error when connecting to the View Composer server.","enum":["OK","MALFORMED_URL","ERROR","CERT_ERROR"]},"thumbprint_accepted":{"type":"boolean","example":false,"description":"Indicates if the thumbprint of the View Composer was accepted."}},"title":"ViewComposerMonitorConnectionServer","description":"Information about the View Composer connection from connection server."},"ViewComposerMonitorDetails":{"type":"object","required":["api_verion","build","min_esx_version","min_vc_version","referenced_vcs","version"],"properties":{"api_verion":{"type":"string","example":3.5,"description":"The version of the View Composer API used to communicate with the View Composer server."},"build":{"type":"string","example":1234567,"description":"The build of the View Composer server."},"min_esx_version":{"type":"string","example":5.5,"description":"The minimum ESX version required for compatibility with this View Composer server."},"min_vc_version":{"type":"string","example":5.5,"description":"The minimum Virtual Center version required for compatibility with this View Composer server."},"referenced_vcs":{"type":"array","description":"The Virtual Center servers referencing to this View Composer.","items":{"type":"string"}},"version":{"type":"string","example":"7.9.0.12345","description":"The version of the View Composer server."}},"title":"ViewComposerMonitorDetails","description":"Details of the View Composer."},"ViewComposerMonitorInfo":{"type":"object","required":["connection_servers","details","name","port"],"properties":{"connection_servers":{"type":"array","description":"Information about the View Composer connections from each of the connection servers.","items":{"$ref":"#/definitions/ViewComposerMonitorConnectionServer"}},"details":{"description":"Details about the View Composer.","$ref":"#/definitions/ViewComposerMonitorDetails"},"name":{"type":"string","example":"composer1.example.com","description":"View Composer server host name or IP address."},"port":{"type":"integer","format":"int32","example":18443,"description":"View Composer server port number.","minimum":0,"maximum":65535,"exclusiveMinimum":false,"exclusiveMaximum":false}},"title":"ViewComposerMonitorInfo","description":"Monitoring information related to View Composer."},"VirtualCenterInfo":{"type":"object","required":["enabled","id","limits","port","se_sparse_reclamation_enabled","server_name","storage_accelerator_data","use_ssl","user_name","version"],"properties":{"certificate_override":{"description":"Virtual center certificate thumbprint should the client choose to override an invalid certificate.","$ref":"#/definitions/CertificateOverrideData"},"description":{"type":"string","example":"Virtual Center Server","description":"Human readable description of the Virtual Center instance."},"display_name":{"type":"string","example":"vc1.example.com","description":"Human readable name of the Virtual Center instance."},"enabled":{"type":"boolean","example":true,"description":"Indicates if the virtual center is enabled."},"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the Virtual Center."},"instance_uuid":{"type":"string","example":"6605d116-d1b5-4810-8e3a-b710b30993da","description":"Virtual center's instanceUuid."},"limits":{"description":"Virtual center's limits for the number of concurrent operations.","$ref":"#/definitions/VCLimits"},"port":{"type":"integer","format":"int32","example":443,"description":"Port of the virtual center to connect to."},"se_sparse_reclamation_enabled":{"type":"boolean","example":true,"description":"Indicates if Storage Efficiency Sparse (seSparse) reclamation is enabled."},"server_name":{"type":"string","example":"vc1.example.com","description":"Virtual Center's server name or IP address."},"storage_accelerator_data":{"description":"Storage Accelerator configuration details.","$ref":"#/definitions/StorageAcceleratorData"},"use_ssl":{"type":"boolean","example":true,"description":"Indicates if SSL should be used when connecting to the server."},"user_name":{"type":"string","example":"administrator@vsphere.local","description":"User name to use for the connection."},"version":{"type":"string","example":"6.5.0","description":"Version of the Virtual Center."},"vmc_deployment":{"type":"boolean","example":false,"description":"Indicates if virtual center is deployed in VMC."}},"title":"VirtualCenterInfo","description":"Information related to Virtual Center."},"VirtualCenterMonitorInfo":{"type":"object","required":["connection_servers","datastores","details","hosts","id","name"],"properties":{"connection_servers":{"type":"array","description":"Information about the Virtual Center connections from each of the connection servers.","items":{"$ref":"#/definitions/VCMonitorConnectionServer"}},"datastores":{"type":"array","description":"Information about the datastores of the Virtual Center.","items":{"$ref":"#/definitions/VCMonitorDatastore"}},"details":{"description":"Details about the Virtual Center.","$ref":"#/definitions/VCMonitorDetails"},"hosts":{"type":"array","description":"Information about the ESX hosts added in the Virtual Center.","items":{"$ref":"#/definitions/VCMonitorHost"}},"id":{"type":"string","example":"d0325b13-2bf1-4fa4-b027-e780004f2d1e","description":"Unique ID of the Virtual Center."},"name":{"type":"string","example":"vc1.example.com","description":"Virtual Center server name or IP address."}},"title":"VirtualCenterMonitorInfo","description":"Monitoring information related to a Virtual Center"}}}