Get-AXModelManifest

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.

Get-AXModelManifest

Retrieves the properties of a model file.

Syntax

Parameter Set: Default
Get-AXModelManifest [-Config <String> ] [-Database <String> ] [-File <String> ] [-Model <String> ] [-Server <String> ] [-Xml] [ <CommonParameters>]

Detailed description

The Get-AXModelManifest cmdlet retrieves the properties of a model. It can be used to retrieve properties from a model in a model store or an .axmodel file. The cmdlet can also be used to output an XML version of a model manifest. This cmdlet returns all properties of a model, including properties that you cannot set values for, such as Category, Signed, and Layer.

Possible values for Category are Standard, Hotfix, and Virtual. Most models are in the Standard category. Hotfix describes the models that are created by the Microsoft sustained engineering team. Virtual describes models that are created by using the Install-AXModel cmdlet with the -CreateParents parameter.

Signed indicates whether a model has been signed.

Layer indicates the name of the layer that the model is in.

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 currently active configuration. 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

-File<String>

Specifies an .axmodel file to retrieve the manifest properties from.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Model<String>

Specifies a model to get the manifest for.

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

-Xml

Specifies that the model manifest should be returned in XML format, which can be piped to a file.

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

Example 1: Return an XML file

This example outputs an XML manifest from the model MyModel.

PS C:\>Get-AXModelManifest -File MyModel -Xml
<?xml version="1.0" encoding="utf-8"?>

<ModelManifest SchemaVersion="1.9" ModelFileVersion="17" ElementCount="0">
<Name>MyModel</Name>
<DisplayName>MyModel</DisplayName>
<Description />
<Publisher />
<Signed>false</Signed>
<Category>Standard</Category>
<InstallMode>Standard</InstallMode>
<Version>1.0.0.0</Version>
<Layer>ISV</Layer>
<DependencyState />
</ModelManifest>PS C:\Windows\system32>

Example 2: output a manifest

This example outputs a manifest from the model MyModel.

PS C:\>Get-AXModelManifest -File MyModel
Category : Standard

DependencyState :
Description :
DisplayName : MyModel
InstallMode : Standard
Layer : Usr
Name : MyModel
Publisher :
Signed : False
Version : 1.0.0.0
Details :
PS C:\>
                        

How to: View or Change the Manifest Properties of a Model

Copyright Microsoft Corporation. All rights reserved.