Resource Type: dsc_xfirewall

Defined in:

lib/puppet/type/dsc_xfirewall.rb

Providers:

powershell

Overview

The DSC xFirewall resource type. Automatically generated from ‘xNetworking/DSCResources/MSFT_xFirewall/MSFT_xFirewall.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_action

  Action - Allow or Block the supplied configuration Valid values are NotConfigured, Allow, Block.

• dsc_authentication

  Authentication - Specifies that authentication is required on firewall rules Valid values are NotRequired, Required, NoEncap.

• dsc_description

  Description - Documentation for the Rule.

• dsc_direction

  Direction - Direction of the connection Valid values are Inbound, Outbound.

• dsc_displaygroup

  DisplayGroup - The current value of the Display Group of the Firewall Rule

• dsc_displayname

  DisplayName - Localized, user-facing name of the Firewall Rule being created

• dsc_dynamictransport

  DynamicTransport - Specifies a dynamic transport Valid values are Any, ProximityApps, ProximitySharing, WifiDirectPrinting, WifiDirectDisplay, WifiDirectDevices.

• dsc_edgetraversalpolicy

  EdgeTraversalPolicy - Specifies that matching firewall rules of the indicated edge traversal policy are created Valid values are Block, Allow, DeferToUser, DeferToApp.

• dsc_enabled

  Enabled - Enable or disable the supplied configuration Valid values are True, False.

• dsc_encryption

  Encryption - Specifies that encryption in authentication is required on firewall rules Valid values are NotRequired, Required, Dynamic.

• dsc_ensure

  Ensure - Ensure the presence/absence of the resource Valid values are Present, Absent.

• dsc_group

  Group - Name of the Firewall Group where we want to put the Firewall Rule

• dsc_icmptype

  IcmpType - Specifies the ICMP type codes

• dsc_interfacealias

  InterfaceAlias - Specifies the alias of the interface that applies to the traffic

• dsc_interfacetype

  InterfaceType - Specifies that only network connections made through the indicated interface types are subject to the requirements of this rule Valid values are Any, Wired, Wireless, RemoteAccess.

• dsc_localaddress

  LocalAddress - Specifies that network packets with matching IP addresses match this rule

• dsc_localonlymapping

  LocalOnlyMapping - Indicates that matching firewall rules of the indicated value are created

  Supported values:

  • true
  • false
• dsc_localport

  LocalPort - Local Port used for the filter

• dsc_localuser

  LocalUser - Specifies the principals to which network traffic this firewall rule applies

• dsc_loosesourcemapping

  LooseSourceMapping - Indicates that matching firewall rules of the indicated value are created

  Supported values:

  • true
  • false
• dsc_name

  Name - Name of the Firewall Rule

• dsc_overrideblockrules

  OverrideBlockRules - Indicates that matching network traffic that would otherwise be blocked are allowed

  Supported values:

  • true
  • false
• dsc_owner

  Owner - Specifies that matching firewall rules of the indicated owner are created

• dsc_package

  Package - Specifies the Windows Store application to which the firewall rule applies

• dsc_platform

  Platform - Specifies which version of Windows the associated rule applies

• dsc_profile

  Profile - Specifies one or more profiles to which the rule is assigned

• dsc_program

  Program - Path and file name of the program for which the rule is applied

• dsc_protocol

  Protocol - Specific Protocol for filter. Specified by name, number, or range

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_remoteaddress

  RemoteAddress - Specifies that network packets with matching IP addresses match this rule

• dsc_remotemachine

  RemoteMachine - Specifies that matching IPsec rules of the indicated computer accounts are created

• dsc_remoteport

  RemotePort - Specific Port used for filter. Specified by port number, range, or keyword

• dsc_remoteuser

  RemoteUser - Specifies that matching IPsec rules of the indicated user accounts are created

• dsc_service

  Service - Specifies the short name of a Windows service to which the firewall rule applies

• name (namevar)
• provider

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