Skip to content

IT-Service/xITGHyperV

 
 

Repository files navigation

xITGHyperV

The xITGHyperV module based on xHyper-V and contains DSC resources for deployment and configuration of virtual machines and related resources.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ.

Branches

master

Build status codecov

This is the branch containing the latest release - no contributions should be made directly to this branch.

develop

Build status codecov

This is the development branch to which contributions should be proposed by contributors as pull requests. This development branch will periodically be merged to the master branch, and be released to PowerShell Gallery.

Contributing

Please check out common DSC Resources contributing guidelines.

Change log

A full list of changes in each version can be found in the change log.

Resources

xVMLegacyNetworkAdapter

Manages legacy VM Network adapters attached to a Hyper-V virtual machine.

Requirements for xVMLegacyNetworkAdapter

  • The Hyper-V Role has to be installed on the machine.
  • The Hyper-V PowerShell module has to be installed on the machine.

Parameters for xVMLegacyNetworkAdapter

  • [String] Id (Key): Unique string for identifying the resource instance.
  • [String] Name (Required): Name of the network adapter as it appears either in the management OS or attached to a VM.
  • [String] SwitchName (Required): Virtual Switch name to connect to.
  • [String] VMName (Required): Name of the VM to attach to. If you want to attach new VM Network adapter to the management OS, set this property to 'Management OS'.
  • [String] MacAddress (Write): Use this to specify a Static MAC Address. If this parameter is not specified, dynamic MAC Address will be set.
  • [String] Ensure (Write): Ensures that the VM Network Adapter is Present or Absent. The default value is Present. { Present | Absent }.

Read-Only Properties from Get-TargetResource for xVMLegacyNetworkAdapter

  • [Boolean] DynamicMacAddress (Read): Does the VM Network Adapter use a Dynamic MAC Address.

Examples

xVMNonLegacyNetworkAdapter

Manages non legacy VM Network adapters attached to a Hyper-V virtual machine.

Requirements for xVMNonLegacyNetworkAdapter

  • The Hyper-V Role has to be installed on the machine.
  • The Hyper-V PowerShell module has to be installed on the machine.

Parameters for xVMNonLegacyNetworkAdapter

  • [String] Id (Key): Unique string for identifying the resource instance.
  • [String] Name (Required): Name of the network adapter as it appears either in the management OS or attached to a VM.
  • [String] SwitchName (Required): Virtual Switch name to connect to.
  • [String] VMName (Required): Name of the VM to attach to. If you want to attach new VM Network adapter to the management OS, set this property to 'Management OS'.
  • [String] MacAddress (Write): Use this to specify a Static MAC Address. If this parameter is not specified, dynamic MAC Address will be set.
  • [String] Ensure (Write): Ensures that the VM Network Adapter is Present or Absent. The default value is Present. { Present | Absent }.

Read-Only Properties from Get-TargetResource for xVMNonLegacyNetworkAdapter

  • [Boolean] DynamicMacAddress (Read): Does the VM Network Adapter use a Dynamic MAC Address.

Examples

xVMComPort

Manages VM serial ports attached to a Hyper-V virtual machine.

Requirements for xVMComPort

  • The Hyper-V Role has to be installed on the machine.
  • The Hyper-V PowerShell module has to be installed on the machine.

Parameters for xVMComPort

  • [String] Id (Key): Unique string for identifying the resource instance.
  • [String] VMName (Required): Name of the VM to attach to.
  • [UInt16] Number (Required): serial port number.
  • [String] Path (Write): named pipe path or empty string. If this parameter is not specified, serial port detached from any named pipes.
  • [String] Ensure (Write): Ensures that the VM serial port is Present or Absent. The default value is Present. { Present | Absent }. Now supported only Present.

Examples

About

Hyper-V DSC Resources

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PowerShell 100.0%