Inventory APIs

APIs for inventory resources

Operations

POST

Add Custom Icon

Associates a custom icon to the application pool.

POST

Add Local Application Pools To GAE

Adds Local Application Pools to Global Application Entitlement.

POST

Add Local Desktop Pools To GDE

Adds Local Desktop Pools to Global Desktop Entitlement.

POST

Add Machines

Adds machines to the given manual desktop pool.

POST

Add Machines By Name

Adds the named machines to the given desktop pool.

POST

Add Rds Servers

Add RDS servers to the specified manual farm.

POST

Archive Machines

Initiates machine archival process

POST

Assign Machine Aliases

Assigns the specified aliases to the assigned users of the machine.

POST

Assign Users

Assigns the specified users to the machine.

POST

Cancel Desktop Pool Task

Cancels the instant clone desktop pool push image task.

POST

Cancel Scheduled Maintenance

Requests cancellation of the current scheduled maintenance on the specified Instant Clone farm.

POST

Cancel Scheduled Push Image

Request the cancellation of the current scheduled push image operation on the specified instant clone desktop pool.

POST

Check Application Pool Name Availability

Checks if the given name is available for application pool creation.

POST

Check Desktop Pool Name Availability

Checks if the given name is available for desktop pool creation.

POST

Check Farm Name Availability

Checks if the given name is available for farm creation.

POST

Check Machine Prefix Availability

Checks if the given prefix is available for machine creation.

POST

Check RDS Server Prefix Availability

Checks if the given prefix is available for RDS Server creation.

POST

Create Application Icon

Creates an application icon.

POST

Create Application Pool

Creates an application pool.

POST

Create Application Pool V2

Creates an application pool.

POST

Create Desktop Pool

Creates a desktop pool.

POST

Create Desktop Pool V2

Creates a desktop pool.

POST

Create Farm

Creates a farm.

POST

Create Farm V2

Creates a farm.

POST

Create Farm V3

Creates a farm.

POST

Create Global Application Entitlement

Creates a Global Application Entitlement.

POST

Create Global Desktop Entitlement

Creates a Global Desktop Entitlement.

POST

Create Global Desktop Entitlement V2

Creates a Global Desktop Entitlement.

DELETE

Delete Application Pool

Deletes application pool.

DELETE

Delete Desktop Pool

Deletes a desktop pool.

DELETE

Delete Farm

Deletes a farm.

DELETE

Delete Global Application Entitlement

Deletes a Global Application Entitlement.

DELETE

Delete Global Desktop Entitlement

Deletes a Global Desktop Entitlement.

DELETE

Delete Machine

Deletes the machine.

DELETE

Delete Machines

Deletes the specified machines.

DELETE

Delete Physical Machine

Deletes the Physical Machine.

DELETE

Delete RDS Server

Deletes the RDS Server.

POST

Desktop Pool Apply Image

Applies the pending image or the current image to selected machines in the desktop pool.

POST

Desktop Pool Promote Pending Image

Promotes pending image to current image in the desktop pool.

POST

Disconnect Global Sessions

Disconnects global sessions in the environment.

POST

Disconnect Sessions

Disconnects locally resourced user sessions.

POST

Enter Maintenance

Puts the machines into maintenance mode.

POST

Exit Maintenance

Puts the machines out of maintenance mode.

POST

Farm Apply Image

Applies the pending image or the current image to selected RDS servers in the farm.

POST

Farm Promote Pending Image

Promotes pending image to current image in the farm.

GET

Get Application Icon

Gets application icon.

GET

Get Application Pool

Gets application pool.

GET

Get Application Pool V2

Gets application pool.

GET

Get Application Pool V3

Gets application pool.

GET

Get Desktop Pool

Gets the Desktop Pool information.

GET

Get Desktop Pool Task

Gets the task information on the desktop pool.

GET

Get Desktop Pool V2

Gets the desktop pool information.

GET

Get Desktop Pool V3

Gets the desktop pool information.

GET

Get Desktop Pool V4

Gets the desktop pool information.

GET

Get Desktop Pool V5

Gets the desktop pool information.

GET

Get Desktop Pool V6

Gets the desktop pool information.

GET

Get Farm

Gets the Farm information.

GET

Get Farm V2

Gets the Farm information.

GET

Get Farm V3

Gets the Farm information.

GET

Get Farm V4

Gets the Farm information.

GET

Get Global Application Entitlement

Gets the Global Application Entitlement in the environment.

GET

Get Global Application Entitlement V2

Gets the Global Application Entitlement in the environment.

GET

Get Global Desktop Entitlement

Gets the Global Desktop Entitlement in the environment.

GET

Get Global Desktop Entitlement V2

Gets the Global Desktop Entitlement in the environment.

GET

Get Machine

Gets the Machine information.

GET

Get Machine V2

Gets the Machine information.

GET

Get Machine V3

Gets the Machine information.

GET

Get Physical Machine

Gets the Physical Machine information.

GET

Get Physical Machine V2

Gets the Physical Machine information.

GET

Get RDS Server

Gets the RDS Server information.

GET

Get Session Info

Gets the Session information for locally resourced session.

GET

List Application Icons

Lists the application icons for the given application pool.

GET

List Application Pools

Lists the application pools in the environment.

GET

List Application Pools V2

Lists the application pools in the environment.

GET

List Application Pools V3

Lists the application pools in the environment.

GET

List Compatible Backup GA Es

