Resource Type: dsc_sqlagreplica

Defined in:

lib/puppet/type/dsc_sqlagreplica.rb

Providers:

powershell

Overview

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

• 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_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_endpointhostname

  EndpointHostName - Specifies the hostname or IP address of the availability group replica endpoint. Default is the instance network name which is set in the code because the value can only be determined when connected to the SQL Instance.

• dsc_endpointport

  EndpointPort - Output the network port the endpoint is listening on. Used by Get-TargetResource.

• dsc_endpointurl

  EndpointUrl - Output the endpoint URL of the Availability Group Replica. Used by Get-TargetResource.

• dsc_ensure

  Ensure - Specifies if the availability group replica 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_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 replica. For named instances this must be in the following format ServerName\InstanceName.

• dsc_primaryreplicainstancename

  PrimaryReplicaInstanceName - Name of the SQL instance where the primary replica lives.

• dsc_primaryreplicaservername

  PrimaryReplicaServerName - Hostname of the SQL Server where the primary replica is expected to be active. If the primary replica is not found here, the resource will attempt to find the host that holds the primary replica and connect to it.

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

  ReadOnlyRoutingConnectionUrl - Specifies the fully-qualified domain name (FQDN) and port to use when routing to the replica for read only connections.

• dsc_readonlyroutinglist

  ReadOnlyRoutingList - Specifies an ordered list of replica server names that represent the probe sequence for connection director to use when redirecting read-only connections through this availability replica. This parameter applies if the availability replica is the current primary replica of the availability group.

• dsc_servername

  ServerName - Hostname of the SQL Server to be configured.

• name (namevar)
• provider

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