-
Notifications
You must be signed in to change notification settings - Fork 90
Route
Daniel Scott-Raynsford edited this page Dec 1, 2018
·
6 revisions
Parameter | Attribute | DataType | Description | Allowed Values |
---|---|---|---|---|
InterfaceAlias | Key | string | Specifies the alias of a network interface. | |
AddressFamily | Key | string | Specifies the IP address family. | IPv4, IPv6 |
DestinationPrefix | Key | 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 (/). | |
NextHop | Key | String | Specifies the next hop for the IP route. | |
Ensure | Write | String | Specifies whether the route should exist. Defaults to 'Present'. | Present, Absent |
RouteMetric | Write | Uint16 | Specifies an integer route metric for an IP route. Defaults to 256. | |
Publish | Write | String | Specifies the publish setting of an IP route. Defaults to 'No'. | No, Yes, Age |
PreferredLifetime | Write | Real64 | Specifies a preferred lifetime in seconds of an IP route. |
This resource is used to control static routes on an interface for a node.
Add a net route to the Ethernet interface
Configuration Example
{
param
(
[Parameter()]
[System.String[]]
$NodeName = 'localhost'
)
Import-DSCResource -ModuleName NetworkingDsc
Node $NodeName
{
Route NetRoute1
{
Ensure = 'Present'
InterfaceAlias = 'Ethernet'
AddressFamily = 'IPv4'
DestinationPrefix = '192.168.0.0/16'
NextHop = '192.168.120.0'
RouteMetric = 200
}
}
}
- DefaultGatewayAddress
- DnsClientGlobalSetting
- DnsConnectionSuffix
- DnsServerAddress
- Firewall
- FirewallProfile
- HostsFile
- IPAddress
- IPAddressOption
- NetAdapterAdvancedProperty
- NetAdapterBinding
- NetAdapterLso
- NetAdapterName
- NetAdapterRdma
- NetAdapterRsc
- NetAdapterRss
- NetAdapterState
- NetBios
- NetConnectionProfile
- NetIPInterface
- NetworkTeam
- NetworkTeamInterface
- ProxySettings
- Route
- WaitForNetworkTeam
- WinsServerAddress
- WinsSetting