Resource Type: dsc_xvmswitch

Defined in:
lib/puppet/type/dsc_xvmswitch.rb
Providers:
powershell

Overview

The DSC xVMSwitch resource type. Automatically generated from ‘xHyper-V/DSCResources/MSFT_xVMSwitch/MSFT_xVMSwitch.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

  • ensure

    The basic property that the resource should be in.

    Supported values:
    • exists?
    • present
    • absent

Parameters

  • dsc_allowmanagementos

    AllowManagementOS - Specify if the VM host has access to the physical NIC

    Supported values:
    • true
    • false
  • dsc_bandwidthreservationmode

    BandwidthReservationMode - Type of Bandwidth Reservation Mode to use for the switch Valid values are Default, Weight, Absolute, None, NA.

  • dsc_enableembeddedteaming

    EnableEmbeddedTeaming - Should embedded NIC teaming be used (Windows Server 2016 only)

    Supported values:
    • true
    • false
  • dsc_ensure

    Ensure - Whether switch should be present or absent Valid values are Present, Absent.

  • dsc_id

    Id - Unique ID for the switch

  • dsc_loadbalancingalgorithm

    LoadBalancingAlgorithm - Specifies the load balancing algorithm that this switch team uses Valid values are Dynamic, HyperVPort.

  • dsc_name

    Name - Name of the VM Switch

  • dsc_netadapterinterfacedescription

    NetAdapterInterfaceDescription - Description of the network interface

  • dsc_netadaptername

    NetAdapterName - Network adapter name(s) for external switch type

  • dsc_psdscrunascredential

    PsDscRunAsCredential

  • dsc_type

    Type - Type of switch Valid values are External, Internal, Private.

  • name (namevar)
  • provider

    The specific backend to use for this ‘dsc_xvmswitch` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.