ServerProtocol Class

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

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

public sealed class ServerProtocol : ProtocolBase

The ServerProtocol type exposes the following members.

  NameDescription
Public propertyDisplayNameGets or sets the display name of the referenced protocol.
Public propertyHasMultiIPAddressesGets the Boolean property that specifies whether there are multiple IP addresses associated with the server protocol.
Public propertyIPAddressesRepresents a collection of ServerIPAddress objects. Each ServerIPAddress object represents an IP address defined on the server protocol.
Public propertyIsEnabledGets or sets the Boolean property that specifies whether the server network protocol is enabled or disabled.
Public propertyNameGets or sets the name of the referenced Windows Management Instrumentation (WMI) object. (Inherited from WmiSmoObject.)
Public propertyParentGets the ManagedComputer object that is the parent of the ServerProtocol object.
Public propertyPropertiesRepresents a collection of Property objects. Each Property object represents a property defined on the Windows Management Instrumentation (WMI) object. (Inherited from WmiSmoObject.)
Public propertyProtocolPropertiesRepresents a collection of ProtocolProperty objects. Each ProtocolProperty object represents an attribute defined on the referenced protocol. (Inherited from ProtocolBase.)
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyUrnGets the Uniform Resource Name (URN) address that represents the Windows Management Instrumentation (WMI) object. (Inherited from WmiSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public methodAlterUpdates any Protocol object property changes on an instance of SQL Server. (Inherited from ProtocolBase.)
Protected methodAlterProtocolPropertiesUpdates any protocol object property changes on the Windows Management Instrumentation (WMI) installation. (Inherited from WmiSmoObject.)
Protected methodCheckObjectStateChecks the state of the referenced object. (Inherited from WmiSmoObject.)
Protected methodCreateProtocolPropertyCollectionCreates a set of protocol attributes for the referenced object. (Inherited from WmiSmoObject.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetManagementObjectReturns the object that manages the referenced protocol object. (Inherited from ProtocolBase.)
Protected methodGetPropertyManagementObjectGets the management object for the specified protocol property. (Inherited from WmiSmoObject.)
Protected methodGetPropertyObjectGets the property from the specified collection with the specified position and value. (Inherited from WmiSmoObject.)
Protected methodGetProtocolPropertyCollectionReturns the protocol property collection for the referenced object. (Inherited from WmiSmoObject.)
Public methodGetType (Inherited from Object.)
Protected methodImplInitializeInitializes the fields of the WmiSmoObjectobject. (Inherited from WmiSmoObject.)
Public methodInitializeInitializes the referenced object. (Inherited from WmiSmoObject.)
Protected methodInvokeMgmtMethod(ManagementObject, String, Object[])Invokes the management method for the referenced object with the specified management object, method name, and parameters. (Inherited from WmiSmoObject.)
Protected methodInvokeMgmtMethod(ManagementObject, ManagementOperationObserver, String, Object[])Invokes the management method for the referenced object with the specified management object, observer, method name, and parameters. (Inherited from WmiSmoObject.)
Protected methodIsObjectInitializedSpecifies whether the referenced object is initialized. (Inherited from WmiSmoObject.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodRefreshRefreshes the properties of the referenced object. (Inherited from ProtocolBase.)
Protected methodSetNameSets the name of the referenced object. (Inherited from WmiSmoObject.)
Protected methodSetParentImplSets the parent of the referenced object. (Inherited from WmiSmoObject.)
Public methodToString (Inherited from Object.)
Protected methodUpdateObjectStateUpdates the object state. (Inherited from WmiSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top

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.

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

Community Additions

ADD
Show: