HyperV VM Tasks - Cisco · HyperVVMTasks Thischaptercontainsthefollowingsections:...

HyperV VM Tasks

This chapter contains the following sections:

• Add Hyper-V VM Nic, on page 2• Add VM Disk, on page 3• Assign/Unassign VM to SCVMM cloud, on page 4• Clone Hyper-V VM, on page 5• Create Hyper-V VM Snapshot, on page 6• Delete All Hyper-V Snapshots, on page 7• Delete Hyper-V VM, on page 8• Delete Hyper-V VM Snapshot, on page 9• Edit Hyper-V VM Nic, on page 10• Execute Hyper-V VM Power Action, on page 11• HyperV - Provision a VM without VDC, on page 12• Manage Hyper-V Resource Allocation, on page 15• Mark/Unmark Hyper-V Golden snapshot, on page 16• Provision Hyper-V VM , on page 17• Provision basic HyperV VM, on page 19• Remove Hyper-V VM Disk, on page 21• Remove Hyper-V VM Nic, on page 22• Resize CPU and Memory, on page 23• Resize HyperV VM Disk, on page 24• Resync Hyper-V VM, on page 25• Revert Hyper-V VM Snapshot, on page 26

HyperV VM Tasks1

Add Hyper-V VM NicSummary

Add a VM NIC.Description

This task adds a VM NIC. This task is supported for the following versions of SCVMM:

• SCVMM 2012 R2

Inputs

MandatoryMappable To TypeDescriptionInput

YvmSelect the VM on which to performthe action

Select VM

Ygen_text_inputSelect adapter typeAdapter Type

gen_text_inputSelect if need to enable the MACspoofing

Enable MAC Spoofing

YhypervVMNetworkIdentitySelect VM networkVM Network

hypervVMNetworkSubnetIdentity

Select a SubnetSubnet

Select if DHCP is used for VM IPaddress allocation

Use DHCP

hypervPortClassificationIdentity

Select Port ClassificationPort Classification

Outputs

TypeDescriptionOutput

vmID of the VMOUTPUT_VM_ID

hypervVMNicIdentityVM Nic IdentityOUTPUT_VM_NIC_IDENTITY

HyperV VM Tasks2

HyperV VM TasksAdd Hyper-V VM Nic

Add VM DiskSummary

Create a new disk for a VM.Description

This task adds disks to an existing VM. You can configure the size, type and adapters of the disk. Diskscan be only be attached to SCSI adapters.

Inputs


YvmSelect the VM on which to perform theaction

Select VM

Ygen_text_inputSpecify the name of the Virtual HardDisk to Add

Disk Name

gen_text_inputSelect the diskDisk

Ygen_text_inputSelect the SCSI controllerSCSI Controller

Ygen_text_inputSelect whether the disk size is fixed ordynamic in nature

Type

Ygen_text_inputSelect the size of the disk in GBSize (GB)

Ygen_text_inputChoose Virtual Hard diskChoose Virtual HardDisk

Outputs


gen_text_inputName of the DiskOUTPUT_HYPERV_VM_DISK


HyperV VM Tasks3

HyperV VM TasksAdd VM Disk

Assign/Unassign VM to SCVMM cloudSummary

Assign or unassign a VM to or from an SCVMM cloud.Description

This task assigns or unassigns a VM to or from an SCVMMcloud. This task is supported for the followingversions of SCVMM:

• SCVMM 2012 R2

Inputs


YAssign VM to cloudAssign VM to cloud

YvmSelect the VM onwhich to performthe action

Select VM

hypervSCVMMCloudIdentity

Specify SCVMM CloudSelect SCVMM Cloud

Outputs




SCVMM Cloud IdentityOUTPUT_SCVMM_CLOUD_IDENTITY

HyperV VM Tasks4

HyperV VM TasksAssign/Unassign VM to SCVMM cloud

Clone Hyper-V VMSummary

Clone a VM.Description

This task clones a VM. This task is supported for the following versions of SCVMM:

• SCVMM 2012 R2

Inputs


YvmSelect VMSelect VM

Ycuic_multi_user_group_IDSelect GroupsSelect Groups

YapplicationCategorySelect a vDC CategoryCategory

hyperVVMAppChargeFrequency

Select VM App ChargeFrequency

