| external help file | Module Name | online version | schema |
|---|---|---|---|
Jagabata.psm.dll-Help.xml |
Jagabata.psm |
2.0.0 |
Retrieve jobs for JobTemplate.
Find-AnsibleJob [[-JobTemplate] <UInt64>] [[-Name] <String[]>] [-Status <String[]>] [-LaunchType <String[]>]
[-OrderBy <String[]>] [-Search <String[]>] [-Filter <NameValueCollection>] [-Count <UInt16>] [-Page <UInt32>]
[-All] [<CommonParameters>]
Retrieve the list of jobs launched from JobTemplates.
Implementation of following API:
/api/v2/jobs//api/v2/job_templates/{id}/jobs/
PS C:\> Find-AnsibleJob -Status runningRetreive running jobs.
PS C:\> Find-AnsibleJob -JobTemplate 1Retrieve jobs associated with the JobTemplate of ID 1
Retrieve resources from all pages.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseNumber to retrieve per page.
Type: UInt16
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 20
Accept pipeline input: False
Accept wildcard characters: FalseFiltering various fields.
For examples:
name__icontains=test: "name" field contains "test" (case-insensitive)."name_ in=test,demo", created _gt=2024-01-01: "name" field is "test" or "demo" and created after 2024-01-01.@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }: "name" field NOT contains "test"
For more details, see about_Jagabata.psm_Filter_parameter.
Type: NameValueCollection
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseJobTemplate ID or it's object. Filter to jobs in the JobTemplate for the specified ID.
Tip
Can specify IResource object.
For example: -JobTemplate (Get-AnsibleJobTemplate -Id 3), -JobTemplate $jobTemplate
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseFilter with launch_type field
Type: String[]
Parameter Sets: (All)
Aliases:
Accepted values: manual, relaunch, callback, scheduled, dependency, workflow, webhook, sync, scm
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseFilter by job name. The names must be an exact match. (case-sensitive)
Multiple words are available by separating with a comma(,).
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseRetrieve list in the specified orders.
Use ! prefix to sort in reverse.
Multiple sorting fields are available by separating with a comma(,).
Default value: !id (descending order of ID)
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: ["!id"]
Accept pipeline input: False
Accept wildcard characters: FalsePage number.
Type: UInt32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 1
Accept pipeline input: False
Accept wildcard characters: FalseSearch words. (case-insensitive)
Target fields: name, description
Multiple words are available by separating with a comma(,).
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseFilter by status field.
Type: String[]
Parameter Sets: (All)
Aliases:
Accepted values: new, started, pending, waiting, running, successful, failed, error, canceled
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
JobTemplate ID or it's object.