Resource Type: dsc_xnetadaptername

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

Overview

The DSC xNetAdapterName resource type. Automatically generated from ‘xNetworking/DSCResources/MSFT_xNetAdapterName/MSFT_xNetAdapterName.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

Parameters

  • dsc_driverdescription

    DriverDescription - This is the driver description of the network adapter.

  • dsc_ignoremultiplematchingadapters

    IgnoreMultipleMatchingAdapters - This switch will suppress an error occurring if more than one matching adapter matches the parameters passed.

    Supported values:
    • true
    • false
  • dsc_interfacedescription

    InterfaceDescription - This is the interface description of the network adapter to find.

  • dsc_interfaceguid

    InterfaceGuid - This is the interface GUID of the network adapter to find.

  • dsc_interfaceindex

    InterfaceIndex - This is the interface index of the network adapter to find.

  • dsc_interfacenumber

    InterfaceNumber - This is the interface number of the network adapter if more than one are returned by the parameters.

  • dsc_macaddress

    MacAddress - This is the MAC address of the network adapter to find.

  • dsc_name

    Name - This is the name of the network adapter to find.

  • dsc_newname

    NewName - Specifies the new name of the network adapter.

  • dsc_physicalmediatype

    PhysicalMediaType - This is the media type of the network adapter to find.

  • dsc_psdscrunascredential

    PsDscRunAsCredential

  • dsc_status

    Status - This is the status of the network adapter to find. Valid values are Up, Disconnected, Disabled.

  • name (namevar)
  • provider

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