VMAppCharge Frequency

gen_text_inputEnter Active VM ApplicationCost

Active VM ApplicationCost

gen_text_inputEnter In Active VMApplicationCost

Inactive VM ApplicationCost

YvDCSelect VDCSelect VDC

gen_text_inputEnter VM Name or VM PrefixVM Name or VM Prefix

gen_text_inputEnter CommentComment

YprovisionPeriodSelect ProvisionProvision

Ydateselect DateProvision Time

YBooleanEnter Lease TimeLease Time

Ygen_text_inputEnter DaysDays

Ygen_text_inputEnter HoursHours

YhyperVDatastoreIdentitySelect DatastoreSelect DataStore

Add one or more networksVM Networks

Outputs


gen_text_inputRest SR IDOUTPUT_SR_ID

gen_text_inputCloud NameOUTPUT_CLOUD_NAME

HyperV VM Tasks5

HyperV VM TasksClone Hyper-V VM

Create Hyper-V VM SnapshotSummary

Create a VM Snapshot.Description

This task creates a snapshot of a VM.Inputs


YvmSelect the VM for which snapshotneed to be created

Select VM

Ygen_text_inputName of the snapshotSnapshot Name

gen_text_inputDescriptionDescription

Outputs


gen_text_inputID of the SnapshotOUTPUT_SNAPSHOT


HyperV VM Tasks6

HyperV VM TasksCreate Hyper-V VM Snapshot

Delete All Hyper-V SnapshotsSummary

Delete all the snapshots of a VM.Description

This task deletes all the snapshots of a VM.Inputs



Select VM

Outputs

No Outputs

HyperV VM Tasks7

HyperV VM TasksDelete All Hyper-V Snapshots

Delete Hyper-V VMSummary

Delete a Hyperv VM.Description

This task deletes and archives a HyperV VM.Inputs


YvmSelect the VM to be deletedSelect VM

Outputs



HyperV VM Tasks8

HyperV VM TasksDelete Hyper-V VM

Delete Hyper-V VM SnapshotSummary

Delete a VM Snapshot.Description

This task deletes a snapshot of a VM.Inputs


YvmSelect the VM for which snapshotneed to be created

Select VM

YsnapshotList of snapshotsSelect Snapshot

Outputs

No Outputs

HyperV VM Tasks9

HyperV VM TasksDelete Hyper-V VM Snapshot

Edit Hyper-V VM NicSummary

Edit a VM NIC.Description

This task edits a VM NIC. This task is supported for the following versions of SCVMM:

• SCVMM 2012 R2

Inputs


YvmSelect the VMonwhich to performthe action

Select VM

YhypervVMNicIdentitySelect VM NicSelect VM Nic

Ygen_text_inputSelect adapter typeAdapter Type

gen_text_inputSelect if need to enable the MACspoofing

Enable MAC Spoofing

YhypervVMNetworkIdentitySelect VM networkVM Network

hypervVMNetworkSubnetIdentity

Select a SubnetSubnet

Select if DHCP is used for VM IPaddress allocation

Use DHCP

hypervPortClassificationIdentity

Select Port ClassificationPort Classification

Outputs




HyperV VM Tasks10

HyperV VM TasksEdit Hyper-V VM Nic

Execute Hyper-V VM Power ActionSummary

Perform a power action on the HyperV instance.Description

This task is used to perform the power actions on the HyperV instance like Power On, Off, Pause, Resume,Reboot, Archive, Restore, Shutdown, Terminate.

Inputs


YvmSelect the VM on which toperform the action

Select Instance

YhypervVMPowerActionsVM ActionVM Action

Outputs

No Outputs

HyperV VM Tasks11

HyperV VM TasksExecute Hyper-V VM Power Action

HyperV - Provision a VM without VDCSummary

Provision a HyperV VM without VDC policies and CatalogDescription

This task provisions a new HyperV VMwithout VDC policies and Catalog.It helps to provision the VMby giving parameters required to provision the VM directly. Note: This task is not intended for publishingto the service end user

Inputs

MandatoryMappableToType

DescriptionInput

Ygen_text_input

VM Name or VM PrefixVM Name or VMPrefix

Yhyperv_image_identity

VM Image to provision VMSelect Image


