lowlydba.sqlserver.instance_info module – Returns basic information for a SQL Server instance

Note

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

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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.instance_info.

New in lowlydba.sqlserver 0.2.0

Synopsis

  • Returns basic information for a SQL Server instance.

Requirements

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

Parameters

Parameter

Comments

sql_instance

string / required

The SQL Server instance to modify.

sql_password

string

Password for SQL Authentication.

sql_username

string

Username for SQL Authentication.

Attributes

Attribute

Support

Description

check_mode

Support: full

This module is “read only” and operates the same regardless of check mode.

platform

Platforms: all

Target OS/families that can be operated against.

Examples

- name: Get basic info for an instance
  lowlydba.sqlserver.instance_info:
    sql_instance: sql-01.myco.io

Return Values

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

Key

Description

data

dictionary

Instance level properties of the SQL Server instance.

Returned: always

Authors

  • John McCall (@lowlydba)