Inputs & Outputs

MSSQLServer

Contains MSSQL Server connection details.

Supplying Credentials

You should always use a PPA Vault integration to provide credentials to a plugin action.

Authentication Methods

Both local SQL & Active Directory authentication are supported.

For Active Directory authentication the username must be in this format:

domain\username

The domain portion should be the short-format name (NETBIOS Domain Name).

Required Keys

address: Server IP or DNS address

database: Database to connect to

username: Username for authentication

password: Password for authentication

Optional Keys

instance: The SQL database instance to connect to.

port: The port to use when connecting to the instance.

Depending on what PPA needs to connect to, at least one of these values will be required.

See the table below for more information.

The plugin will fail if neither is supplied.

When To Supply Instance & Port

Multiple Instance Server	Default Instance	Default Database	Required Details
No	Yes	Yes	Instance and/or Port
No	Yes	No	Port or Port & Instance
Yes	Yes	Yes	Instance and/or Port
Yes	Yes	No	Instance and/or Port
Yes	No	Yes	Instance and/or Port
Yes	No	No	Instance only

Examples - Single-Instance Server

Connecting to the default database:

mssql:
  address: sql-server.internal.net
  database: master
  username: example.username
  password: example.password
  # Either or both of the following is accepted
  instance: SQLEXPRESS
  port: 1433

Connecting to a non-default_ database:

mssql:
  address: sql-server.internal.net
  database: master
  username: example.username
  password: example.password
  # The port must be supplied, the instance name is optional
  port: 1433
  instance: SQLEXPRESS

Examples - Multiple-Instance Server

Connecting to any database on the default instance:

mssql:
  address: sql-server.internal.net
  database: master
  username: example.username
  password: example.password
  # Either or both of the following is accepted
  instance: SQLEXPRESS
  port: 1433

Connecting to the default database on a non-default instance:

mssql:
  address: sql-server.internal.net
  database: master
  username: example.username
  password: example.password
  # Either or both of the following is accepted
  instance: PAYROLL
  port: 1433

Connecting to a non-default database on a non-default instance:

mssql:
  address: sql-server.internal.net
  database: users
  username: example.username
  password: example.password
  # Only the instance must be supplied
  instance: PAYROLL