lowlydba.sqlserver.agent_job_category (2.3.2) — module

Install collection

Install with ansible-galaxy collection install lowlydba.sqlserver:==2.3.2

Add to requirements.yml

  collections:
    - name: lowlydba.sqlserver
      version: 2.3.2

Description

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

Requirements

• L(dbatools,https://www.powershellgallery.com/packages/dbatools/) PowerShell module

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether or not the object should be C(present) or C(absent).
    required: false
    type: str

category:
    description:
    - Name of the category.
    required: true
    type: str

sql_instance:
    description:
    - The SQL Server instance to modify.
    required: true
    type: str

sql_password:
    description:
    - Password for SQL Authentication.
    required: false
    type: str

sql_username:
    description:
    - Username for SQL Authentication.
    required: false
    type: str

category_type:
    choices:
    - LocalJob
    - MultiServerJob
    - None
    description:
    - The type of category.
    required: false
    type: str

Outputs

data:
  description: Output from the C(New-DbaAgentJobCategory) or C(Remove-DbaAgentJobCategory)
    function.
  returned: success, but not in check_mode.
  type: dict