Skip to content

umich-vci/gohorizon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Go API client for gohorizon

Welcome to the Horizon Server API Reference documentation. This API reference provides comprehensive information about status of all Horizon Server components and resources.
Choose Latest spec from dropdown to view API reference on latest version available.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 2111
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sw "./gohorizon"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost/rest

Class Method HTTP request Description
AuthApi LoginUser Post /login Logs in a user. Returns access token and refresh token.
AuthApi LogoutUser Post /logout Logs out a user.
AuthApi RefreshAccessToken Post /refresh Refreshes access token from refresh token.
ConfigApi CreateFederationAccessGroup Post /config/v1/federation-access-groups Creates federation access group.
ConfigApi CreateICDomainAccount Post /config/v1/ic-domain-accounts Creates instant clone domain account.
ConfigApi CreateIMAsset Post /config/v1/im-assets Creates image management asset.
ConfigApi CreateIMAssets Post /config/v1/im-assets/action/bulk-create Creates one or more image management assets. Each of the index of result in the response, correspond to the index of the original asset.
ConfigApi CreateIMStream Post /config/v1/im-streams Creates image management stream.
ConfigApi CreateIMStreams Post /config/v1/im-streams/action/bulk-create Creates one or more image management streams. Each of the index of result in the response, correspond to the index of the original stream.
ConfigApi CreateIMTag Post /config/v1/im-tags Creates image management tag.
ConfigApi CreateIMTags Post /config/v1/im-tags/action/bulk-create Creates one or more image management tags. Each of the index of result in the response, correspond to the index of the original tag.
ConfigApi CreateIMVersion Post /config/v1/im-versions Creates image management version.
ConfigApi CreateIMVersions Post /config/v1/im-versions/action/bulk-create Creates one or more image management versions. Each of the index of result in the response, correspond to the index of the original version.
ConfigApi DeleteFederationAccessGroup Delete /config/v1/federation-access-groups/{id} Deletes a federation access group.
ConfigApi DeleteICDomainAccount Delete /config/v1/ic-domain-accounts/{id} Deletes instant clone domain account.
ConfigApi DeleteIMAsset Delete /config/v1/im-assets/{id} Deletes image management asset.
ConfigApi DeleteIMStream Delete /config/v1/im-streams/{id} Deletes image management stream.
ConfigApi DeleteIMTag Delete /config/v1/im-tags/{id} Deletes image management tag.
ConfigApi DeleteIMVersion Delete /config/v1/im-versions/{id} Deletes image management version.
ConfigApi GetEnvironment Get /config/v1/environment-properties Retrieves the environment settings.
ConfigApi GetEnvironmentV2 Get /config/v2/environment-properties Retrieves the environment settings.
ConfigApi GetFeatureSettings Get /config/v1/settings/feature Retrieves the feature settings.
ConfigApi GetFederationAccessGroup Get /config/v1/federation-access-groups/{id} Retrieves a federation access group.
ConfigApi GetGeneralSettings Get /config/v1/settings/general Retrieves the general settings.
ConfigApi GetICDomainAccount Get /config/v1/ic-domain-accounts/{id} Gets instant clone domain account.
ConfigApi GetIMAsset Get /config/v1/im-assets/{id} Gets image management asset.
ConfigApi GetIMStream Get /config/v1/im-streams/{id} Gets image management stream.
ConfigApi GetIMTag Get /config/v1/im-tags/{id} Gets image management tag.
ConfigApi GetIMVersion Get /config/v1/im-versions/{id} Gets image management version.
ConfigApi GetLocalAccessGroup Get /config/v1/local-access-groups/{id} Retrieves a local access group.
ConfigApi GetSecuritySettings Get /config/v1/settings/security Retrieves the security settings.
ConfigApi GetSettings Get /config/v1/settings Retrieves the configuration settings.
ConfigApi ListFederationAccessGroups Get /config/v1/federation-access-groups Lists all federation access groups.
ConfigApi ListICDomainAccounts Get /config/v1/ic-domain-accounts Lists instant clone domain accounts of the environment.
ConfigApi ListIMAssets Get /config/v1/im-assets Lists image management assets.
ConfigApi ListIMStreams Get /config/v1/im-streams Lists image management streams.
ConfigApi ListIMTags Get /config/v1/im-tags Lists image management tags.
ConfigApi ListIMVersions Get /config/v1/im-versions Lists image management versions.
ConfigApi ListLocalAccessGroups Get /config/v1/local-access-groups Lists all local access groups.
ConfigApi ListRCXServers Get /config/v1/rcx/servers Lists RCX servers of the cluster.
ConfigApi ListVCInfo Get /config/v1/virtual-centers Lists Virtual Centers configured in the environment.
ConfigApi ListVCInfoV2 Get /config/v2/virtual-centers Lists Virtual Centers configured in the environment.
ConfigApi RegisterRCXClient Post /config/v1/rcx/clients Registers the RCX client
ConfigApi UnregisterRCXClient Delete /config/v1/rcx/clients/{id} Unregisters the given RCX Client
ConfigApi UpdateFeatureSettings Put /config/v1/settings/feature Updates the feature settings.
ConfigApi UpdateGeneralSettings Put /config/v1/settings/general Updates the general settings.
ConfigApi UpdateICDomainAccount Put /config/v1/ic-domain-accounts/{id} Updates instant clone domain account.
ConfigApi UpdateIMAsset Put /config/v1/im-assets/{id} Updates image management asset.
ConfigApi UpdateIMStream Put /config/v1/im-streams/{id} Updates image management stream.
ConfigApi UpdateIMTag Put /config/v1/im-tags/{id} Updates image management tag.
ConfigApi UpdateIMVersion Put /config/v1/im-versions/{id} Updates image management version.
ConfigApi UpdateRCXClient Put /config/v1/rcx/clients/{id} Updates the given RCX client.
ConfigApi UpdateSecuritySettings Put /config/v1/settings/security Updates the security settings.
ConfigApi UpdateSettings Put /config/v1/settings Updates the configuration settings.
EntitlementsApi BulkCreateApplicationPoolEntitlements Post /entitlements/v1/application-pools Create the bulk entitlements for a set of application pools
EntitlementsApi BulkCreateDesktopPoolEntitlements Post /entitlements/v1/desktop-pools Create the bulk entitlements for a set of desktop pools
EntitlementsApi BulkCreateGAEEntitlements Post /entitlements/v1/global-application-entitlements Create the bulk entitlements for a set of Global Application Entitlements
EntitlementsApi BulkCreateGDEEntitlements Post /entitlements/v1/global-desktop-entitlements Create the bulk entitlements for a set of Global Desktop Entitlements
EntitlementsApi BulkDeleteApplicationPoolEntitlements Delete /entitlements/v1/application-pools Delete the bulk entitlements for a set of application pools
EntitlementsApi BulkDeleteDesktopPoolEntitlements Delete /entitlements/v1/desktop-pools Delete the bulk entitlements for a set of desktop pools
EntitlementsApi BulkDeleteGAEEntitlements Delete /entitlements/v1/global-application-entitlements Delete the bulk entitlements for a set of Global Application Entitlements
EntitlementsApi BulkDeleteGDEEntitlements Delete /entitlements/v1/global-desktop-entitlements Delete the bulk entitlements for a set of Global Desktop Entitlements
EntitlementsApi GetApplicationPoolEntitlements Get /entitlements/v1/application-pools/{id} Returns the IDs of users or groups entitled to a given application pool.
EntitlementsApi GetDesktopPoolEntitlements Get /entitlements/v1/desktop-pools/{id} Returns the IDs of users or groups entitled to a given desktop pool.
EntitlementsApi GetGAEEntitlement Get /entitlements/v1/global-application-entitlements/{id} Gets the user or group entitlements for a Global Application Entitlement.
EntitlementsApi GetGDEEntitlement Get /entitlements/v1/global-desktop-entitlements/{id} Gets the user or group entitlements for a Global Desktop Entitlement.
EntitlementsApi ListApplicationPoolEntitlements Get /entitlements/v1/application-pools Lists the entitlements for Application Pools in the environment.
EntitlementsApi ListDesktopPoolEntitlements Get /entitlements/v1/desktop-pools Lists the entitlements for Desktop Pools in the environment.
EntitlementsApi ListGAEEntitlements Get /entitlements/v1/global-application-entitlements Lists the user or group entitlements for Global Application Entitlements in the environment.
EntitlementsApi ListGDEEntitlements Get /entitlements/v1/global-desktop-entitlements Lists the user or group entitlements for Global Desktop Entitlements in the environment.
ExternalApi AddAuxiliaryAccounts Post /external/v1/ad-domains/{id}/action/add-auxiliary-accounts Add auxiliary accounts to the untrusted domain
ExternalApi AuditEventsExtendedAttributes Get /external/v1/audit-events/extended-attributes Get extended attributes of audit events
ExternalApi Bind Post /external/v1/ad-domains/action/bind Bind untrusted domain to the connection server.
ExternalApi ChangeUserPassword Post /external/v1/ad-users-or-groups/action/change-user-password Changes the password of AD User
ExternalApi ComputeSpaceRequirements Post /external/v1/datastores/action/compute-requirements Computes the datastore space requirements for inventory resources.
ExternalApi DeleteAuxiliaryAccounts Post /external/v1/ad-domains/{id}/action/delete-auxiliary-accounts Specification to delete auxiliary accounts from the untrusted domain
ExternalApi GetADUserOrGroupInfo Get /external/v1/ad-users-or-groups/{id} Get information related to AD User or Group
ExternalApi ListADDomains Get /external/v1/ad-domains Lists information related to AD Domains of the environment.
ExternalApi ListADDomainsV2 Get /external/v2/ad-domains Lists information related to AD Domains of the environment.
ExternalApi ListADDomainsV3 Get /external/v3/ad-domains Lists information related to AD Domains of the environment.
ExternalApi ListADUserOrGroupSummary Get /external/v1/ad-users-or-groups Lists AD users or groups information.
ExternalApi ListAuditEvents Get /external/v1/audit-events Lists the audit events.
ExternalApi ListBaseSnapshots Get /external/v1/base-snapshots Lists all the VM snapshots from the vCenter for a given VM.
ExternalApi ListBaseVMs Get /external/v1/base-vms Lists all the VMs from a vCenter or a datacenter in that vCenter which may be suitable as snapshots for instant clone desktop pool or farm creation.
ExternalApi ListCustomizationSpecs Get /external/v1/customization-specifications Lists all the customization specifications from the vCenter.
ExternalApi ListDatacenters Get /external/v1/datacenters Lists all the datacenters of a vCenter.
ExternalApi ListDatastoreClusters Get /external/v1/datastore-clusters Lists all the datastore clusters from the vCenter for the given host or cluster.
ExternalApi ListDatastorePaths Get /external/v1/datastore-paths Lists all the folder paths within a Datastore from vCenter.
ExternalApi ListHostsOrClusters Get /external/v1/hosts-or-clusters Lists all the hosts or clusters of the datacenter.
ExternalApi ListNetworkInterfaceCards Get /external/v1/network-interface-cards Returns a list of network interface cards (NICs) suitable for configuration on a desktop pool/farm.
ExternalApi ListNetworkLabels Get /external/v1/network-labels Retrieves all network labels on the given host or cluster
ExternalApi ListResourcePools Get /external/v1/resource-pools Lists all the resource pools from the vCenter for the given host or cluster.
ExternalApi ListVMFolders Get /external/v1/vm-folders Lists all the VM folders from the vCenter for the given datacenter.
ExternalApi ListVMTemplates Get /external/v1/vm-templates Lists all the VM templates from a vCenter or a datacenter for the given vCenter which may be suitable for full clone desktop pool creation.
ExternalApi ListVirtualMachines Get /external/v1/virtual-machines Lists all the VMs from a vCenter.
ExternalApi Listdatastores Get /external/v1/datastores Lists all the datastores from the vCenter for the given host or cluster.
ExternalApi Unbind Post /external/v1/ad-domains/{id}/action/unbind Unbind untrusted domain from the connection server.
ExternalApi Update Post /external/v1/ad-domains/{id}/action/update Updates untrusted domain.
ExternalApi UpdateAuxiliaryAccounts Post /external/v1/ad-domains/action/update-auxiliary-accounts Update auxiliary accounts of the untrusted domain
ExternalApi ValidateADUserEncryptedCredentials Post /external/v1/ad-users-or-groups/action/validate-user-encrypted-credentials Validates the encrypted credentials of AD User
FederationApi CreateHomeSites Post /federation/v1/home-sites Creates the given home sites in the pod federation.
FederationApi CreateSite Post /federation/v1/sites Creates a site.
FederationApi DeleteHomeSites Delete /federation/v1/home-sites Deletes the given home sites from the pod federation.
FederationApi DeleteSite Delete /federation/v1/sites/{id} Deletes a site.
FederationApi EjectPod Post /federation/v1/cpa/action/eject Removes a pod from Cloud Pod Federation.
FederationApi GetHomeSite Get /federation/v1/home-sites/{id} Retrieves a given home site in the pod federation.
FederationApi GetPod Get /federation/v1/pods/{id} Retrieves a given pod from the pod federation.
FederationApi GetPodAssignment Get /federation/v1/pod-assignments/{id} Retrieves a given pod assignment from the pod federation.
FederationApi GetPodEndpoint Get /federation/v1/pods/{id}/endpoints/{endpointId} Retrieves pod endpoint details for the given pod endpoint id in the given pod.
FederationApi GetPodFederation Get /federation/v1/cpa Retrieves the pod federation details.
FederationApi GetSite Get /federation/v1/sites/{id} Retrives a given site.
FederationApi GetTask Get /federation/v1/cpa/tasks/{id} Retrieves the information for a given task.
FederationApi InitializeCPA Post /federation/v1/cpa/action/initialize Initialize Cloud Pod Federation.
FederationApi JoinCPA Post /federation/v1/cpa/action/join Join Cloud Pod Federation.
FederationApi ListHomeSites Get /federation/v1/home-sites Lists all the home sites in the pod federation.
FederationApi ListPodAssignments Get /federation/v1/pod-assignments Lists all the pod assignments in the pod federation.
FederationApi ListPodEndpoint Get /federation/v1/pods/{id}/endpoints Lists all the pod endpoints for the given pod.
FederationApi ListPods Get /federation/v1/pods Lists all the pods in the pod federation.
FederationApi ListSites Get /federation/v1/sites Lists all the sites in the pod federation.
FederationApi ListTasks Get /federation/v1/cpa/tasks Lists all the CPA tasks in the pod federation.
FederationApi ResolveHomeSites Post /federation/v1/home-sites/action/resolve Resolves home sites for a user in the pod federation.
FederationApi UninitializeCPA Post /federation/v1/cpa/action/uninitialize Uninitialize Cloud Pod Federation.
FederationApi UnjoinCPA Post /federation/v1/cpa/action/unjoin Unjoin from Cloud Pod Federation.
FederationApi UpdatePod Put /federation/v1/pods/{id} Updates the given pod in the pod federation.
FederationApi UpdatePodFederation Put /federation/v1/cpa Updates a Pod Federation.
FederationApi UpdateSite Put /federation/v1/sites/{id} Updates a site.
InventoryApi AddCustomIcon Post /inventory/v1/application-pools/{id}/action/add-custom-icon Associates a custom icon to the application pool.
InventoryApi AddLocalApplicationPoolsToGAE Post /inventory/v1/global-application-entitlements/{id}/local-application-pools Adds Local Application Pools to Global Application Entitlement.
InventoryApi AddLocalDesktopPoolsToGDE Post /inventory/v1/global-desktop-entitlements/{id}/local-desktop-pools Adds Local Desktop Pools to Global Desktop Entitlement.
InventoryApi AddMachines Post /inventory/v1/desktop-pools/{id}/action/add-machines Adds machines to the given manual desktop pool.
InventoryApi AddMachinesByName Post /inventory/v1/desktop-pools/{id}/action/add-machines-by-name Adds the named machines to the given desktop pool.
InventoryApi AddRdsServers Post /inventory/v1/farms/{id}/action/add-rds-servers Add RDS servers to the specified manual farm.
InventoryApi AssignMachineAliases Post /inventory/v1/machines/{id}/action/assign-aliases Assigns the specified aliases to the assigned users of the machine.
InventoryApi AssignUsers Post /inventory/v1/machines/{id}/action/assign-users Assigns the specified users to the machine.
InventoryApi CancelDesktopPoolTask Post /inventory/v1/desktop-pools/{id}/tasks/{taskId}/action/cancel Cancels the instant clone desktop pool push image task.
InventoryApi CancelScheduledMaintenance Post /inventory/v1/farms/{id}/action/cancel-scheduled-maintenance Requests cancellation of the current scheduled maintenance on the specified Instant Clone farm.
InventoryApi CancelScheduledPushImage Post /inventory/v1/desktop-pools/{id}/action/cancel-scheduled-push-image Request the cancellation of the current scheduled push image operation on the specified instant clone desktop pool.
InventoryApi CheckApplicationPoolNameAvailability Post /inventory/v1/application-pools/action/check-name-availability Checks if the given name is available for application pool creation.
InventoryApi CheckDesktopPoolNameAvailability Post /inventory/v1/desktop-pools/action/check-name-availability Checks if the given name is available for desktop pool creation.
InventoryApi CheckFarmNameAvailability Post /inventory/v1/farms/action/check-name-availability Checks if the given name is available for farm creation.
InventoryApi CheckMachinePrefixAvailability Post /inventory/v1/machines/action/check-name-availability Checks if the given prefix is available for machine creation.
InventoryApi CheckRDSServerPrefixAvailability Post /inventory/v1/rds-servers/action/check-name-availability Checks if the given prefix is available for RDS Server creation.
InventoryApi CreateApplicationIcon Post /inventory/v1/application-icons Creates an application icon.
InventoryApi CreateApplicationPool Post /inventory/v1/application-pools Creates an application pool.
InventoryApi CreateApplicationPoolV2 Post /inventory/v2/application-pools Creates an application pool.
InventoryApi CreateDesktopPool Post /inventory/v1/desktop-pools Creates a desktop pool.
InventoryApi CreateFarm Post /inventory/v1/farms Creates a farm.
InventoryApi CreateFarmV2 Post /inventory/v2/farms Creates a farm.
InventoryApi CreateGlobalApplicationEntitlement Post /inventory/v1/global-application-entitlements Creates a Global Application Entitlement.
InventoryApi CreateGlobalDesktopEntitlement Post /inventory/v1/global-desktop-entitlements Creates a Global Desktop Entitlement.
InventoryApi CreateGlobalDesktopEntitlementV2 Post /inventory/v2/global-desktop-entitlements Creates a Global Desktop Entitlement.
InventoryApi DeleteApplicationPool Delete /inventory/v1/application-pools/{id} Deletes application pool.
InventoryApi DeleteDesktopPool Delete /inventory/v1/desktop-pools/{id} Deletes a desktop pool.
InventoryApi DeleteFarm Delete /inventory/v1/farms/{id} Deletes a farm.
InventoryApi DeleteGlobalApplicationEntitlement Delete /inventory/v1/global-application-entitlements/{id} Deletes a Global Application Entitlement.
InventoryApi DeleteGlobalDesktopEntitlement Delete /inventory/v1/global-desktop-entitlements/{id} Deletes a Global Desktop Entitlement.
InventoryApi DeleteMachine Delete /inventory/v1/machines/{id} Deletes the machine.
InventoryApi DeleteMachines Delete /inventory/v1/machines Deletes the specified machines.
InventoryApi DeletePhysicalMachine Delete /inventory/v1/physical-machines/{id} Deletes the Physical Machine.
InventoryApi DeleteRDSServer Delete /inventory/v1/rds-servers/{id} Deletes the RDS Server.
InventoryApi DisconnectGlobalSessions Post /inventory/v1/global-sessions/action/disconnect Disconnects global sessions in the environment.
InventoryApi DisconnectSessions Post /inventory/v1/sessions/action/disconnect Disconnects locally resourced user sessions.
InventoryApi EnterMaintenance Post /inventory/v1/machines/action/enter-maintenance Puts the machines into maintenance mode.
InventoryApi ExitMaintenance Post /inventory/v1/machines/action/exit-maintenance Puts the machines out of maintenance mode.
InventoryApi GetApplicationIcon Get /inventory/v1/application-icons/{id} Gets application icon.
InventoryApi GetApplicationPool Get /inventory/v1/application-pools/{id} Gets application pool.
InventoryApi GetApplicationPoolV2 Get /inventory/v2/application-pools/{id} Gets application pool.
InventoryApi GetApplicationPoolV3 Get /inventory/v3/application-pools/{id} Gets application pool.
InventoryApi GetDesktopPool Get /inventory/v1/desktop-pools/{id} Gets the Desktop Pool information.
InventoryApi GetDesktopPoolTask Get /inventory/v1/desktop-pools/{id}/tasks/{taskId} Gets the task information on the desktop pool.
InventoryApi GetDesktopPoolV2 Get /inventory/v2/desktop-pools/{id} Gets the desktop pool information.
InventoryApi GetDesktopPoolV3 Get /inventory/v3/desktop-pools/{id} Gets the desktop pool information.
InventoryApi GetDesktopPoolV4 Get /inventory/v4/desktop-pools/{id} Gets the desktop pool information.
InventoryApi GetDesktopPoolV5 Get /inventory/v5/desktop-pools/{id} Gets the desktop pool information.
InventoryApi GetFarm Get /inventory/v1/farms/{id} Gets the Farm information.
InventoryApi GetFarmV2 Get /inventory/v2/farms/{id} Gets the Farm information.
InventoryApi GetFarmV3 Get /inventory/v3/farms/{id} Gets the Farm information.
InventoryApi GetGlobalApplicationEntitlement Get /inventory/v1/global-application-entitlements/{id} Gets the Global Application Entitlement in the environment.
InventoryApi GetGlobalApplicationEntitlementV2 Get /inventory/v2/global-application-entitlements/{id} Gets the Global Application Entitlement in the environment.
InventoryApi GetGlobalDesktopEntitlement Get /inventory/v1/global-desktop-entitlements/{id} Gets the Global Desktop Entitlement in the environment.
InventoryApi GetGlobalDesktopEntitlementV2 Get /inventory/v2/global-desktop-entitlements/{id} Gets the Global Desktop Entitlement in the environment.
InventoryApi GetMachine Get /inventory/v1/machines/{id} Gets the Machine information.
InventoryApi GetMachineV2 Get /inventory/v2/machines/{id} Gets the Machine information.
InventoryApi GetPhysicalMachine Get /inventory/v1/physical-machines/{id} Gets the Physical Machine information.
InventoryApi GetRDSServer Get /inventory/v1/rds-servers/{id} Gets the RDS Server information.
InventoryApi GetSessionInfo Get /inventory/v1/sessions/{id} Gets the Session information for locally resourced session.
InventoryApi ListApplicationIcons Get /inventory/v1/application-icons Lists the application icons for the given application pool.
InventoryApi ListApplicationPools Get /inventory/v1/application-pools Lists the application pools in the environment.
InventoryApi ListApplicationPoolsV2 Get /inventory/v2/application-pools Lists the application pools in the environment.
InventoryApi ListApplicationPoolsV3 Get /inventory/v3/application-pools Lists the application pools in the environment.
InventoryApi ListCompatibleBackupGAEs Get /inventory/v1/global-application-entitlements/{id}/compatible-backup-global-application-entitlements Lists the Global Application Entitlements that can be associated as backup Global Application Entitlement.
InventoryApi ListCompatibleBackupGDEs Get /inventory/v1/global-desktop-entitlements/{id}/compatible-backup-global-desktop-entitlements Lists the Global Desktop Entitlements that can be associated as backup Global Desktop Entitlement.
InventoryApi ListCompatibleLocalApplicationPools Get /inventory/v1/global-application-entitlements/{id}/compatible-local-application-pools Lists Local Application Pools which are compatible with Global Application Entitlement.
InventoryApi ListCompatibleLocalDesktopPools Get /inventory/v1/global-desktop-entitlements/{id}/compatible-local-desktop-pools Lists Local Desktop Pools which are compatible with Global Desktop Entitlement.
InventoryApi ListDesktopPoolTasks Get /inventory/v1/desktop-pools/{id}/tasks Lists the tasks on the desktop pool.
InventoryApi ListDesktopPools Get /inventory/v1/desktop-pools Lists the Desktop Pools in the environment.
InventoryApi ListDesktopPoolsV2 Get /inventory/v2/desktop-pools Lists the desktop pools in the environment.
InventoryApi ListDesktopPoolsV3 Get /inventory/v3/desktop-pools Lists the desktop pools in the environment.
InventoryApi ListDesktopPoolsV4 Get /inventory/v4/desktop-pools Lists the desktop pools in the environment.
InventoryApi ListDesktopPoolsV5 Get /inventory/v5/desktop-pools Lists the desktop pools in the environment.
InventoryApi ListFarms Get /inventory/v1/farms Lists the Farms in the environment.
InventoryApi ListFarmsV2 Get /inventory/v2/farms Lists the Farms in the environment.
InventoryApi ListFarmsV3 Get /inventory/v3/farms Lists the Farms in the environment.
InventoryApi ListGlobalApplicationEntitlements Get /inventory/v1/global-application-entitlements Lists the Global Application Entitlements in the environment.
InventoryApi ListGlobalApplicationEntitlementsV2 Get /inventory/v2/global-application-entitlements Lists the Global Application Entitlements in the environment.
InventoryApi ListGlobalDesktopEntitlements Get /inventory/v1/global-desktop-entitlements Lists the Global Desktop Entitlements in the environment.
InventoryApi ListGlobalDesktopEntitlementsV2 Get /inventory/v2/global-desktop-entitlements Lists the Global Desktop Entitlements in the environment.
InventoryApi ListInstalledApplicationsOnDesktopPool Get /inventory/v1/desktop-pools/{id}/installed-applications Lists the installed applications on the given desktop pool.
InventoryApi ListInstalledApplicationsOnFarm Get /inventory/v1/farms/{id}/installed-applications Lists the installed applications on the given farm.
InventoryApi ListLocalApplicationPools Get /inventory/v1/global-application-entitlements/{id}/local-application-pools Lists Local Application Pools which are assigned to Global Application Entitlement.
InventoryApi ListLocalDesktopPools Get /inventory/v1/global-desktop-entitlements/{id}/local-desktop-pools Lists Local Desktop Pools which are assigned to Global Desktop Entitlement.
InventoryApi ListMachines Get /inventory/v1/machines Lists the Machines in the environment.
InventoryApi ListMachinesV2 Get /inventory/v2/machines Lists the Machines in the environment.
InventoryApi ListPhysicalMachines Get /inventory/v1/physical-machines Lists the Physical Machines in the environment.
InventoryApi ListRDSServers Get /inventory/v1/rds-servers Lists the RDS Servers in the environment.
InventoryApi ListSessionInfo Get /inventory/v1/sessions Lists the locally resourced Sessions in the environment
InventoryApi LogOffGlobalSessions Post /inventory/v1/global-sessions/action/logoff Logs off global sessions in the environment.
InventoryApi LogOffSessions Post /inventory/v1/sessions/action/logoff Logs off locally resourced user sessions, if they are not locked.
InventoryApi PauseDesktopPoolTask Post /inventory/v1/desktop-pools/{id}/tasks/{taskId}/action/pause Pause the instant clone desktop pool push image task.
InventoryApi QueryGlobalSessions Get /inventory/v1/global-sessions Lists global sessions in the environment for the given user, pod or brokering pod.
InventoryApi RebuildMachines Post /inventory/v1/machines/action/rebuild Rebuilds the specified machines.
InventoryApi RecoverMachines Post /inventory/v1/machines/action/recover Recovers the specified machines.
InventoryApi RecoverRDSServers Post /inventory/v1/rds-servers/action/recover Recovers the specified RDS Servers.
InventoryApi RegisterPhysicalMachine Post /inventory/v1/physical-machines/action/register Registers the Physical Machine.
InventoryApi RegisterRDSServer Post /inventory/v1/rds-servers/action/register Registers the RDS Server.
InventoryApi RemoveCustomIcon Post /inventory/v1/application-pools/{id}/action/remove-custom-icon Removes the associated custom icon from the application pool.
InventoryApi RemoveLocalApplicationPoolsFromGAE Delete /inventory/v1/global-application-entitlements/{id}/local-application-pools Removes Local Application Pools from Global Application Entitlement.
InventoryApi RemoveLocalDesktopPoolsFromGDE Delete /inventory/v1/global-desktop-entitlements/{id}/local-desktop-pools Removes Local Desktop Pools from Global Desktop Entitlement.
InventoryApi RemoveMachines Post /inventory/v1/desktop-pools/{id}/action/remove-machines Removes machines from the given manual desktop pool.
InventoryApi RemoveRdsServers Post /inventory/v1/farms/{id}/action/remove-rds-servers Remove RDS servers from the specified farm.
InventoryApi ResetGlobalSessions Post /inventory/v1/global-sessions/action/reset Resets machines of global sessions in the environment.
InventoryApi ResetMachines Post /inventory/v1/machines/action/reset Resets the specified machines.
InventoryApi ResetSessions Post /inventory/v1/sessions/action/reset Resets machine of locally resourced user sessions. The machine must be managed by Virtual Center and the session cannot be an application or an RDS desktop session.
InventoryApi RestartGlobalSessions Post /inventory/v1/global-sessions/action/restart Restarts machines of global sessions in the environment.
InventoryApi RestartMachines Post /inventory/v1/machines/action/restart Restarts the specified machines.
InventoryApi RestartSessions Post /inventory/v1/sessions/action/restart Restarts machine of locally resourced user sessions. The machine must be managed by Virtual Center and the session cannot be an application or an RDS desktop session.
InventoryApi ResumeDesktopPoolTask Post /inventory/v1/desktop-pools/{id}/tasks/{taskId}/action/resume Resume the instant clone desktop pool push image task.
InventoryApi ScheduleMaintenance Post /inventory/v1/farms/{id}/action/schedule-maintenance Creates maintenance schedule for the specified farm.
InventoryApi SchedulePushImage Post /inventory/v1/desktop-pools/{id}/action/schedule-push-image Schedule/reschedule a request to update the image in an instant clone desktop pool.
InventoryApi SendMessageToGlobalSessions Post /inventory/v1/global-sessions/action/send-message Sends message to global sessions in the environment.
InventoryApi SendMessageToSessions Post /inventory/v1/sessions/action/send-message Sends the message to locally resourced user sessions.
InventoryApi UnassignMachineAliases Post /inventory/v1/machines/{id}/action/unassign-aliases Un-assigns the aliases for the specified users from the machine.
InventoryApi UnassignUsers Post /inventory/v1/machines/{id}/action/unassign-users Un-assigns the specified users from the machine.
InventoryApi UpdateApplicationPool Put /inventory/v1/application-pools/{id} Updates application pool.
InventoryApi UpdateApplicationPoolV2 Put /inventory/v2/application-pools/{id} Updates application pool.
InventoryApi UpdateDesktopPool Put /inventory/v1/desktop-pools/{id} Updates desktop pool.
InventoryApi UpdateFarm Put /inventory/v1/farms/{id} Updates farm.
InventoryApi UpdateFarmV2 Put /inventory/v2/farms/{id} Updates farm.
InventoryApi UpdateGlobalApplicationEntitlement Put /inventory/v1/global-application-entitlements/{id} Updates a Global Application Entitlement.
InventoryApi UpdateGlobalDesktopEntitlement Put /inventory/v1/global-desktop-entitlements/{id} Updates a Global Desktop Entitlement.
InventoryApi UpdateRDSServer Put /inventory/v1/rds-servers/{id} Updates the RDS Server.
InventoryApi ValidateInstalledApplicationsOnDesktopPool Post /inventory/v1/desktop-pools/{id}/action/validate-installed-applications Validates that each application in the given list is installed on the machines belonging to the specified desktop pool.
InventoryApi ValidateInstalledApplicationsOnFarm Post /inventory/v1/farms/{id}/action/validate-installed-applications Validates that each application in the given list is installed on the RDS Servers belonging to the specified Farm.
InventoryApi ValidateSpecifiedNames Post /inventory/v1/desktop-pools/action/validate-specified-names Validates manually specified virtual machines. Ensures machine and user names are valid and aren't duplicated in the given desktop pool.
MonitorApi GetConnectionServerMonitorInfoV2 Get /monitor/v1/connection-servers/{id} Gets monitoring information related to Connection Server.
MonitorApi GetEventDatabaseMonitor Get /monitor/event-database Returns monitoring information related to Event database of the environment.
MonitorApi GetFarmMonitorInfo Get /monitor/v1/farms/{id} Gets monitoring information related to farm.
MonitorApi GetGatewayMonitorInfo Get /monitor/v1/gateways/{id} Gets monitoring information related to a Gateway.
MonitorApi GetPodMonitorInfoV2 Get /monitor/v1/pods/{id} Gets monitoring information related to the remote pod.
MonitorApi GetRDSServerMonitors Get /monitor/v1/rds-servers/{id} Gets monitoring information related to RDS Server.
MonitorApi GetSAMLAuthenticatorMonitorInfo Get /monitor/v1/saml-authenticators/{id} Gets Monitoring Information related to a SAML Authenticator
MonitorApi GetTrueSSOMonitorInfo Get /monitor/v1/true-sso/{id} Gets monitoring information related to a True SSO connector.
MonitorApi GetViewComposerByVCId Get /monitor/v1/view-composers/{vcId} View Composer is no longer supported from Horizon version 2012 onwards.
MonitorApi GetVirtualCenterMonitorInfo Get /monitor/v1/virtual-centers/{id} Gets monitoring information related to Virtual Center.
MonitorApi ListADDomainMonitorInfosV2 Get /monitor/v2/ad-domains Lists monitoring information related to AD Domains of the environment.
MonitorApi ListADDomainMonitorInfosV3 Get /monitor/v3/ad-domains Lists monitoring information related to AD Domains of the environment.
MonitorApi ListADDomainMonitors Get /monitor/ad-domains Lists monitoring information related to AD Domains of the environment.
MonitorApi ListConnectionServerMonitors Get /monitor/connection-servers Lists monitoring information related to Connection Servers of the environment.
MonitorApi ListConnectionServerMonitorsV2 Get /monitor/v2/connection-servers Lists monitoring information related to Connection Servers of the environment.
MonitorApi ListDesktopPoolMetrics Get /monitor/v1/desktop-pools/metrics Lists metrics of desktop pools (except RDS desktop pools).
MonitorApi ListFarmMonitors Get /monitor/farms Lists monitoring information related to Farms of the environment.
MonitorApi ListGatewayMonitorInfoV1 Get /monitor/gateways Lists monitoring information related to Gateways registered in the environment.
MonitorApi ListGatewayMonitorInfoV2 Get /monitor/v2/gateways Lists monitoring information related to Gateways registered in the environment.
MonitorApi ListPodMonitorInfosV1 Get /monitor/v1/pods Lists monitoring information related to the remote pods.
MonitorApi ListPodMonitorInfosV2 Get /monitor/v2/pods Lists monitoring information related to the remote pods.
MonitorApi ListRDSServerMonitors Get /monitor/rds-servers Lists monitoring information related to RDS Servers of the environment.
MonitorApi ListSAMLAuthenticatorMonitorsV1 Get /monitor/saml-authenticators Lists monitoring information related to SAML Authenticators of the environment.
MonitorApi ListSAMLAuthenticatorMonitorsV2 Get /monitor/v2/saml-authenticators Lists monitoring information related to SAML Authenticators of the environment.
MonitorApi ListTrueSSOMonitorInfos Get /monitor/v1/true-sso Lists monitoring information related to True SSO connectors.
MonitorApi ListViewComposerMonitorsV1 Get /monitor/view-composers View Composer is no longer supported from Horizon version 2012 onwards.
MonitorApi ListViewComposerMonitorsV2 Get /monitor/v2/view-composers View Composer is no longer supported from Horizon version 2012 onwards.
MonitorApi ListVirtualCenterMonitors Get /monitor/virtual-centers Lists monitoring information related to Virtual Centers of the environment.
MonitorApi ListVirtualCenterMonitorsV2 Get /monitor/v2/virtual-centers Lists monitoring information related to Virtual Centers of the environment.

Documentation For Models

Documentation For Authorization

Bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

About

Golang bindings for the VMware Horizon REST API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages