New-NAVServerInstance

New-NAVServerInstance

Creates a new Microsoft Dynamics NAV Server instance.

Syntax

Parameter Set: __AllParameterSets
New-NAVServerInstance [-ServerInstance] <String> -ManagementServicesPort <Int> [-ClientServicesCredentialType <String> ] [-ClientServicesPort <Int> ] [-DatabaseInstance <String> ] [-DatabaseName <String> ] [-DatabaseServer <String> ] [-Force] [-ODataServicesPort <Int> ] [-ServiceAccount <ServiceAccount> ] [-ServiceAccountCredential <PSCredential> ] [-ServicesCertificateThumbprint <ClientServicesCertificateThumbprint> ] [-SOAPServicesPort <Int> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

Use the New-NAVServerInstance cmdlet to create a new Microsoft Dynamics NAV Server instance. You must specify a name for the instance, in addition to values for the four port parameters. All other configuration values for the new instance are based on default values. Make sure that you verify the DatabaseServer and DatabaseName values after the instance is created, to ensure that the instance can accept client requests. All permissions that are required for the instance to start are configured automatically.

Parameters

-ClientServicesCredentialType<String>

The type of client credential used for client authentication.

Possible values are: Windows, Username, NavUserPassword and AccessControlService.

If you use the Windows credential type, then the client connects with current user. This user must be known to both the server and the client. This is the default credential type. Typically, it is used on a LAN with Active Directory. With the Windows credential type, X.509 certificates are not used.

If you use the UserName credential type, then the user must specify username/password credentials on the client. These credentials are then validated against Windows authentication by Microsoft Dynamics NAV Server. There must already be a corresponding user in Windows. Security certificates are required to protect the passing of credentials across a wide-area network. This setting should typically be used when the computer on which Microsoft Dynamics NAV Server is installed is part of an authenticating Active Directory domain but the computer where the client is installed is not part of the domain.

If you use the NavUserPassword credential type, then authentication is managed by Microsoft Dynamics NAV Server but is not based on Windows users or Active Directory. The user is prompted for username/password credentials when they start the client. The credentials are then validated by an external mechanism. Security certificates are required to protect the passing of credentials. This mode is intended for hosted environments, for example, where Microsoft Dynamics NAV is implemented in Windows Azure and the list of allowed users is maintained by Microsoft Dynamics NAV and not based on Windows users.

If you use the AccessControlService credential type, then authentication is handled by Windows Azure AccessControlService (ACS) or Microsoft Azure Active Directory (Microsoft Azure AD) for user authentication services. You can use only the security token types that are supported by ACS, namely, SAML 1.1, SAML 2.0. and SWT. With this credential setting enabled, SOAP and OData Services accept a user-mapped ServiceSecurityToken as authentication model. This credential type is used by Windows Azure Marketplace.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ManagementServicesPort<Int>

Specifies the TCP port that is used to manage the Microsoft Dynamics NAV Server instance.

The Management Services port has no exceptions in the firewall, and will only be accessed from the local computer. The port is used by Windows PowerShell for access Microsoft Dynamics NAV Server management data.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ServerInstance<String>

Specifies the name of the Microsoft Dynamics NAV Server instance. The default instance name isDynamicsNAV80. You can specify either the full name of an instance, such as MicrosoftDynamicsNavServer$DynamicsNAV80, or the short name, such as DynamicsNAV80. You must use single-quotes around the instance name.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-ClientServicesPort<Int>

Specifies the listening TCP port for clients such as Microsoft Dynamics NAV Windows client and Microsoft Dynamics NAV Web client.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DatabaseInstance<String>

Specifies the SQL Server instance on which the Microsoft Dynamics NAV database is installed.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DatabaseName<String>

Specifies the name of the Microsoft Dynamics NAV database.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DatabaseServer<String>

Specifies the name of the computer on which the SQL Server instance for the Microsoft Dynamics NAV database is installed.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-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

-ODataServicesPort<Int>

Specifies the listening HTTP port for Microsoft Dynamics NAV OData web services.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ServiceAccount<ServiceAccount>

Specifies the Windows-based computer account that the Microsoft Dynamics NAV Server instance must use to log on. The default value is NT AUTHORITY\NETWORK SERVICE. Only NetworkService and User values are supported. This parameter accepts values from the enum System.ServiceProcess.ServiceAccount.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ServiceAccountCredential<PSCredential>

Specifies a set of security credentials that you must use when configuring the service account.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-ServicesCertificateThumbprint<ClientServicesCertificateThumbprint>

Specifies the certificate thumbprint for the x509 certificate that is going to be used for securing communication with the server. The certificate must be stored in the local machine store and in the personal sub-store in the certificate store. The private key of the certificate must be present and exchangeable. The certificate must be in .pfx format, not .cer format. The certificate can be either self-signed or issued by a trusted certification authority (CA).

When specifying a ServicesCertificateThumbprint, SOAP web services and OData web services become HTTPS.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SOAPServicesPort<Int>

Specifies the listening HTTP port for Microsoft Dynamics NAV SOAP web services.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

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 or the security credentials to the cmdlet.

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 creates a new Microsoft Dynamics NAV Server instance. It configures the necessary firewall exceptions and performs the necessary Access Control List registrations.

C:\PS>New-NAVServerInstance NewInstance -ManagementServicesPort 8099 -ClientServicesPort 8100 -SOAPServicesPort 8101 -ODataServicesPort 8102 -verbose
VERBOSE: NavCommand.BeginProcessing
VERBOSE: NavCommand.ProcessRecord
VERBOSE: Creating Instance directory C:\Program Files\Microsoft Dynamics NAV\80\Service\Instances\NewNAVServer
VERBOSE: Adding Windows Firewall (and UrlAcl) rules for Server Instance MicrosoftDynamicsNavServer$NewNAVServer
VERBOSE: Adding Windows Firewall (and UrlAcl) rules for Server Instance MicrosoftDynamicsNavServer$NewNAVServer
VERBOSE: Adding Windows Firewall (and UrlAcl) rules for Server Instance MicrosoftDynamicsNavServer$NewNAVServer
VERBOSE: Adding Windows Firewall (and UrlAcl) rules for Server Instance MicrosoftDynamicsNavServer$NewNAVServer
VERBOSE: NavCommand.EndProcessing

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

Description

-----------

This example prompts for ServiceAccount credentials and then creates a new Microsoft Dynamics NAV Server instance.

C:\PS>Get-Credential | New-NAVServerInstance NewInstance -ServiceAccount User -ManagementServicesPort 8099 -ClientServicesPort 8100 -SOAPServicesPort 8101 -ODataServicesPort 8102 -verbose
VERBOSE: NavCommand.BeginProcessing

VERBOSE: NavCommand.ProcessRecord

VERBOSE: Performing operation "New-NAVServerInstance" on Target "ServerInstance
 = MicrosoftDynamicsNavServer$NewInstance, DatabaseInstance = ".

VERBOSE: Creating Instance directory C:\Program Files\Microsoft DynamicsNAV\80\Service\Instances\NewInstance

VERBOSE: Installing Server Instance MicrosoftDynamicsNavServer$NewInstance

VERBOSE: Setting service parameter: 'ManagementServicesPort' to value: '8099'

VERBOSE: Setting service parameter: 'ClientServicesPort' to value: '8100'

VERBOSE: Setting service parameter: 'SOAPServicesPort' to value: '8101'

VERBOSE: Setting service parameter: 'ODataServicesPort' to value: '8102' 

VERBOSE: NavCommand.EndProcessing