Configure The Alternate Access Mappings,Using Stsadm Operations

In this articles,

• Addalternatedomain
• Addzoneurl 
• Deletealternatedomain 
• Enumalternatedomains 

Addalternatedomain: Stsadm operation (Office SharePoint Server)

Operation name: Addalternatedomain

Description

Adds an internal URL and maps it to one of the five URL zones of a Web application or external resource.

This operation is equivalent to the Add Internal URLs user interface setting that is located on the Alternate Access Mappings page of the SharePoint Central Administration Web site.

For more information, see Configure alternate access mapping.

Syntax

stsadm -o addalternatedomain

   -url <URL name>

   -incomingurl <http://internal.url>

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

   -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 urlparameter is used then theresourcenameparameter 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.
incomingurl	A valid URL, such as "http://sharepoint.courses.contoso.com:1234"	Yes	The internal URL that you want to add. This parameter should be limited to the protocol scheme, host name, and port number portions of the URL. It should not contain any other portions of an URL. You can map multiple internal URLs to the same URL zone.
urlzone	Any one of the following values: Default Intranet Internet Extranet Custom	Yes	One of the five zones with which the internal URL is associated.
resourcename	A valid name, such as "Resource1"	No. However, a resource name must already exist before this parameter can be used. You can create a new resource name using theAddzoneurloperation. Note: If theresourcenameparameter is used, then theurl parameter cannot be used. .	Specifies the external resource which the internal URL should be added to. This parameter is equivalent to theExternal Resource Mapping user interface setting that is located on the Create External Resource Mapping page of the SharePoint Central Administration Web site.

Remarks

A separate zone mapping for each Web application can be performed.

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 Microsoft Office SharePoint Server 2007. Public refers to the URL of an externally accessible Web site. The public URL is the base URL that Office SharePoint Server 2007 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 only have a single public URL. Mapping collections correspond to the following authentication zones:

• Default
• Internet
• Intranet
• Extranet
• Custom

For additional information about zones, URLs, and to view a corporate deployment scenario for each zone.

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, http://sharepoint:1234 is already an AAM URL that is assigned to a Web application and the Internet zone is used.

To configure an internal URL, use the following syntax:

stsadm -o addalternatedomain -url http://sharepoint:1234 -urlzone Internet -incomingurlhttp://sharepoint.courses.contoso.com:1234

To map the public URL to the URL zone, use the following syntax:

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

Note:
There can be only one public URL per URL zone. This is the URL used in Web pages or e-mail messages going from the Web server to the reverse proxy server or the client.

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

stsadm -o enumalternatedomains -url http://sharepoint.courses.contoso.com:1234

______________________________________________________________________________

Addzoneurl: Stsadm operation (Office SharePoint Server)

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.

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 urlparameter is used, then theresourcenameparameter 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 http://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 theresourcenameparameter is used, the urlparameter 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 theExternal 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 Microsoft Office SharePoint Server 2007. Public refers to the URL of an externally accessible Web site. The public URL is the base URL that Office SharePoint Server 2007 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 to view a corporate deployment scenario for each zone, see the

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, http://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 http://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 http://sharepoint:1234

______________________________________________________________________________

Deletealternatedomain: Stsadm operation (Office SharePoint Server)

Operation name: Deletealternatedomain

Description

Deletes an internal URL from a URL zone.

This operation is equivalent to the Edit Internal URLs user interface setting that is located on the Alternate Access Mappings page of the SharePoint Central Administration Web site.

For more information.

Syntax

stsadm -o deletealternatedomain

   -url <valid URL>

   -incomingurl <http://incoming.url>

Parameters

Parameter name	Value	Required?	Description
url	A valid URL, such as http://server_name or http://sharepoint:1234	No	URL of the Web application. In Windows SharePoint Services 3.0, this parameter is ignored. It remains for backward compatibility.
incomingurl	A valid URL, such as "http://sharepoint.courses.contoso.com:1234"	Yes	The internal URL that you want to delete.

Remarks

Because the public URL of a zone also serves as an internal URL of a zone, and because a Web application must always have a public URL for the Default zone, you cannot delete the last internal URL for the Default zone.

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.

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, http://sharepoint:1234 and http://sharepoint.courses.contoso.com:1234 are already alternate access mappings (AAM) URLs that are assigned to a Web application that are using the Internet zone.

To delete the http://sharepoint.courses.contoso.com:1234 internal URL, use the following syntax:

stsadm -o deletealternatedomain -incomingurl http://sharepoint.courses.contoso.com:1234

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

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

_________________________________________________________________________

Enumalternatedomains: Stsadm operation (Office SharePoint Server)

Updated: 2007-12-13

Operation name: Enumalternatedomains

Description

Lists the internal URLs and specifies the URL zones and public URLs to which they are mapped.

This property is equivalent to the Alternate Access Mappings page of the SharePoint Central Administration Web site.

For more information.

Syntax

stsadm -o enumalternatedomains

   -url <URL name>

   -resourcename <non-Web application name>

Parameters

Parameter name	Value	Required?	Description
url	A valid URL, such as http://server_name or http://sharepoint:1234	No. However, if the url orresourcenameparameters are not specified, the result is the public alternate access mappings (AAM) URLs for all of the Web applications and external resources in your farm are returned. If the url parameter is specified, the result is the public AAM URLs for the Web application that is specified. Note: If the url parameter is used, then theresourcenameparameter cannot be used.	URL of the Web application. This parameter should be an existing 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.
resourcename	A valid name, such as "Resource1"	No. However, a resource name must already exist before this parameter can be used. You can create a new resource name using the Addzoneurl operation. Note: If the resourcenameparameter is used, then the url parameter cannot be used.	Outputs the AAM information for the external resource you specify.

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.

The enumalternatedomains operation is especially useful when a support engineer needs to troubleshoot an AAM issue but does not have immediate access to your farm to view the settings. When the enumalternatedomainsoperation is run without any parameters, the result is a list of all the Web applications, external resources, and zones in your farm. It clearly identifies the public and internal URLs and the zones to which they are mapped. You can redirect the output to a text file by using the following command:

stsadm -o enumalternatedomains > C:\foldername\output.txt

Once the text file is created, you can send this file to the support engineer for them to review.

Examples

If you want display AAM information for all Web applications and external resources, such as which zones are in use, the public URL for those zones, and the internal URLs in those zones, use the following syntax:

stsadm -o enumalternatedomains

If you want to display AAM information for a specific Web application, such as which zones are in use, the public URL for those zones, and the internal URLs in those zones, use the following syntax:

stsadm -o enumalternatedomains -url https://www.contoso.com