Resource Type: dsc_sqlag

Defined in:

lib/puppet/type/dsc_sqlag.rb

Providers:

powershell

Overview

The DSC SqlAG resource type. Automatically generated from ‘SqlServerDsc/DSCResources/MSFT_SqlAG/MSFT_SqlAG.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_automatedbackuppreference

  AutomatedBackupPreference - Specifies the automated backup preference for the availability group. Default is None Valid values are Primary, SecondaryOnly, Secondary, None.

• dsc_availabilitymode

  AvailabilityMode - Specifies the replica availability mode. Default is ‘AsynchronousCommit’. Valid values are AsynchronousCommit, SynchronousCommit.

• dsc_backuppriority

  BackupPriority - Specifies the desired priority of the replicas in performing backups. The acceptable values for this parameter are: integers from 0 through 100. Of the set of replicas which are online and available, the replica that has the highest priority performs the backup. Default is 50.

• dsc_basicavailabilitygroup

  BasicAvailabilityGroup - Specifies the type of availability group is Basic. This is only available is SQL Server 2016 and later and is ignored when applied to previous versions.

  Supported values:

  • true
  • false
• dsc_connectionmodeinprimaryrole

  ConnectionModeInPrimaryRole - Specifies how the availability replica handles connections when in the primary role. Valid values are AllowAllConnections, AllowReadWriteConnections.

• dsc_connectionmodeinsecondaryrole

  ConnectionModeInSecondaryRole - Specifies how the availability replica handles connections when in the secondary role. Valid values are AllowNoConnections, AllowReadIntentConnectionsOnly, AllowAllConnections.

• dsc_databasehealthtrigger

  DatabaseHealthTrigger - Specifies if the option Database Level Health Detection is enabled. This is only available is SQL Server 2016 and later and is ignored when applied to previous versions.

  Supported values:

  • true
  • false
• dsc_dtcsupportenabled

  DtcSupportEnabled - Specifies if the option Database DTC Support is enabled. This is only available is SQL Server 2016 and later and is ignored when applied to previous versions. This can’t be altered once the Availability Group is created and is ignored if it is the case.

  Supported values:

  • true
  • false
• dsc_endpointhostname

  EndpointHostName - Specifies the hostname or IP address of the availability group replica endpoint. Default is the instance network name.

• dsc_endpointport

  EndpointPort - Gets the port the database mirroring endpoint is listening on.

• dsc_endpointurl

  EndpointUrl - Gets the Endpoint URL of the availability group replica endpoint.

• dsc_ensure

  Ensure - Specifies if the availability group should be present or absent. Default is Present. Valid values are Present, Absent.

• dsc_failovermode

  FailoverMode - Specifies the failover mode. Default is ‘Manual’. Valid values are Automatic, Manual.

• dsc_failureconditionlevel

  FailureConditionLevel - Specifies the automatic failover behavior of the availability group. Valid values are OnServerDown, OnServerUnresponsive, OnCriticalServerErrors, OnModerateServerErrors, OnAnyQualifiedFailureCondition.

• dsc_healthchecktimeout

  HealthCheckTimeout - Specifies the length of time, in milliseconds, after which AlwaysOn availability groups declare an unresponsive server to be unhealthy. Default is 30000.

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

  Name - The name of the availability group.

• 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 to be configured.

• dsc_version

  Version - Gets the major version of the SQL Server instance.

• name (namevar)
• provider

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