Set-NAVServerConfiguration
Set-NAVServerConfiguration
Configures settings for a Microsoft Dynamics NAV Server instance.
Syntax
Parameter Set: KeyValuePairSettings
Set-NAVServerConfiguration -KeyName <String> [-Element <String> ] [-Force] [-KeyValue <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: __AllParameterSets
Set-NAVServerConfiguration [-ServerInstance] <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: DatabaseCredentials
Set-NAVServerConfiguration -DatabaseCredentials <PSCredential> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
Use the Set-NAVServerConfiguration cmdlet to configure settings for a Microsoft Dynamics NAV Server instance. Values are written directly to the configuration file for the instance (CustomSettings.config). New setting values do not take effect until you restart the server instance.
Parameters
-DatabaseCredentials<PSCredential>
The user name and password of the login account that the Microsoft Dynamics NAV Server instance will use to connect to the Microsoft Dynamics NAV database in SQL Server. This parameter is configures the Microsoft Dynamics NAV Server instance to use SQL Server Authentication instead of Windows Authentication on the connection to the database. The login account must be a member of the db_owner role on the database.
Aliases |
none |
Required? |
true |
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 DynamicsNAV90. You can specify either the full name of an instance such as MicrosoftDynamicsNavServer$myinstance or the short name such as myinstance.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-KeyName<String>
The configuration key name. Examine the CustomSettings.config file to determine the correct key name.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-KeyValue<String>
The configuration key value. For more information about supported values, see "Configuring Microsoft Dynamics NAV Server" in the Microsoft Dynamics NAV Developer and IT Pro Help. A version of this topic is available online at: https://go.microsoft.com/fwlink/?LinkID=163750.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Element<String>
Specifies the navigation path from the root element to the appSettings section of the configuration document.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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 |
-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 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
-----------
In this example, the Set-NAVServerConfiguration cmdlet sets the value for the appSettings Key 'DatabaseServer' to 'DatabaseServer.Domain.Com' for a Microsoft Dynamics NAV Server instance, MyInstance.
C:\PS>Set-NAVServerConfiguration MyInstance -KeyName DatabaseServer -KeyValue DatabaseServer.Domain.Com