Updates an Access Key's details within the Management Platform.
SYNTAX
Set-TSTMGMTAccessKey
-AccessKey <AccessKey> [-AccessKeyName <string>] [-AccessKeyDescription <string>] [-RegenerateRegistrationKey] [-RegenerateKey1] [-RegenerateKey2] [-Disable] [-Enable] [-AllowAutoAdd] [-DisallowAutoAdd] [-DefaultDeviceFolderId <guid>] [-DefaultDeviceFolderName <string>] [-ForceDeviceFolder] [-EnableMoveDeviceOnAuth] [-DisableMoveDeviceOnAuth] [-EnableMoveDeviceOnInstall] [-DisableMoveDeviceOnInstall] [-EnableLegacyAuth] [-DisableLegacyAuth] [-LegacyAuthUsername <string>] [-LegacyAuthPassword <string>] [-RegistrationKeyCreatesNewDevice] [-UseMACWhenDeviceIdNotFound] [-UseSIDWhenDeviceIdNotFound] [-VerifyDeviceIdWithMAC] [-VerifyDeviceIdWithSID] [-Interface <guid>] [-Timeout <int>]
DESCRIPTION
Updates properties of an existing Access Key in the Management Platform.
EXAMPLES
- Change the description of the Access Key called ‘Support Department’, Default Device Folder and enable Legacy authentication using SupportAdmin username and Support password.
![](https://static.helpjuice.com/helpjuice_production/uploads/upload/image/4871/direct/1671025609357-image.png)
2. Disable the Access Key called Support Department
![](https://static.helpjuice.com/helpjuice_production/uploads/upload/image/4871/direct/1671025676878-image.png)
PARAMETERS
-AccessKeyName
Fully qualified or relative name of the AccessKey to create
Type: | String |
Required: | Yes |
Accept Pipeline Input: | No |
-AccessKeyDescription
Description of the AccessKey to create
Type: | String |
Required: | Yes |
Accept Pipeline Input: | No |
-RegenerateRegistrationKey
Generate a new registration key. The previous registration key will no longer be valid for new devices connecting.
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
-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.
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
-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.
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
-Disable
Disable the AccessKey.
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
-Enable
Enable the AccessKey.
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
-AllowAutoAdd
Allows devices to be added if they do not exist when connecting via this AccessKey
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
-DisallowAutoAdd
Prevent devices being added if they do not exist when connecting via this AccessKey.
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
-DefaultDeviceFolderId
The GUID of the folder devices will be added to the access Key.
Type: | Guid |
Required: | No |
Accept Pipeline Input: | No |
-DefaultDeviceFolderName
The fully qualified name of the folder devices will be added to the Access Key.
Type: | String |
Required: | No |
Accept Pipeline Input: | No |
-ForceDeviceFolder
If multiple DefaultDeviceFolders are found with the same name, the first retrieved will be used otherwise the call will fail
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
-EnableMoveDeviceOnAuth
Enable devices to be moved to the default folder during authentication
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
-EnableMoveDeviceOnInstall
Enable devices to be moved to the default folder during installation
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
-DisableMoveDeviceOnAuth
Prevent devices to be moved to the default folder during authentication.
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
-DisableMoveDeviceOnInstall
Disable devices to be moved to the default folder during installation.
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
-EnableLegacyAuth
Enable devices to connect using the old Site username/password credentials
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
-LegacyAuthUsername
If LegacyAuth is enabled, specify the username for authentication
Type: | String |
Required: | No |
Accept Pipeline Input: | No |
-LegacyAuthPassword
If LegacyAuth is enabled, specify the password for authentication
Type: | String |
Required: | No |
Accept Pipeline Input: | No |
-DisableLegacyAuth
Disable devices from connecting with the old Site username/password credentials.
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
-RegistrationKeyCreatesNewDevice
Always create a new device if same machine uses registration key more than once
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
-UseMACWhenDeviceIdNotFound
When device NOT found try to identify machine by MAC Address
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
-UseSIDWhenDeviceIdNotFound
When device NOT found try to identify machine by SID
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
-VerifyDeviceIdWithMAC
When device IS found verify device is unique by MAC
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
-VerifyDeviceIdWithSID
When device IS found verify device is unique by MAC
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
-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.
Type: | Guid |
Required: | No |
Accept Pipeline Input: | No |
-Timeout
The time allowed in milliseconds for the call to complete before it is deemed to have timed out and is aborted
Type: | Int32 |
Required: | No |
Accept Pipeline Input: | No |
-Force
If the path for the new user does not exist then it will be created
Type: | SwitchParameter |
Required: | No |
Accept Pipeline Input: | No |
INPUTS
ThinScale.Management.DataObjects.AccessKey
OUTPUTS
ThinScale.Management.DataObjects.AccessKey