Resource Type: dsc_xroute

Defined in:

lib/puppet/type/dsc_xroute.rb

Providers:

powershell

Overview

The DSC xRoute resource type. Automatically generated from ‘xNetworking/DSCResources/MSFT_xRoute/MSFT_xRoute.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present
  • absent

Parameters

• dsc_addressfamily

  AddressFamily - Specifies the IP address family. Valid values are IPv4, IPv6.

• dsc_destinationprefix

  DestinationPrefix - 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_ensure

  Ensure - Specifies whether the route should exist. Defaults to ‘Present’. Valid values are Present, Absent.

• dsc_interfacealias

  InterfaceAlias - Specifies the alias of a network interface.

• dsc_nexthop

  NextHop - Specifies the next hop for the IP route.

• dsc_preferredlifetime

  PreferredLifetime - Specifies a preferred lifetime in seconds of an IP route.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_publish

  Publish - Specifies the publish setting of an IP route. Defaults to ‘No’. Valid values are No, Yes, Age.

• dsc_routemetric

  RouteMetric - Specifies an integer route metric for an IP route. Defaults to 256.

• name (namevar)
• provider

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