en-US/about_SPDatabaseAAG.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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
.NAME
    SPDatabaseAAG

# Description
    
    This resource will allow specifying which SQL Server AlwaysOn Availability
    group a resource should be in. This resource does not configure the
    Availability Groups on SQL Server, they must already exist. It simply adds
    the specified database to the group.
    
    You can add a single database name by specifying the database name, or
    multiple databases by specifying wildcards. For example:
    SP_Content* or *Content*
    
    Important:
    This resource requires the April 2014 CU to be installed. The required
    cmdlets have been added in this CU: http://support.microsoft.com/kb/2880551
    
    The default value for the Ensure parameter is Present. When not specifying this
    parameter, the content database is added to the AAG.
    
.PARAMETER DatabaseName
    Key - string
    The name of the database to put in the AlwaysOn group

.PARAMETER AGName
    Required - string
    Name of the AlwaysOn group on the SQL server - this must already exist

.PARAMETER FileShare
    Write - string
    The fileshare to use for the SQL backup when adding to the group

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present if the database should be in this AlwaysOn group, or Absent if it should not be in the group

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


.EXAMPLE
    This example takes an existing SharePoint database and puts it in to the specified
    AlwaysOn Availability Group (AAG).


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

        node localhost {
            SPDatabaseAAG ConfigDBAAG
            {
                DatabaseName         = "SP_Config"
                AGName               = "MyAvailabilityGroup"
                FileShare            = "\\SQL\Backups"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }


.EXAMPLE
    This example takes existing SharePoint databases, based on the database name pattern, and puts
    them in to the specified AlwaysOn Availability Group (AAG).


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

        node localhost {
            SPDatabaseAAG ConfigDBAAG
            {
                DatabaseName         = "*Content*"
                AGName               = "MyAvailabilityGroup"
                FileShare            = "\\SQL\Backups"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }


.EXAMPLE
    This example removes a database from the specified AlwaysOn Availability Group (AAG)


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

        node localhost {
            SPDatabaseAAG ConfigDBAAG
            {
                DatabaseName         = "SP_Config"
                AGName               = "MyAvailabilityGroup"
                Ensure               = "Absent"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }