Note: Please go to docs.rightscale.com to access the current RightScale documentation set. Also, feel free to Chat with us!
Home > ServerTemplates > v13.5 LTS > ST > Database Manager for Microsoft SQL Server (v13.5 LTS) > Database Manager for Microsoft SQL Server (13.5.0-LTS) - Reference

Database Manager for Microsoft SQL Server (13.5.0-LTS) - Reference

Table of Contents
  1. Info
  2. Images
  3. Scripts
  4. Inputs
    1. ADMIN_ACCOUNT_NAME
      1. ADMIN_PASSWORD
        1. AWS_ACCESS_KEY_ID
        2. AWS_SECRET_ACCESS_KEY
        3. BACKUP_FILE_NAME
        4. BACKUP_LOCAL_DIR
        5. BACKUP_METHOD
        6. BACKUP_VOLUME_IO_OPERATIONS_PER_SECOND
        7. BACKUP_VOLUME_LETTER
        8. BACKUP_VOLUME_SIZE
        9. BACKUP_VOLUME_TYPE
        10. DATA_VOLUME_IO_OPERATIONS_PER_SECOND
        11. DATA_VOLUME_SIZE
        12. DATA_VOLUME_TYPE
        13. DB_BACKUP_FREQUENCY
        14. DB_BACKUP_KEEP_DAILY
        15. DB_BACKUP_KEEP_LAST
        16. DB_BACKUP_KEEP_MONTHLY
        17. DB_BACKUP_KEEP_WEEKLY
        18. DB_BACKUP_KEEP_YEARLY
        19. DB_FULL_BACKUP_INTERVAL
        20. DB_LINEAGE_NAME
        21. DB_LINEAGE_NAME_OVERRIDE
        22. DB_NAME
        23. DB_NEW_LOGIN_NAME
        24. DB_NEW_LOGIN_PASSWORD
        25. DB_REMOTE_SERVER_IP
        26. DB_REMOTE_SQL_LOGIN
        27. DB_REMOTE_SQL_PASSWORD
        28. DISABLE_SAFETY
        29. DNS_DOMAIN_NAME
        30. DNS_ID
        31. DNS_IP_ADDRESS
        32. DNS_PASSWORD
        33. DNS_SERVICE
        34. DNS_TTL
        35. DNS_USER
        36. ENABLE_TLOG_BACKUPS_BEFORE_SNAPSHOT
        37. FORCE_SERVICE_ALLOW_DATA_LOSS
        38. INIT_MIRRORING_METHOD
        39. INSTANCE_ID
        40. KB_ARTICLE_NUMBER
        41. KMS_HOST
        42. KMS_PORT
        43. LOGS_VOLUME_IO_OPERATIONS_PER_SECOND
        44. LOGS_VOLUME_SIZE
        45. LOGS_VOLUME_TYPE
        46. MASTER_KEY_PASSWORD
        47. MASTER_KEY_SAFETY
        48. MDF_FILE_NAME
        49. MIRROR_CERTIFICATE
        50. MIRROR_PRIVATE_KEY_PASSWORD
        51. MSSQL_PRODUCT_KEY
        52. NUMBER_STRIPES
        53. OPT_BACKUP_TEMP_DIR
        54. OPT_DATA_VOLUME_LETTER
        55. OPT_DB_RESTORE_TIMESTAMP
        56. OPT_FILE_PREFIX
        57. OPT_FORCE_CREATE_VOLUMES
        58. OPT_FORCE_FULL_BACKUP
        59. OPT_FORCE_NORECOVERY
        60. OPT_LOGS_VOLUME_LETTER
        61. OPT_MIRRORING_PORT
        62. OPT_TEMPDB_DATAFILE_SIZE
        63. OPT_TEMP_VOLUME_LETTER
        64. OPT_USE_PUBLIC_IP
        65. PRINCIPAL_CERTIFICATE
        66. PRINCIPAL_PRIVATE_KEY_PASSWORD
        67. PRIVATE_KEY_PASSWORD
        68. REMOTE_STORAGE_ACCOUNT_ID
        69. REMOTE_STORAGE_ACCOUNT_PROVIDER
        70. REMOTE_STORAGE_ACCOUNT_SECRET
        71. REMOTE_STORAGE_BLOCK_SIZE
        72. REMOTE_STORAGE_CONTAINER
        73. REMOTE_STORAGE_CONTAINER_OVERRIDE
        74. REMOTE_STORAGE_ENDPOINT_URL
        75. REMOTE_STORAGE_THREAD_COUNT
        76. REMOTE_STORAGE_USE_INTERNAL_NETWORK
        77. SERVER_MODE
        78. SERVER_UUID
        79. SKETCHY
        80. SKIP_RESTORE_SYSTEM_DATABASES
        81. SYS_WINDOWS_TZINFO
        82. USE_PUBLIC_IP_WITNESS
        83. WINDOWS_AUTOMATIC_UPDATES_POLICY
        84. WINDOWS_UPDATES_REBOOT_SETTING
        85. WITNESS_CERTIFICATE
        86. WITNESS_PRIVATE_KEY_PASSWORD
  5. Revision History
  6. See also

Table of Contents    
  1. Info
  2. Images
  3. Scripts
  4. Inputs
  5. Revisions
  6. See also

Long Term Support

Stable, tested ServerTemplate assets

   ►  Reference

Info

Current revision: 2
Date published: 2013/08/30 00:03:17 +0000
MultiCloud Marketplace: https://my.rightscale.com/api/acct/2901/ec2_server_templates/316501001

  • Description:
    This ServerTemplate is on the LTS Lineage. For the latest Infinity version, see the Infinity Release  
    
    For a description of the Infinity and LTS lineages, see ServerTemplate Release Methodology
    
    
    
    This ServerTemplate configures a Microsoft SQL Server standalone database server or pair of servers in a high-availability (HA) configuration (synchronous mirroring). It supports graceful (no data loss) and forceful (possible data loss) manual failover, with the latter to be used for disaster-recovery situations. This can also be used with our SQL Server Witness ServerTemplate to provide automatic failover. Also included are built-in monitoring and alerts on CPU, memory, and disk. 
    
    
    
    Key Features:
    
    * MS Best Practices for disk and database configuration.
    
    * Cloud-agnostic data storage on dynamic volumes or equivalent.
    
    * Striped data and log volumes (on supported clouds).
    
    * Automatically scheduled backups with data consistency.
    
    * Backup and restore to/from remote storage to enable data migration between clouds.
    
    
    
    Related ServerTemplates:  
    
    Microsoft SQL Server Witness  
    
    Microsoft Active Directory  
    
    Microsoft IIS App Server
    
    
    
    Documentation:  
    
    Database Manager for MS SQL Server Release Notes  
    
    Tutorial   
    
    
    
    
    
    

    Application versions: * .Net 3.5SP1 * .Net 4.0 * .Net 4.5 * PowerShell 2.0 * PowerShell 3.0 * SQL Server 2008R2 (on Windows 2008R2 image) * SQL Server 2008R2?Enterprise (Windows 2008R2 image - Windows Azure only) * SQL Server 2012 (on Windows 2008R2 & Windows 2012 images - n/a for SoftLayer) * SQL Server 2012?Enterprise (Windows 2008R2 & Windows 2012 images - Windows Azure only) Supported public compute clouds: * Amazon Web Services EC2 * Rackspace Open Cloud (US, UK) * SoftLayer * Windows Azure Supported private compute clouds: * Citrix CloudStack (3.0.6)(XenServer and VMware) * OpenStack Folsom (KVM) * Rackspace Private Cloud (KVM) Supported Storage Services: * Amazon Simple Storage Service (S3) * OpenStack Swift (Folsom) * Rackspace Cloud Files (US, UK) * Rackspace Private (Swift)(Folsom) * SoftLayer Object Storage * Windows Azure Blob Storage Supported MultiCloud Images: * Windows 2012/SQL 2012 - Amazon, CloudStack, OpenStack, Rackspace Open Cloud, Rackspace Private * Windows 2008R2/SQL 2012 - Amazon, CloudStack, Rackspace Open Cloud, Rackspace Private, Windows Azure * Windows 2008R2/SQL 2008R2 - Amazon, CloudStack, Rackspace Open Cloud, Rackspace Private, SoftLayer
  • Supported Clouds: AWS AP-Singapore, AWS AP-Sydney, AWS AP-Tokyo, AWS EU, AWS SA-Sao Paulo, AWS US-East, AWS US-Oregon, AWS US-West, Azure East Asia, Azure East US, Azure North Europe, Azure Southeast Asia, Azure West Europe, Azure West US, CloudStack default, OpenStack default, Rackspace Open Cloud - Chicago, Rackspace Open Cloud - Dallas, Rackspace Open Cloud - London

Images

The following MultiCloud Images (MCIs) are used by the ServerTemplate. The MCIs determine which operating systems and clouds are supported.

MultiCloud Images

  • RightImage_Windows_2008R2_SP1_x64_sqlsvr2012_v13.5.0-LTS
    • AWS AP-Singapore, AWS AP-Sydney, AWS AP-Tokyo, AWS EU, AWS SA-Sao Paulo, AWS US-East, AWS US-Oregon, AWS US-West, Azure East Asia, Azure East US, Azure North Europe, Azure Southeast Asia, Azure West Europe, Azure West US, Rackspace Open Cloud - Chicago, Rackspace Open Cloud - Dallas, Rackspace Open Cloud - London
  • RightImage_Windows_2008R2_SP1_x64_sqlsvr2012_v13.5.0_VMware-LTS
    • None
  • RightImage_Windows_2008R2_SP1_x64_sqlsvr2012_v13.5.0_XenServer-LTS
    • None
  • RightImage_Windows_2008R2_SP1_x64_sqlsvr2012ent_v13.5.0-LTS
    • Azure East Asia, Azure East US, Azure North Europe, Azure Southeast Asia, Azure West Europe, Azure West US
  • RightImage_Windows_2008R2_SP1_x64_sqlsvr2k8r2_v13.5.0-LTS
    • AWS AP-Singapore, AWS AP-Sydney, AWS AP-Tokyo, AWS EU, AWS SA-Sao Paulo, AWS US-East, AWS US-Oregon, AWS US-West, Azure East Asia, Azure East US, Azure North Europe, Azure Southeast Asia, Azure West Europe, Azure West US, Rackspace Open Cloud - Chicago, Rackspace Open Cloud - Dallas, Rackspace Open Cloud - London
  • RightImage_Windows_2008R2_SP1_x64_sqlsvr2k8r2_v13.5.0_VMware-LTS
    • None
  • RightImage_Windows_2008R2_SP1_x64_sqlsvr2k8r2_v13.5.0_XenServer-LTS
    • None
  • RightImage_Windows_2008R2_SP1_x64_sqlsvr2k8r2ent_v13.5.0-LTS
    • Azure East Asia, Azure East US, Azure North Europe, Azure Southeast Asia, Azure West Europe, Azure West US
  • RightImage_Windows_2012_x64_sqlsvr2012_v13.5.0-LTS
    • AWS AP-Singapore, AWS AP-Sydney, AWS AP-Tokyo, AWS EU, AWS SA-Sao Paulo, AWS US-East, AWS US-Oregon, AWS US-West, Azure East Asia, Azure East US, Azure North Europe, Azure Southeast Asia, Azure West Europe, Azure West US, Rackspace Open Cloud - Chicago, Rackspace Open Cloud - Dallas, Rackspace Open Cloud - London
  • RightImage_Windows_2012_x64_sqlsvr2012_v13.5.0_KVM-LTS
    • CloudStack default, OpenStack default
  • RightImage_Windows_2012_x64_sqlsvr2012_v13.5.0_VMware-LTS
    • None
  • RightImage_Windows_2012_x64_sqlsvr2012_v13.5.0_XenServer-LTS
    • None
  • RightImage_Windows_2012_x64_sqlsvr2012ent_v13.5.0-LTS
    • Azure East Asia, Azure East US, Azure North Europe, Azure Southeast Asia, Azure West Europe, Azure West US
  • SoftLayerImage_Storage_Windows_2008R2_SP1_x64_sqlsvr2k8r2_v13.5.0-LTS
    • None

Scripts

Inputs

ADMIN_ACCOUNT_NAME

Input to change name of local administrator account. If this input is empty or equals existing name of the account only password change is performed.

ADMIN_PASSWORD

Set the password for the local Administrator account. This should be at least 7 characters long with at least one upper case letter, one lower case letter and one digit.

