Windows-based Hosting::ControlCustomerWebSite

  • Article

The ControlCustomerWebSite procedure starts, stops, or pauses a customer Web site.

Arguments

The ControlCustomerWebSite procedure requires the following input parameters.

Input Argument Description

<org>

The Lightweight Directory Access Protocol (LDAP) path of the owning organization.

<webSiteName> or <location>

The unique Web site name that was established when the site was created, or use the IIS metabase path.

<serverState>

Valid integer values for this node are as follows:

  • 2 - Causes the server to start (or continue).

  • 4 - Causes the server to stop.

  • 6 - Causes the server to pause.

<preferredDomainController>

The name of the preferred domain controller.

Output Arguments

The ControlCustomerWebSite procedure has no return values.

Remarks

Security

The ControlCustomerWebSite procedure has the following security requirements:

  • The caller is impersonated.

  • The caller is tested for UserCreator permissions.

Process Steps

The following steps occur when controlling a customer Web site with the ControlCustomerWebSite procedure of the Managed Windows-based Hosting Namespace:

  • Validate that the organization owns the site.

  • Set the server state by calling Managed Web Hosting::ControlCustomerWebSite.

Sample Code

Example XML Request

The following is an example of an XML request for the ControlCustomerWebSite procedure of the Managed Windows-based Hosting Namespace:

                <request> 
                        <procedure> 
                                <execute namespace="Managed Web Hosting"  
                                procedure="ControlCustomerWebSite" impersonate="1"> 
                                        <executeData> 
                                        <webSiteName>NorthWindWeb</webSiteName> 
                                        <serverState>6</serverState> 
                                        </executeData> 
                                </execute> 
                        </procedure> 
                </request>

Applies To

Managed Windows-based Hosting Namespace API for:

  • Hosted Messaging and Collaboration version 3.5

  • Hosted Messaging and Collaboration version 3.0

  • Windows-based Hosting version 4.5

  • Windows-based Hosting version 4.0

  • Windows-based Hosting version 3.5

  • Windows-based Hosting for Applications version 1.0

See also

Tasks

Windows-based Hosting::DeleteCustomerWebSite
Windows-based Hosting::DeleteCustomerWebSite
Windows-based Hosting::ModifyCustomerWebSite