Resource Type: dsc_spsearchcrawlrule

Defined in:

lib/puppet/type/dsc_spsearchcrawlrule.rb

Providers:

powershell

Overview

The DSC SPSearchCrawlRule resource type. Automatically generated from ‘SharePointDsc/DSCResources/MSFT_SPSearchCrawlRule/MSFT_SPSearchCrawlRule.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_authenticationcredentials

  AuthenticationCredentials - The credentials used for this crawl rule (used for types BasicAccountRuleAccess and NTLMAccountRuleAccess)

• dsc_authenticationtype

  AuthenticationType - Authentication type used by the crawl rule Valid values are DefaultRuleAccess, BasicAccountRuleAccess, CertificateRuleAccess, NTLMAccountRuleAccess, FormRuleAccess, CookieRuleAccess, AnonymousAccess.

• dsc_certificatename

  CertificateName - The certificate used for this crawl rule (used for type CertificateRuleAccess)

• dsc_crawlconfigurationrules

  CrawlConfigurationRules - The configuration options for this rule Valid values are FollowLinksNoPageCrawl, CrawlComplexUrls, CrawlAsHTTP.

• dsc_ensure

  Ensure - Present if the crawl rule should exist, absent if it should not Valid values are Present, Absent.

• dsc_installaccount

  InstallAccount - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5

• dsc_path

  Path - The name of the search service application

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_ruletype

  RuleType - The type of the rule Valid values are InclusionRule, ExclusionRule.

• dsc_serviceappname

  ServiceAppName - The name of the search service application

• name (namevar)
• provider

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