Addzoneurl: Stsadm operation (Windows SharePoint Services)

Article
07/25/2014

Applies To: Windows SharePoint Services 3.0

Topic Last Modified: 2007-12-11

Operation name: Addzoneurl

Description

Configures the public URL and maps it to one of the five URL zones of a Web application or external resource.

This property is equivalent to the Public URLs user interface setting that is located on the Edit Public Zone URLs page of the SharePoint Central Administration Web site.

For more information, see Configure alternate access mapping (Windows SharePoint Services).

Syntax

stsadm -o addzoneurl

** -url <URL name>**

** -urlzone {Default | Internet | Intranet | Extranet | Custom}**

** -zonemappedurl <http://public.url>**

** -resourcename <non-Web application resource name>**

Parameters

Parameter name	Value	Required?	Description
url	A valid URL, such as http://server_name or http://server_name:1234	No. However, if the url parameter is used, then the resourcename parameter cannot be used.	URL of the Web application. This parameter should be an existing alternate access mappings (AAM) URL that is assigned to a Web application so that Stsadm can determine which Web application you are targeting. The URL can be a public URL or an internal URL from any zone associated with the targeted Web application.
urlzone	Any one of the following values: Default Intranet Internet Extranet Custom	Yes	One of the five zones with which the public URL is associated.
zonemappedurl	A valid URL, such as https://www.contoso.com	Yes	The public URL that you want to add. It is used as the base URL used in hyperlinks on Web pages or e-mail messages going from the Web server to the reverse proxy server or the client. This URL is the one that can be reached by the end user. This step ensures that the end user sees the correct URL when the URL is returned from the server to the client.
resourcename	A valid name, such as "Resource1"	No. However, if the resourcename parameter is used, the url parameter cannot be used.	A new resource name with a public URL in its default zone needs to be created using the addzoneurl operation. Once the resource name is created, you can use the existing resource name to add public URLs into additional zones or update existing public URLs. This parameter is equivalent to the External Resource Mapping user interface setting that is located on the Create External Resource Mapping page of the SharePoint Central Administration Web site.

Remarks

In Windows SharePoint Services 2.0, an internal URL was referred to as an incoming URL and a public URL was referred to as an outgoing URL.

For each Web request, Windows SharePoint Services 3.0 determines the protocol, host header, and port of the request and looks for a matching internal URL that was previously entered. If a matching internal URL is found, Windows SharePoint Services 3.0 then determines which zone will be used to format the hyperlinks in the response. A URL zone contains one public URL and one or more internal URLs.

Alternate access mappings enable a Web application that receives a request for an internal URL, in one of the five authentication zones, to return pages that contain links to the public URL for the zone. You can associate a Web application with a collection of mappings between internal and public URLs.

Internal refers to the URL of a Web request as it is received by Windows SharePoint Services 3.0. Public refers to the URL of an externally accessible Web site. The public URL is the base URL that Windows SharePoint Services 3.0 uses in the pages that it returns.

If the internal URL has been modified by a reverse proxy device, it can differ from the public URL.

Multiple internal URLs can be associated with a single public URL. Mapping collections can contain up to five authentication zones, but each zone can have no more than one public URL. Mapping collections correspond to the following authentication zones:

Default
Internet
Intranet
Extranet
Custom

The Default zone must always contain a public URL.

For additional information about zones, URLs, and logical architecture, see the Design logical architecture (Windows SharePoint Services)

Host-named site collections cannot use alternate access mappings. Host-named site collections are automatically considered to be in the Default zone, and the URL of the request must not be modified between the end user and the server.

Examples

If a reverse proxy server or load balancer receives a request from the user as https://www.contoso.com and forwards it to the server running Windows SharePoint Services 3.0 as http://sharepoint.courses.contoso.com:1234, the administrator would configure the following URLs for a SharePoint Web application:

Internal URL: http://sharepoint.courses.contoso.com:1234

Public URL: https://www.contoso.com

For this example, https://sharepoint:1234 is already an AAM URL that is assigned to a Web application and the Internet zone is used.

To set the public URL of an URL zone, use the following syntax:

stsadm -o addzoneurl -url https://sharepoint:1234 -urlzone Internet -zonemappedurl https://www.contoso.com

To confirm the change to the public URL, use the following syntax:

stsadm -o enumalternatedomains -url https://sharepoint:1234

Share via