Resource Type: dsc_spweb

Defined in:
lib/puppet/type/dsc_spweb.rb
Providers:
powershell

Overview

The DSC SPWeb resource type. Automatically generated from ‘SharePointDsc/DSCResources/MSFT_SPWeb/MSFT_SPWeb.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_addtoquicklaunch

    AddToQuickLaunch - True if the web should be in the quick launch of the parent web, otherwise false.

    Supported values:
    • true
    • false
  • dsc_addtotopnav

    AddToTopNav - True if the web should be added to the top nav bar of the parent web, otherwise false.

    Supported values:
    • true
    • false
  • dsc_description

    Description - The description to apply to the web

  • dsc_ensure

    Ensure - Present if the web should exist or Absent if it should be removed 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_language

    Language - The Lanhuage (LCID) of the web

  • dsc_name

    Name - The Name of the web

  • dsc_psdscrunascredential

    PsDscRunAsCredential

  • dsc_requestaccessemail

    RequestAccessEmail - The e-mail address to which requests for access are sent. Set to emtpy string to disable access requests.

  • dsc_template

    Template - The WebTemplate to use to create the web

  • dsc_uniquepermissions

    UniquePermissions - True if the web should have unique permissions, otherwise false.

    Supported values:
    • true
    • false
  • dsc_url

    Url - The URL of the web

  • dsc_useparenttopnav

    UseParentTopNav - True if the web should use the parent nav bar, otherwise false.

    Supported values:
    • true
    • false
  • name (namevar)
  • provider

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