Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
 
Connect To HyperV

Add Virtual Hard Drive

This activity

connects to a Hyper-V Host. The Output of this activity should be used as Input for all Connection parameters used for all activities found under this category

creates a virtual hard drive for the specified VM.

Activity Parameters

The 

Connect to HyperV 

Add Virtual Hard Drive activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image Removed

Image Added

Parameters:

Authority 
  • Address (text box editor type) (type: string):
 leave the default value for this parameter or blank if no authority is required.Hostname or IP 
  • the MAC address.
  • Network Adapter Name (text box editor type) (type: string): the name of the network adapter.
  • VHD Name (text box editor type) (type: string):
the Hostname or IP address of target machine - example: "\\\\10.10.10.10\\root\\virtualization" or "\\\\ServerName\\root\\virtualization".Password (
  •  the name of the virtual hard drive.
  • VM Name (text box editor type) (type: string):
the password for the provided username.Password Binding (text box editor type)
  • the name of the VM to be created.

The Read Only Output variable are the possible output values that the activity will provide:

  • Created  (type:
string
  • boolean):
 bind to a variable containing the encrypted password for the HyperV. (This parameter is used only when the user wants to send an encripted password from outside the task, for example Flowster Portal).
  • Username (text box editor type) (type: string): the username for the user to query to the remote computer.
  • The Read Only Output variable are the possible output values that the activity will provide:

    • Connection  (type: object): outputs a Hyper-V connection. The Output parameter should be used as Input for all Connection parameters of the activities found under HyperV category.
     As mentioned above, the values
    •  outputs a bool value indicating if the VM was successfully created.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Add Virtual Hard Drive activity:

    Image Added



     

    Add Virtual Network

    This activity creates a virtual network for the specified VM.

    Activity Parameters

    The Add Virtual Network activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Image Added

    Parameters:

    • Address (text box editor type) (type: string): the MAC address.
    • Network Adapter Name (text box editor type) (type: string): the name of the network adapter.
    • VM Name (text box editor type) (type: string): the name of the VM to be created.

    The Read Only Output variable are the possible output values that the activity will provide:

    • Created  (type: boolean): outputs a bool value indicating if the VM was successfully created.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the 

    Connect to HyperV

    Add Virtual Network activity:

    Image Removed

    Image Added

     

     

     

    Disconnect from HyperV

    Clone VM

    This activity disconnects from a Hyper-V Hostclones a VM on a HyperV host.

    Activity Parameters

    The Disconnect from HyperV Clone VM activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Image RemovedImage Added

    Parameters:

    • Connection Base Machine Name (text box editor type) (type: objectstring): the Hyper-V Host connection. The Output from Connect to Hyper-V activity should be used as Input here.

    Add Virtual Hard Drive

    This activity creates a virtual hard drive for the specified VM.

    Activity Parameters

    The Add Virtual Hard Drive activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Image Removed

    Parameters:

    • Address the name of the base virtual machine name.
    • Machine Folder (text box editor type) (type: string): the MAC address.
    • Network Adapter Name (text box editor type) (type: string): the name of the network adapter.
    • VHD the full path where the virtual machine will be created.
    • VM Name (text box editor type) (type: string): the name  the name of the virtual hard driveVM to be created.
    • VM Name Set Generation Type (text combo box editor typecontrol) (type: string): the name of the VM to be createdthe generation type for the new VM that will be cloned: generation 1 / generation 2.

    The Read Only Output variable are the possible output values that the activity will provide:

    • Created  (type: boolean): outputs a bool a bool value indicating if the VM was successfully created.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Add Virtual Hard DriveClone VM activity:

    Image RemovedImage Added

     

     

    Add

    Compact Virtual

    Network

    Hard Disk

    This activity creates compacts a virtual network for the specified VMdynamic virtual hard disk file. Compacting is the process of unallocating unused portions of the virtual hard disk.

    Activity Parameters

    The Add Compact Virtual Network Hard Disk activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Image RemovedImage Added

    Parameters:

    • Address Path (text box editor type) (type: string): the MAC address.
    • Network Adapter Name (text box editor type) (type: string): the name of the network adapter.
    • VM Name (text box editor type) (type: string): the name of the VM to be created.
    The Read Only
    • the fully qualified path that specifies the location of the merging file.

    The Read Only Output variable are the possible output values that the activity will provide:

    • Created Output Status  (type: boolean): outputs a bool  outputs a bool value indicating if the VM compacting was successfully createddone.
    Clone VM
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Add Compact Virtual NetworkHard Disk activity:

    Image Removed

     

     

    Image Added

    Connect To HyperV

    This activity

    clones a VM on a HyperV host.

    Activity Parameters

    The Clone VM activity parameters can be

    connects to a Hyper-V Host. The Output of this activity should be used as Input for all Connection parameters used for all activities found under this category.

    Activity Parameters

    The Connect to HyperV activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Image Removed

    Image Added

    Parameters:

    Base Machine Name 
    • Authority (text box editor type)
     
    • (type: string):
    the name of the base virtual machine name.Machine Folder 
    •  leave the default value for this parameter or blank if no authority is required.
    • Hostname or IP (text box editor type) (type: string): the
    full path where the virtual machine will be created.VM Name 
    • Hostname or IP address of target machine - example: "\\10.10.10.10\root\virtualization\v2" or "\\ServerName\root\virtualization\v2".
    • Password (text box editor type) (type: string):
     the name of the VM to be created.

    The Read Only Output variable are the possible output values that the activity will provide:

    Created 
    • the password for the provided username.
    • Password Binding (text box editor type) (type:
    boolean
    • string):
     outputs a bool value indicating if the VM was successfully created.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Clone VM activity:

    Image Removed

     

     

    Compact Virtual Hard Disk

    This activity compacts a dynamic virtual hard disk file. Compacting is the process of unallocating unused portions of the virtual hard disk.

    Activity Parameters

    The Compact Virtual Hard Disk activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Image Removed

    Parameters:

    • Path (text box editor type) (type: string): the fully qualified path that specifies the location of the merging file.

    The Read Only Output variable are the possible output values that the activity will provide:

    • Output Status  (type: boolean): outputs a bool value indicating if the compacting was successfully done.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Compact Virtual Hard Disk activity:

    Image Removed

    •  bind to a variable containing the encrypted password for the HyperV. (This parameter is used only when the user wants to send an encripted password from outside the task, for example Flowster Portal).
    • Username (text box editor type) (type: string): the username for the user to query to the remote computer.

    The Read Only Output variable are the possible output values that the activity will provide:

    • Connection  (type: object): outputs a Hyper-V connection. The Output parameter should be used as Input for all Connection parameters of the activities found under HyperV category.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Connect to HyperV activity:

    Image Added

     

     

     

    Disconnect from HyperV

    This activity disconnects from a Hyper-V Host.

    Activity Parameters

    The Disconnect from HyperV activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Image Added

    Parameters:

    • Connection (text box editor type) (type: object): the Hyper-V Host connection. The Output from Connect to Hyper-V activity should be used as Input here.



     

    Create New Disk

    This activity creates a new disk and add it to a virtual machine.

    Activity Parameters

    The Create New Disk activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Parameters:

    • Base Image Path (text box editor type) (type: string): the full path of base virtual disk image to use.
    • Disk Type (combo box control) (type: string): the virtual disk type.
    • New Image Path (text box editor type) (type: string): the full path (with disk image name) of new virtual disk image.
    • Size (text box editor type) (type: int32): the size of the new virtual disk in GB.

    The Read Only Output variable are the possible output values that the activity will provide:

    • Created  (type: boolean): outputs a bool value indicating if the virtual hard disk was successfully created.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Create New Disk activity:



     

    Create User Role

     Create VM

    This activity creates a user role VM on a HyperV virtual machinehost.

    Activity Parameters

    The Create User Role VM activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Image RemovedImage Added

    Parameters:

    • Scope VM Name (text box editor type) (type: string): the name of the authorization scope to use in determining the access control policy for the virtual machineVM to be created.
    • VM Name (text box editor typeSet Generation Type (combo box control) (type: string): the name of the VMthe generation type for the new VM that will be created: generation 1 / generation 2.

    The Read Only Output variable are the possible output values that the activity will provide:

    • Output Created  (type: boolean): outputs a bool value indicating if the user role vm was successfully created.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Create User RoleVM activity:

    Image RemovedImage Added



     

    Create VM From Template

    This activity creates a VM on a HyperV host.

    Activity Parameters

    The Create VM VM from Template activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Image RemovedImage Added

    Parameters:

    • VM Source Template Name (text box editor type) (type: string): the name of the VM to be createdvirtual machine Template used to create the virtual machine.
    • VM Name (text box editor type) (type: string): the name of the VM to be created.
    • VM Set Generation Type (combo box control) (type: string): the generation type for the new VM that will be created: generation 1 / generation 2.

    The Read Only Output variable are the possible output values that the activity will provide:

    • Created  (type: boolean): outputs a bool value indicating if the vm was successfully created.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Create VM from Template activity:

    Image RemovedImage Added



     

    Create VM From Template

    Delete Snapshot

    This activity creates a VM on a HyperV hostremoves the specified snapshot of the specified VM.

    Activity Parameters

    The Create VM from Template Delete Snapshot activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Image RemovedImage Added

    Parameters:

    • Source Template Snapshot Name (text box editor type) (type: string): the name of the virtual machine Template used to create the virtual machinethe snapshot name.
    • VM Name Name(text box editor type) (type: string): the name of the VM to be created.

    The Read Only Output variable are the possible output values that the activity will provide:

    • Created  (type: boolean): outputs a bool value indicating if the vm was successfully created.
     As mentioned above, the values for all the required parameters can be provided by IN arguments or variables.
    • virtual machine.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Create VM from TemplateDelete Snapshot activity:

    Image RemovedImage Added



     

    Delete

    Snapshot

    VM

    This activity removes the specified snapshot of the specified VMvirtual machine.

    Activity Parameters

    The Delete Snapshot VM activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Image RemovedImage Added

    Parameters:

    • Snapshot VM Name (text box editor type) (type: string): the snapshot the name of virtual machine.
    • VM Name(text box editor type) (type: string): the name of virtual machine.
     As  

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Delete SnapshotVM activity:

    Image RemovedImage Added

     

    Delete User Role

    Expand Virtual Hard Disk

    This activity deletes a user role on a HyperV virtual machineexpands an existing virtual hard disk (.vhd) file.

    Activity Parameters

    The Delete User Role Expand Virtual Hard Disk activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Image RemovedImage Added

    Parameters:

    • VM Name Max Internal Size (text box editor type) (type: stringint32): the name of the VM.

    The Read Only Output variable are the possible output values that the activity will provide:

    • Output Status  (type: boolean): outputs a bool value indicating if the user role was successfully deleted.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Delete User Role activity:

    Image Removed

     

    Delete VM

    This activity removes the specified virtual machine.

    Activity Parameters

    The Delete VM activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Image Removed

    Parameters:

    • VM Name (text box editor type) (type: string): the name of virtual machine.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Delete VM activity:

    Image Removed

     

    Expand Virtual Hard Disk

    This activity expands an existing virtual hard disk (.vhd) file.

    Activity Parameters

    The Expand Virtual Hard Disk activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Image Removed

    Parameters:

    • Max Internal Size (text box editor type) (type: int32): the maximum size of the virtual hard disk as viewable by the virtual machine, in bytes. MaxInternalSize minimum value is DiskSize + 512 - (DiskSize mod 512). DiskSize is the disk image file in number of bytes. The InvalidParameter error (32773) is returned if the MaxInternalSize value specified is less than the minimum value.
    • Path (text box editor type) (type: string): the fully qualified path that specifies the location of the disk image file.

    The Read Only Output variable are the possible output values that the activity will provide:

    • Output Status  (type: boolean): outputs a bool value indicating if the expanding was successfully done.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Expand Virtual Hard Disk activity:

    Image Removed

     

     

     

     

    Get User Role

    This activity gets the user role of a HyperV virtual machine.

    Activity Parameters

    The Get User Role activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Image Removed

    Parameters:

    • VM Name the maximum size of the virtual hard disk as viewable by the virtual machine, in bytes. MaxInternalSize minimum value is DiskSize + 512 - (DiskSize mod 512). DiskSize is the disk image file in number of bytes. The InvalidParameter error (32773) is returned if the MaxInternalSize value specified is less than the minimum value.
    • Path (text box editor type) (type: string): the name fully qualified path that specifies the location of the VMdisk image file.

    The Read Only Output variable are the possible output values that the activity will provide:

    • Output Scope Status  (type: stringboolean): outputs the 'ScopeOfResidence' valuea bool value indicating if the expanding was successfully done.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Get User RoleExpand Virtual Hard Disk activity:

    Image RemovedImage Added

     

     

     

     


     

     

    Get VM Host

    This activity gets the host of a HyperV virtual machine.

    Activity Parameters

    The Get VM Host activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Parameters:

    • VM Name (text box editor type) (type: string): the name of the VM.

    The Read Only Output variable are the possible output values that the activity will provide:

    • Output Host  (type: string): outputs the host name.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Get VM Host activity:


     

     

    Get VMs on HyperV

    This activity gets and returns all registered Virtual Machines on a Hyper-V Host.

    Activity Parameters

    The Get VMs on HyperV activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Parameters:

    • Connection (text box editor type) (type: string): the Hyper-V Host connection. The Output from Connect to Hyper-V activity should be used as Input here.

    The Read Only Output variable are the possible output values that the activity will provide:

    • Output  (type: collection<string>): outputs a collection of all VMs from a HyperV host.To use the elements of the collection, use Get Element From Collection activity.
     

     

     

    HyperV Apply Snapshot

    This activity applies the specified snapshot to the specified VM.

    Activity Parameters

    The HyperV Apply Snapshot activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Parameters:

    • Apply Latest (combo box control) (type: string): if set to yes, it will apply the last snapshot created.
    • Snapshot Name (text box editor type) (type: string): if Apply Latest set to no, this snapshot will be applied, otherwise this parameter is ignored.
    • VM Name (text box editor type) (type: string): the name of virtual machine.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the HyperV Apply Snapshot activity:




     

    HyperV Edit VM Parameters

    This activity modify a specified VM's parameters.

    Activity Parameters

    The HyperV Edit VM Parameters activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Parameters:

    • New VM Name (text box editor type) (type: string): the new name for the VM, if you do not wish to edit it, leave empty.
    • VM Name (text box editor type) (type: string): the name of the VM to be edited.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the HyperV Edit VM Parameters activity:



     

    HyperV Export VM

    This activity exports a virtual computer system, or a snapshot of a virtual computer system, in the 'powered off' or 'saved' state to a file.

    Activity Parameters

    The HyperV Export VM activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Parameters:

    • Folder (text box editor type) (type: string): the folder path from the HyperV host machine to which to save the exported VM.
    • VM Name (text box editor type) (type: string): the name of virtual machine to export.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the HyperV Export VM activity:



     

    HyperV Import VM

    This activity imports a virtual computer system. The resulting virtual computer system will be in the Disabled state.

    Activity Parameters

    The HyperV Import VM activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Parameters:

    • Import Directory (text box editor type) (type: string): the folder from which to import the VM (path relative to the HyperV Host machine).
    • Import VM Name (text box editor type) (type: string): the name for the imported VM.
    • Root Directory (text box editor type) (type: string): the folder to which to store the imported VM.
    • Target Connection (text box editor type) (type: string): the Hyper-V Host connection to which the specified VM will be imported. The Output from Connect to Hyper-V activity should be used as Input here.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the HyperV Import VM activity:

     

     

     

     

    List VM Snapshots

    This activity retrieves all snapshots belonging to a specified VM.

    Activity Parameters

    The List VM Snapshots activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Parameters:

    • VM Name (text box editor type) (type: string): the name of virtual machine.

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the List VM Snapshots activity:

    The Read Only Output variable are the possible output values that the activity will provide:

    • Snapshot List  (type: collection<ManagementObject>): output of type System.Management.ManagementObjectCollection(collection of ManagementObject).
    • Snapshot Names List  (type: collection<string>): output of type Collection. Represents the names of the snapshots contained in Snapshot List.
     

     

      

    Merge Virtual Hard Disk

    This activity merges a differencing virtual hard disk file with its parents. If the user executing this function does not have permission to update the virtual machines, then this function will fail.

    Activity Parameters

    The Merge Virtual Hard Disk activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Parameters:

    • Destination Path (text box editor type) (type: string): the fully qualified path that specifies the location of the parent disk image file into which data is to be merged. This could be the immediate parent virtual disk image of the merging file or parent disk image few levels up the differencing drive chain.
    • Source Path (text box editor type) (type: string): the fully qualified path that specifies the location of the merging file.

    The Read Only Output variable are the possible output values that the activity will provide:

    • Output Status  (type: boolean): outputs a bool value indicating if the merge was successfully done.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Merge Virtual Hard Disk activity:



     

     

    Mount Virtual Disk

    This activity mounts a virtual disk image file.

    Activity Parameters

    The Mount Virtual Disk activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Parameters:

    • Path (text box editor type) (type: string): the fully qualified path that specifies the location of the disk image file.

    The Read Only Output variable are the possible output values that the activity will provide:

    • Output  (type: boolean): outputs 'true' if the specified virtual disk was mounted, otherwise 'false'.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Mount Virtual Disk activity:

     

     

     

    Pause VM on HyperV

    This activity pauses a specified virtual machine on a Hyper-V Host.

    Activity Parameters

    The Pause VM on HyperV activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Parameters:

    • VM Name (text box editor type) (type: string): the name of virtual machine to Pause.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Pause VM on HyperV activity:

     

     

     

    Power Off VM on HyperV

    This activity powers off a specified virtual machine on a Hyper-V Host.

    Activity Parameters

    The Power Off VM on HyperV activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Parameters:

    • VM Name (text box editor type) (type: string): the name of virtual machine to power off.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Power Off VM on HyperV activity:

     

     

     

    Power On VM on HyperV

    This activity powers on a specified virtual machine on a Hyper-V Host.

    Activity Parameters

    The Power On VM on HyperV activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Parameters:

    • VM Name (text box editor type) (type: string): the name of virtual machine to power on.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Power On VM on HyperV activity:

     

     

    Reboot VM on HyperV

    This activity reboots the guest operating system of a specified virtual machine on a Hyper-V Host.

    Activity Parameters

    The Reboot VM on HyperV activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Parameters:

    • VM Name (text box editor type) (type: string): the name of virtual machine to reboot.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Reboot VM on HyperV activity:


     

     

    Remove Network Adapter

    This activity removes the specified Network Adapter of the specified VM.

    Activity Parameters

    The Remove Network Adapter activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Parameters:

    • Network Adapter Name (text box editor type) (type: string): the Network Adapter name.
    • VM Name (text box editor type) (type: string): the name of virtual machine.

     

     

     

    Reset VM on HyperV

    This activity resets a virtual machine on a Hyper-V Host.

    Activity Parameters

    The Reset VM on HyperV activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Parameters:

    • VM Name (text box editor type) (type: string): the name of virtual machine to reset.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Reset VM on HyperV activity:

     

     

     

    Save Snapshot

    This activity saves the current state of a specified virtual machine.

    Activity Parameters

    The Save Snapshot activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Parameters:

    • VM Name (text box editor type) (type: string): the name of virtual machine.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Save Snapshot activity:

     

     

     

    Shutdown VM on HyperV

    This activity shuts down the guest operating system of a specified virtual machine on an Hyper-V Host.

    Activity Parameters

    The Shutdown VM on HyperV activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Parameters:

    • Vm Name (text box editor type) (type: string): the name of virtual machine.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Shutdown VM on HyperV activity:

     

     

     

     

    Unmount Virtual Disk

    This activity unmounts a virtual disk image file.

    Activity Parameters

    The Unmount Virtual Disk activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Parameters:

    • Path (text box editor type) (type: string): the fully qualified path that specifies the location of the disk image file.

    The Read Only Output variable are the possible output values that the activity will provide:

    • Output  (type: boolean): outputs 'true' if the specified virtual disk was deleted, otherwise 'false'.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Unmount Virtual Disk activity:

     

     

     

    VM Exists

    This activity verifies if the specified virtual machine exists.

    Activity Parameters

    The VM Exists activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Parameters:

    • Vm Name (text box editor type) (type: string): the name of virtual machine.

    The Read Only Output variable are the possible output values that the activity will provide:

    • Output  (type: boolean): outputs 'true' if the specified VM exists, otherwise 'false'.
     

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the VM Exists activity:




     

    VM Get Network Adapter

    This activity retrieves an existing Virtual Network Adapter based on the filters you specify.

    Activity Parameters

    The VM Get Network Adapter activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Parameters:

    • VM Name (text box editor type) (type: string): the name of virtual machine.

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the VM Get Network Adapter activity:

    The Read Only Output variable are the possible output values that the activity will provide:

    • Output  (type: collection<collection<string>>): outputs the address of the resource. For example, the MAC address of a Ethernet port.
    • Output MAC Address  (type: string): outputs the address of the resource. For example, the MAC address of a Ethernet port.
     



     

     

    VM Get Status

    This activity retrieves the state and other related information about a virtual machine.

    Activity Parameters

    The VM Get Status activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Parameters:

    • VM Name (text box editor type) (type: string): the name of virtual machine.

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the VM Get Status activity:

    The Read Only Output variable are the possible output values that the activity will provide:

    • Output Status  (type: collection<collection<string>>): outputs the current status of the virtual machine.
     



     

     

    VM Get Virtual Hard Disk

    This activity retrieves information about a virtual hard disk.

    Activity Parameters

    The VM Get Virtual Hard Disk activity parameters can be provided by manual inserted values or via IN arguments or variables:

    Parameters:

    • Path (text box editor type) (type: string): the fully qualified path that specifies the location of the disk image file.

    As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the VM Get Virtual Hard Disk activity:

    The Read Only Output variable are the possible output values that the activity will provide:

    • Output Details  (type: collection<string>): outputs all the information about the virtual hard disk.