lowlydba.sqlserver.spn module – Configures SPNs for SQL Server

Note

This module is part of the lowlydba.sqlserver collection (version 1.1.2).

To install it, use: ansible-galaxy collection install lowlydba.sqlserver. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: lowlydba.sqlserver.spn.

New in lowlydba.sqlserver 0.6.0

Synopsis

  • Configures SPNs for SQL Server.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter

Comments

computer

string / required

The host or alias to configure the SPN for. Can include the port in the format host:port.

computer_password

string

Password of a credential to connect to Active Directory with.

computer_username

string

Username of a credential to connect to Active Directory with.

service_account

string / required

The account you want the SPN added to. Will be looked up if not provided.

state

string

Whether or not the object should be present or absent.

Choices:

  • "present" ← (default)

  • "absent"

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

platform

Platform: Windows

Target OS/families that can be operated against.

Examples

- name: Add server SPN
  lowlydba.sqlserver.spn:
    computer: sql-01.myco.io
    service_account: myco\sql-svc

- name: Create an AG Listener
  lowlydba.sqlserver.ag_listener:
    sql_instance_primary: sql-01.myco.io
    ag_name: AG_MyDatabase
    listener_name: aglMyDatabase
    ip_address: 10.0.20.20,10.1.77.77
    subnet_ip: 255.255.252.0
    subnet_mask: 255.255.255.0

- name: Add SPN for new AG listener on port 1433
  lowlydba.sqlserver.spn:
    computer: aglMyDatabase.myco.io:1433
    service_account: myco\sql-svc

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

data

dictionary

Output from the Set-DbaSpn or Remove-DbaSpn function.

Returned: success, but not in check_mode.

Authors

  • John McCall (@lowlydba)