AF SDK Reference

AFAdmin.ResyncUsers Method

Save PDF

Save PDF

AFAdmin.ResyncUsers Method

Updates the usernames in AF.

Namespace: OSIsoft.AF.Diagnostics
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

public static void ResyncUsers(
	PISystem system
)

Public Shared Sub ResyncUsers ( 
	system As PISystem
)

Dim system As PISystem

AFAdmin.ResyncUsers(system)

public:
static void ResyncUsers(
	PISystem^ system
)

static member ResyncUsers : 
        system : PISystem -> unit

system: Type: OSIsoft.AFPISystem
The operation will be performed on the specified PISystem.

Exception	Condition
SecurityException	This exception is thrown when attempting to execute without Admin security rights.
ArgumentNullException	This exception is thrown when attempting to execute on a PISystem that is null or deleted.
NotSupportedException	This exception is thrown when attempting to execute on a PISystem that does not support the AdminFunctionality feature.

This method will update the usernames in AF with that from Active Directory.

Use the PISystem.Supports method to check if the PISystem supports the AdminFunctionality feature.

Security Note
Requires the Admin right to execute.

Notes to Callers
This method will error on servers before AF 2.10.10.

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11