AWS_ACCESS_KEY_ID

The Access Key ID is an Amazon Access Credential that's used to authenticate your requests to AWS services. It's unique to your AWS Account Number. The Access Key ID and Secret Access Key are used to retrieve objects from an S3 bucket that are 'private'. Log into your AWS account at aws.amazon.com to retrieve your access identifiers. It's strongly recommended that you use a RightScale Credential (Design > Credentials) to hide the actual key value from non-admin users while still allowing them to pass the appropriate value as an input. Ex: 1JHQQ4KVEVM02KVEVM02

AWS_SECRET_ACCESS_KEY

The Secret Access Key is an Amazon Access Credential that's used to authenticate your requests to AWS services. It's unique to your AWS Account Number. The Access Key ID and Secret Access Key are used to retrieve objects from an S3 bucket that are 'private'. Log into your AWS account at aws.amazon.com to retrieve your access identifiers. It's strongly recommended that you use a RightScale Credential (Design > Credentials) to hide the actual key value from non-admin users while still allowing them to pass the appropriate value as an input. Ex: XVdxPgOM4auGcMlPz61IZGotpr9LzzI07tT8s2Ws

BACKUP_FILE_NAME

Name of target backup file (without path).

BACKUP_LOCAL_DIR

Local directory that contains database data file to be attached. Leave this input empty if you are downloading the file from remote storage. Ex: D:\

BACKUP_METHOD

Use this input to specify method of doing continuous database backups. 2 methods are currently supported--uploading backup files to remote storage such as S3/Cloud Files, or performing volume snapshots (on clouds supporting snapshots). Ex: Snapshots

BACKUP_VOLUME_IO_OPERATIONS_PER_SECOND

The number of I/O operations per second (IOPS) that the volume supports. IOPS is currently only supported on Amazon EC2. Range is 100 to 1000. Example: 500

BACKUP_VOLUME_LETTER

Use this input to reserve drive letter for backup volume at boot time and assign to the volume when executing operational script. Drive letters D-P are supported on EC2, D-J are supported on CloudStack. Note, that all volume letter inputs should have different values. Ex: F

BACKUP_VOLUME_SIZE

Size of backup volume in GB or empty string if fixed-size volume type is used (this use case is currently supported only on CloudStack clouds). In that case BACKUP_VOLUME_TYPE should be specified. Ex: 100

BACKUP_VOLUME_TYPE

Name of the volume type for backup volume (on supported clouds, currently Rackspace Open and CloudStack). On Rackspace Open both SATA and SSD volume types are supported, size of the volume should be specified via BACKUP_VOLUME_SIZE input. On CloudStack-based clouds volume types depend on cloud configuration.

DATA_VOLUME_IO_OPERATIONS_PER_SECOND

The number of I/O operations per second (IOPS) that the volume supports. IOPS is currently only supported on Amazon EC2. Range is 100 to 1000. Example: 500

DATA_VOLUME_SIZE

Size of data volume in GB or empty string if fixed-size volume type is used (this use case is currently supported only on CloudStack clouds). In that case DATA_VOLUME_TYPE should be specified. Ex: 100

DATA_VOLUME_TYPE

Name of the volume type for data volume (on supported clouds, currently Rackspace Open and CloudStack). On Rackspace Open both SATA and SSD volume types are supported, size of the volume should be specified via DATA_VOLUME_SIZE input. On CloudStack-based clouds volume types depend on cloud configuration.

DB_BACKUP_FREQUENCY

Backup frequency in hours. Default value is 4 (performs backup every 4 hours). Ex: 2

DB_BACKUP_KEEP_DAILY

The number of daily snapshots (backups) to keep (i.e. rotation size). A daily backup is defined as the latest completed snapshot of a day that is closest to the end of the day (23:59:59). (Default: 14) See "Archiving of EBS Snapshots" on RightScale's Support site for further details on the archiving logic.

DB_BACKUP_KEEP_LAST

The total number of snapshots to keep. When this limit has been reached, the oldest snapshot will be deleted. (Default: 60) See "Archiving of EBS Snapshots" on RightScale's Support site for further details on the archiving logic.

DB_BACKUP_KEEP_MONTHLY

The number of monthly snapshots to keep (i.e. rotation size. Default: 12) See "Archiving of EBS Snapshots" on RightScale's Support site for further details on the archiving logic.

DB_BACKUP_KEEP_WEEKLY

The number of weekly snapshots to keep (i.e. rotation size. Default: 6) See "Archiving of EBS Snapshots" on RightScale's Support site for further details on the archiving logic.

DB_BACKUP_KEEP_YEARLY

The number of yearly snapshots to keep (i.e. rotation size. Default: 2) See "Archiving of EBS Snapshots" on RightScale's Support site for further details on the archiving logic.

DB_FULL_BACKUP_INTERVAL

Interval in days of doing full database backups when remote storage backup method is used. Ex: 1

DB_LINEAGE_NAME

The lineage of the database backups. This is a string that is used to track all backups in a certain 'set', usually deployment wide. Ex: mymssqlserver

DB_LINEAGE_NAME_OVERRIDE

Optional input to override lineage name to restore from backup in another database backup lineage. If this input has a value it's used instead of DB_LINEAGE_NAME input. Ex: mymssqlserver2

DB_NAME

Name of the default database to assign to the created SQL Server login. Ex: MyDatabase

DB_NEW_LOGIN_NAME

Login name for the new SQL Server user.

DB_NEW_LOGIN_PASSWORD

Password for SQL Server login to be created.

DB_REMOTE_SERVER_IP

IP address of remote SQL Server database server. Ex: 180.100.100.38

DB_REMOTE_SQL_LOGIN

SQL Server login with administrative rights to the remote SQL Server database server. Ex: sqladmin

DB_REMOTE_SQL_PASSWORD

Password of remote SQL Server user.

DISABLE_SAFETY

Prevents the accidental running of the "DB DISABLE SERVER" script. This script will only run if the input variable is set to "off".

DNS_DOMAIN_NAME

FQDN of the DNS record to be updated. This input is used for DynDNS, Rackspace Cloud DNS, Route53. Set to "text:" and leave blank to bypass DNS registration on boot. Ex: my.domain.com

DNS_ID

ID of DNS record or zone to be updated. This input has specific meaning for each DNS provider: DNS Made Easy: 7-digit DNS record ID provided by DNS Made Easy. Ex: 1234123 DynDNS: not used Rackspace Cloud DNS: ID if Rackspace DNS zone of the record to be updated. Ex: 123456 Route53: ID of Route53 zone of the record to be updated. Ex: Z1BINKNIEY8Y9L Set to "text:" and leave blank to bypass DNS registration on boot.

DNS_IP_ADDRESS

IP address to update the DNS record. Type specific IP address or select whether to use public or private IP address of the current instance. Set to "text:" and leave blank to bypass DNS registration on boot. Ex: 1.2.3.4

DNS_PASSWORD

Password or authentication key that is used to access and modify DNS records. Provider-specific details: DNS Made Easy: Password of your DNS Made Easy account: Ex: cred:DME_PASSWORD DynDNS: Password of your DynDNS account. Ex: cred:DYN_DNS_PASSWORD Rackspace Cloud DNS: Rackspace API authentication key. Ex: cred:RACKSPACE_AUTH_KEY Route53: Your AWS Secret Access Key. Ex: cred:AWS_SECRET_ACCESS_KEY

DNS_SERVICE

One of the supported DNS providers: DNS Made Easy, DynDNS, Rackspace Cloud DNS (US and UK regions), Route53. Please use predefined value and don't override the dropdown.

DNS_TTL

TTL of the DNS record, default value is 60.

DNS_USER

Username or account ID that is used to access and modify DNS records. Provider-specific details: DNS Made Easy: Username of your DNS Made Easy account: Ex: mydnsacct DynDNS: Username of your DynDNS account. Ex: mydnsacct Rackspace Cloud DNS: Username of your Rackspace account. Ex: cred:RACKSPACE_USERNAME Route53: Your AWS Access Key ID. Ex: cred:AWS_ACCESS_KEY_ID Set to "text:" and leave blank to bypass DNS registration on boot.

ENABLE_TLOG_BACKUPS_BEFORE_SNAPSHOT

Enabling this option will force a SQL based transaction log backup to be issued before the volume snapshot backup is taken. This is provided to facilitate transaction log truncation when using the BACKUP_METHOD of snapshots. Note that the log backup is performed for all user databases in full recovery model and saved to temp_tlog_backups dir on logs volume.

FORCE_SERVICE_ALLOW_DATA_LOSS

Use this parameter only for disaster recovery to force mirror to be promoted to principal.

INIT_MIRRORING_METHOD

Method of data exchange between principal and mirror server to initialize mirroring session. 2 options are supported--via remote storage such as S3 or Cloud Files or via volume snapshots. Ex: Snapshots

INSTANCE_ID

Cloud Providers unique identifier for this instance

KB_ARTICLE_NUMBER

Microsoft KB number of update to be installed. Use format KBxxxxxx (x is digit) or just xxxxxx to specify the number.

KMS_HOST

FQDN or IP address of KMS server to activate this instance with. Ex: kms.mydomain.com

KMS_PORT

Port number to be used to connect to KMS server. Default value is 1688. Ex: 11688

LOGS_VOLUME_IO_OPERATIONS_PER_SECOND

The number of I/O operations per second (IOPS) that the volume supports. IOPS is currently only supported on Amazon EC2. Range is 100 to 1000. Example: 500

LOGS_VOLUME_SIZE

Size of logs volume in GB or empty string if fixed-size volume type is used (this use case is currently supported only on CloudStack clouds). In that case LOGS_VOLUME_TYPE should be specified. Ex: 100

LOGS_VOLUME_TYPE

Name of the volume type for logs volume (on supported clouds, currently Rackspace Open and CloudStack). On Rackspace Open both SATA and SSD volume types are supported, size of the volume should be specified via DATA_VOLUME_SIZE input. On CloudStack-based clouds volume types depend on cloud configuration.

MASTER_KEY_PASSWORD

Password used for encryption of master database master key. This password is used to encrypt master key when it's created or decrypt when opening existing master key. Using a credential is strictly recommended for this input. Please see our support portal for more information on using credentials. Ex: cred:MY_MASTER_KEY_PASSWORD

MASTER_KEY_SAFETY

Prevents the accidental running of the "DB SQLS Recreate master key" script. This script will only run if the input is set to "off".

MDF_FILE_NAME

File name of the database data file (.mdf) Ex: MyDatabase.mdf

MIRROR_CERTIFICATE

Certificate to be used for authentication on mirroring endpoint of Mirror server. This input is required when launching Principal, Mirror or Witness but not needed for Standalone SQL Server. Use a credential containing encoded certificate and private key generated by "DB SQLS Generate and Save a Certificate" RightScript. Note that the private key is encryped by password (MIRROR_PRIVATE_KEY_PASSWORD input). Please see our support portal for more information on using credentials for passing certificates for mirroring authentication.

MIRROR_PRIVATE_KEY_PASSWORD

Password to decrypt private key containing in MIRROR_CERTIFICATE input. This input is required when launching Principal, Mirror or Witness but not needed for Standalone SQL Server. Should be the same password which was used to generate and encode certificate and private key by "DB SQLS Generate and Save a Certificate" RightScript. Please see our support portal for more information on using credentials for passing certificates for mirroring authentication.

MSSQL_PRODUCT_KEY

Microsoft SQL Server 2008R2 Product Key

NUMBER_STRIPES

Number of disks used in the logical volume stripe created for the data and log volumes. A value of 1 means (no striping). This value can be between 1 and 5 depending on the cloud/instance size you are using. For Amazon EC2 the max value is 5. For CloudStack based clouds max value is 2. For Windows Azure the max value depends on the instance size you are using. For standalone configurations, determine the total disk count by multiplying the number of stripes times the total number of data and log volumes (default 2). For high availability configurations, add 1 to that total to determine your total disk count. Ex: 1

OPT_BACKUP_TEMP_DIR

Full path to directory used as temporary location for backup files. Optional; root directory of data volume is used by default. Ex: C:\Windows

OPT_DATA_VOLUME_LETTER

Optional parameter to assign data volume a drive letter other than D.Drive letters D-P are supported on EC2, D-J are supported on CloudStack. Note, that all volume letter inputs should have different values. Ex: F

OPT_DB_RESTORE_TIMESTAMP

