Remove Send Port (BizTalk Server Sample)

The Remove Send Port sample demonstrates how to unenlist and remove one or more send ports.

Warning

Deployment scripts should be removed after deployment if not needed. Administration scripts and other scripts that must remain should be secured by ACL’s and closely monitored.

What This Sample Does

The Visual Basic Scripting Edition (VBScript) script in the script file that constitutes this sample shows how to perform the following operations using the BizTalk Server WMI provider:

  • Given a send port name, query for a list of matching send ports.

    Note

    Generally, there will only be one send port that matches a given name.

  • Unenlist those send ports.

  • Delete those send ports.

  • Handle any errors such that meaningful information is returned to the user.

Where to Find This Sample

The sample is located in the following SDK location:

<Samples Path>\Admin\WMI\Remove Send Port\

The following table shows the files in this sample and describes their purpose.

File(s) Description
In the \VBScript folder:

RemoveSendPort.vbs
VBScript file that takes a parameter that specifies one or more send ports to unenlist and remove.

Building and Initializing This Sample

The Remove Send Port sample consists of a single VBScript file that you not need to build or initialize.

Running This Sample

To run the Remove Send Port sample

  1. In a command window, navigate to the following folder:

    <Samples Path>\Admin\WMI\Remove Receive Port\VBScript\

  2. Run the file RemoveSendPort.vbs using the cscript program, passing the following command-line argument:

    < SendPortName >. The name of the send port(s) to remove. If the send port name contains spaces, enclose the name in quotes.

    For example:

    cscript RemoveSendPort.vbs "My Business Send Port"
    

Comments

All tasks that you can perform in the BizTalk Server Administration console can also be performed by using script that accesses the Windows WMI object model.

The script file RemoveSendPort.vbs contains detailed comments with further explanation about the operations that it performs. For more information, see Windows Management Instrumentation.

See Also

Admin-WMI (BizTalk Server Samples Folder)