# NetworkingDsc

**Repository Path**: ggg567/NetworkingDsc

## Basic Information

- **Project Name**: NetworkingDsc
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-01-05
- **Last Updated**: 2022-01-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# NetworkingDsc

[![Build Status](https://dev.azure.com/dsccommunity/NetworkingDsc/_apis/build/status/dsccommunity.NetworkingDsc?branchName=main)](https://dev.azure.com/dsccommunity/NetworkingDsc/_build/latest?definitionId=16&branchName=main)
![Code Coverage](https://img.shields.io/azure-devops/coverage/dsccommunity/NetworkingDsc/16/main)
[![Azure DevOps tests](https://img.shields.io/azure-devops/tests/dsccommunity/NetworkingDsc/16/main)](https://dsccommunity.visualstudio.com/NetworkingDsc/_test/analytics?definitionId=16&contextType=build)
[![PowerShell Gallery (with prereleases)](https://img.shields.io/powershellgallery/vpre/NetworkingDsc?label=NetworkingDsc%20Preview)](https://www.powershellgallery.com/packages/NetworkingDsc/)
[![PowerShell Gallery](https://img.shields.io/powershellgallery/v/NetworkingDsc?label=NetworkingDsc)](https://www.powershellgallery.com/packages/NetworkingDsc/)
[![codecov](https://codecov.io/gh/dsccommunity/NetworkingDsc/branch/main/graph/badge.svg)](https://codecov.io/gh/dsccommunity/NetworkingDsc)

## Code of Conduct

This project has adopted [this code of conduct](CODE_OF_CONDUCT.md).

## Releases

For each merge to the branch `main` a preview release will be
deployed to [PowerShell Gallery](https://www.powershellgallery.com/).
Periodically a release version tag will be pushed which will deploy a
full release to [PowerShell Gallery](https://www.powershellgallery.com/).

## Contributing

Please check out common DSC Community [contributing guidelines](https://dsccommunity.org/guidelines/contributing).

## Change log

A full list of changes in each version can be found in the [change log](CHANGELOG.md).

## Resources

The **NetworkingDsc** module contains the following resources:

- **DefaultGatewayAddress**: Sets a node's default gateway address.
- **DnsClientGlobalSetting**: Configure DNS client global settings.
- **DnsConnectionSuffix**: Sets a node's network interface
    connection-specific DNS suffix.
- **DnsServerAddress**: Sets a node's DNS server address(s).
- **Firewall**: Sets a node's firewall rules.
- **FirewallProfile**: Configures a node's private, public or domain firewall profile.
- **HostsFile**: Adds, edits or removes entries from the hosts file on a node.
- **IPAddress**: Sets a node's IP address(s).
- **IPAddressOption**: Sets an IP address option.
- **NetAdapterAdvancedProperty**: Sets advanced properties on a network adapter.
- **NetAdapterBinding**: Bind or unbind transport or filters to a network interface.
- **NetAdapterLso**: Enable or disable Lso for different protocols
    on a network adapter.
- **NetAdapterName**: Rename a network interface that matches specified search parameters.
- **NetAdapterRdma**: Enable or disable RDMA on a network adapter.
- **NetAdapterRsc**: Enable or disable Rsc for different protocols
    on a network adapter.
- **NetAdapterRss**: Enable or disable Rss on a network adapter.
- **NetBios**: Enable or Disable NetBios on a network interface.
- **NetConnectionProfile**: Sets a node's connection profile.
- **NetIPInterface**: Configure the IP interface settings for a network interface.
- **NetworkTeam**: Set up network teams on a node.
- **NetworkTeamInterface**: Add network interfaces to a network team.
- **ProxySettings**: Configures the proxy settings for the computer.
- **Route**: Sets static routes on a node.
- **WaitForNetworkTeam**: Wait for a network team to achieve the 'Up' status.
- **WinsSetting**: Configure the WINS settings that enable or disable LMHOSTS lookups
  and enable or disable DNS for name resolution over WINS.
- **WinsServerAddress**: Sets a node's WINS server address(s).

## Documentation and Examples

For a full list of resources in NetworkingDsc and examples on their use, check out
the [NetworkingDsc wiki](https://github.com/dsccommunity/NetworkingDsc/wiki).

## Known Issues

### Firewall Known Issues

The following error may occur when using the resource Firewall in configurations
on Windows Server 2012 R2 if [KB3000850](https://support.microsoft.com/en-us/kb/3000850)
is not installed. Please ensure this update is installed if this error occurs.

````markdown
    The cmdlet does not fully support the Inquire action for debug messages.
    Cmdlet operation will continue during the prompt. Select a different action
    preference via -Debug switch or $DebugPreference variable, and try again.
````

### Known Invalid Configuration

- The exception 'One of the port keywords is invalid' will be thrown if a rule
    is created with the LocalPort set to PlayToDiscovery and the Protocol is not
    set to UDP. This is not an unexpected error, but because the
    New-NetFirewallRule documentation is incorrect.

This issue has been reported on [Microsoft Connect](https://connect.microsoft.com/PowerShell/feedbackdetail/view/1974268/new-set-netfirewallrule-cmdlet-localport-parameter-documentation-is-incorrect-for-playtodiscovery)