• View Communities
    • Citrix Communities
      Visit the Citrix Communities to get and share technical information and best practices about desktop delivery, datacenter, networking and cloud computing solutions.
    • Citrix Blogs
      Learn the latest from the Citrix employees who are building the future of virtual computing.
    • Citrix Developer Network
      The place for unfiltered straight talk on Citrix products. Find related blogs, best practices, code downloads, APIs and more.
    • Citrix Ready Community Verified
      Does it work with Citrix? Application compatibility questions are a thing of the past with the new Citrix Community Verified site.
  •  Sign In
Citrix Developer Network
Version 1 by Kathy Paxton
on Apr 13, 2009 13:50.


 
compared with
Current by Kathy Paxton
on Sep 17, 2009 16:25.


 
Key
These lines were removed. This word was removed.
These lines were added. This word was added.

View page history


There are 7 changes. View first change.

 h1. GetVM
  
 Returns one or more XenServer vitual machine objects. Automatically binds to the first XenServer connection object preceding this activity.
 h3.Properties
 {color:#003399} *VMPropertyFilter* {color}
 Type: System.ComponentModel.BindingList`1\[\[Citrix.WorkflowStudio.CustomActivities.Editors.VariableEdit, CustomActivityPropertyEditors, Version=1.0.0.0, Culture=neutral, PublicKeyToken=36841176f080fbec\]\]
 Specifies by properties, through the Microsoft Collection Editor dialog, the virtual machines to be retrieved.
  {color:#003399} *Include* {color}
 Type: VMIncludes
 Specifies the types to include in return from GetVM. Defaults to 'Both'.
  
{color:#003399} *VMNameFilter* {color}
 Type: System.String
  {color:#003399} *VM Name* {color}
 Type: String
 Specifies the names of the virtual machines to be retrieved.
  
{color:#003399} *IncludeTemplate* {color}
 Type: System.Boolean
 Specify whether to include templates in search.
  {color:#003399} *Virtual Machines* {color}
 Type: Object
 Contains a list of one or more virtual machines on the XenServer host that match the criteria in 'VM Name Filter' and 'VM Property Filter'. This is a read-only output parameter.
  
 {color:#003399} *Connection* {color}
Type: XenAPI.Session
  Type: CTXXSSession
 Overrides the connection object assumed for the XenServer connection. This activity automatically binds to the first connection object defined in a workflow. Specify a binding for this parameter to override the assumed connection.
  
{color:#003399} *ListOutput* {color}
 Type: System.Collections.Generic.List`1\[\[Citrix.WorkflowStudio.ActivityLibrary.XenServer.CTXVM, Citrix.WorkflowStudio.ActivityLibrary.XenServer, Version=1.0.0.0, Culture=neutral, PublicKeyToken=991e1e90131e756e\]\]
 Contains a list of one or more virtual machines on the XenServer host that match the criteria in 'VM Name Filter' and 'VM Property Filter'. This is a read-only output parameter.
  {color:#003399} *Stop On Error (SOE)* {color}
 Type: Boolean
 If the task throws an exception and this property is 'True' (the default), workflow execution will be stopped. When 'False', the error will be logged and workflow execution will continue as if no error occurred.
  
{color:#003399} *Name* {color}
 Type: String
 Please specify the identifier of the activity. It has to be unique in the workflow.
  
 {color:#003399} *Enabled* {color}
 Type: Boolean
 Please specify if the activity is enabled or not. If an activity is not enabled it will not participate in the execution and validation.
  
 {color:#003399} *Description* {color}
 Type: String
 Please specify the description of the activity.
  
  
  
Related Links