Uninstall-AXModel

Important

This content is archived and is not being updated. For the latest documentation, see Microsoft Dynamics 365 product documentation. For the latest release plans, see Dynamics 365 and Microsoft Power Platform release plans.

Uninstall-AXModel

Removes a model from the Microsoft Dynamics AX model store database.

Syntax

Parameter Set: Default
Uninstall-AXModel -Model <String> [-Config <String> ] [-Database <String> ] [-Details] [-Layer <String> ] [-ManifestFile <String> ] [-NoPrompt] [-Server <String> ] [ <CommonParameters>]

Detailed description

The Uninstall-AXModel cmdlet removes a model from the Microsoft Dynamics AX model store database. Deleting a model may cause orphan elements in other models.

Parameters

-Config<String>

Specifies an Application Object Server (AOS) configuration to use to determine the model store database and server name. The default value is the configuration that is currently active. This parameter cannot be used with the -Database or -Server parameters. If no -Database, -Server, or -Config parameters are supplied, the default configuration is used.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Database<String>

Specifies the Microsoft Dynamics AX model store database. This parameter cannot be used with the -Config parameter. If the -Database parameter is specified without a -Server parameter, the default server value of "(local)" is used.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Details

Specifies that a detailed description of the model being deleted should be displayed.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Layer<String>

Specifies the three-letter name of the Microsoft Dynamics AX layer where the model is installed, for example, VAR.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ManifestFile<String>

Specifies an XML file that identifies a model.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Model<String>

Identifies, by name, the model to be uninstalled.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NoPrompt

Specifies that the user will not receive a yes/no prompt to validate that they intended to uninstall a model.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Server<String>

Specifies the server that hosts the Microsoft Dynamics AX model store database. This parameter can only be used with the -Database parameter--it cannot be used by itself.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

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

Inputs

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

  • None

    You cannot pipe input to this cmdlet.

Outputs

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

  • ModelManifest

    Returns the model manifest class.

Examples

This example uninstalls the TestModel.

PS C:\>Uninstall-AXModel -Model TestModel -Details
PS C:\>
                        

How to: Remove (Uninstall) a Model

Copyright Microsoft Corporation. All rights reserved.