lowlydba.sqlserver.agent_job module – Configures a SQL Agent job
Note
This module is part of the lowlydba.sqlserver collection (version 2.3.6).
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
.
New in lowlydba.sqlserver 0.1.0
Synopsis
Configure a SQL Agent job, including which schedules and category it belongs to.
Requirements
The below requirements are needed on the host that executes this module.
dbatools PowerShell module
Parameters
Parameter |
Comments |
---|---|
Category for the target SQL Agent job. Must already exist. |
|
Description for the SQL Agent job. |
|
Whether the SQL Agent job should be enabled or disabled. Choices:
|
|
If force=true, any job categories will be created if they don’t exist already. Choices:
|
|
The name of the target SQL Agent job. |
|
The owning login for the database. Will default to the current user if the database is being created and none supplied. |
|
The name of the schedule the job should be associated with. Only one schedule per job is supported. |
|
The SQL Server instance to modify. |
|
Password for SQL Authentication. |
|
Username for SQL Authentication. |
|
What step number the job should begin with when run. |
|
Whether or not the object should be Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in check_mode and return changed status prediction without modifying target. |
|
Platforms: all |
Target OS/families that can be operated against. |
Notes
Note
On slower hardware, stale job component data may be returned (i.e., a previous or default job category). Configuring each component (schedule, step, category, etc.) individually is recommended for this reason.
Examples
- name: Create a job
lowlydba.sqlserver.agent_job:
sql_instance: sql-01.myco.io
job: MyJob
force: true
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Output from the Returned: success, but not in check_mode. |