Share via

Get-NAVServerInstance

Module:
Microsoft.Dynamics.Nav.Management Module

Gets service details for the specified Business Central Server instance.

Syntax

Default (Default) 

Get-NAVServerInstance
    [[-ServerInstance] <String>]
    [-AsXml]
    [-Force]
    [<CommonParameters>]

Description

Use the Get-NAVServerInstance cmdlet to obtain service details for the specified Business Central Server instance.

If no Business Central Server instance is specified, then the cmdlet obtains service details for all Business Central Server instances on the server computer. The service details include the name of the instance (for example, MicrosoftDynamicsNavServer$BC), the display name (for example, Business Central Server [BC]), the state of the instance (Running or Stopped), the Service Account (that is, the account that the Business Central Server uses for its credentials), the Business Central Server version (such as 7.0.33571.0), and whether the instance is the default Business Central Server instance.

Examples

EXAMPLE 1

Get-NavServerInstance MyInstance

Name           : MicrosoftDynamicsNavServer$MyInstance
DisplayName    : Business Central Server [MyInstance]
State          : Running
ServiceAccount : NT AUTHORITY\NETWORK SERVICE
Version        : 7.1.33544.0
Default        : False

This example returns status information for the MyInstance Business Central Server instance.

Parameters

-AsXml

Formats the cmdlet output as an XML document.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ServerInstance

Specifies the name of a Business Central Server instance, for example, BC or myinstance. You can specify either the full name of an instance, such as MicrosoftDynamicsNavServer$myinstance or the short name such as myinstance.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

System.String

You can pipe a string that contains a Business Central Server instance name to the cmdlet.

Outputs

System.Xml.XPathNodeList

Returns the Business Central Server instances as well-formatted text.

System.Xml.XmlDocument

If you use the AsXml parameter, then the cmdlet returns the Business Central Server instances as an XML document