Remove-NAVServerUser

  • Article

Remove-NAVServerUser

Deletes a Microsoft Dynamics NAV user.

Syntax

Parameter Set: __AllParameterSets
Remove-NAVServerUser [-ServerInstance] <String> [-Force] [-Tenant <TenantId> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject
Remove-NAVServerUser -InputObject <DataRow> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Sid
Remove-NAVServerUser -Sid <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: UserName
Remove-NAVServerUser -UserName <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: WindowsAccount
Remove-NAVServerUser -WindowsAccount <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

Use the Remove-NAVServerUser cmdlet to delete a Microsoft Dynamics NAV user from a specified database or tenant database that is connected to a Microsoft Dynamics NAV Server instance.

Parameters

-Force

Forces the command to run without asking for user confirmation.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InputObject<DataRow>

Specifies the DataRow object that identifies the user to remove. You can pass this object from the Get-NAVServerUser cmdlet.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-ServerInstance<String>

Specifies the name of a Microsoft Dynamics NAV Server instance. The default instance name is DynamicsNAV71. You can specify either the full name of an instance (such as MicrosoftDynamicsNavServer$myinstance) or the short name (such as myinstance).

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-Sid<String>

A security identifier (SID) for the Microsoft Dynamics NAV user to delete. The SID is a unique value that identifies a Windows user account.

You can use the Sid, UserName, or WindowsAccount parameters to identify the user. If you use the Sid parameter, then do not set the UserName or WindowsAccount parameters.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Tenant<TenantId>

Specifies the ID of the tenant that the user is stored in, such as Tenant1. This parameter is required unless the specified service instance is not configured to run multiple tenants.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-UserName<String>

Specifies the user name of a Microsoft Dynamics NAV user to delete. The user name is defined by the User Name field in a user's account in Microsoft Dynamics NAV.

You can use the UserName, WindowsAccount or Sid parameters to identify the user. If you use the Username parameter, then you cannot use the Windows Account or Sid parameters.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WindowsAccount<String>

Specifies the Windows user name of the Microsoft Dynamics NAV user to delete. The value has the domain\username format.

You can use the WindowsAccount, UserName, or Sid parameters to identify the user. If you use the WindowsAccount parameter, then you cannot use the UserName or Sid parameters.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String

    You can pipe a string that contains a Microsoft Dynamics NAV Server instance name and tenant ID, if applicable, to the cmdlet.

  • System.Data.DataRow

    You can pass this object from the Get-NAVServerUser cmdlet to remove a user.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • None

    This cmdlet does not generate any output.

Examples

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

Description

-----------

This example deletes a Microsoft Dynamics NAV user from the database that is connected to the Microsoft Dynamics NAV Server server instance that has the name MicrosoftDynamicsNavServer. The user is identified by the security identifier.

C:\PS>Remove-NAVServerUser MicrosoftDynamicsNavServer -Sid S-1-5-20

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

Description
-----------

This example deletes a Microsoft Dynamics NAV. The user is identified by the Windows account user name.

C:\PS>Remove-NAVServerUser MicrosoftDynamicsNavServer –WindowsAccount cronus\chris

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

Description
-----------

This example deletes a Microsoft Dynamics NAV. The user is identified by the user name in Microsoft Dynamics NAV.

C:\PS>Remove-NAVServerUser MicrosoftDynamicsNavServer -UserName USER2

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

Description
-----------

This example uses piping to delete all Microsoft Dynamics NAV users for the Microsoft Dynamics NAV Server instance with the name MicrosoftDynamicsNavServer.

C:\PS>Get-NAVServerUser MicrosoftDynamicsNavServer | Remove-NAVServerUser MicrosoftDynamicsNavServer