dbatools
dbatools copied to clipboard
New-DbaAgentSchedule's documentation does not illustrate most of its parameters
Summarize Functionality
Every time that I want to use New-DbaAgentSchedule
, I need to crack open my copy of Learn dbatools in a Month of Lunches. Standard parameters aside, the function has 14 parameters:
-
[[-Job] <Object[]>]
-
[[-Schedule] <Object>]
-
[-Disabled]
-
[[-FrequencyType] <Object>]
-
[[-FrequencyInterval] <Object[]>]
-
[[-FrequencySubdayType] <Object>]
-
[[-FrequencySubdayInterval] <Int32>]
-
[[-FrequencyRelativeInterval] <Object>]
-
[[-FrequencyRecurrenceFactor] <Int32>]
-
[[-StartDate] <String>]
-
[[-EndDate] <String>]
-
[[-StartTime] <String>]
-
[[-EndTime] <String>]
-
[[-Owner] <String>]
Of these 14 parameters, more than half have no examples in the documentation. Specifically, the following 9 have none:
-
[[-Job] <Object[]>]
-
[-Disabled]
-
[[-FrequencySubdayType] <Object>]
-
[[-FrequencySubdayInterval] <Int32>]
-
[[-FrequencyRelativeInterval] <Object>]
-
[[-StartDate] <String>]
-
[[-EndDate] <String>]
-
[[-EndTime] <String>]
-
[[-Owner] <String>]
and Force
is used in every example.
This should be corrected, but the fact that I have to use the documentation so much to notice this issue proves that I'm not qualified to solve it!
Is there a command that is similiar or close to what you are looking for?
Yes
Technical Details
Directly stealing examples from Learn dbatools in a Month of Lunches would be a great step forward. A little more variety in the schedules would also be welcome. For example, I'm sure that plenty of people write jobs that run twice per day or every hour.