Set-LinaAgent

NAME Set-LinaAgent



SYNOPSIS

Changes the configuration of an agent.





SYNTAX

Set-LinaAgent -LinaAgents <PSObject[]> [-NewName <String>] [-Tenant <String>] [-Group <String>] [-Strategy

<String>] [-Protection <String>] [<CommonParameters>]





DESCRIPTION

Changes the configuration of an agent for example its name.





PARAMETERS

-LinaAgents <PSObject[]>



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-NewName <String>

New name for the agent. If multiple agent are passed, only the first one will be renamed as names have to be

unique.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Tenant <String>

Move the agent to this tenant.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Group <String>

Move the agent to this agent group.

Note : Agent group has to be in the same tenant as the agent or in its new tenant (if Tenant is provided)



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Strategy <String>

Change the strategy for this agent



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Protection <String>

Change the protection for this agent



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

Array of LinaAgent Objects





OUTPUTS

The modified LinaAgent Objects





-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-LinaAgent -Name "TEST1" | Set-LinaAgent -NewName "TEST2"



Changes the name of the agent from TEST1 to TEST2









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-LinaAgent -Name "TEST1" | Set-LinaAgent -Tenant "MyTenant"



Moves the agent TEST1 to the Tenant MyTenant









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Get-LinaAgent -Name "TEST1" | Set-LinaAgent -NewName "TEST2" -Tenant "MyTenant" -Group "MyGroup" -Strategy

"MyStrategy" -Protection "MyProtection"



Changes everything at the same time (Name, Tenant, Group, Strategy and Protection)











RELATED LINKS