Skip to content

Commit

Permalink
Fix Help Block style and redeploy with Localization Fix - Fixes #466 (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
PlagueHO authored Jul 27, 2020
1 parent 2bc731f commit b808662
Show file tree
Hide file tree
Showing 29 changed files with 786 additions and 778 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- NetIPInterface
- Added `NlMtu` parameter - Fixes [Issue #460](https://github.com/dsccommunity/NetworkingDsc/issues/460).

## Fixed

- NetworkingDsc
- Update to force redeployment with latest version of `DSCResource.Common`
with fix `Get-LocalizationData` - Fixes [Issue #464](https://github.com/dsccommunity/NetworkingDsc/issues/464).
- Correct help block comment indentation - Fixes [Issue #466](https://github.com/dsccommunity/NetworkingDsc/issues/466).

## [8.0.0] - 2020-06-21

### Added
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US'

<#
.SYNOPSIS
Returns the current state of the Default Gateway for an interface.
Returns the current state of the Default Gateway for an interface.
.PARAMETER InterfaceAlias
Alias of the network interface for which the default gateway address is set.
Alias of the network interface for which the default gateway address is set.
.PARAMETER AddressFamily
IP address family.
IP address family.
.PARAMETER Address
The desired default gateway address - if not provided default gateway will be removed.
The desired default gateway address - if not provided default gateway will be removed.
#>
function Get-TargetResource
{
Expand Down Expand Up @@ -82,16 +82,16 @@ function Get-TargetResource

<#
.SYNOPSIS
Sets the Default Gateway for an interface.
Sets the Default Gateway for an interface.
.PARAMETER InterfaceAlias
Alias of the network interface for which the default gateway address is set.
Alias of the network interface for which the default gateway address is set.
.PARAMETER AddressFamily
IP address family.
IP address family.
.PARAMETER Address
The desired default gateway address - if not provided default gateway will be removed.
The desired default gateway address - if not provided default gateway will be removed.
#>
function Set-TargetResource
{
Expand Down Expand Up @@ -161,16 +161,16 @@ function Set-TargetResource

<#
.SYNOPSIS
Tests the state of the Default Gateway for an interface.
Tests the state of the Default Gateway for an interface.
.PARAMETER InterfaceAlias
Alias of the network interface for which the default gateway address is set.
Alias of the network interface for which the default gateway address is set.
.PARAMETER AddressFamily
IP address family.
IP address family.
.PARAMETER Address
The desired default gateway address - if not provided default gateway will be removed.
The desired default gateway address - if not provided default gateway will be removed.
#>
function Test-TargetResource
{
Expand Down Expand Up @@ -260,17 +260,17 @@ function Test-TargetResource

<#
.SYNOPSIS
Check the Address details are valid and do not conflict with Address family.
Ensures interface exists. If any problems are detected an exception will be thrown.
Check the Address details are valid and do not conflict with Address family.
Ensures interface exists. If any problems are detected an exception will be thrown.
.PARAMETER InterfaceAlias
Alias of the network interface for which the default gateway address is set.
Alias of the network interface for which the default gateway address is set.
.PARAMETER AddressFamily
IP address family.
IP address family.
.PARAMETER Address
The desired default gateway address - if not provided default gateway will be removed.
The desired default gateway address - if not provided default gateway will be removed.
#>
function Assert-ResourceProperty
{
Expand Down Expand Up @@ -337,13 +337,13 @@ function Get-NetDefaultGatewayDestinationPrefix

<#
.SYNOPSIS
Get the default network routes assigned to the interface.
Get the default network routes assigned to the interface.
.PARAMETER InterfaceAlias
Alias of the network interface for which the default gateway address is set.
Alias of the network interface for which the default gateway address is set.
.PARAMETER AddressFamily
IP address family.
IP address family.
#>
function Get-NetDefaultRoute
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ $script:parameterList = $resourceData.ParameterList

<#
.SYNOPSIS
Returns the current DNS Client Global Settings.
Returns the current DNS Client Global Settings.
.PARAMETER IsSingleInstance
Specifies the resource is a single instance, the value must be 'Yes'.
Specifies the resource is a single instance, the value must be 'Yes'.
#>
function Get-TargetResource
{
Expand Down Expand Up @@ -65,20 +65,20 @@ function Get-TargetResource

<#
.SYNOPSIS
Sets the DNS Client Global Settings.
Sets the DNS Client Global Settings.
.PARAMETER IsSingleInstance
Specifies the resource is a single instance, the value must be 'Yes'.
Specifies the resource is a single instance, the value must be 'Yes'.
.PARAMETER SuffixSearchList
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.
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.
.PARAMETER UseDevolution.
Specifies that devolution is activated.
Specifies that devolution is activated.
.PARAMETER DevolutionLevel
Specifies the number of labels up to which devolution should occur.
Specifies the number of labels up to which devolution should occur.
#>
function Set-TargetResource
{
Expand Down Expand Up @@ -151,20 +151,20 @@ function Set-TargetResource

<#
.SYNOPSIS
Tests the state of DNS Client Global Settings.
Tests the state of DNS Client Global Settings.
.PARAMETER IsSingleInstance
Specifies the resource is a single instance, the value must be 'Yes'.
Specifies the resource is a single instance, the value must be 'Yes'.
.PARAMETER SuffixSearchList
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.
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.
.PARAMETER UseDevolution.
Specifies that devolution is activated.
Specifies that devolution is activated.
.PARAMETER DevolutionLevel
Specifies the number of labels up to which devolution should occur.
Specifies the number of labels up to which devolution should occur.
#>
function Test-TargetResource
{
Expand Down Expand Up @@ -196,7 +196,7 @@ function Test-TargetResource
) -join '' )

# Flag to signal whether settings are correct
[Boolean] $desiredConfigurationMatch = $true
$desiredConfigurationMatch = $true

# Get the current Dns Client Global Settings
$dnsClientGlobalSetting = Get-DnsClientGlobalSetting `
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,23 @@ $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US'

<#
.SYNOPSIS
Returns the current DNS Connection Suffix for an interface.
Returns the current DNS Connection Suffix for an interface.
.PARAMETER InterfaceAlias
Alias of the network interface for which the DNS server address is set.
Alias of the network interface for which the DNS server address is set.
.PARAMETER ConnectionSpecificSuffix
DNS connection-specific suffix to assign to the network interface.
DNS connection-specific suffix to assign to the network interface.
.PARAMETER RegisterThisConnectionsAddress
Specifies that the IP address for this connection is to be registered.
Specifies that the IP address for this connection is to be registered.
.PARAMETER UseSuffixWhenRegistering
Specifies that this host name and the connection specific suffix for this connection are to
be registered.
Specifies that this host name and the connection specific suffix for this connection are to
be registered.
.PARAMETER Ensure
Ensure that the network interface connection-specific suffix is present or not.
Ensure that the network interface connection-specific suffix is present or not.
#>
function Get-TargetResource
{
Expand Down Expand Up @@ -105,23 +105,23 @@ function Get-TargetResource

<#
.SYNOPSIS
Sets the DNS Connection Suffix for an interface.
Sets the DNS Connection Suffix for an interface.
.PARAMETER InterfaceAlias
Alias of the network interface for which the DNS server address is set.
Alias of the network interface for which the DNS server address is set.
.PARAMETER ConnectionSpecificSuffix
DNS connection-specific suffix to assign to the network interface.
DNS connection-specific suffix to assign to the network interface.
.PARAMETER RegisterThisConnectionsAddress
Specifies that the IP address for this connection is to be registered.
Specifies that the IP address for this connection is to be registered.
.PARAMETER UseSuffixWhenRegistering
Specifies that this host name and the connection specific suffix for this connection are to
be registered.
Specifies that this host name and the connection specific suffix for this connection are to
be registered.
.PARAMETER Ensure
Ensure that the network interface connection-specific suffix is present or not.
Ensure that the network interface connection-specific suffix is present or not.
#>
function Set-TargetResource
{
Expand Down Expand Up @@ -178,23 +178,23 @@ function Set-TargetResource

<#
.SYNOPSIS
Tests the current state of a DNS Connection Suffix for an interface.
Tests the current state of a DNS Connection Suffix for an interface.
.PARAMETER InterfaceAlias
Alias of the network interface for which the DNS server address is set.
Alias of the network interface for which the DNS server address is set.
.PARAMETER ConnectionSpecificSuffix
DNS connection-specific suffix to assign to the network interface.
DNS connection-specific suffix to assign to the network interface.
.PARAMETER RegisterThisConnectionsAddress
Specifies that the IP address for this connection is to be registered.
Specifies that the IP address for this connection is to be registered.
.PARAMETER UseSuffixWhenRegistering
Specifies that this host name and the connection specific suffix for this connection are to
be registered.
Specifies that this host name and the connection specific suffix for this connection are to
be registered.
.PARAMETER Ensure
Ensure that the network interface connection-specific suffix is present or not.
Ensure that the network interface connection-specific suffix is present or not.
#>
function Test-TargetResource
{
Expand Down
48 changes: 24 additions & 24 deletions source/DSCResources/DSC_DnsServerAddress/DSC_DnsServerAddress.psm1
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US'

<#
.SYNOPSIS
Returns the current DNS Server Addresses for an interface.
Returns the current DNS Server Addresses for an interface.
.PARAMETER InterfaceAlias
Alias of the network interface for which the DNS server address is set.
Alias of the network interface for which the DNS server address is set.
.PARAMETER AddressFamily
IP address family.
IP address family.
.PARAMETER Address
The desired DNS Server address(es). Exclude to enable DHCP.
The desired DNS Server address(es). Exclude to enable DHCP.
#>
function Get-TargetResource
{
Expand Down Expand Up @@ -68,21 +68,21 @@ function Get-TargetResource

<#
.SYNOPSIS
Sets the DNS Server Address for an interface.
Sets the DNS Server Address for an interface.
.PARAMETER InterfaceAlias
Alias of the network interface for which the DNS server address is set.
Alias of the network interface for which the DNS server address is set.
.PARAMETER AddressFamily
IP address family.
IP address family.
.PARAMETER Address
The desired DNS Server address(es). Exclude to enable DHCP.
The desired DNS Server address(es). Exclude to enable DHCP.
.PARAMETER Validate
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.
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.
#>
function Set-TargetResource
{
Expand Down Expand Up @@ -181,21 +181,21 @@ function Set-TargetResource

<#
.SYNOPSIS
Tests the current state of a DNS Server Address for an interface.
Tests the current state of a DNS Server Address for an interface.
.PARAMETER InterfaceAlias
Alias of the network interface for which the DNS server address is set.
Alias of the network interface for which the DNS server address is set.
.PARAMETER AddressFamily
IP address family.
IP address family.
.PARAMETER Address
The desired DNS Server address(es). Exclude to enable DHCP.
The desired DNS Server address(es). Exclude to enable DHCP.
.PARAMETER Validate
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.
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.
#>
function Test-TargetResource
{
Expand Down Expand Up @@ -223,7 +223,7 @@ function Test-TargetResource
$Validate = $false
)
# Flag to signal whether settings are correct
[Boolean] $desiredConfigurationMatch = $true
$desiredConfigurationMatch = $true

Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): "
$($script:localizedData.CheckingDnsServerAddressesMessage)
Expand Down Expand Up @@ -281,17 +281,17 @@ function Test-TargetResource

<#
.SYNOPSIS
Checks the Address details are valid and do not conflict with Address family.
Ensures interface exists. If any problems are detected an exception will be thrown.
Checks the Address details are valid and do not conflict with Address family.
Ensures interface exists. If any problems are detected an exception will be thrown.
.PARAMETER InterfaceAlias
Alias of the network interface for which the DNS server address is set.
Alias of the network interface for which the DNS server address is set.
.PARAMETER AddressFamily
IP address family.
IP address family.
.PARAMETER Address
The desired DNS Server address. Set to empty to enable DHCP.
The desired DNS Server address. Set to empty to enable DHCP.
#>
function Assert-ResourceProperty
{
Expand Down
Loading

0 comments on commit b808662

Please sign in to comment.