Managed Web Hosting::ControlCustomerWebSite

  • Article

The ControlCustomerWebSite method starts, stops, or pauses a specified Web site.

Arguments

Input argument Required Description

<webSiteName> or <location>

Yes

For this parameter, use the unique Web site name that was established when creating the site, or you can use the IIS metabase path.

<serverState>

No

Valid integer values for this parameter are:

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

  • 4 - causes the server to stop.

  • 6 - causes the server to pause.

Remarks

Process Steps

The following step occurs when controlling a Web site with the ControlCustomerWebSite method of the Managed Web Hosting Namespace:

  1. Set the server state.

Security

The ControlCustomerWebSite method has the following security requirements:

  • The caller is impersonated.

  • The caller is tested for OrgCreator permissions by checking for membership in any of the following groups:

    • Domain Admins

    • Hosting Admins

    • Reseller Admins

Sample Code

Example XML Request

The following is an example of an XML request for the ControlCustomerWebSite method of the Managed Web Hosting Namespace:

<request> 
        <procedure> 
                <execute namespace="Managed Web Hosting"  
                Procedure="ControlCustomerWebSite" impersonate="1"> 
                        <executeData> 
                        <org>LDAP://OU=northwindtraders,OU=consolidatedmessenger, 
                        OU=Hosting,DC=fabrikam,DC=Com</org> 
                        <webSiteName>www.northwindtraders.com</webSiteName> 
                        <serverState>2</serverState> 
                        <preferredDomainController>AD01.fabrikam.com 
                        </preferredDomainController> 
                        </executeData> 
                </execute> 
        </procedure> 
</request>

Example XML Response

No example XML response.

Applies To

Managed Web Hosting Namespace API for:

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0

  • 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

Managed Web Hosting::CreateCustomerWebSite
Managed Web Hosting::DeleteCustomerWebSite
Managed Web Hosting::ModifyCustomerWebSite