Renaming a SecureAuth Realm
Applies to
SecureAuth IdP on Windows Server 2008 R2, 2012, and 2012 R2
Introduction
When a SecureAuth Realm is created, it is given the name SecureAuth plus a sequential number (e.g. SecureAuth3). Some customers prefer to use their own naming scheme to make it easier for users to locate resources. The instructions below discuss how to change the name of a SecureAuth IdP realm.
Discussion
Portal Page
Do not use these instructions if your site has a Portal page it does not yet support SecureAuth realms with custom naming schemes. Changing a realm name will break the link on the portal page and present users with an error. As an alternative you can create a User Friendly (vanity) URL. Please see the SecureAuth support document User Friendly URL Best Practice for further information on that process
Warning
Once a realm name is changed, the previous realm name (e.g. SecureAuth3) becomes unavailable to access
Ensure that a proper migration plan is in place before making the change
Warning
A restart of the World Wide Web Publishing service (IIS) is required to finalize the name change, and SecureAuth will be unavailable for user requests during the restart of the service
These changes should be scheduled during an official maintenance window to prevent unexpected downtime
Changing the Realm Name
1. Open a command prompt with elevated user rights (Run as administrator)
2. Backup the IIS configuration by entering the following command into the command prompt, and press Enter
%windir%\system32\inetsrv\appcmd.exe add backup "PreRenameBackup"
3. Change a realm's name by entering the following command into thecommand prompt,and press Enter
%windir%\system32\inetsrv\appcmd.exe set app "Default Web Site/OriginalAppName" -path:/NewAppName
Note
Change OriginalAppName to the SecureAuth Realm name to change (e.g. SecureAuth3)
Change NewAppName to the preferred name for the realm
4. Repeat step 3 for each realm that requires a name change
5. Restart the World Wide Web publishing service by entering the following command into thecommand prompt,and press Enter
iisreset
Restoring from Backup
Should an error occur during the rename process, the configuration can be reverted to the previous settings by restoring the backup made at the beginning of the process. Follow the instructions below to recover from the backup.
1. Open a command prompt with elevated user rights (Run as administrator)
2. Restore the IIS configuration by entering the following command into thecommand prompt,and press Enter
%windir%\system32\inetsrv\appcmd.exe restore backup "PreRenameBackup"
3. Restart the World Wide Web publishing service byentering the following command into thecommand prompt,and press Enter
iisreset