IPS_SetRemoteAccessPassword

 void IPS_SetRemoteAccessPassword (string $Password) 

Parameters

Returns

No return value

Description

The function sets or changes the password for remote access to the Management Console. The username for remote access is always the e-mail address of the licensee (see IPS_GetLicensee). Therefore a valid license must be set up in Symcon before calling the function (see Change license). Otherwise the function fails with "Cannot set the remote access password without a valid license!".

If an empty string is passed for Password, the remote access password is removed. Remote access is then disabled until a new password is set.

The change takes effect immediately; a restart of IP-Symcon is not required. The password is stored in the registry on Windows and in the .symcon file on all other platforms, where it previously had to be entered by hand. Whether a password is set is returned by IPS_HasRemoteAccessPassword; the password itself cannot be read back.

The currently logged in user (see IPS_GetLoggedInUser) must be an administrator, i.e. the @admin user or a user with the @admin role. Otherwise the function fails with "Administrator permissions are required for this action!". Without a login, e.g. when accessing from the local network while no remote access password is set yet, the call is allowed so that a new installation can be configured.

Example

IPS_SetRemoteAccessPassword('secret'); // set the remote access password
IPS_SetRemoteAccessPassword(''); // remove the remote access password, this disables remote access