Rename-TSTMGMTObject

Rename an object within the Management Platform.

Written by Giuseppe

Last published at: December 14th, 2022

Rename an object within the Management Platform


SYNTAX

Rename-TSTMGMTObject

Rename-TSTMGMTObject -Object <IObject> -NewName <string> [-ObjectType {Folder | Device | Profile | Site | SoftwarePackage | Role | User | Broker | Notification | License}] [-Interface <guid>] [-Timeout <int>]

Rename-TSTMGMTObject

Rename-TSTMGMTObject -OldName <string> -NewName <string> [-Force] [-ObjectType {Folder | Device | Profile | Site |SoftwarePackage | Role | User | Broker | Notification | License}] [-Interface <guid>] [-Timeout <int>]

Rename-TSTMGMTObject

Rename-TSTMGMTObject -ObjectId <guid> -NewName <string> [-ObjectType {Folder | Device | Profile | Site |    SoftwarePackage | Role | User | Broker | Notification | License}] [-Interface <guid>] [-Timeout <int>]


DESCRIPTION

Rename an object from the Management Platform. You can specify a fully qualified Object Name, an ObjectId or an Object


EXAMPLES

1. Rename a Profile using the ObjectId

Rename-TSTMGMTObject -NewName 'Testing Rename' -ObjectId 'C5F5B049-C680-4D55-B48F-D8E464CBA2DD' -ObjectType Profile 


PARAMETERS


-NewName

The new name of the object

Type: String
Required: Yes
Accept Pipeline Input: No


-OldName

        The fully qualified name of the existing object

Type: String
Required: Yes
Accept Pipeline Input: No 


-Object

        An object to rename

Type: ThinScale.Management.DataObjects.IObject
Required: True
Accept Pipeline Input: True


-ObjectId

 The GUID of the existing object

Type: Guid
Required: Yes
Accept Pipeline Input: No


-ObjectType

         The type of object being renamed

            ('Folder','Device','Profile','Site','SoftwarePackage','Role','User','Broker','Notification','License')

Type: String
Required: No
Accept Pipeline Input: No
Accepted values: Folder, Device, Profile, Site, SoftwarePackage, Role, User, Broker, Notification, License


-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 multiple objects 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


INPUTS

ThinScale.Management.DataObjects.IObject


OUTPUTS

System.Object