Response File Entries to Configure the Common Platform
- Last UpdatedJul 07, 2022
- 2 minute read
The Common Platform settings are used to:
-
Establish machine trust between nodes via the System Management Server. See Configuring the System Management Server for additional information.
-
Configure an external Authentication Provider. See Authentication Provider Configuration for more information.
-
Set the License Mode and license type. See License Mode Configuration for more information.
<configurator>
Common Platform.ASBRuntime.HttpPort=80
Common Platform.ASBRuntime.HttpsPort=443
// Sets the HTTPS port of Aveva web apps running on the local node.
// Corresponds to the HTTPS Port setting on the Advanced Configuration Ports tab.
Common Platform.ASBRuntime.ManagementServerPort=443
// Sets the HTTPS port number for a "remote” SMS, and is used only when the SMS is on a different node.
// Corresponds to the SMS Port setting on the Advanced Configuration Certificates tab.
Common Platform.ASBRuntime.ManagementServerName=MachineName
// Use if connecting to System Management Server on another node.
Common Platform.ASBRuntime.UserName=username
Common Platform.ASBRuntime.Password=password
// UserName and Password parameters are not required if the current logged in user is authenticated to access the Management Server. You can remove the parameters if they are not required.
// The following parameters enable or disable enhanced SuiteLink and NMX security:
Common Platform.ASBRuntime.SuiteLinkMixedModeEnabled = 0
// Valid entries are 0 or 1. 0 indicates SuiteLink accepts only encrypted connection requests.
// Set to 0 for new installations. For upgrades should be set to 1, then reset to 0 when all nodes have been upgraded.
// NEW for System Platform 2023
Common Platform.ASBRuntime.NmxAllowAllUsers = 0
// Valid entries are 0 or 1. 0 restricts user access.
// Set to 0 for new installations. For upgrades should be set to 1, then reset to 0 when all nodes have been upgraded.
// NEW for System Platform 2023
Common Platform.ASBRuntime.AsbManagedCertificates=true
Common Platform.ASBRuntime.BindingCertificateThumbprint=thumbprint
// Required if AsbManagedCertificates = false, otherwise do not use this parameter.
// The following parameter is used to configure a redundant SSO server:
Common Platform.ASBRuntime.IsRedundantSsoServer = true
// Ensure ManagementServerName is the remote node machine name, not the local node machine name.
// NEW for System Platform 2023
// The following parameters are used for configuring Azure AD as an external Authentication Provider:
Common Platform.Bootstrap.IsAzureADMode=true
// Enables Azure AD as the Authentication Provider.
// NEW for System Platform 2023
Common Platform.Bootstrap.Endpoint=<AzureEndpoint>
// Sets the Endpoint when Azure AD is the Authentication Provider.
Common Platform.Bootstrap.ClientId=<AzureClientID>
// Sets the Client ID when Azure AD is the Authentication Provider.
// NEW for System Platform 2023
Common Platform.Bootstrap.ClientSecret=<AzureClientSecret>
// Sets the Client Secret when Azure AD is the Authentication Provider.
// NEW for System Platform 2023
</configurator>
The following parameters are included in some sample response files, but not implemented in System Platform 2023:
Common Platform.Bootstrap.IsAVEVAConnectMode=true
Common Platform.Bootstrap.Endpoint="AVEVAConnectEndPoint"
Common Platform.Bootstrap.ClientId=<AVEVAConnectClientID>
Common Platform.Bootstrap.ServiceEndpoint=<AVEVAConnectServiceEndpoint>
Common Platform.Bootstrap.AccessToken=<AVEVAConnectAccessToken>