lowlydba.sqlserver.agent_job_category module – Configures a SQL Agent job category

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

New in lowlydba.sqlserver 0.1.0

Synopsis

  • Configures a SQL Agent job category. Creates if it does not exist, else does nothing.

Requirements

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

Parameters

Parameter

Comments

category

string / required

Name of the category.

category_type

string

The type of category.

Choices:

  • "LocalJob"

  • "MultiServerJob"

  • "None"

sql_instance

string / required

The SQL Server instance to modify.

sql_password

string

Password for SQL Authentication.

sql_username

string

Username for SQL Authentication.

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

Platforms: all

Target OS/families that can be operated against.

Examples

- name: Create a maintenance job category
  lowlydba.sqlserver.agent_job_category:
    sql_instance: sql-01.myco.io
    category: "Index Maintenance"

Return Values

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

Key

Description

data

dictionary

Output from the New-DbaAgentJobCategory or Remove-DbaAgentJobCategory function.

Returned: success, but not in check_mode.

Authors

  • John McCall (@lowlydba)