Resource Type: dsc_sqlagdatabase

Defined in:
lib/puppet/type/dsc_sqlagdatabase.rb

Overview

The DSC SqlAGDatabase resource type. Automatically generated from version 16.6.0

Properties

  • dsc_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

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

  • dsc_ensure

    Specifies the membership of the database(s) in the availability group. The option ‘’Present’‘ means that the defined database(s) are added to the availability group. All other databases that may be a member of the availability group are ignored. The option `’Absent’‘ means that 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’‘.

  • dsc_isactivenode

    Returns if the current node is actively hosting the _SQL Server_ instance.

  • dsc_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 PsDscRunAsCredential has _impersonate any login_, _control server_, _impersonate login_, or _control login_ permissions. If set to `$false`, the owner of the database will be the username specified in PsDscRunAsCredential. The default is `$false`.

  • dsc_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.

  • dsc_replaceexisting

    If set to ‘$true`, this adds the restore option `WITH REPLACE`. If set to `$false`, existing databases and files will block the restore and throw error. The default is `$false`.

  • dsc_statementtimeout

    Set the query timeout in seconds for the backup and restore operations. The default is 600 seconds (10mins).

Parameters

  • dsc_availabilitygroupname (namevar)

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

  • dsc_force

    When parameter Ensure is set to ‘’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 parameter Ensure is set to `’Absent’‘.

  • dsc_instancename (namevar)

    Name of the _SQL Server_ instance where the primary replica of the availability group lives. If the availability group is not currently on this instance, the resource will attempt to connect to the instance where the primary replica lives.

  • dsc_psdscrunascredential
  • dsc_servername (namevar)

    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.

  • dsc_timeout

    The maximum time in seconds to wait for the DSC resource to complete.

  • name (namevar)

    Description of the purpose for this resource declaration.

  • validation_mode (defaults to: property)

    Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).