Set-AmsHostConfig
Last updated
Was this helpful?
Last updated
Was this helpful?
Was this helpful?
Sets one or more AMS host configuration parameters
Set-AmsHostConfig [-AgentAccessEnabled <Boolean>] [-WebAppEnabled <Boolean>] [-ExternalHostname <String>]
[-LogPath <String>] [-ConfigPath <String>] [-ConnectionString <String>] [-SkipConnectionStringValidation]
[-RemoteManagementEnabled <Boolean>] [<CommonParameters>]
This cmdlet allows you to specify settings that apply to the specific host where the cmdlet is run. These settings are not shared between hosts in a farm, and must be set on each individual AMS server where appropriate.
Note, you must restart the service after making changes with this cmdlet for those changes to take effect.
PS C:\> Set-AmsHostConfig -AgentAccessEnabled $true -ExternalHostName "ams.lithnet.local"
This example enables the AMS agent API, specifying a hostname of "ams.lithnet.local". This is the hostname that agents use to connect to the service, and must match exactly what is configured on the client side.
PS C:\> Set-AmsHostConfig -WebAppEnabled $false
This example disables the web app, preventing user access.
PS C:\> Set-AmsHostConfig -LogPath "C:\Logs\AMS"
This example changes the log location to "C:\Logs\AMS"
The path where the applications config files are stored
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The connection string used to connect to the database
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The path where the applications log files are stored
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Skips the process of validating the connection string. Used when the user performing the action does not have access to the database itself
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Enables or disables the web app
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Sets the external hostname for the service. This is the hostname that agents use to connect to the service, and must match exactly what is configured on the client side.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Enables or disables agent access to this service
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Enables or disables remote management of this service (Requires enterprise edition license). Please note there are security implications to enabling remote management. Ensure that the use of PS remoting, named pipes and SMB is appropriately restricted to trusted hosts
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.