e Set-TdOperator | Welcome to TOPdeskPS

Main | Command Reference | Quick Start

Welcome to TOPdeskPS

PowerShell module to interact with the TOPdesk REST Api

Set-TdOperator

SYNOPSIS

Update operators

SYNTAX

Modify

Set-TdOperator -Operator <Object> [-SurName <Object>] [-FirstName <String>] [-Gender <String>]
 [-EmployeeNumber <String>] [-Telephone <String>] [-MobileNumber <String>] [-NetworkLoginName <String>]
 [-Email <String>] [-Branch <String>] [-Location <String>] [-Department <String>] [-BudgetHolder <String>]
 [-LoginPermission] [-LoginName <String>] [-Password <SecureString>] [-TasksToAdd <String[]>]
 [-TasksToRemove <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Archive

Set-TdOperator -Operator <Object> [-ArchiveReason <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

Unarchive

Set-TdOperator -Operator <Object> [-Unarchive] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Update an operator by id. You can update the various properties of an operator. You can also archive an operator if you provide an archive. Same thing goes for Unarchiving a user. Due to api limitiations Archive/Unarchive requests may not be combined with updates to other properties of a user. They must be sent in seperate requests.

EXAMPLES

EXAMPLE 1

Get-TdOperator -TOPdeskLoginName 'first.last' | Set-TdOperator -Surname 'UpdatedSurname'

Updates the surname of the first.last operator.

EXAMPLE 2

Set-TdOperator -id $operator.id -password (read-host -assecurestring) -Login

Update the password for the operator stored in the $operator variable

EXAMPLE 3

Get-TdOperator -TOPdeskLoginName 'first.last' | Set-TdOperator -ArchiveReason (Get-TdArchiveReason 'no longer employed').id -LoginPermission:$false

EXAMPLE 4

PARAMETERS

-Operator

Id of the operator that you want to edit

Type: Object
Parameter Sets: (All)
Aliases: id

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SurName

Surname of the operator

Type: Object
Parameter Sets: Modify
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-FirstName

Firstname of the operator

Type: String
Parameter Sets: Modify
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Gender

The gender of the operator

Type: String
Parameter Sets: Modify
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EmployeeNumber

The employee number of the operator

Type: String
Parameter Sets: Modify
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Telephone

The telephone number for the operator

Type: String
Parameter Sets: Modify
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MobileNumber

Mobile number for the operator

Type: String
Parameter Sets: Modify
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NetworkLoginName

The network login name for the operator

Type: String
Parameter Sets: Modify
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Email

Email address of the operator

Type: String
Parameter Sets: Modify
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Branch

The id of the branch that you want to give the operator

Type: String
Parameter Sets: Modify
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Location

Location id of the operator

Type: String
Parameter Sets: Modify
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Department

The department id of the operator

Type: String
Parameter Sets: Modify
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-BudgetHolder

The budget holder id of the operator

Type: String
Parameter Sets: Modify
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LoginPermission

specify whether the operator has the permission to log on

Type: SwitchParameter
Parameter Sets: Modify
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-LoginName

Login name, operator requires permission “Settings > Login Settings” Is mandatory when loginPermission is set to true.

Type: String
Parameter Sets: Modify
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Password

Password, operator requires permission “Settings > Login Settings”. Is mandatory when “Functional Settings > Login Settings > Operator’s Section > Password mandatory on Operator card” is set.

Type: SecureString
Parameter Sets: Modify
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TasksToAdd

All of the tasks that you want to grant the operator

Type: String[]
Parameter Sets: Modify
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TasksToRemove

All of the tasks that you wish to revoke from the operator

Type: String[]
Parameter Sets: Modify
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ArchiveReason

Id of the archive reason that will be used to archive the operator. See Get-TdArchiveReason

Type: String
Parameter Sets: Archive
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Unarchive

Specify if you want to unarchive an operator.

Type: SwitchParameter
Parameter Sets: Unarchive
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES