Inputs & Outputs

MSSQLServer

  • Contains remote SQL Server connection details for a Microsoft SQL Server

  • It is used as an input to many of the actions in this plugin

  • The example below shows the dictionary structure in YAML

  • See the required and optional keys underneath the example

Supplying Credentials

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

Example

1
2
3
4
5
6
7
mssql:
  address: sql-server.internal.net
  instance: sqlserver
  database: master
  username: example.username
  password: example.password
  port: 1433

Required Keys

address: The target IP or DNS address.

database: The database to connect to.

username: Username for authentication.

password: Password for authentication.

Optional Keys

instance: The SQL instance being connected to (defaults to MSSQLSERVER).

port: The port to use when connecting (defaults to 1433).