Specify SCVMM CloudSelect SCVMMCloud

BooleanEnable Guest CustomizationEnable GuestCustomization

gen_text_input

Host Name TemplateHost NameTemplate

hypervTimeZone

Select time zoneTime Zone

gen_text_input

Comma separated list of GUI run once commandsGUI Run OnceCommands

hypervVMImageType

Select a VM image typeVM Image Type

Linux Parameters

passwordRoot PasswordRoot Password

gen_text_input

DNS Domain NameDNS DomainName

WindowsParameters

gen_text_input

Enter product IDProduct ID

gen_text_input

Enter usernameUsername

HyperV VM Tasks12

HyperV VM TasksHyperV - Provision a VM without VDC


DescriptionInput

passwordEnter administrator passwordAdministratorPassword

gen_text_input

Enter organization NameOrganizationName

gen_text_input

Full NameFull Name

hypervDomainList

Domain/WorkgroupDomain/Workgroup

gen_text_input

DomainDomain

gen_text_input

Domain UsernameDomain Username

passwordDomain PasswordDomain Password

gen_text_input

WorkgroupWorkgroup

gen_text_input

Enter the VMNics with comma (,) separated in specifictext format - [NIC Alias]@[Adapter Type]@[VMNetwork]@[VM Subnet]@[VLAN Id]@[Is

VM Nics

MACSpoofingEnabled]@[IsDHCPEnabled]@[StaticIP Pool Id]@[PortClassification] Ex -NIC1@Synthetic@CFD_VM_Network_NoIsolation@@66@false@true@@@,NIC2@Synthetic@VM_Network_VLAN@@false@SCVMM-38-2k16;VLANNetworkIPPool;6ae309d0-accf-424b-ae15-d7e691dcdd31@Highbandwidth

YhypervScopeSelectionType

Select the Host Node/Cluster scopeHost Node/Cluster

hypervHostselect the host node on which VM should be provisionedHost

YhyperVDatastoreIdentity

Select datastoreDatastore

gen_text_input

Number of vCPUsNumberOf vCPUs

YBooleanMemory ConfigurationEnable DynamicMemory

gen_text_input

Memory (MB)Memory (MB)

gen_text_input

Memory (MB)Startup Memory(MB)

HyperV VM Tasks13



DescriptionInput

gen_text_input

Memory (MB)MaximumMemory(MB)

gen_text_input

Memory (MB)Memory Buffer(%)

gen_text_input

Memory WeightMemory Weight

gen_text_input

Custom Disk Size (GB)Custom Disk Size(GB)

gen_text_input

Wait for network to be up for a specified amount ofminutes (at the most)

Max Wait forNetwork (mins)

BooleanEnable this option to power the VM after deploymentPower On AfterDeploy

Outputs





gen_text_inputVM NameOUTPUT_VM_NAME

gen_text_inputVM TypeOUTPUT_VM_TYPE

gen_text_inputVM IP AddressOUTPUT_VM_IP_ADDRESS

crendentialOptionsCredential optionsOUTPUT_CREDENTIAL_OPTIONS

gen_text_inputUsernameOUTPUT_CREDENTIAL_USERNAME

passwordPasswordOUTPUT_CREDENTIAL_PASSWORD

gen_text_inputVM Deployment StatusOUTPUT_VM_DEPLOYMENT_STATUS

HyperV VM Tasks14


Manage Hyper-V Resource AllocationSummary

Perform resource allocation on a HyperV VM for a given catalog and vDC.Description

This task identifies hosts and datastores with which to provision a VM, given a catalog and vDC.Inputs


YcatalogSelect CatalogSelect Catalog

YvDCSelect vDCSelect vDC

Outputs


gen_text_inputPrimary Host NodeOUTPUT_HYPERV_PRIMARY_HOST_NAME

gen_text_inputSecondary Host NodeOUTPUT_HYPERV_SECONDARY_HOST_NAME

gen_text_inputPrimary DatastoreOUTPUT_HYPERV_PRIMARY_DATASTORE

gen_text_inputSecondary DatastoreOUTPUT_HYPERV_SECONDARY_DATASTORE

HyperV VM Tasks15

HyperV VM TasksManage Hyper-V Resource Allocation

Mark/Unmark Hyper-V Golden snapshotSummary

Mark a snapshot as a golden snapshot.Description

This task marks or unmarks a snapshot as a golden snapshot. A golden snapshot cannot be deleted. Tobe removed, a golden snapshot must be marked as a regular snapshot, then deleted. The output of thistask is the name of the snapshot that was marked (or unmarked).

Inputs



Select VM


BooleanMark or Unmark the selected snapshotas golden snapshot.

Mark As GoldenSnapshot

Outputs

No Outputs

HyperV VM Tasks16

HyperV VM TasksMark/Unmark Hyper-V Golden snapshot

Provision Hyper-V VMSummary

Provision a Hyper-V VM. The host and datastore inputs must be allocated before running this task.Description

This task provisions a Hyper-V VM. The task's host and datastore inputs must be allocated before thetask runs. The task does not validate these resources, and fails if they are not properly allocated andconnected. If you provide both primary and alternate (secondary) resources, the task selects the appropriateresource based on preference rating. To allocate resources in a workflow, see the "Manage Hyper-VResource Allocation" task, which selects optimal primary and secondary hosts and datastores from avDC.

Inputs


YSelect name of the HyperV Cloudin this system

Select HyperV Cloud

YcatalogSelect Catalog on which to performthe action

Select Catalog

YvDCSelect vDC on which to performthe action

Select vDC

gen_text_inputVM Name or VM PrefixVM Name or VM Prefix

gen_text_inputSelect Primary hostSelect Primary Host

gen_text_inputSelect Primary DatastoreSelect Primary Datastore

gen_text_inputSelect Alternate hostSelect Alternate Host

gen_text_inputSelect Alternate DatastoreSelect Alternate Datastore

gen_text_inputEnable High AvailabilityEnable High Availability

vCPUCountNumber of vCPUsNumber of vCPUs

gen_text_inputEnable Dynamic MemoryEnable Dynamic Memory

memSizeMBMemoryMemory

gen_text_inputStartup Memory in MBStartup memory(MB)

gen_text_inputMaximum Memory in MBMaximum memory(MB)

gen_text_inputMemory Buffer(%)Memory Buffer(%)

gen_text_inputMemory WeightMemory Weight

gen_text_inputSelect disk sizeDisk

Wait for network to be up for aspecified amount of minutes (at themost)

MaxWait for Network (mins)

HyperV VM Tasks17

HyperV VM TasksProvision Hyper-V VM

Outputs




HyperV VM Tasks18

HyperV VM TasksProvision Hyper-V VM

Provision basic HyperV VMSummary

Provision a HyperV VM.Description

This task provisions a new VM in selected HyperV cloud using parameters defined in the task.Inputs


Ygen_text_inputSelect name of the HyperVCloud in this system

Select HyperV Cloud


Specify SCVMM CloudSelect SCVMM Cloud

gen_text_inputVM Name or VM PrefixVM Name or VM Prefix

Yhyperv_image_lovVM Image to provision VMSelect Image

YuserGroupSelect GroupSelect Group

YhypervDeploymentPolicyIdentity

Select the system policySelect System Policy

Add one or more NICsVM Nic(s)

YhypervHostSelect Primary hostSelect Primary Host

YhyperVDatastoreIdentitySelect Primary DatastoreSelect Primary Datastore

hypervHostSelect Alternate hostSelect Alternate Host

hyperVDatastoreIdentitySelect Alternate DatastoreSelect Alternate Datastore

gen_text_inputEnable High AvailabilityEnable High Availability

vCPUCountNumber of vCPUsNumber of vCPUs

gen_text_inputEnable Dynamic MemoryEnable Dynamic Memory

memSizeMBMemoryMemory

memSizeMBStartup Memory in MBStartup memory(MB)

memSizeMBMaximum Memory in MBMaximum memory(MB)

MemBufferListProviderMemory Buffer(%)Memory Buffer(%)

MemWeightListProviderMemory WeightMemory Weight

diskSizeGBSelect disk sizeDisk

MaxWaitForNetworkListWait for network to be up for aspecified amount of minutes (atthe most)

Max Wait for Network(mins)

EnableGuestCustomizationEnable Guest CustomizationEnable Guest Customization

crendentialOptionsSelect Credential OptionsSelect Credential Options

