Updates an Access Key's details within the Management Platform.

SYNTAX

DESCRIPTION

Updates properties of an existing Access Key in the Management Platform.

EXAMPLES

1. Change the description of the Access Key called ‘Support Department’, Default Device Folder and enable Legacy authentication using SupportAdmin username and Support password.
    

2. Disable the Access Key called Support Department

PARAMETERS

-AccessKeyName

Fully qualified or relative name of the AccessKey to create

-AccessKeyDescription

Description of the AccessKey to create

-RegenerateRegistrationKey

Generate a new registration key. The previous registration key will no longer be valid for new devices connecting.

-RegenerateKey1

Generate a new Key1 for existing devices. Existing devices will receieve this key the next time they connect if they still have a valid Key2.

-RegenerateKey2

Generate a new Key2 for existing devices. Existing devices will receieve this key the next time they connect if they still have a valid Key1.

-Disable

Disable the AccessKey.

-Enable

Enable the AccessKey.

-AllowAutoAdd

Allows devices to be added if they do not exist when connecting via this AccessKey

-DisallowAutoAdd

Prevent devices being added if they do not exist when connecting via this AccessKey.

-DefaultDeviceFolderId

The GUID of the folder devices will be added to the access Key.

-DefaultDeviceFolderName

The fully qualified name of the folder devices will be added to the Access Key.

-ForceDeviceFolder

If multiple DefaultDeviceFolders are found with the same name, the first retrieved will be used otherwise the call will fail

-EnableMoveDeviceOnAuth

Enable devices to be moved to the default folder during authentication

-EnableMoveDeviceOnInstall

Enable devices to be moved to the default folder during installation

-DisableMoveDeviceOnAuth

Prevent devices to be moved to the default folder during authentication.

-DisableMoveDeviceOnInstall

Disable devices to be moved to the default folder during installation.

-EnableLegacyAuth

Enable devices to connect using the old Site username/password credentials

-LegacyAuthUsername

If LegacyAuth is enabled, specify the username for authentication

-LegacyAuthPassword

If LegacyAuth is enabled, specify the password for authentication

-DisableLegacyAuth

Disable devices from connecting with the old Site username/password credentials.

-RegistrationKeyCreatesNewDevice

Always create a new device if same machine uses registration key more than once

-UseMACWhenDeviceIdNotFound

When device NOT found try to identify machine by MAC Address

-UseSIDWhenDeviceIdNotFound

When device NOT found try to identify machine by SID

-VerifyDeviceIdWithMAC

When device IS found verify device is unique by MAC

-VerifyDeviceIdWithSID

When device IS found verify device is unique by MAC

-Interface

The interface ID returned by a previously successful call to Connect-TSTMGMTServer. This parameter is only required if you are connected to 2 or more Management Platform instances at the same time. If this parameter is not specified the connection to the last successful call to Connect-TSTMgmtServer will be used.

-Timeout

The time allowed in milliseconds for the call to complete before it is deemed to have timed out and is aborted

-Force

        If the path for the new user does not exist then it will be created

INPUTS

ThinScale.Management.DataObjects.AccessKey

OUTPUTS

ThinScale.Management.DataObjects.AccessKey