SqlServerDsc

15.0.1-preview0004

DSCResources/DSC_SqlProtocol/DSC_SqlProtocol.schema.mof

                                [ClassVersion("1.0.0.0"), FriendlyName("SqlProtocol")]

class DSC_SqlProtocol : OMI_BaseResource

{

    [Key, Description("Specifies the name of the _SQL Server_ instance to enable the protocol for.")] String InstanceName;

    [Key, Description("Specifies the name of network protocol to be configured."), ValueMap{"SharedMemory", "NamedPipes", "TcpIp"}, Values{"SharedMemory", "NamedPipes", "TcpIp"}] String ProtocolName;

    [Write, Description("Specifies the host name of the _SQL Server_ to be configured. If the SQL Server belongs to a cluster or availability group specify the host name for the listener or cluster group. Default value is $env:COMPUTERNAME.")] String ServerName;

    [Write, Description("Specifies if the protocol should be enabled or disabled.")] Boolean Enabled;

    [Write, Description("Specifies to listen on all IP addresses. Only used for the _TCP/IP_ protocol, ignored for all other protocols.")] Boolean ListenOnAllIpAddresses;

    [Write, Description("Specifies the keep alive duration in milliseconds. Only used for the _TCP/IP_ protocol, ignored for all other protocols.")] SInt32 KeepAlive;

    [Write, Description("Specifies the name of the named pipe. Only used for the _Named Pipes_ protocol, ignored for all other protocols.")] String PipeName;

    [Write, Description("If set to `$true` then the any attempt by the resource to restart the service is suppressed. The default value is `$false`.")] Boolean SuppressRestart;

    [Write, Description("Timeout value for restarting the _SQL Server_ services. The default value is `120` seconds.")] UInt16 RestartTimeout;

    [Read, Description("Returns `$true` or `$false` whether the instance has multiple IP addresses or not.")] Boolean HasMultiIPAddresses;

};