HyperV VM Tasks19

HyperV VM TasksProvision basic HyperV VM

Outputs





gen_text_inputVM NameOUTPUT_VM_NAME

gen_text_inputVM TypeOUTPUT_VM_TYPE

gen_text_inputVM IP AddressOUTPUT_VM_IP_ADDRESS

crendentialOptionsCredential optionsOUTPUT_CREDENTIAL_OPTIONS

gen_text_inputUsernameOUTPUT_CREDENTIAL_USERNAME

passwordPasswordOUTPUT_CREDENTIAL_PASSWORD

gen_text_inputVM Deployment StatusOUTPUT_VM_DEPLOYMENT_STATUS

HyperV VM Tasks20

HyperV VM TasksProvision basic HyperV VM

Remove Hyper-V VM DiskSummary

Remove a VM Disk.Description

This task removes a VM disk. Only disks attached to SCSI adapters can be removed.Inputs



Select VM

Ygen_text_inputSpecify the name of the Virtual Hard Diskto Remove

Disk Name

Outputs

No Outputs

HyperV VM Tasks21

HyperV VM TasksRemove Hyper-V VM Disk

Remove Hyper-V VM NicSummary

Remove a VM NIC.Description

This task removes a VM NIC. This task is supported for the following versions of SCVMM:

• SCVMM 2012 R2

Inputs


YvmSelect the VMonwhich to performthe action

Select VM

YhypervVMNicIdentitySelect VM NicSelect VM Nic

Outputs




HyperV VM Tasks22

HyperV VM TasksRemove Hyper-V VM Nic

Resize CPU and MemorySummary

Reconfigure the memory and CPU of a virtual machine.Description

This task modifies a VM's memory and CPU.Inputs


YvmSelect the VMSelect VM

gen_text_inputNumber of CPUsCPU Count

Enable Dynamic Memory.Enable Dynamic Memory

Ygen_text_inputMemory in MBMemory (MB)

Ygen_text_inputStartup memory in MBStartup memory (MB)

Ygen_text_inputMaximum memory in MBMaximum memory (MB)

Ygen_text_inputMemory buffer(%)Memory buffer(%)

gen_text_inputMemory WeightMemory Weight

Outputs

No Outputs

HyperV VM Tasks23

HyperV VM TasksResize CPU and Memory

Resize HyperV VM DiskSummary

Resize a disk on a VM.Description

This task resizes a VM's disk.Inputs


YvmSelect the VM for which to beresized

Select VM

Ygen_text_inputVM DiskSelect Disk

gen_text_inputVM DiskCurrent Disk Size (GB)

Ygen_text_inputNew Disk Size of the VMNew Disk Size (GB)

Outputs



HyperV VM Tasks24

HyperV VM TasksResize HyperV VM Disk

Resync Hyper-V VMSummary

Collect inventory of a VM.Description

This task inventories a VM. The task refreshes the parameters of a VM, including memory, ipaddress,and snapshots.

Inputs

MandatoryMappable ToType

DescriptionInput


Select VM

YMax Wait Time in minutesMax Wait Time (minutes)

Outputs


gen_text_inputVMID of the Selected VMVM_ID

gen_text_inputName of the Selected VMVM_NAME

accountNameAccount Name of the Selected VMVM_ACCOUNTNAME

ipaddressPrimary IP Address of the VMVM_PRIMARYIP

vmHostHost of the Selected VMVM_HOST

gen_text_inputStatus the VMVM_STATUS

gen_text_inputNumber of NICS on the VMVM_NUM_NICS

HyperV VM Tasks25

HyperV VM TasksResync Hyper-V VM

Revert Hyper-V VM SnapshotSummary

Revert a VM snapshot.Description

This task reverts a snapshot of a VM.Inputs


YvmSelect the VM for which snapshotneed to be reverted

Select VM


Outputs


gen_text_inputID of the SnapshotOUTPUT_SNAPSHOT


HyperV VM Tasks26

HyperV VM TasksRevert Hyper-V VM Snapshot

HyperV VM Tasks - Cisco · HyperVVMTasks Thischaptercontainsthefollowingsections:...

Documents

Transcript of HyperV VM Tasks - Cisco · HyperVVMTasks Thischaptercontainsthefollowingsections:...