Share via

  • Article

ServerProtocol Class

The ServerProtocol class represents a network protocol installed on a server instance that allows communication with SQL Server clients over a network.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.Wmi.WmiSmoObject
      Microsoft.SqlServer.Management.Smo.Wmi.ProtocolBase
        Microsoft.SqlServer.Management.Smo.Wmi.ServerProtocol

Namespace:  Microsoft.SqlServer.Management.Smo.Wmi
Assembly:  Microsoft.SqlServer.SqlWmiManagement (in Microsoft.SqlServer.SqlWmiManagement.dll)

Syntax

'Declaration
Public NotInheritable Class ServerProtocol _
    Inherits ProtocolBase
'Usage
Dim instance As ServerProtocol

public sealed class ServerProtocol : ProtocolBase

public ref class ServerProtocol sealed : public ProtocolBase

[<SealedAttribute>]
type ServerProtocol =  
    class
        inherit ProtocolBase
    end

public final class ServerProtocol extends ProtocolBase

The ServerProtocol type exposes the following members.

Properties

  Name Description
Public property DisplayName Gets or sets the display name of the referenced protocol.
Public property HasMultiIPAddresses Gets the Boolean property that specifies whether there are multiple IP addresses associated with the server protocol.
Public property IPAddresses Represents a collection of ServerIPAddress objects. Each ServerIPAddress object represents an IP address defined on the server protocol.
Public property IsEnabled Gets or sets the Boolean property that specifies whether the server network protocol is enabled or disabled.
Public property Name Gets or sets the name of the referenced Windows Management Instrumentation (WMI) object. (Inherited from WmiSmoObject.)
Public property Parent Gets the ManagedComputer object that is the parent of the ServerProtocol object.
Public property Properties Represents a collection of Property objects. Each Property object represents a property defined on the Windows Management Instrumentation (WMI) object. (Inherited from WmiSmoObject.)
Public property ProtocolProperties Represents a collection of ProtocolProperty objects. Each ProtocolProperty object represents an attribute defined on the referenced protocol. (Inherited from ProtocolBase.)
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property Urn Gets the Uniform Resource Name (URN) address that represents the Windows Management Instrumentation (WMI) object. (Inherited from WmiSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

  Name Description
Public method Alter Updates any Protocol object property changes on an instance of SQL Server. (Inherited from ProtocolBase.)
Protected method AlterProtocolProperties Updates any protocol object property changes on the Windows Management Instrumentation (WMI) installation. (Inherited from WmiSmoObject.)
Protected method CheckObjectState Checks the state of the referenced object. (Inherited from WmiSmoObject.)
Protected method CreateProtocolPropertyCollection Creates a set of protocol attributes for the referenced object. (Inherited from WmiSmoObject.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Protected method GetManagementObject Returns the object that manages the referenced protocol object. (Inherited from ProtocolBase.)
Protected method GetPropertyManagementObject Gets the management object for the specified protocol property. (Inherited from WmiSmoObject.)
Protected method GetPropertyObject Gets the property from the specified collection with the specified position and value. (Inherited from WmiSmoObject.)
Protected method GetProtocolPropertyCollection Returns the protocol property collection for the referenced object. (Inherited from WmiSmoObject.)
Public method GetType (Inherited from Object.)
Protected method ImplInitialize Initializes the fields of the WmiSmoObjectobject. (Inherited from WmiSmoObject.)
Public method Initialize Initializes the referenced object. (Inherited from WmiSmoObject.)
Protected method InvokeMgmtMethod(ManagementObject, String, array<Object[]) Invokes the management method for the referenced object with the specified management object, method name, and parameters. (Inherited from WmiSmoObject.)
Protected method InvokeMgmtMethod(ManagementObject, ManagementOperationObserver, String, array<Object[]) Invokes the management method for the referenced object with the specified management object, observer, method name, and parameters. (Inherited from WmiSmoObject.)
Protected method IsObjectInitialized Specifies whether the referenced object is initialized. (Inherited from WmiSmoObject.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Refresh Refreshes the properties of the referenced object. (Inherited from ProtocolBase.)
Protected method SetName Sets the name of the referenced object. (Inherited from WmiSmoObject.)
Protected method SetParentImpl Sets the parent of the referenced object. (Inherited from WmiSmoObject.)
Public method ToString (Inherited from Object.)
Protected method UpdateObjectState Updates the object state. (Inherited from WmiSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Remarks

With the ServerProtocol class you can:

  • Modify the display name of the protocol.

  • Enable or disable the protocol.

  • View the IP addresses associated with the protocol.

  • Create a set of attributes for the protocol.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.