Version information
This version is compatible with:
- Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x
- Puppet >= 6.0.0 < 8.0.0
Start using this module
Add this module to your Puppetfile:
mod 'dsc-networkingdsc', '7.4.0-0-2'
Learn more about managing modules with a PuppetfileDocumentation
networkingdsc
Table of Contents
Description
This is an auto-generated module, using the Puppet DSC Builder to vendor and expose the networkingdsc PowerShell module's DSC resources as Puppet resources. The functionality of this module comes entirely from the vendored PowerShell resources, which are pinned at v7.4.0.0. The PowerShell module describes itself like this:
Module with DSC Resources for Networking area
For information on troubleshooting to determine whether any encountered problems are with the Puppet wrapper or the DSC resource, see the troubleshooting section below.
Requirements
This module, like all auto-generated Puppetized DSC modules, relies on two important technologies in the Puppet stack: the Puppet Resource API and the puppetlabs/pwshlib Puppet module.
The Resource API provides a simplified option for writing types and providers and is responsible for how this module is structured. The Resource API ships inside of Puppet starting with version 6. While it is technically possible to add the Resource API functionality to Puppet 5.5.x, the DSC functionality has not been tested in this setup. For more information on the Resource API, review the documentation.
The module also depends on the pwshlib module. This Puppet module includes two important things: the ruby-pwsh library for running PowerShell code from ruby and the base provider for DSC resources, which this module leverages.
All of the actual work being done to call the DSC resources vendored with this module is in this file from the pwshlib module. This is important for troubleshooting and bug reporting, but doesn't impact your use of the module except that the end result will be that nothing works, as the dependency is not installed alongside this module!
Long File Path Support
Several PowerShell modules with DSC Resources end up with very long file paths once vendored, many of which exceed the 260 character limit for file paths. Luckily in Windows 10 (build 1607+), Windows Server 2016 (build 1607+), and Windows Server 2019 there is now an option for supporting long file paths transparently!
We strongly recommend enabling long file path support on any machines using this module to avoid path length issues.
You can set this value using the Puppet registry_value
resource:
registry_value { 'HKLM\System\CurrentControlSet\Control\FileSystem\LongPathsEnabled':
ensure => 'present',
data => [1],
provider => 'registry',
type => 'dword',
}
You can also set this value outside of Puppet by following the Microsoft documentation.
Usage
You can specify any of the DSC resources from this module like a normal Puppet resource in your manifests. The examples below use DSC resources from from the PowerShellGet repository, regardless of what module you're looking at here; the syntax, not the specifics, is what's important.
For reference documentation about the DSC resources exposed in this module, see the Reference Forge tab, or the REFERENCE.md file.
# Include a meaningful title for your resource declaration
dsc_psrepository { 'Add team module repo':
dsc_name => 'foo',
dsc_ensure => present,
# This location is nonsense, can be any valid folder on your
# machine or in a share, any location the SourceLocation param
# for the DSC resource will accept.
dsc_sourcelocation => 'C:\Program Files',
# You must always pass an enum fully lower-cased;
# Puppet is case sensitive even when PowerShell isn't
dsc_installationpolicy => untrusted,
}
dsc_psrepository { 'Trust public gallery':
dsc_name => 'PSGallery',
dsc_ensure => present,
dsc_installationpolicy => trusted,
}
dsc_psmodule { 'Make Ruby manageable via uru':
dsc_name => 'RubyInstaller',
dsc_ensure => present,
}
Credentials
Credentials are always specified as a hash of the username and password for the account. The password must use the Puppet Sensitive type; this ensures that logs and reports redact the password, displaying it instead as <Sensitive [value redacted]>.
dsc_psrepository { 'PowerShell Gallery':
dsc_name => 'psgAllery',
dsc_installationpolicy => 'Trusted',
dsc_psdscrunascredential => {
user => 'apple',
password => Sensitive('foobar'),
},
}
CIM Instances
Because the CIM instances for DSC resources are fully mapped, the types actually explain fairly precisely what the shape of each CIM instance has to be - and, moreover, the type definition means that you get checking at catalog compile time. Puppet parses CIM instances are structured hashes (or arrays of structured hashes) that explicitly declare their keys and the valid types of values for each key.
So, for the dsc_accesscontrolentry
property of the dsc_ntfsaccessentry
type, which has a MOF type of NTFSAccessControlList[]
, Puppet defines the CIM instance as:
Array[Struct[{
accesscontrolentry => Array[Struct[{
accesscontroltype => Enum['Allow', 'Deny'],
inheritance => Enum['This folder only', 'This folder subfolders and files', 'This folder and subfolders', 'This folder and files', 'Subfolders and files only', 'Subfolders only', 'Files only'],
ensure => Enum['Present', 'Absent'],
cim_instance_type => 'NTFSAccessControlEntry',
filesystemrights => Array[Enum['AppendData', 'ChangePermissions', 'CreateDirectories', 'CreateFiles', 'Delete', 'DeleteSubdirectoriesAndFiles', 'ExecuteFile', 'FullControl', 'ListDirectory', 'Modify', 'Read', 'ReadAndExecute', 'ReadAttributes', 'ReadData', 'ReadExtendedAttributes', 'ReadPermissions', 'Synchronize', 'TakeOwnership', 'Traverse', 'Write', 'WriteAttributes', 'WriteData', 'WriteExtendedAttributes']]
}]],
forceprincipal => Optional[Boolean],
principal => Optional[String],
}]]
A valid example of that in a puppet manifest looks like this:
dsc_accesscontrollist => [
{
accesscontrolentry => [
{
accesscontroltype => 'Allow',
inheritance => 'This folder only',
ensure => 'Present',
filesystemrights => 'ChangePermissions',
cim_instance_type => 'NTFSAccessControlEntry',
},
],
principal => 'veryRealUserName',
},
]
For more information about using a built module, check out our narrative documentation.
Properties
Note that the only properties specified in a resource declaration which are passed to Invoke-Dsc are all prepended with dsc.
If a property does _not start with dsc_ it is used to control how Puppet interacts with DSC/other Puppet resources - for example,
specifying a unique name for the resource for Puppet to distinguish between declarations or Puppet metaparameters (notifies,
before, etc).
Validation Mode
By default, these resources use the property validation mode, which checks whether or not the resource is in the desired state the same way most Puppet resources are validated;
by comparing the properties returned from the system with those specified in the manifest.
Sometimes, however, this is insufficient;
many DSC Resources return data that does not compare properly to the desired state (some are missing properties, others are malformed, some simply cannot be strictly compared).
In these cases, you can set the validation mode to resource
, which falls back on calling Invoke-DscResource
with the Test
method and trusts that result.
When using the resource
validation mode, the resource is tested once and will then treat all properties of that resource as in sync (if the result returned true
) or not in sync.
This loses the granularity of change reporting for the resource but prevents flapping and unexpected behavior.
# This will flap because the DSC resource never returns name in SecurityPolicyDsc v2.10.0.0
dsc_securityoption { 'Enforce Anonoymous SID Translation':
dsc_name => 'Enforce Anonymous SID Translation',
dsc_network_access_allow_anonymous_sid_name_translation => 'Disabled',
}
# This will idempotently apply
dsc_psrepository { 'PowerShell Gallery':
validation_mode => 'resource',
dsc_name => 'Enforce Anonymous SID Translation',
dsc_network_access_allow_anonymous_sid_name_translation => 'Disabled',
}
It is important to note that this feature is only supported with a version of puppetlabs-pwshlib
equal to or higher than 0.9.0
, in which the supporting code for the DSC Base Provider to implement custom insync was shipped.
Finally, while this module's metadata says that the supported Puppet versions are 6.0.0 and up, the implementation of the validation_mode
parameter relies on the custom_insync
feature of the Puppet Resource API.
The custom_insync
feature first shipped in the puppet-resource_api
version 1.8.14
, which itself is only included in Puppet versions equal to or newer than 6.23.0
and 7.8.0
for the 6x and 7x platforms respectively.
Using this module against older Puppet versions will result in a warning (example below) and only use the default property-by-property change reporting, regardless of the setting of validation_mode
.
Warning: Unknown feature detected: ["custom_insync"]
Troubleshooting
In general, there are three broad categories of problems:
- Problems with the way the underlying DSC resource works.
- Problems with the type definition, where you can't specify a valid set of properties for the DSC resource
- Problems with calling the underlying DSC resource - the parameters aren't being passed correctly or the resource can't be found
Unfortunately, problems with the way the underlying DSC resource works are something we can't help directly with. You'll need to file an issue with the upstream maintainers for the PowerShell module.
Problems with the type definition are when a value that should be valid according to the DSC resource's documentation and code is not accepted by the Puppet wrapper. If and when you run across one of these, please file an issue with the Puppet DSC Builder; this is where the conversion happens and once we know of a problem we can fix it and regenerate the Puppet modules. To help us identify the issue, please specify the DSC module, version, resource, property and values that are giving you issues. Once a fix is available we will regenerate and release updated versions of this Puppet wrapper.
Problems with calling the underlying DSC resource become apparent by comparing <value passed in in puppet>
with <value received by DSC>
.
In this case, please file an issue with the puppetlabs/pwshlib module, which is where the DSC base provider actually lives.
We'll investigate and prioritize a fix and update the puppetlabs/pwshlib module.
Updating to the pwshlib version with the fix will immediately take advantage of the improved functionality without waiting for this module to be reconverted and published.
For specific information on troubleshooting a generated module, check the troubleshooting guide for the puppet.dsc module.
Known Limitations
Currently, because of the way Puppet caches files on agents, use of the legacy puppetlabs-dsc
module is not compatible with this or any auto-generated DSC module.
Inclusion of both will lead to pluginsync conflicts.
Configuring the LCM
In order for a Puppetized DSC module to function, the DSC Local Configuration Manager (LCM) RefreshMode
must be set to either Push
or Disabled
.
The default value for RefreshMode
in WMF 5.0 and WMF 5.1 is Push
- so if it has not been set to anything else then there is no action needed on your part.
However if the value of the LCM has been set to anything other than Push
then the module will not function and so the value must either be changed back or disabled.
The Puppetized DSC modules use the Invoke-DscResource
cmdlet to invoke DSC Resources of the target machine.
If the RefreshMode
is set to Pull
, DSC Resources will only run from a DSC Pull Server - in this setting DSC does not allow any DSC Resources to be run interactively on the host.
Module Installation
If you're using this module with Puppet Enterprise and Code Manager, everything should "just work" - no errors or issues acquiring and deploying this or any Puppetized DSC module to nodes.
Unfortunately, due a bug in minitar which prevents it from unpacking archives with long file paths, both r10k
and serverless Puppet (via puppet module install
) methods of installing modules with long path names will fail.
In short, minitar is unable to unpack modules that contain long file paths (though it can create them).
As a workaround, you can retrieve DSC modules from the forge via PowerShell and 7zip:
$ModuleAuthor = 'dsc'
$ModuleName = 'xremotedesktopsessionhost'
$ModuleVersion = '2.0.0-0-1'
$ArchiveFileName = "$ModuleAuthor-$ModuleName-$ModuleVersion.tar.gz"
$DownloadUri = "https://forge.puppet.com/v3/files/$ArchiveFileName"
# Download the module tar.gz to the current directory
Invoke-WebRequest -Uri $DownloadUri -OutFile ./$ArchiveFileName
# Use 7zip to extract the module to the current directory
& 7z x $ArchiveFileName -so | & 7z x -aoa -si -ttar
Reference
Table of Contents
Resource types
dsc_defaultgatewayaddress
: The DSC DefaultGatewayAddress resource type. Automatically generated from version 7.4.0.0dsc_dnsclientglobalsetting
: The DSC DnsClientGlobalSetting resource type. Automatically generated from version 7.4.0.0dsc_dnsconnectionsuffix
: The DSC DnsConnectionSuffix resource type. Automatically generated from version 7.4.0.0dsc_dnsserveraddress
: The DSC DnsServerAddress resource type. Automatically generated from version 7.4.0.0dsc_firewall
: The DSC Firewall resource type. Automatically generated from version 7.4.0.0dsc_firewallprofile
: The DSC FirewallProfile resource type. Automatically generated from version 7.4.0.0dsc_hostsfile
: The DSC HostsFile resource type. Automatically generated from version 7.4.0.0dsc_ipaddress
: The DSC IPAddress resource type. Automatically generated from version 7.4.0.0dsc_ipaddressoption
: The DSC IPAddressOption resource type. Automatically generated from version 7.4.0.0dsc_netadapteradvancedproperty
: The DSC NetAdapterAdvancedProperty resource type. Automatically generated from version 7.4.0.0dsc_netadapterbinding
: The DSC NetAdapterBinding resource type. Automatically generated from version 7.4.0.0dsc_netadapterlso
: The DSC NetAdapterLso resource type. Automatically generated from version 7.4.0.0dsc_netadaptername
: The DSC NetAdapterName resource type. Automatically generated from version 7.4.0.0dsc_netadapterrdma
: The DSC NetAdapterRdma resource type. Automatically generated from version 7.4.0.0dsc_netadapterrsc
: The DSC NetAdapterRsc resource type. Automatically generated from version 7.4.0.0dsc_netadapterrss
: The DSC NetAdapterRss resource type. Automatically generated from version 7.4.0.0dsc_netadapterstate
: The DSC NetAdapterState resource type. Automatically generated from version 7.4.0.0dsc_netbios
: The DSC NetBios resource type. Automatically generated from version 7.4.0.0dsc_netconnectionprofile
: The DSC NetConnectionProfile resource type. Automatically generated from version 7.4.0.0dsc_netipinterface
: The DSC NetIPInterface resource type. Automatically generated from version 7.4.0.0dsc_networkteam
: The DSC NetworkTeam resource type. Automatically generated from version 7.4.0.0dsc_networkteaminterface
: The DSC NetworkTeamInterface resource type. Automatically generated from version 7.4.0.0dsc_proxysettings
: The DSC ProxySettings resource type. Automatically generated from version 7.4.0.0dsc_route
: The DSC Route resource type. Automatically generated from version 7.4.0.0dsc_waitfornetworkteam
: The DSC WaitForNetworkTeam resource type. Automatically generated from version 7.4.0.0dsc_winsserveraddress
: The DSC WinsServerAddress resource type. Automatically generated from version 7.4.0.0dsc_winssetting
: The DSC WinsSetting resource type. Automatically generated from version 7.4.0.0
Resource types
dsc_defaultgatewayaddress
The DSC DefaultGatewayAddress resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_defaultgatewayaddress
type.
dsc_address
Data type: Optional[String]
The desired default gateway address - if not provided default gateway will be removed.
Parameters
The following parameters are available in the dsc_defaultgatewayaddress
type.
dsc_addressfamily
namevar
Data type: Enum['IPv4', 'IPv6']
IP address family.
dsc_interfacealias
namevar
Data type: String
Alias of the network interface for which the default gateway address is set.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_dnsclientglobalsetting
The DSC DnsClientGlobalSetting resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_dnsclientglobalsetting
type.
dsc_devolutionlevel
Data type: Optional[Integer[0, 4294967295]]
Specifies the number of labels up to which devolution should occur.
dsc_suffixsearchlist
Data type: Optional[Array[String]]
Specifies a list of global suffixes that can be used in the specified order by the DNS client for resolving the IP address of the computer name.
dsc_usedevolution
Data type: Optional[Boolean]
Specifies that devolution is activated.
Parameters
The following parameters are available in the dsc_dnsclientglobalsetting
type.
dsc_issingleinstance
namevar
Data type: Enum['Yes']
Specifies the resource is a single instance, the value must be 'Yes'.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_dnsconnectionsuffix
The DSC DnsConnectionSuffix resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_dnsconnectionsuffix
type.
dsc_connectionspecificsuffix
Data type: String
DNS connection-specific suffix to assign to the network interface.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Ensure that the network interface connection-specific suffix is present or not.
dsc_registerthisconnectionsaddress
Data type: Optional[Boolean]
Specifies that the IP address for this connection is to be registered.
dsc_usesuffixwhenregistering
Data type: Optional[Boolean]
Specifies that this host name and the connection specific suffix for this connection are to be registered.
Parameters
The following parameters are available in the dsc_dnsconnectionsuffix
type.
dsc_interfacealias
namevar
Data type: String
Alias of the network interface for which the DNS server address is set.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_dnsserveraddress
The DSC DnsServerAddress resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_dnsserveraddress
type.
dsc_address
Data type: Optional[Array[String]]
The desired DNS Server address(es). Exclude to enable DHCP.
Parameters
The following parameters are available in the dsc_dnsserveraddress
type.
dsc_addressfamily
namevar
Data type: Enum['IPv4', 'IPv6']
IP address family.
dsc_interfacealias
namevar
Data type: String
Alias of the network interface for which the DNS server address is set.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_validate
Data type: Optional[Boolean]
Requires that the DNS Server addresses be validated if they are updated. It will cause the resource to throw a 'A general error occurred that is not covered by a more specific error code.' error if set to True and specified DNS Servers are not accessible.
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_firewall
The DSC Firewall resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_firewall
type.
dsc_action
Data type: Optional[Enum['NotConfigured', 'Allow', 'Block']]
Allow or Block the supplied configuration.
dsc_authentication
Data type: Optional[Enum['NotRequired', 'Required', 'NoEncap']]
Specifies that authentication is required on firewall rules.
dsc_description
Data type: Optional[String]
Documentation for the Rule.
dsc_direction
Data type: Optional[Enum['Inbound', 'Outbound']]
Direction of the connection.
dsc_displaygroup
Data type: Optional[String]
The current value of the Display Group of the Firewall Rule.
dsc_displayname
Data type: Optional[String]
Localized, user-facing name of the Firewall Rule being created.
dsc_dynamictransport
Data type: Optional[Enum['Any', 'ProximityApps', 'ProximitySharing', 'WifiDirectPrinting', 'WifiDirectDisplay', 'WifiDirectDevices']]
Specifies a dynamic transport.
dsc_edgetraversalpolicy
Data type: Optional[Enum['Block', 'Allow', 'DeferToUser', 'DeferToApp']]
Specifies that matching firewall rules of the indicated edge traversal policy are created.
dsc_enabled
Data type: Optional[Enum['True', 'False']]
Enable or disable the supplied configuration.
dsc_encryption
Data type: Optional[Enum['NotRequired', 'Required', 'Dynamic']]
Specifies that encryption in authentication is required on firewall rules.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Ensure the presence/absence of the resource.
dsc_group
Data type: Optional[String]
Name of the Firewall Group where we want to put the Firewall Rule.
dsc_icmptype
Data type: Optional[Array[String]]
Specifies the ICMP type codes.
dsc_interfacealias
Data type: Optional[Array[String]]
Specifies the alias of the interface that applies to the traffic.
dsc_interfacetype
Data type: Optional[Enum['Any', 'Wired', 'Wireless', 'RemoteAccess']]
Specifies that only network connections made through the indicated interface types are subject to the requirements of this rule.
dsc_localaddress
Data type: Optional[Array[String]]
Specifies that network packets with matching IP addresses match this rule.
dsc_localonlymapping
Data type: Optional[Boolean]
Indicates that matching firewall rules of the indicated value are created.
dsc_localport
Data type: Optional[Array[String]]
Local Port used for the filter.
dsc_localuser
Data type: Optional[String]
Specifies the principals to which network traffic this firewall rule applies.
dsc_loosesourcemapping
Data type: Optional[Boolean]
Indicates that matching firewall rules of the indicated value are created.
dsc_overrideblockrules
Data type: Optional[Boolean]
Indicates that matching network traffic that would otherwise be blocked are allowed.
dsc_owner
Data type: Optional[String]
Specifies that matching firewall rules of the indicated owner are created.
dsc_package
Data type: Optional[String]
Specifies the Windows Store application to which the firewall rule applies.
dsc_platform
Data type: Optional[Array[String]]
Specifies which version of Windows the associated rule applies.
dsc_profile
Data type: Optional[Array[String]]
Specifies one or more profiles to which the rule is assigned.
dsc_program
Data type: Optional[String]
Path and file name of the program for which the rule is applied.
dsc_protocol
Data type: Optional[String]
Specific Protocol for filter. Specified by name, number, or range.
dsc_remoteaddress
Data type: Optional[Array[String]]
Specifies that network packets with matching IP addresses match this rule.
dsc_remotemachine
Data type: Optional[String]
Specifies that matching IPsec rules of the indicated computer accounts are created.
dsc_remoteport
Data type: Optional[Array[String]]
Specific Port used for filter. Specified by port number, range, or keyword
dsc_remoteuser
Data type: Optional[String]
Specifies that matching IPsec rules of the indicated user accounts are created.
dsc_service
Data type: Optional[String]
Specifies the short name of a Windows service to which the firewall rule applies.
Parameters
The following parameters are available in the dsc_firewall
type.
dsc_name
namevar
Data type: String
Name of the Firewall Rule.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_firewallprofile
The DSC FirewallProfile resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_firewallprofile
type.
dsc_allowinboundrules
Data type: Optional[Enum['True', 'False', 'NotConfigured']]
Specifies that the firewall blocks inbound traffic.
dsc_allowlocalfirewallrules
Data type: Optional[Enum['True', 'False', 'NotConfigured']]
Specifies that the local firewall rules should be merged into the effective policy along with Group Policy settings.
dsc_allowlocalipsecrules
Data type: Optional[Enum['True', 'False', 'NotConfigured']]
Specifies that the local IPsec rules should be merged into the effective policy along with Group Policy settings.
dsc_allowunicastresponsetomulticast
Data type: Optional[Enum['True', 'False', 'NotConfigured']]
Allows unicast responses to multi-cast traffic.
dsc_allowuserapps
Data type: Optional[Enum['True', 'False', 'NotConfigured']]
Specifies that traffic from local user applications is allowed through the firewall.
dsc_allowuserports
Data type: Optional[Enum['True', 'False', 'NotConfigured']]
Specifies that traffic is allowed through local user ports.
dsc_defaultinboundaction
Data type: Optional[Enum['Block', 'Allow', 'NotConfigured']]
Specifies how to filter inbound traffic.
dsc_defaultoutboundaction
Data type: Optional[Enum['Block', 'Allow', 'NotConfigured']]
Specifies how to filter outbound traffic.
dsc_disabledinterfacealiases
Data type: Optional[Array[String]]
Specifies a list of interfaces on which firewall settings are excluded.
dsc_enabled
Data type: Optional[Enum['True', 'False', 'NotConfigured']]
Specifies that devolution is activated.
dsc_enablestealthmodeforipsec
Data type: Optional[Enum['True', 'False', 'NotConfigured']]
Enables stealth mode for IPsec traffic.
dsc_logallowed
Data type: Optional[Enum['True', 'False', 'NotConfigured']]
Specifies how to log the allowed packets in the location specified by the LogFileName parameter.
dsc_logblocked
Data type: Optional[Enum['True', 'False', 'NotConfigured']]
Specifies how to log the dropped packets in the location specified by the LogFileName parameter.
dsc_logfilename
Data type: Optional[String]
Specifies the path and filename of the file to which Windows Server writes log entries.
dsc_logignored
Data type: Optional[Enum['True', 'False', 'NotConfigured']]
Specifies how to log the ignored packets in the location specified by the LogFileName parameter.
dsc_logmaxsizekilobytes
Data type: Optional[Integer[0, 18446744073709551615]]
Specifies the maximum file size of the log, in kilobytes. The acceptable values for this parameter are: 1 through 32767.
dsc_notifyonlisten
Data type: Optional[Enum['True', 'False', 'NotConfigured']]
Allows the notification of listening for inbound connections by a service.
Parameters
The following parameters are available in the dsc_firewallprofile
type.
dsc_name
namevar
Data type: Enum['Domain', 'Public', 'Private']
The name of the firewall profile to configure.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_hostsfile
The DSC HostsFile resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_hostsfile
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Specifies if the hosts file entry should be created or deleted.
dsc_ipaddress
Data type: Optional[String]
Specifies the IP Address that should be mapped to the host name.
Parameters
The following parameters are available in the dsc_hostsfile
type.
dsc_hostname
namevar
Data type: String
Specifies the name of the computer that will be mapped to an IP address.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_ipaddress
The DSC IPAddress resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_ipaddress
type.
dsc_ipaddress
Data type: Optional[Array[String]]
The desired IP address, optionally including prefix length using CIDR notation.
dsc_keepexistingaddress
Data type: Optional[Boolean]
Indicates whether or not existing IP addresses on an interface will be retained.
Parameters
The following parameters are available in the dsc_ipaddress
type.
dsc_addressfamily
namevar
Data type: Enum['IPv4', 'IPv6']
IP address family.
dsc_interfacealias
namevar
Data type: String
Alias of the network interface for which the IP address should be set.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_ipaddressoption
The DSC IPAddressOption resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_ipaddressoption
type.
dsc_skipassource
Data type: Optional[Boolean]
Skip as source option of the ip address.
Parameters
The following parameters are available in the dsc_ipaddressoption
type.
dsc_ipaddress
namevar
Data type: String
The target IP address, must already be configured on the system.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_netadapteradvancedproperty
The DSC NetAdapterAdvancedProperty resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_netadapteradvancedproperty
type.
dsc_displayvalue
Data type: Optional[String]
Output Display value of selected RegistryKeyword.
dsc_registryvalue
Data type: String
Specifies the value of the registry keyword.
Parameters
The following parameters are available in the dsc_netadapteradvancedproperty
type.
dsc_networkadaptername
namevar
Data type: String
Specifies the name of the network adapter to set the advanced property for.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_registrykeyword
namevar
Data type: String
Specifies the registry keyword that should be in desired state.
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_netadapterbinding
The DSC NetAdapterBinding resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_netadapterbinding
type.
dsc_currentstate
Data type: Optional[Enum['Enabled', 'Disabled', 'Mixed']]
Returns the current state of the component ID for the Interfaces.
dsc_state
Data type: Optional[Enum['Enabled', 'Disabled']]
Specifies if the component ID for the Interface should be Enabled or Disabled.
Parameters
The following parameters are available in the dsc_netadapterbinding
type.
dsc_componentid
namevar
Data type: String
Specifies the underlying name of the transport or filter in the following form - ms_xxxx, such as ms_tcpip.
dsc_interfacealias
namevar
Data type: String
Specifies the alias of a network interface. Supports the use of '*'.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_netadapterlso
The DSC NetAdapterLso resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_netadapterlso
type.
dsc_protocol
Data type: Enum['V1IPv4', 'IPv4', 'IPv6']
Specifies which protocol to make changes to.
dsc_state
Data type: Boolean
Specifies whether LSO should be enabled or disabled.
Parameters
The following parameters are available in the dsc_netadapterlso
type.
dsc_name
namevar
Data type: String
Specifies the name of network adapter.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_netadaptername
The DSC NetAdapterName resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_netadaptername
type.
dsc_driverdescription
Data type: Optional[String]
This is the driver description of the network adapter.
dsc_ignoremultiplematchingadapters
Data type: Optional[Boolean]
This switch will suppress an error occurring if more than one matching adapter matches the parameters passed.
dsc_interfacedescription
Data type: Optional[String]
This is the interface description of the network adapter to find.
dsc_interfaceguid
Data type: Optional[String]
This is the interface GUID of the network adapter to find.
dsc_interfaceindex
Data type: Optional[Integer[0, 4294967295]]
This is the interface index of the network adapter to find.
dsc_interfacenumber
Data type: Optional[Integer[0, 4294967295]]
This is the interface number of the network adapter if more than one are returned by the parameters.
dsc_macaddress
Data type: Optional[String]
This is the MAC address of the network adapter to find.
dsc_name
Data type: Optional[String]
This is the name of the network adapter to find.
dsc_physicalmediatype
Data type: Optional[String]
This is the media type of the network adapter to find.
dsc_status
Data type: Optional[Enum['Up', 'Disconnected', 'Disabled']]
This is the status of the network adapter to find.
Parameters
The following parameters are available in the dsc_netadaptername
type.
dsc_newname
namevar
Data type: String
Specifies the new name of the network adapter.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_netadapterrdma
The DSC NetAdapterRdma resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_netadapterrdma
type.
dsc_enabled
Data type: Optional[Boolean]
Specifies if the RDMA configuration should be enabled or disabled. Defaults to $true.
Parameters
The following parameters are available in the dsc_netadapterrdma
type.
dsc_name
namevar
Data type: String
Specifies the name of network adapter for which RDMA needs to be configured.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_netadapterrsc
The DSC NetAdapterRsc resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_netadapterrsc
type.
dsc_protocol
Data type: Enum['IPv4', 'IPv6', 'All']
Specifies which protocol to make changes to.
dsc_state
Data type: Boolean
Specifies whether RSC should be enabled or disabled.
dsc_stateipv4
Data type: Optional[String]
Returns the current state of RSC for IPv4
dsc_stateipv6
Data type: Optional[String]
Returns the current state of RSC for IPv6
Parameters
The following parameters are available in the dsc_netadapterrsc
type.
dsc_name
namevar
Data type: String
Specifies the Name of network adapter.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_netadapterrss
The DSC NetAdapterRss resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_netadapterrss
type.
dsc_enabled
Data type: Boolean
Specifies whether RSS should be enabled or disabled.
Parameters
The following parameters are available in the dsc_netadapterrss
type.
dsc_name
namevar
Data type: String
Specifies the Name of network adapter.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_netadapterstate
The DSC NetAdapterState resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_netadapterstate
type.
dsc_state
Data type: Enum['Enabled', 'Disabled']
Specifies the desired state of the network adapter
Parameters
The following parameters are available in the dsc_netadapterstate
type.
dsc_name
namevar
Data type: String
Specifies the name of network adapter.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_netbios
The DSC NetBios resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_netbios
type.
dsc_setting
Data type: Enum['Default', 'Enable', 'Disable']
Specifies if NetBIOS should be enabled or disabled or obtained from the DHCP server (Default). If static IP, Enable NetBIOS.
Parameters
The following parameters are available in the dsc_netbios
type.
dsc_interfacealias
namevar
Data type: String
Specifies the alias of a network interface. Supports the use of '*' and '%'
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_netconnectionprofile
The DSC NetConnectionProfile resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_netconnectionprofile
type.
dsc_ipv4connectivity
Data type: Optional[Enum['Disconnected', 'NoTraffic', 'Subnet', 'LocalNetwork', 'Internet']]
Sets the Network Category for the interface.
dsc_ipv6connectivity
Data type: Optional[Enum['Disconnected', 'NoTraffic', 'Subnet', 'LocalNetwork', 'Internet']]
Specifies the IPv4 Connection Value.
dsc_networkcategory
Data type: Optional[Enum['Public', 'Private']]
Specifies the IPv6 Connection Value.
Parameters
The following parameters are available in the dsc_netconnectionprofile
type.
dsc_interfacealias
namevar
Data type: String
Specifies the alias for the Interface that is being changed.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_netipinterface
The DSC NetIPInterface resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_netipinterface
type.
dsc_advertisedefaultroute
Data type: Optional[Enum['Enabled', 'Disabled']]
Specifies the default router advertisement for an interface.
dsc_advertising
Data type: Optional[Enum['Enabled', 'Disabled']]
Specifies the router advertisement value for the IP interface.
dsc_automaticmetric
Data type: Optional[Enum['Enabled', 'Disabled']]
Specifies the value for automatic metric calculation.
dsc_dhcp
Data type: Optional[Enum['Enabled', 'Disabled']]
Specifies the Dynamic Host Configuration Protocol (DHCP) value for an IP interface.
dsc_directedmacwolpattern
Data type: Optional[Enum['Enabled', 'Disabled']]
Specifies the wake-up packet value for an IP interface.
dsc_ecnmarking
Data type: Optional[Enum['Disabled', 'UseEct1', 'UseEct0', 'AppDecide']]
Specifies the value for Explicit Congestion Notification (ECN) marking.
dsc_forcearpndwolpattern
Data type: Optional[Enum['Enabled', 'Disabled']]
Specifies the Wake On LAN (WOL) value for the IP interface.
dsc_forwarding
Data type: Optional[Enum['Enabled', 'Disabled']]
Specifies the packet forwarding value for the IP interface.
dsc_ignoredefaultroutes
Data type: Optional[Enum['Enabled', 'Disabled']]
Specifies a value for Default Route advertisements.
dsc_managedaddressconfiguration
Data type: Optional[Enum['Enabled', 'Disabled']]
Specifies the value for managed address configuration.
dsc_neighborunreachabilitydetection
Data type: Optional[Enum['Enabled', 'Disabled']]
Specifies the value for Neighbor Unreachability Detection (NUD).
dsc_otherstatefulconfiguration
Data type: Optional[Enum['Enabled', 'Disabled']]
Specifies the value for configuration other than addresses.
dsc_routerdiscovery
Data type: Optional[Enum['Enabled', 'Disabled', 'ControlledByDHCP']]
Specifies the value for router discovery for an IP interface.
dsc_weakhostreceive
Data type: Optional[Enum['Enabled', 'Disabled']]
Specifies the receive value for a weak host model.
dsc_weakhostsend
Data type: Optional[Enum['Enabled', 'Disabled']]
Specifies the send value for a weak host model.
Parameters
The following parameters are available in the dsc_netipinterface
type.
dsc_addressfamily
namevar
Data type: Enum['IPv4', 'IPv6']
IP address family on the interface to configure.
dsc_interfacealias
namevar
Data type: String
Alias of the network interface to configure.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_networkteam
The DSC NetworkTeam resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_networkteam
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Specifies if the network team should be created or deleted. Defaults to 'Present'.
dsc_loadbalancingalgorithm
Data type: Optional[Enum['Dynamic', 'HyperVPort', 'IPAddresses', 'MacAddresses', 'TransportPorts']]
Specifies the load balancing algorithm for the network team.
dsc_teamingmode
Data type: Optional[Enum['SwitchIndependent', 'LACP', 'Static']]
Specifies the teaming mode configuration.
dsc_teammembers
Data type: Array[String]
Specifies the network interfaces that should be a part of the network team. This is a comma-separated list.
Parameters
The following parameters are available in the dsc_networkteam
type.
dsc_name
namevar
Data type: String
Specifies the name of the network team to create.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_networkteaminterface
The DSC NetworkTeamInterface resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_networkteaminterface
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Specifies if the network team interface should be created or deleted. Defaults to 'Present'.
dsc_teamname
Data type: String
Specifies the name of the network team on which this particular interface should exist.
dsc_vlanid
Data type: Optional[Integer[0, 4294967295]]
Specifies VLAN ID to be set on network team interface.
Parameters
The following parameters are available in the dsc_networkteaminterface
type.
dsc_name
namevar
Data type: String
Specifies the name of the network team interface to create.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_proxysettings
The DSC ProxySettings resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_proxysettings
type.
dsc_autoconfigurl
Data type: Optional[String]
The URL of the automatic configuration script to specify the proxy settings. Should be specified if 'EnableAutoConfiguration' is 'True'.
dsc_connectiontype
Data type: Optional[Enum['All', 'Default', 'Legacy']]
Defines if the proxy settings should be configured for default connections, legacy connections or all connections. Defaults to 'All'.
dsc_enableautoconfiguration
Data type: Optional[Boolean]
Use automatic configuration script for specifying proxy settings. Defaults to 'False'.
dsc_enableautodetection
Data type: Optional[Boolean]
Enable automatic detection of the proxy settings. Defaults to 'False'.
dsc_enablemanualproxy
Data type: Optional[Boolean]
Use manual proxy server settings. Defaults to 'False'.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Specifies if computer proxy settings should be set. Defaults to 'Present'.
dsc_proxyserver
Data type: Optional[String]
The address and port of the manual proxy server to use. Should be specified if 'EnableManualProxy' is 'True'.
dsc_proxyserverbypasslocal
Data type: Optional[Boolean]
Bypass proxy server for local addresses. Defaults to 'False'.
dsc_proxyserverexceptions
Data type: Optional[Array[String]]
Bypass proxy server for addresses starting with addresses in this list.
Parameters
The following parameters are available in the dsc_proxysettings
type.
dsc_issingleinstance
namevar
Data type: Enum['Yes']
Specifies the resource is a single instance, the value must be 'Yes'.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_route
The DSC Route resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_route
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Specifies whether the route should exist. Defaults to 'Present'.
dsc_preferredlifetime
Data type: Optional[Float]
Specifies a preferred lifetime in seconds of an IP route.
dsc_publish
Data type: Optional[Enum['No', 'Yes', 'Age']]
Specifies the publish setting of an IP route. Defaults to 'No'.
dsc_routemetric
Data type: Optional[Integer[0, 65535]]
Specifies an integer route metric for an IP route. Defaults to 256.
Parameters
The following parameters are available in the dsc_route
type.
dsc_addressfamily
dsc_destinationprefix
dsc_interfacealias
dsc_nexthop
dsc_psdscrunascredential
name
validation_mode
dsc_addressfamily
namevar
Data type: Enum['IPv4', 'IPv6']
Specifies the IP address family.
dsc_destinationprefix
namevar
Data type: String
Specifies a destination prefix of an IP route. A destination prefix consists of an IP address prefix and a prefix length, separated by a slash (/).
dsc_interfacealias
namevar
Data type: String
Specifies the alias of a network interface.
dsc_nexthop
namevar
Data type: String
Specifies the next hop for the IP route.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_waitfornetworkteam
The DSC WaitForNetworkTeam resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_waitfornetworkteam
type.
dsc_retrycount
Data type: Optional[Integer[0, 4294967295]]
The number of times to loop the retry interval while waiting for the network team.
dsc_retryintervalsec
Data type: Optional[Integer[0, 4294967295]]
Specifies the number of seconds to wait for the network team to become available.
Parameters
The following parameters are available in the dsc_waitfornetworkteam
type.
dsc_name
namevar
Data type: String
Specifies the name of the network team to wait for.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_winsserveraddress
The DSC WinsServerAddress resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_winsserveraddress
type.
dsc_address
Data type: Optional[Array[String]]
The desired WINS Server address(es). Exclude to remove all WINS servers.
Parameters
The following parameters are available in the dsc_winsserveraddress
type.
dsc_interfacealias
namevar
Data type: String
Alias of the network interface for which the WINS server address is set.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
dsc_winssetting
The DSC WinsSetting resource type. Automatically generated from version 7.4.0.0
Properties
The following properties are available in the dsc_winssetting
type.
dsc_enabledns
Data type: Optional[Boolean]
Specifies if DNS is enabled for name resolution over WINS for all network adapters with TCP/IP enabled.
dsc_enablelmhosts
Data type: Optional[Boolean]
Specifies if LMHOSTS lookup should be enabled for all network adapters with TCP/IP enabled.
Parameters
The following parameters are available in the dsc_winssetting
type.
dsc_issingleinstance
namevar
Data type: Enum['Yes']
Specifies the resource is a single instance, the value must be 'Yes'.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
validation_mode
Data type: Enum[property, resource]
Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).
Default value: property
Versions
Unreleased
7.4.0.0
- Added Comment Based Help for
New-NotImplementedException
common function - fixes Issue #411. - Added common function 'Format-Win32NetworkADapterFilterByNetConnectionID' to properly accept wild cards for Win32_NetworkAdapter filters.
- Updated MSFT_Netbios to use 'Format-Win32NetworkADapterFilterByNetConnectionID'
- fixes Issue #413.
- Corrected minor style and consistency issues in
NetworkingDsc.Common.tests.ps1
andNetworkingDsc.Common.ps1
. - Changed verbose messages in
Test-DscParameterState
to include full type name. - Fixed bug in
Test-DscParameterState
that causes it to return true when both the current array and desired array is empty. - Fix minor style issues in statement case.
7.3.0.0
- DnsClientGlobalSettings:
- Fixed SuffixSearchList Empty String Handling - fixes Issue #398.
- NetAdapterAdvancedProperty:
- Removed validation from RegistryKeyword parameter because the list of valid registry keywords is not fixed and will depend on adapter driver - fixes Issue #388.
- MSFT_WinsServerAddress Added MSFT_WinsServerAddress to control the WINS servers for a given network adapter.
- Test-DscParameterState:
- This function was enhanced with an optional reversecheck, optional internal sorting for arrays.
- The functions ConvertTo-CimInstance and ConvertTo-Hashtable were added required by Test-DscParameterState.
- Fix missing context message content in unit tests - fixes Issue #405.
- Correct style violations in unit tests:
- Adding
Get
,Set
andTest
tags to appropriatedescribe
blocks. - Removing uneccesary
#region
blocks. - Conversion of double quotes to single quotes where possible.
- Replace variables with string litterals in
describe
block description.
- Adding
- Firewall:
- Fix bug when LocalAddress or RemoteAddress is specified using CIDR notation with number of bits specified in subnet mask (e.g. 10.0.0.1/8) rather than using CIDR subnet mask notation (e.g 10.0.0.1/255.0.0.0) - fixes Issue #404.
7.2.0.0
- NetAdapterAdvancedProperty:
- Added support for RegistryKeyword
MaxRxRing1Length
andNumRxBuffersSmall
- fixes Issue #387.
- Added support for RegistryKeyword
- Firewall:
- Prevent 'Parameter set cannot be resolved using the specified named parameters' error when updating rule when group name is specified - fixes Issue #130 and Issue #191.
- Opted into Common Tests 'Common Tests - Validate Localization' - fixes Issue #393.
- Combined all
NetworkingDsc.ResourceHelper
module functions intoNetworkingDsc.Common
module - fixes Issue #394. - Renamed all localization strings so that they are detected by 'Common Tests - Validate Localization'.
- Fixed issues with mismatched localization strings.
- Updated all common functions with the latest versions from DSCResource.Template.
- Fixed an issue with the helper function
Test-IsNanoServer
that prevented it to work. Though the helper function is not used, so this issue was not caught until now when unit tests was added. - Corrected style violations in
NetworkingDsc.Common
.
7.1.0.0
- New Resource: NetAdapterState to enable or disable a network adapter - fixes Issue #365
- Fix example publish to PowerShell Gallery by adding
gallery_api
environment variable toAppVeyor.yml
- fixes Issue #385. - MSFT_Proxy:
- Fixed
ProxyServer
,ProxyServerExceptions
andAutoConfigURL
parameters so that they correctly support strings longer than 255 characters - fixes Issue #378.
- Fixed
7.0.0.0
- Refactored module folder structure to move resource to root folder of repository and remove test harness - fixes Issue #372.
- Removed module conflict tests because only required for harness style modules.
- Opted into Common Tests 'Validate Example Files To Be Published', 'Validate Markdown Links' and 'Relative Path Length'.
- Added 'DscResourcesToExport' to manifest to improve information in PowerShell Gallery and removed wildcards from 'FunctionsToExport', 'CmdletsToExport', 'VariablesToExport' and 'AliasesToExport' - fixes Issue #376.
- MSFT_NetIPInterface:
- Added
Dhcp
,WeakHostReceive
andWeakHostSend
parameters so that MSFT_DHCPClient, MSFT_WeakHostReceive, MSFT_WeakHostSend can be deprecated - fixes Issue #360.
- Added
- MSFT_DhcpClient:
- BREAKING CHANGE: Resource has been deprecated and replaced by
Dhcp
parameter in MSFT_NetIPInterface.
- BREAKING CHANGE: Resource has been deprecated and replaced by
- MSFT_WeakHostReceive:
- BREAKING CHANGE: Resource has been deprecated and replaced by
WeakHostReceive
parameter in MSFT_NetIPInterface.
- BREAKING CHANGE: Resource has been deprecated and replaced by
- MSFT_WeakHostSend:
- BREAKING CHANGE: Resource has been deprecated and replaced by
WeakHostSend
parameter in MSFT_NetIPInterface.
- BREAKING CHANGE: Resource has been deprecated and replaced by
- MSFT_IPAddress:
- Updated examples to use NetIPInterface.
- MSFT_NetAdapterName:
- Updated examples to use NetIPInterface.
- MSFT_DnsServerAddress:
- Updated examples to use NetIPInterface.
- MSFT_NetworkTeam:
- Change
Get-TargetResource
to return actual TeamMembers if network team exists and 'Ensure' returns 'Present' even when actual TeamMembers do not match 'TeamMembers' parameter - fixes Issue #342.
- Change
- Updated examples to format required for publishing to PowerShell Gallery - fixes Issue #374.
- MSFT_NetAdapterAdvancedProperty:
- Fixes NetworkAdapterName being returned in Name property when calling Get-TargetResourceFixes - fixes Issue #370.
6.3.0.0
- MSFT_IPAddress:
- Updated to allow retaining existing addresses in order to support cluster configurations as well.
6.2.0.0
- Added .VSCode settings for applying DSC PSSA rules - fixes Issue #357.
- Updated LICENSE file to match the Microsoft Open Source Team standard - fixes Issue #363
- MSFT_NetIPInterface:
- Added a new resource for configuring the IP interface settings for a network interface.
6.1.0.0
- MSFT_Firewall:
- Added full stop to end of MOF field descriptions.
- Support for
[
,]
and*
characters in the Name property added - fixes Issue #348. - Improved unit tests to meet style guidelines.
6.0.0.0
- New Example 2-ConfigureSuffixSearchList.ps1 for multiple SuffixSearchList entries for resource DnsClientGlobalSetting.
- BREAKING CHANGE:
- Renamed xNetworking to NetworkingDsc - fixes Issue #119.
- Changed all MSFT_xResourceName to MSFT_ResourceName.
- Updated DSCResources, Examples, Modules and Tests with new naming.
- Updated Year to 2018 in License and Manifest.
- Updated README.md from xNetworking to NetworkingDsc.
- MSFT_IPAddress:
- Updated to allow setting multiple IP Addresses when one is already set - Fixes Issue #323
- Corrected CHANGELOG.MD to report that issue with InterfaceAlias matching on Adapter description rather than Adapter Name was released in 5.7.0.0 rather than 5.6.0.0 - See Issue #315.
- MSFT_WaitForNetworkTeam:
- Added a new resource to set the wait for a network team to become 'Up'.
- MSFT_NetworkTeam:
- Improved detection of environmemt for running network team integration tests.
- MSFT_NetworkTeamInterface:
- Improved detection of environmemt for running network team integration tests.
- Added a CODE_OF_CONDUCT.md with the same content as in the README.md - fixes Issue #337.
5.7.0.0
- Enabled PSSA rule violations to fail build - Fixes Issue #320.
- MSFT_xNetAdapterAdvancedProperty:
- Enabled setting the same property on multiple network adapters - Fixes issue #324.
- MSFT_xNetBIOS:
- Fix issue with InterfaceAlias matching on Adapter description rather than Adapter Name - Fixes Issue #315.
5.6.0.0
- Reordered resource list in README.MD to be alphabetical and added missing resource xNetAdapterAdvancedProperty - Fixes issue #309.
- MSFT_xNetworkTeamInterface:
- Corrected style and formatting to meet HQRM guidelines.
- Updated tests to meet Pester v4 guidelines.
- Converted exceptions to use ResourceHelper functions.
- Changed unit tests to output Verbose logs.
- MSFT_xNetAdapterAdvancedProperty:
- Added a number of additional advanced properties.
- Fixes issue #314.
- MSFT_xNetBIOS:
- Corrected style and formatting to meet HQRM guidelines.
- Ensured CommonTestHelper.psm1 is loaded before running unit tests.
- MSFT_xNetworkTeam:
- Corrected style and formatting to meet HQRM guidelines.
- Added missing default from MOF description of Ensure parameter.
- Fixed
Get-TargetResource
to always output Ensure parameter. - Changed unit tests to output Verbose logs.
- MSFT_xNetConnectionProfile:
- Corrected style and formatting to meet HQRM guidelines.
- Updated tests to meet Pester V4 guidelines - Fixes Issue #272.
5.5.0.0
- MSFT_xNetAdapterAdvancedProperty:
- Created new resource configuring AdvancedProperties for NetAdapter
- MSFT_xNetAdapterLso:
- Corrected style and formatting to meet HQRM guidelines.
- Updated tests to meet Pester v4 guidelines.
- MSFT_xNetAdapterName:
- Corrected style and formatting to meet HQRM guidelines.
- Updated tests to meet Pester v4 guidelines.
- MSFT_xNetAdapterRDMA:
- Corrected style and formatting to meet HQRM guidelines.
- Updated tests to meet Pester v4 guidelines.
- Converted exceptions to use ResourceHelper functions.
- Improved integration tests to preserve system status and run in more scenarios.
- MSFT_xNetBIOS:
- Corrected style and formatting to meet HQRM guidelines.
- Updated tests to meet Pester v4 guidelines.
- Converted exceptions to use ResourceHelper functions.
- Improved integration tests to preserve system status, run in more scenarios and more effectively test the resource.
- Changed to report back error if unable to set NetBIOS setting.
- MSFT_xWinsSetting:
- Created new resource for enabling/disabling LMHOSTS lookup and enabling/disabling WINS name resoluton using DNS.
- MSFT_xNetworkTeam:
- Corrected style and formatting to meet HQRM guidelines.
- Updated tests to meet Pester v4 guidelines.
- Converted exceptions to use ResourceHelper functions.
5.4.0.0
- MSFT_xIPAddressOption:
- Added a new resource to set the SkipAsSource option for an IP address.
- MSFT_xWeakHostSend:
- Created the new Weak Host Send resource.
- MSFT_xWeakHostReceive:
- Created the new Weak Host Receive resource.
- MSFT_xRoute:
- Corrected style and formatting to meet HQRM guidelines.
- Converted exceptions to use ResourceHelper functions.
- Changed unit tests so that they can be run in any order.
- Included default values in MOF file so that they are displayed in Wiki documentation.
- Converted tests to meet Pester V4 standards.
5.3.0.0
- MSFT_xProxySettings:
- Created new resource configuring proxy settings.
- MSFT_xDefaultGatewayAddress:
- Correct
2-SetDefaultGateway.md
address family and improve example description - fixes Issue #275.
- Correct
- MSFT_xIPAddress:
- Corrected style and formatting to meet HQRM guidelines.
- Converted exceptions to use ResourceHelper functions.
- Changed unit tests so that they can be run in any order.
- MSFT_xNetAdapterBinding:
- Corrected style and formatting to meet HQRM guidelines.
- Converted exceptions to use ResourceHelper functions.
5.2.0.0
- Added
Documentation and Examples
section to Readme.md file - see issue #259. - Prevent unit tests from DSCResource.Tests from running during test execution - fixes Issue #264.
- MSFT_xNetworkTeamInterface:
- Updated Test-TargetResource to substitute VLANID value 0 to $null
- MSFT_xNetAdapterRsc:
- Created new resource configuring Rsc
- MSFT_xNetAdapterRss:
- Created new resource configuring Rss
- MSFT_xHostsFile:
- Corrected style and formatting to meet HQRM guidelines.
- Converted exceptions to use ResourceHelper functions.
5.1.0.0
- MSFT_xDhcpClient:
- Corrected style and formatting to meet HQRM guidelines.
- Converted exceptions to use ResourceHelper functions.
- README.MD:
- Cleaned up badges by putting them into a table.
- MSFT_xDnsConnectionSuffix:
- Corrected style and formatting to meet HQRM guidelines.
- Converted exceptions to use ResourceHelper functions.
- README.MD:
- Converted badges to use branch header as used in xSQLServer.
- Added standard .markdownlint.json to configure rules to run on Markdown files.
- MSFT_xDnsClientGlobalSetting:
- Corrected style and formatting to meet HQRM guidelines.
- Converted exceptions to use ResourceHelper functions.
- Updated year to 2017 in LICENSE and module manifest.
- MSFT_xDnsServerAddress:
- Fix error when setting address on adapter where NameServer Property does not exist in registry for interface - see issue #237.
- Corrected style and formatting to meet HQRM guidelines.
- MSFT_xIPAddress:
- Improved examples to clarify how to set IP Address prefix - see issue #239.
- MSFT_xFirewall:
- Fixed bug with DisplayName not being set correctly in some situations - see issue #234.
- Corrected style and formatting to meet HQRM guidelines.
- Converted exceptions to use ResourceHelper functions.
- Added .github support files:
- CONTRIBUTING.md
- ISSUE_TEMPLATE.md
- PULL_REQUEST_TEMPLATE.md
- Opted into Common Tests 'Validate Module Files' and 'Validate Script Files'.
- Converted files with UTF8 with BOM over to UTF8 - fixes Issue 250.
- MSFT_xFirewallProfile:
- Created new resource configuring firewall profiles.
- MSFT_xNetConnectionProfile:
- Corrected style and formatting to meet HQRM guidelines.
- Added validation for provided parameters.
- Prevent testing parameter values of connection that aren't set in resource - fixes Issue 254.
- Improved unit test coverage for this resource.
5.0.0.0
- Find-NetworkAdapter:
- Fixed to return null if exception thrown.
- Allowed passing no selection parameters.
- MSFT_xNetAdapterName:
- Fixed bug in Get-TargetResource when Name is the only adapter selector parameter.
- Improved verbose logging.
- More improvements to verbose logging.
- Added Get-DnsClientServerStaticAddress to NetworkingDsc.Common to return statically assigned DNS server addresses to support fix for issue 113.
- MSFT_xDNSserverAddress:
- Added support for setting DNS Client to DHCP for issue 113.
- Added new examples to show how to enable DHCP on DNS Client.
- Improved integration test coverage to enable testing of multiple addresses and DHCP.
- Converted exception creation to use common exception functions.
- MSFT_xDhcpClient:
- Updated example to also cover setting DNS Client to DHCP.
- Added the VS Code PowerShell extension formatting settings that cause PowerShell files to be formatted as per the DSC Resource kit style guidelines.
- MSFT_xDefaultGatewayAddress:
- Corrected style and formatting to meet HQRM guidelines.
- Converted exceptions to use ResourceHelper functions.
- Updated badges in README.MD to match the layout from PSDscResources.
- MSFT_xIPAddress:
- BREAKING CHANGE: Adding support for multiple IP addresses being assigned.
4.1.0.0
- Added integration test to test for conflicts with other common resource kit modules.
- Prevented ResourceHelper and Common module cmdlets from being exported to resolve conflicts with other resource modules.
4.0.0.0
- Converted to use AppVeyor.psm1 in DSCResource.Tests repository.
- Converted to use Example and Markdown tests in DSCResource.Tests repository.
- Added CodeCov.io support.
- Added a new example to xDNSServerAddress to clarify setting multiple DNS Servers.
- Fix examples to correct display in auto documentation generation.
- BREAKING CHANGE: Migrated xNetworkAdapter module functionality to xNetAdapterName resource.
- Added CommonTestHelper module for aiding testing.
- MSFT_xNetAdapterName:
- Created new resource for renaming network adapters.
- Added Find-NetAdapter cmdlet to NetworkingDsc.Common.
- Correct example parameters format to meet style guidelines.
3.2.0.0
- Fixed typo in the example's Action property from "Blocked" (which isn't a valid value) to "Block"
- Added support for auto generating wiki, help files, markdown linting and checking examples.
- Added NetworkingDsc.ResourceHelper module based on copy from PSDscResources.
- MSFT_xFirewall:
- Cleaned up ParameterList table layout and moved into a new file (MSFT_xFirewall.data.psd1).
- Separated Localization strings into strings file.
- Added standard help blocks to all functions to meet HQRM standards.
- Added CmdletBinding attribute to all functions to meet HQRM standards.
- Style changes to meet HQRM standards.
- Fixed issue using CIDR notation for LocalAddress or RemoteAddress. See GitHub issue.
- Fixed integration tests so that values being set are correctly tested.
- Added integration tests for Removal of Firewall rule.
- Added NetworkingDsc.Common module to contain shared networking functions.
- MSFT_xDNSServerAddress:
- Separated Localization strings into strings file.
- MSFT_xDefaultGatewayAddress:
- Separated Localization strings into strings file.
- Style changes to meet HQRM standards.
- MSFT_xDhcpClient:
- Separated Localization strings into strings file.
- Fix parameter descriptions in MOF file.
- Style changes to meet HQRM standards.
- MSFT_xDnsClientGlobalSetting:
- Renamed Localization strings file to be standard naming format.
- Moved ParameterList into a new file (MSFT_xDnsClientGlobalSetting.data.psd1).
- Style changes to meet HQRM standards.
- Removed New-TerminatingError function because never called.
- Converted to remove Invoke-Expression.
- MSFT_xDnsConnectionSuffix:
- Separated Localization strings into strings file.
- Style changes to meet HQRM standards.
- MSFT_xHostsFile:
- Renamed Localization strings file to be standard naming format.
- Style changes to meet HQRM standards.
- Refactored for performance
- Code now reads 38k lines in > 1 second vs 4
- Now ignores inline comments
- Added more integration tests
- MSFT_xIPAddress:
- Separated Localization strings into strings file.
- Style changes to meet HQRM standards.
- MSFT_xNetAdapterBinding:
- Separated Localization strings into strings file.
- Style changes to meet HQRM standards.
- MSFT_xNetAdapterRDMA:
- Renamed Localization strings file to be standard naming format.
- Style changes to meet HQRM standards.
- MSFT_xNetBIOS:
- Renamed Localization strings file to be standard naming format.
- Style changes to meet HQRM standards.
- MSFT_xNetConnectionProfile:
- Separated Localization strings into strings file.
- Style changes to meet HQRM standards.
- MSFT_xNetworkTeam:
- Style changes to meet HQRM standards.
- MSFT_xNetworkTeamInterface:
- Updated integration tests to remove Invoke-Expression.
- Style changes to meet HQRM standards.
- MSFT_xRoute:
- Separated Localization strings into strings file.
- Style changes to meet HQRM standards.
- MSFT_xFirewall:
- Converted to remove Invoke-Expression.
3.1.0.0
- Changed parameter format in Readme.md to improve information coverage and consistency.
- Changed all MOF files to be consistent and meet HQRM guidelines.
- Removed most markdown errors (MD*) in Readme.md.
- Added xNetAdapterRDMA resource
- Fixes to support changes to DSCResource.Tests.
3.0.0.0
- Corrected integration test filenames:
- MSFT_xDefaultGatewayAddress.Integration.Tests.ps1
- MSFT_xDhcpClient.Integration.Tests.ps1
- MSFT_xDNSConnectionSuffix.Integration.Tests.ps1
- MSFT_xNetAdapterBinding.Integration.Tests.ps1
- Updated all integration tests to use v1.1.0 header and script variable context.
- Updated all unit tests to use v1.1.0 header and script variable context.
- Removed uneccessary global variable from MSFT_xNetworkTeam.integration.tests.ps1
- Converted Invoke-Expression in all integration tests to &.
- Fixed unit test description in xNetworkAdapter.Tests.ps1
- xNetAdapterBinding
- Added support for the use of wildcard (*) in InterfaceAlias parameter.
- BREAKING CHANGE - MSFT_xIPAddress: SubnetMask parameter renamed to PrefixLength.
2.12.0.0
- Fixed bug in MSFT_xIPAddress resource when xIPAddress follows xVMSwitch.
- Added the following resources:
- MSFT_xNetworkTeamInterface resource to add/remove network team interfaces
- Added conditional loading of LocalizedData to MSFT_xHostsFile and MSFT_xNetworkTeam to prevent failures while loading those resources on systems with $PSUICulture other than en-US
2.11.0.0
- Added the following resources:
- MSFT_xDnsClientGlobalSetting resource to configure the DNS Suffix Search List and Devolution.
- Converted AppVeyor.yml to pull Pester from PSGallery instead of Chocolatey.
- Changed AppVeyor.yml to use default image.
- Fix xNetBios unit tests to work on default appveyor image.
- Fix bug in xRoute when removing an existing route.
- Updated xRoute integration tests to use v1.1.0 test header.
- Extended xRoute integration tests to perform both add and remove route tests.
2.10.0.0
- Added the following resources:
- MSFT_xNetAdapterBinding resource to enable/disable network adapter bindings.
- Fixed bug where xHostsFile would duplicate an entry instead of updating an existing one
- Updated SamplexIPAddress*.ps1 examples to show correct usage of setting a Static IP address to prevent issue when DHCP assigned IP address already matches staticly assigned IP address.
2.9.0.0
- MSFT_xDefaultGatewayAddress: Added Integration Tests.
- MSFT_xDhcpClient: Added Integration Tests.
- MSFT_xDnsConnectionSuffix: Added Integration Tests.
- MSFT_xDnsServerAddress: Added Integration Tests.
- MSFT_xIPAddress: Added Integration Tests.
- MSFT_xDhcpClient: Fixed logged message in Test-TargetResource.
- Added functions:
- Get-xNetworkAdapterName
- Test-xNetworkAdapterName
- Set-xNetworkAdapterName
2.8.0.0
- Templates folder removed. Use the test templates in them Tests.Template folder in the DSCResources repository instead.
- Added the following resources:
- MSFT_xHostsFile resource to manage hosts file entries.
- MSFT_xFirewall: Fix test of Profile parameter status.
- MSFT_xIPAddress: Fix false negative when desired IP is a substring of current IP.
2.7.0.0
- Added the following resources:
- MSFT_xNetworkTeam resource to manage native network adapter teaming.
2.6.0.0
- Added the following resources:
- MSFT_xDhcpClient resource to enable/disable DHCP on individual interfaces.
- MSFT_xRoute resource to manage network routes.
- MSFT_xNetBIOS resource to configure NetBIOS over TCP/IP settings on individual interfaces.
- MSFT_*: Unit and Integration tests updated to use DSCResource.Tests\TestHelper.psm1 functions.
- MSFT_*: Resource Name added to all unit test Desribes.
- Templates update to use DSCResource.Tests\TestHelper.psm1 functions.
- MSFT_xNetConnectionProfile: Integration tests fixed when more than one connection profile present.
- Changed AppVeyor.yml to use WMF 5 build environment.
- MSFT_xIPAddress: Removed test for DHCP Status.
- MSFT_xFirewall: New parameters added:
- DynamicTransport
- EdgeTraversalPolicy
- LocalOnlyMapping
- LooseSourceMapping
- OverrideBlockRules
- Owner
- All unit & integration tests updated to be able to be run from any folder under tests directory.
- Unit & Integration test template headers updated to match DSCResource templates.
2.5.0.0
- Added the following resources:
- MSFT_xDNSConnectionSuffix resource to manage connection-specific DNS suffixes.
- MSFT_xNetConnectionProfile resource to manage Connection Profiles for interfaces.
- MSFT_xDNSServerAddress: Corrected Verbose logging messages when multiple DNS adddressed specified.
- MSFT_xDNSServerAddress: Change to ensure resource terminates if DNS Server validation fails.
- MSFT_xDNSServerAddress: Added Validate parameter to enable DNS server validation when changing server addresses.
- MSFT_xFirewall: ApplicationPath Parameter renamed to Program for consistency with Cmdlets.
- MSFT_xFirewall: Fix to prevent error when DisplayName parameter is set on an existing rule.
- MSFT_xFirewall: Setting a different DisplayName parameter on an existing rule now correctly reports as needs change.
- MSFT_xFirewall: Changed DisplayGroup parameter to Group for consistency with Cmdlets and reduce confusion.
- MSFT_xFirewall: Changing the Group of an existing Firewall rule will recreate the Firewall rule rather than change it.
- MSFT_xFirewall: New parameters added:
- Authentication
- Encryption
- InterfaceAlias
- InterfaceType
- LocalAddress
- LocalUser
- Package
- Platform
- RemoteAddress
- RemoteMachine
- RemoteUser
- MSFT_xFirewall: Profile parameter now handled as an Array.
2.4.0.0
- Added following resources:
- MSFT_xDefaultGatewayAddress
- MSFT_xFirewall: Removed code using DisplayGroup to lookup Firewall Rule because it was redundant.
- MSFT_xFirewall: Set-TargetResource now updates firewall rules instead of recreating them.
- MSFT_xFirewall: Added message localization support.
- MSFT_xFirewall: Removed unnecessary code for handling multiple rules with same name.
- MSFT_xDefaultGatewayAddress: Removed unnecessary try/catch logic from around networking cmdlets.
- MSFT_xIPAddress: Removed unnecessary try/catch logic from around networking cmdlets.
- MSFT_xDNSServerAddress: Removed unnecessary try/catch logic from around networking cmdlets.
- MSFT_xDefaultGatewayAddress: Refactored to add more unit tests and cleanup logic.
- MSFT_xIPAddress: Network Connection Profile no longer forced to Private when IP address changed.
- MSFT_xIPAddress: Refactored to add more unit tests and cleanup logic.
- MSFT_xDNSServerAddress: Refactored to add more unit tests and cleanup logic.
- MSFT_xFirewall: Refactored to add more unit tests and cleanup logic.
- MSFT_xIPAddress: Removed default gateway parameter - use xDefaultGatewayAddress resource.
- MSFT_xIPAddress: Added check for IP address format not matching address family.
- MSFT_xDNSServerAddress: Corrected error message when address format doesn't match address family.
2.3.0.0
-
MSFT_xDNSServerAddress: Added support for setting DNS for both IPv4 and IPv6 on the same Interface
-
MSFT_xDNSServerAddress: AddressFamily parameter has been changed to mandatory.
-
Removed xDscResourceDesigner tests (moved to common tests)
-
Fixed Test-TargetResource to test against all provided parameters
-
Modified tests to not copy file to Program Files
-
Changes to xFirewall causes Get-DSCConfiguration to no longer crash
- Modified Schema to reduce needed functions.
- General re-factoring and clean up of xFirewall.
- Added Unit and Integration tests to resource.
2.2.0.0
- Changes in xFirewall resources to meet Test-xDscResource criteria
2.1.1.1
- Updated to fix issue with Get-DscConfiguration and xFirewall
2.1.0
- Added validity check that IPAddress and IPAddressFamily conforms with each other
2.0.0.0
- Adding the xFirewall resource
1.0.0.0
- Initial release with the following resources:
- xIPAddress
- xDnsServerAddress
Dependencies
- puppetlabs/pwshlib (>= 0.9.0 < 2.0.0)