About Help

Choose a topic from the list on the left or search for a specific topic. Choose a topic from the list or search for a specific topic.
Cmdlets  Providers  Aliases  Modules
 

about_SPDatabaseAAG

Spdatabaseaag

SharePointDSC
 

SHORT DESCRIPTION

 

.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 
     
.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 
            } 
        } 
    }