en-US/about_SPContentDatabase.help.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
.NAME
    SPContentDatabase

# Description
    
    This resource is used to add and remove Content Databases to web applications
    and configure these databases. Note: The resource cannot be used to move the
    database to a different SQL instance. It will throw an error when it detects
    that the specified SQL instance is a different instance that is currently in
    use.
    
    The default value for the Ensure parameter is Present. When not specifying this
    parameter, the content database is provisioned.
    
.PARAMETER Name
    Key - String
    Specifies the name of the content database

.PARAMETER DatabaseServer
    Write - string
    The name of the database server to host the content DB

.PARAMETER WebAppUrl
    Required - string
    The URL of the web application

.PARAMETER Enabled
    Write - Boolean
    Should the database be enabled

.PARAMETER WarningSiteCount
    Write - Uint16
    Specify the site collection warning limit for the content database

.PARAMETER MaximumSiteCount
    Write - Uint16
    Specify the site collection maximum limit for the content database

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present to create this database, absent to ensure it does not exist

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


.EXAMPLE
    This example creates a new content database for the specified web application.


    Configuration Example 
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPContentDatabase ContentDB 
            {
                Name                 = "SharePoint_Content_01"
                DatabaseServer       = "SQL.contoso.local\SQLINSTANCE"
                WebAppUrl            = "http://sharepoint.contoso.com"
                Enabled              = $true
                WarningSiteCount     = 2000
                MaximumSiteCount     = 5000
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }


.EXAMPLE
    This example dismounts a content database from the specified web application. This 
    will not remove the database from SQL server however, only taking it out of the 
    web applications configuration.


    Configuration Example 
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPContentDatabase ContentDB 
            {
                Name                 = "SharePoint_Content_01"
                DatabaseServer       = "SQL.contoso.local\SQLINSTANCE"
                WebAppUrl            = "http://sharepoint.contoso.com"
                Ensure               = "Absent"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }