MSBTS_HostInstance (WMI)
Represents a single instance of a BizTalk Host.
Declaration
class MSBTS_HostInstance : MSBTS_Service
Members
MSBTS_HostInstance defines the following properties:
| Property | Description |
|---|---|
| MSBTS_HostInstance.ClusterInstanceType Property (WMI) | This property tells whether the BizTalk Host Instance NT service is clustered. |
| Caption (Inherited from CIM_ManagedSystemElement) | For more information about the CIM_ManagedSystemElement class, see the Windows Management Instrumentation documentation at https://go.microsoft.com/fwlink/?LinkID=20245. |
| ConfigurationState | Contains the installation state for given instance of the BizTalk host. |
| Description (Inherited from CIM_ManagedSystemElement) | For more information about the CIM_ManagedSystemElement class, see the Windows Management Instrumentation documentation at https://go.microsoft.com/fwlink/?LinkID=20245. |
| HostName | Contains the name of the BizTalk host to which this BizTalk host instance belongs. |
| HostType | Indicates which runtime model the instances of the BizTalk host will be running in. |
| InstallDate (Inherited from CIM_ManagedSystemElement) | For more information about the CIM_ManagedSystemElement class, see the Windows Management Instrumentation documentation at https://go.microsoft.com/fwlink/?LinkID=20245. |
| IsDisabled | Enables or disables a host instance. |
| Logon | Contains the logon information that this BizTalk host instance is using. |
| MgmtDbNameOverride | Overrides the initial catalog part of the BizTalk Management database connect string, and represents the database name. This property was not implemented for BizTalk Server and is reserved for future use. |
| MgmtDbServerOverride | Overrides the data source part of the BizTalk Management database connect string. This property was not implemented for BizTalk Server and is reserved for future use. |
| Name | Contains the name of the host instance. |
| NTGroupName | Contains the name of the Microsoft Windows NT group. |
| RunningServer | Contains the name of the server on which the host instance runs. |
| ServiceState | Contains the state of the host instance. |
| Status (Inherited from CIM_ManagedSystemElement) | For more information about the CIM_ManagedSystemElement class, see the Windows Management Instrumentation documentation at https://go.microsoft.com/fwlink/?LinkID=20245. |
| UniqueID | Contains the unique ID of the host instance. |
MSBTS_HostInstance defines the following methods:
| Method | Description |
|---|---|
| GetState | Retrieves the state of the given instance of the BizTalk host. |
| Install | Installs a service for the given instance of the BizTalk host. |
| Start | Starts the given instance of the BizTalk host. |
| Stop | Stops the given instance of the BizTalk host. |
| Uninstall | Uninstalls a service for the given instance of the BizTalk host. |
Remarks
For more information about the minimum security user rights required to administer a Host instance, see Minimum Security User Rights.
Note
Always specify the name of the local server when using WMI. When you enumerate host instances, both local and remote instances will be returned. You can then call start, stop and other methods.
For samples illustrating the MSBTS_HostInstance class, see WMI Script Samples.
Requirements
Header: Declared in BTSWMISchemaXP.mof.
Namespace: Included in \root\MicrosoftBizTalkServer.