Use this input to restore from specific snapshot or remote storage backup identified by its timestamp. For snapshots-based backup the timestamp could be found in 'rs_backup:timestamp=...' tag. For remote storage backup the timestamp could be extracted from file names. If this input is undefined, the latest backup in the lineage will be used. Ex: 1306232588

OPT_FILE_PREFIX

File prefix (optional; defaults to timestamp). Ex: MYDB_

OPT_FORCE_CREATE_VOLUMES

Set this input to True to avoid restoring from the latest lineage backup and force creation of new volumes from scratch. Ex: True

OPT_FORCE_FULL_BACKUP

Use this input to force creation of full backup. Differential backup is created by default. Ex: True

OPT_FORCE_NORECOVERY

Use this input to force SQL Server to restore backup in NORECOVERY mode. Ex: True

OPT_LOGS_VOLUME_LETTER

Optional parameter to assign logs volume a drive letter other than E. Drive letters D-P are supported on EC2, D-J are supported on CloudStack. Note, that all volume letter inputs should have different values. Ex: G

OPT_MIRRORING_PORT

Port number for mirroring data transfer. Default value is 5022.

OPT_TEMPDB_DATAFILE_SIZE

Use this parameter to specify a custom initial size for tempdb data files in GB. NOTE: Make sure that this value multiplied by the number of CPUs for your instance type does not exceed the size of your log volume. Ex: 1

OPT_TEMP_VOLUME_LETTER

Use this input to reserve drive letter for temporary volume at boot time and assign to the volume when using temp volume in mirroring initialization. Drive letters D-P are supported on EC2, D-J are supported on CloudStack. Note, that all volume letter inputs should have different values. Ex: G

OPT_USE_PUBLIC_IP

Set this input to True to use public (external) IPs for mirroring connection.

PRINCIPAL_CERTIFICATE

Certificate to be used for authentication on mirroring endpoint of Principal server. This input is required when launching Principal, Mirror or Witness but not needed for Standalone SQL Server. Use a credential containing encoded certificate and private key generated by "DB SQLS Generate and Save a Certificate" RightScript. Note that the private key is encryped by password (PRINCIPAL_PRIVATE_KEY_PASSWORD input). Please see our support portal for more information on using credentials for passing certificates for mirroring authentication.

PRINCIPAL_PRIVATE_KEY_PASSWORD

Password to decrypt private key containing in PRINCIPAL_CERTIFICATE input. This input is required when launching Principal, Mirror or Witness but not needed for Standalone SQL Server. Should be the same password which was used to generate and encode certificate and private key by "DB SQLS Generate and Save a Certificate" RightScript. Please see our support portal for more information on using credentials for passing certificates for mirroring authentication.

PRIVATE_KEY_PASSWORD

Password to encrypt private key. The password must meet the Microsoft SQL Server Strong Password requirements: Does not contain all or part of the user's account name Is more than eight characters in length Contains characters from at least three of the following categories: English uppercase characters (A through Z) English lowercase characters (a through z) Base 10 digits (0 through 9) Nonalphabetic characters (for example: !, $, #, %) For more information please see [Microsoft SQL Server Strong Password Guidelines](http://msdn2.microsoft.com/en-us/lib.../ms144284.aspx)

REMOTE_STORAGE_ACCOUNT_ID

The Account ID or Name of the Remote Storage account which is used to authenticate your requests to Remote Storage services. It's strongly recommended that you use a RightScale Credential (Design > Credentials) to hide the actual key value from non-admin users while still allowing them to pass the appropriate value as an input. Ex: cred:AWS_ACCESS_KEY_ID

REMOTE_STORAGE_ACCOUNT_PROVIDER

Name of Remote Storage provider. Amazon S3, Rackspace Cloud Files, Windows Azure Storage, Softlayer Object Storage and OpenStack Swift are currently supported. Please select appropriate value from the dropdown. Ex: Amazon_S3

REMOTE_STORAGE_ACCOUNT_SECRET

The Secret Key or Password of the Remote Storage account which is used to authenticate your requests to Remote Storage services. It's strongly recommended that you use a RightScale Credential (Design > Credentials) to hide the actual key value from non-admin users while still allowing them to pass the appropriate value as an input. Ex: cred:AWS_ACCESS_SECRET_KEY_ID

REMOTE_STORAGE_BLOCK_SIZE

Size of upload block in megabytes (currently supported by Amazon S3 and Windows Azure Storage only). Default and recommended value is 10 (10MB). Supported ranges are 1..5024 for S3 and 1..64 for WAS.

REMOTE_STORAGE_CONTAINER

Name of Remote Storage container (S3 bucket name, Rackspace Cloud Files, Windows Azure Storage or SoftLayer Storage container to be used as storage for database initialization and backups, app server logs. Ex: mycontainer

REMOTE_STORAGE_CONTAINER_OVERRIDE

Optional input to override container name to restore from backup in another remote storage container. If this input has a value it's used instead of REMOTE_STORAGE_CONTAINER input. Ex: mycontainer2

REMOTE_STORAGE_ENDPOINT_URL

The endpoint URL for the Remote Storage provider. Currently this is used to specify endpoint for OpenStack Swift. Ex: http://myswift.com:5000/v2.0/tokens

REMOTE_STORAGE_THREAD_COUNT

Number of parallel threads to be used for file downloads and uploads (currently supported by Windows Azure Storage only). Default value is 2. Ex: 4

REMOTE_STORAGE_USE_INTERNAL_NETWORK

Set this input to True to force network connection to remote storage service using private interface (if the server is located in the same cloud/datacenter as remote storage service). This input is supported for Rackspace Open cloud, SoftLayer and OpenStack. Default is False (using public network interface). Ex: True.

SERVER_MODE

Mode of server operation: either Standalone, Principal, or Mirror. Ex: Standalone

SERVER_UUID

Universally-unique identifier for this server incarnation. Unique across all clouds, partitions, and guaranteed to change after a bundled boot or stop/start operation. Can be used as a sketchy or lumberjack hostname identifier.

SKETCHY

Hostname of the Sketchy server associated with the instance.

SKIP_RESTORE_SYSTEM_DATABASES

Set this input to True to skip restoring system databases when restoring from Remote Storage backup. This could be useful when the backup is created with different version of SQL Server. Default value is False

SYS_WINDOWS_TZINFO

Sets the system timezone to the timezone specified, which must be a valid Windows timezone entry. You can find a list of valid examples using TZUTIL /L from command prompt. You may override the dropdown if you do not see your timezone listed.

USE_PUBLIC_IP_WITNESS

Set this input to True to use public (external) IPs for witness connection.

WINDOWS_AUTOMATIC_UPDATES_POLICY

Define the Windows automatic update policy for the instance.

WINDOWS_UPDATES_REBOOT_SETTING

Specify how the Windows automatic updates should be applied to a running server. For example, you may not want the server to automatically reboot itself after applying an update. Automatic reboot is disabled by default. (e.g. Do Not Allow Reboot)

WITNESS_CERTIFICATE

Certificate to be used for authentication on mirroring endpoint of Witness server. This input is required when launching Principal, Mirror or Witness but not needed for Standalone SQL Server. Use a credential containing encoded certificate and private key generated by "DB SQLS Generate and Save a Certificate" RightScript. Note that the private key is encryped by password (WITNESS_PRIVATE_KEY_PASSWORD input). Please see our support portal for more information on using credentials for passing certificates for mirroring authentication.

WITNESS_PRIVATE_KEY_PASSWORD

Password to decrypt private key containing in WITNESS_CERTIFICATE input. This input is required when launching Principal and Mirror servers with witness (and for Witness server too) but not needed for Standalone SQL Server. Should be the same password which was used to generate and encode certificate and private key by "DB SQLS Generate and Save a Certificate" RightScript. Please see our support portal for more information on using credentials for passing certificates for mirroring authentication.

Revision History

Revision Date Published Description of Changes Known Issues
2 Aug 29, 2013 Initial release. See v13.5 LTS Release Notes. N/A

See also

You must to post a comment.
Last modified
10:41, 16 Oct 2013

Tags

This page has no custom tags.

Classifications

This page has no classifications.

Announcements

None


© 2006-2014 RightScale, Inc. All rights reserved.
RightScale is a registered trademark of RightScale, Inc. All other products and services may be trademarks or servicemarks of their respective owners.