Resource Type: dsc_sqlagdatabase

Defined in:

lib/puppet/type/dsc_sqlagdatabase.rb

Providers:

powershell

Overview

The DSC SqlAGDatabase resource type. Automatically generated from ‘SqlServerDsc/DSCResources/MSFT_SqlAGDatabase/MSFT_SqlAGDatabase.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_availabilitygroupname

  AvailabilityGroupName - The name of the availability group in which to manage the database membership(s).

• dsc_backuppath

  BackupPath - The path used to seed the availability group replicas. This should be a path that is accessible by all of the replicas

• dsc_databasename

  DatabaseName - The name of the database(s) to add to the availability group. This accepts wildcards.

• dsc_ensure

  Ensure - Specifies the membership of the database(s) in the availability group. The options are: Present: The defined database(s) are added to the availability group. All other databases that may be a member of the availability group are ignored. Absent: The defined database(s) are removed from the availability group. All other databases that may be a member of the availability group are ignored. The default is ‘Present’. Valid values are Present, Absent.

• dsc_force

  Force - When used with ‘Ensure = ’Present” it ensures the specified database(s) are the only databases that are a member of the specified Availability Group. This parameter is ignored when ‘Ensure’ is ‘Absent’.

  Supported values:

  • true
  • false
• dsc_instancename

  InstanceName - Name of the SQL instance to be configured.

• dsc_isactivenode

  IsActiveNode - Determines if the current node is actively hosting the SQL Server instance.

  Supported values:

  • true
  • false
• dsc_matchdatabaseowner

  MatchDatabaseOwner - If set to $true, this ensures the database owner of the database on the primary replica is the owner of the database on all secondary replicas. This requires the database owner is available as a login on all replicas and that the PSDscRunAsAccount has impersonate permissions. If set to $false, the owner of the database will be the PSDscRunAsAccount. The default is ‘$true’

  Supported values:

  • true
  • false
• dsc_processonlyonactivenode

  ProcessOnlyOnActiveNode - Specifies that the resource will only determine if a change is needed if the target node is the active host of the SQL Server Instance.

  Supported values:

  • true
  • false
• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_servername

  ServerName - Hostname of the SQL Server where the primary replica of the availability group lives. If the availability group is not currently on this server, the resource will attempt to connect to the server where the primary replica lives.

• name (namevar)
• provider

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