Optional Command Line Parameters
The following parameters can be passed into the setup script using the following format –‘parameter name’ ‘value’ (without apostrophes, Boolean values are $true and $false):
Parameter | Description | Data type | Required |
---|---|---|---|
Name | The name of the web site | String | ✓ |
ResourceGroupName | The name of the resource group | String | |
SqlDatabaseUserName | Username for the SQL database | String:Defaults to “slsuser” | |
SqlDatabasePassword | Username for the SQL database | SecureString | |
StartIPAddress | The starting address of the range of IP addresses in the SQL Azure firewall rule to allow access from the local machine. | String | ✓ |
EndIPAddress | The last address of the range of IP addresses in the SQL Azure firewall rule | String | |
PortalName | The virtual directory to use for Portal | String | |
UseHttps | Whether to use HTTPS or not | Boolean | |
DbPricingTier | The database pricing tier to use | String (Basic, Free, Shared, Standard, Premium) | |
WebAppPricingTier | The web app pricing tier to use | String | |
MsgSendEveryNMinutes | Delay in minutes between the sending of email notifications | Integer | |
MsgFromAddress | From address used for sent email notifications | String | |
MsgNumberOfSendAttempts | Number of email sending attempts | Integer | |
MsgSubject | Subject for feedback assessment emails | String | |
MsgMessageBody | Body for feedback assessment emails | String | |
MsgUseDefaultCredentials | Whether to use default credentials for SMTP server | Boolean | |
MsgUsername | username for SMTP server | String | |
MsgPassword | password for SMTP server | SecureString | |
MsgPort | port for SMTP server | Integer | |
MsgUseSSL | Whether to use SSL for SMTP server | Boolean | |
MsgSMTPServer | SMTP Server | String | |
MsgEnableOutlookMessages | Enable outlook messages | Boolean | |
MsgOutlookDefaultFrom | use default from address for email notifications | String | |
MsgUseDefaultOrganizer | Use default Organizer | Boolean | |
Branding | Use non-default branding (Default/Genesys/Teleopti) | String | |
EnableAlwaysOn | Enable Always On for the web site. This will prevent the web site shutting down when there is no traffic. It also allows the web jobs to continue running as scheduled. | Boolean |
Important
For passing SecureStrings to the command line parameters you will need to do the following: Read-Host "Enter Password" -AsSecureString | ConvertFrom-SecureString | Out-File "C:\Temp\Password1.txt"
If you are passing 2 passwords, you will need to do the above twice into different files, then do the following:
$pass1 = Get-Content "C:\Temp\Password1.txt" | ConvertTo-SecureString
Then pass these variables to the script via the command line.
This page was last edited on April 22, 2020, at 09:40.
Comments or questions about this documentation? Contact us for support!