Skip to content

Latest commit

 

History

History
168 lines (125 loc) · 3.55 KB

Find-AnsibleUnifiedJobTemplate.md

File metadata and controls

168 lines (125 loc) · 3.55 KB
external help file Module Name online version schema
Jagabata.psm.dll-Help.xml
Jagabata.psm
2.0.0

Find-AnsibleUnifiedJobTemplate

SYNOPSIS

Retrieve Unified Job Templates.

SYNTAX

Find-AnsibleUnifiedJobTemplate [-OrderBy <String[]>] [-Search <String[]>] [-Filter <NameValueCollection>]
 [-Count <UInt16>] [-Page <UInt32>] [-All] [<CommonParameters>]

DESCRIPTION

Retrieve Unified Job Templates which are JobTemplate, Project, InventorySource, SystemJobTemplate or WorkflowJobTemplate.

Implementation of following API:

  • /api/v2/unified_job_templates/

EXAMPLES

Example 1

PS C:\> Find-AnsibleUnifiedJobTemplate

PARAMETERS

-All

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: False

-Count

Number to retrieve per page.

Type: UInt16
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 20
Accept pipeline input: False
Accept wildcard characters: False

-Filter

Filtering 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: False

-OrderBy

Retrieve list in the specified orders. Use ! prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(,).

Default value: id (ascending order of ID)

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: ["id"]
Accept pipeline input: False
Accept wildcard characters: False

-Page

Page number.

Type: UInt32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 1
Accept pipeline input: False
Accept wildcard characters: False

-Search

Search words. (case-insensitive)

Target fields: name, description, jobtemplate__playbook

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: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

Jagabata.Resources.IUnifiedJobTemplate

Unified Job Template objects which are following instances implemented IUnifiedJobTemplate:

  • JobTemplate
  • Project
  • InventorSource
  • SystemJobTemplate
  • WorkflowJobTemplate

NOTES

RELATED LINKS

Find-AnsibleUnifiedJob

Find-AnsibleJobTemplate

Find-AnsibleProject

Find-AnsibleInventorySource

Find-AnsibleWorkflowJobTemplate