Skip to content

Commit fe0514e

Browse files
committed
Changes for upgrade scenario
1 parent 9703550 commit fe0514e

File tree

1 file changed

+61
-12
lines changed

1 file changed

+61
-12
lines changed

docs/directorymanager/11.1/credentialprovider/installconfigurecp.md

Lines changed: 61 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ sidebar_position: 1
1717
6. [Common Deployment Scenarios](#common-deployment-scenarios)
1818
7. [Troubleshooting & FAQ](#troubleshooting--faq)
1919
8. [Security Best Practices](#security-best-practices)
20-
9. [Rollback Instructions](#rollback-instructions)
20+
9. [Rollback Instructions](#rollback-instructions) (includes upgrade procedure)
2121
10. [Support](#support)
2222

2323
---
@@ -29,6 +29,7 @@ The Netwrix Directory Manager Credential Provider, formerly known as Netwrix Gro
2929
### What This Documentation Covers
3030

3131
- Step-by-step installation and configuration for first-time users
32+
- Upgrade procedure (uninstall old version, install new version)
3233
- Detailed configuration reference for all available settings
3334
- Common scenarios with example configurations
3435
- Troubleshooting guide for resolving common issues
@@ -42,6 +43,16 @@ The Netwrix Directory Manager Credential Provider, formerly known as Netwrix Gro
4243
- **Network access** to your password reset portal (HTTPS recommended)
4344
- **Minimum 500 MB** free disk space for installation
4445

46+
### Upgrade Policy
47+
48+
**Important:** This product does NOT support in-place upgrades. To upgrade to a newer version:
49+
1. Uninstall the current version (see [Rollback Instructions](#rollback-instructions))
50+
2. Restart the computer
51+
3. Install the new version following the [First-Time Setup Guide](#first-time-setup-guide)
52+
4. Apply your configuration settings
53+
54+
Your configuration settings in CPSettings.xml or Group Policy will be preserved during uninstall and can be reused with the new version.
55+
4556
---
4657

4758
## Glossary
@@ -157,7 +168,7 @@ Open `CPSettings.xml` in a text editor (as administrator) and modify these value
157168

158169
1. **Forgot Password Link Text**:
159170
```xml
160-
<ForgetPasswordText value="Forgot Password?" />
171+
<ForgotPasswordText value="Forgot Password?" />
161172
```
162173
Customize the text that appears on the Windows logon screen for the password reset option.
163174

@@ -384,8 +395,9 @@ If you selected "Advanced" in step 3.4, configure additional options:
384395
- Multiple transforms can be added if needed (processed in order from top to bottom)
385396
386397
3. **Upgrades Tab**:
387-
- Configure if this package replaces a previous version
388-
- Add previous versions if upgrading from older credential provider
398+
- **Note:** This tab is for MSI supersedence configuration only, NOT for in-place upgrades
399+
- Configure only if this MSI package should replace/uninstall a different product
400+
- Leave empty for standard deployments (the product does not support version upgrades)
389401
390402
4. **Security Tab**:
391403
- Verify "Authenticated Users" has "Read" permission
@@ -748,15 +760,16 @@ If your app depends on other applications (e.g., Visual C++ Redistributable):
748760

749761
**Step 6: Supersedence**
750762

751-
If this version replaces a previous credential provider version:
763+
**Note:** Supersedence is for replacing different products, NOT for upgrading versions of this product.
752764

753-
1. **Add Supersedence**:
754-
- Click: **+ Add**
755-
- Select previous version of credential provider
756-
- Supersedence type: **Uninstall** or **Update**
765+
For version upgrades of this credential provider:
766+
- You must first uninstall the old version
767+
- Then deploy the new version as a fresh installation
768+
- See [Upgrade Policy](#upgrade-policy) for details
757769

758-
2. **Or Skip** for first-time deployment:
759-
- Click: **Next**
770+
For first-time deployment:
771+
1. **Skip this step**:
772+
- Click: **Next** without adding supersedence
760773

761774
**Step 7: Assignments**
762775

@@ -2369,7 +2382,43 @@ Only as a temporary workaround for testing:
23692382

23702383
---
23712384

2372-
#### Q10: Do I need to restart after changing configuration?
2385+
#### Q10: How do I upgrade to a newer version?
2386+
2387+
**Answer**: This product does NOT support in-place upgrades. You must uninstall the old version first.
2388+
2389+
**Upgrade Procedure**:
2390+
2391+
1. **Backup Current Configuration**:
2392+
- Export registry settings (if using GPO)
2393+
- Copy CPSettings.xml to a safe location
2394+
- Document current configuration
2395+
2396+
2. **Uninstall Current Version**:
2397+
- Control Panel → Programs and Features
2398+
- Select "Netwrix GroupID Credential Provider"
2399+
- Click "Uninstall"
2400+
- Restart the computer
2401+
2402+
3. **Install New Version**:
2403+
- Follow the [First-Time Setup Guide](#first-time-setup-guide)
2404+
- Install the new MSI package
2405+
- Restart the computer
2406+
2407+
4. **Restore Configuration**:
2408+
- Copy your backed-up CPSettings.xml to the installation directory
2409+
- Or reapply GPO settings
2410+
- Restart or lock/unlock to verify
2411+
2412+
**For Enterprise Deployments**:
2413+
- Update the MSI package in your GPO/SCCM deployment
2414+
- Configure the GPO to uninstall old version before installing new version
2415+
- Test with a pilot group before rolling out organization-wide
2416+
2417+
See [Upgrade Policy](#upgrade-policy) for details.
2418+
2419+
---
2420+
2421+
#### Q11: Do I need to restart after changing configuration?
23732422

23742423
**Answer**: It depends on what you changed and how:
23752424

0 commit comments

Comments
 (0)