Remove-LinaTenant

NAME Remove-LinaTenant



SYNOPSIS

Deletes a Tenant from a Lina Server.





SYNTAX

Remove-LinaTenant -Name <String> [-WhatIf] [-Bulk] [<CommonParameters>]



Remove-LinaTenant -LinaTenants <PSObject[]> [-WhatIf] [-Bulk] [<CommonParameters>]





DESCRIPTION

Deletes a Tenant from a Lina Server.





PARAMETERS

-LinaTenants <PSObject[]>



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Name <String>

Name of the Tenant to delete. Wildcards are accepted (don't forget to enable Bulk mode for actions on multiple

tenants).



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

No actual deletion will happen if set. It will only display what tenants would be deleted.

Sometimes also called "Dry Run mode"



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Bulk [<SwitchParameter>]

Security parameter to enable deletion of multiple tenants. If not set only one tenant will be deleted.



Required? false

Position? named

Default value False

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

Accept pipelining of LinaTenant objects (from Get-LinaTenant for example)





OUTPUTS

None





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



PS C:\\>Remove-LinaTenant -Name "MyTenant"



Real deletion of a single tenant by name









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



PS C:\\>Get-LinaTenant -Name "MyTenant" | Remove-LinaTenant



Same example as #1 but using piped commands









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



PS C:\\>Get-LinaTenant -Name "Group1*" | Remove-LinaTenant -Bulk -WhatIf



Simulates deletion of a multiple Tenants by name (WhatIf mode)









-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Get-LinaTenant -Name Group1*" | Remove-LinaTenant -Bulk



Real deletion of a multiple Tenants by name









-------------------------- EXAMPLE 5 --------------------------



PS C:\\>Get-LinaTenant -ID 164 | Remove-LinaTenant -WhatIf



Simulates deletion of a single Tenant by ID











RELATED LINKS