Lists the Global Application Entitlements that can be associated as backup Global Application Entitlement.

GET

List Compatible Backup GD Es

Lists the Global Desktop Entitlements that can be associated as backup Global Desktop Entitlement.

GET

List Compatible Local Application Pools

Lists Local Application Pools which are compatible with Global Application Entitlement.

GET

List Compatible Local Desktop Pools

Lists Local Desktop Pools which are compatible with Global Desktop Entitlement.

GET

List Desktop Pools

Lists the Desktop Pools in the environment.

GET

List Desktop Pools V2

Lists the desktop pools in the environment.

GET

List Desktop Pools V3

Lists the desktop pools in the environment.

GET

List Desktop Pools V4

Lists the desktop pools in the environment.

GET

List Desktop Pools V5

Lists the desktop pools in the environment.

GET

List Desktop Pools V6

Lists the desktop pools in the environment.

GET

List Desktop Pool Tasks

Lists the tasks on the desktop pool.

GET

List Farms

Lists the Farms in the environment.

GET

List Farms V2

Lists the Farms in the environment.

GET

List Farms V3

Lists the Farms in the environment.

GET

List Farms V4

Lists the Farms in the environment.

GET

List Global Application Entitlements

Lists the Global Application Entitlements in the environment.

GET

List Global Application Entitlements V2

Lists the Global Application Entitlements in the environment.

GET

List Global Desktop Entitlements

Lists the Global Desktop Entitlements in the environment.

GET

List Global Desktop Entitlements V2

Lists the Global Desktop Entitlements in the environment.

GET

List Installed Applications On Desktop Pool

Lists the installed applications on the given desktop pool.

GET

List Installed Applications On Farm

Lists the installed applications on the given farm.

GET

List Local Application Pools

Lists Local Application Pools which are assigned to Global Application Entitlement.

GET

List Local Desktop Pools

Lists Local Desktop Pools which are assigned to Global Desktop Entitlement.

GET

List Machines

Lists the Machines in the environment.

GET

List Machines V2

Lists the Machines in the environment.

GET

List Machines V3

Lists the Machines in the environment.

GET

List Physical Machines

Lists the Physical Machines in the environment.

GET

List Physical Machines V2

Lists the Physical Machines in the environment.

GET

List RDS Servers

Lists the RDS Servers in the environment.

GET

List Session Info

Lists the locally resourced Sessions in the environment

POST

Log Off Global Sessions

Logs off global sessions in the environment.

POST

Log Off Sessions

Logs off locally resourced user sessions, if they are not locked.

POST

Pause Desktop Pool Task

Pause the instant clone desktop pool push image task.

GET

Query Global Sessions

Lists global sessions in the environment for the given user, pod or brokering pod.

POST

Rebuild Machines

Rebuilds the specified machines.

POST

Recover Machines

Recovers the specified machines.

POST

Recover RDS Servers

Recovers the specified RDS Servers.

POST

Register Physical Machine

Registers the Physical Machine.

POST

Register RDS Server

Registers the RDS Server.

POST

Remove Custom Icon

Removes the associated custom icon from the application pool.

DELETE

Remove Local Application Pools From GAE

Removes Local Application Pools from Global Application Entitlement.

DELETE

Remove Local Desktop Pools From GDE

Removes Local Desktop Pools from Global Desktop Entitlement.

POST

Remove Machines

Removes machines from the given manual desktop pool.

POST

Remove Rds Servers

Remove RDS servers from the specified farm.

POST

Reset Global Sessions

Resets machines of global sessions in the environment.

POST

Reset Machines

Resets the specified machines.

POST

Reset Sessions

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.

POST

Restart Global Sessions

Restarts machines of global sessions in the environment.

POST

Restart Machines

Restarts the specified machines.

POST

Restart Sessions

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.

POST

Resume Desktop Pool Task

Resume the instant clone desktop pool push image task.

POST

Schedule Maintenance

Creates maintenance schedule for the specified farm.

POST

Schedule Maintenance V2

Creates maintenance schedule for the specified farm.

POST

Schedule Push Image

Schedule/reschedule a request to update the image in an instant clone desktop pool.

POST

Schedule Push Image V2

Schedule/reschedule a request to update the image in an instant clone desktop pool.

POST

Send Message To Global Sessions

Sends message to global sessions in the environment.

POST

Send Message To Sessions

Sends the message to locally resourced user sessions.

POST

Unassign Machine Aliases

Un-assigns the aliases for the specified users from the machine.

POST

Unassign Users

Un-assigns the specified users from the machine.

PUT

Update Application Pool

Updates application pool.

PUT

Update Application Pool V2

Updates application pool.

PUT

Update Desktop Pool

Updates desktop pool.

PUT

Update Farm

Updates farm.

PUT

Update Farm V2

Updates farm.

PUT

Update Farm V3

Updates farm.

PUT

Update Global Application Entitlement

Updates a Global Application Entitlement.

PUT

Update Global Desktop Entitlement

Updates a Global Desktop Entitlement.

PUT

Update RDS Server

Updates the RDS Server.

POST

Validate Installed Applications On Desktop Pool

Validates that each application in the given list is installed on the machines belonging to the specified desktop pool.

POST

Validate Installed Applications On Farm

Validates that each application in the given list is installed on the RDS Servers belonging to the specified Farm.

POST

Validate Specified Names

Validates manually specified virtual machines. Ensures machine and user names are valid and aren't duplicated in the given desktop pool.