Get-NAVServerInstance

Article
10/18/2021

Get-NAVServerInstance

Obtains service details for the specified Microsoft Dynamics NAV Server instance.

Syntax

Parameter Set: __AllParameterSets
Get-NAVServerInstance [[-ServerInstance] <String> ] [-AsXml] [ <CommonParameters>]

Detailed Description

Use the Get-NAVServerInstance cmdlet to obtain service details for the specified Microsoft Dynamics NAV Server instance. If no Microsoft Dynamics NAV Server instance is specified, then the cmdlet obtains service details for all Microsoft Dynamics NAV Server instances on the server computer.

The service details include the name of the instance (for example, MicrosoftDynamicsNavServer$DynamicsNAV70), the display name (for example, Microsoft Dynamics NAV Server [DynamicsNAV70]), the state of the instance (Running or Stopped), the Service Account (that is, the account that the Microsoft Dynamics NAV Server uses for its credentials), the Microsoft Dynamics NAV Server version (such as 7.0.33571.0), and whether the instance is the default Microsoft Dynamics NAV Server instance.

Parameters

-AsXml

Formats cmdlet output as an XML document.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ServerInstance<String>

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

Aliases	none
Required?	false
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByValue, ByPropertyName)
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 to the cmdlet.

Outputs

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

System.Xml.XPathNodeList

Returns the Microsoft Dynamics NAV Server instances as well-formatted text.
System.Xml.XmlDocument

If you use the AsXml parameter, then the cmdlet returns the Microsoft Dynamics NAV Server instances as an XML document.

Examples

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

Description

-----------

This example returns status information for the MyInstance Microsoft Dynamics NAV Server instance.

C:\PS>Get-NavServerInstance MyInstance


Name           : MicrosoftDynamicsNavServer$MyInstance
DisplayName    : Microsoft Dynamics NAV Server [DynamicsNAV70]
State          : Running
ServiceAccount : NT AUTHORITY\NETWORK SERVICE
Version        : 7.0.33544.0
Default        : False

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

Description

-----------

This example returns an XML document that contains status information for all Microsoft Dynamics NAV Server instances on the server computer.

C:\PS>Get-NAVServerInstance -AsXml | fc


class XmlDocument
{
#comment = Available Dynamics NAV Server Instance(s) on computer .

Instances =
class XmlElement
{
ServerInstance =
[
class XmlElement
{
Name = MicrosoftDynamicsNavServer$ServerInstance1MyInstance
DisplayName = Microsoft Dynamics NAV Server [MyInstance]
State = Running
ServiceAccount = NT AUTHORITY\NETWORK SERVICE
Version = 7.0.33544.0
Default = False
}
class XmlElement
{
Name = MicrosoftDynamicsNavServer$MyInstance2
DisplayName = Microsoft Dynamics NAV Server [MyInstance2]
State = Stopped
ServiceAccount = NT AUTHORITY\NETWORK SERVICE
Version = 7.0.99.99
Default = True
}
]

}
}

Get-NAVServerInstance