| external help file | Module Name | online version | schema |
|---|---|---|---|
Jagabata.psm.dll-Help.xml |
Jagabata.psm |
2.0.0 |
Retrieve Groups.
Find-AnsibleGroup [-OrderBy <String[]>] [-Search <String[]>] [-Filter <NameValueCollection>] [-Count <UInt16>]
[-Page <UInt32>] [-All] [<CommonParameters>]
Find-AnsibleGroup [-Type] <ResourceType> [-Id] <UInt64> [-OnlyRoot] [-OnlyParnets] [-OrderBy <String[]>]
[-Search <String[]>] [-Filter <NameValueCollection>] [-Count <UInt16>] [-Page <UInt32>] [-All]
[<CommonParameters>]
Find-AnsibleGroup -Resource <IResource> [-OnlyRoot] [-OnlyParnets] [-OrderBy <String[]>] [-Search <String[]>]
[-Filter <NameValueCollection>] [-Count <UInt16>] [-Page <UInt32>] [-All] [<CommonParameters>]
Retrieve the list of Groups.
Implementation of following API:
/api/v2/groups//api/v2/inventories/{id}/groups//api/v2/inventories/{id}/root_groups//api/v2/groups/{id}/children//api/v2/inventory_sources/{id}/groups//api/v2/hosts/{id}/groups//api/v2/hosts/{id}/all_groups/
PS C:\> Find-AnsibleGroupPS C:\> Find-AnsibleGroup -Type Inventory -Id 1Retrieve Groups associated with the Inventory of ID 1
Id and Type parameters can also be given from the pipeline, likes following:
Get-AnsibleInventory -Id 1 | Find-AnsibleGroup
PS C:\> Find-AnsibleGroup -Type Inventory -Id 1 -OnlyRootRetrieve root (top-level) Groups associated with the Inventory of ID 1
PS C:\> Find-AnsibleGroup -Type Host -Id 1Retrieve Groups of which the target Host (ID 1) is directly or indirectly a member.
If you need only directly a member, use -OnlyParents parameter.
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: FalseDatebase ID of the target resource.
Use in conjection with the -Type parameter.
Type: UInt64
Parameter Sets: AssociatedWith
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseList only directly member Groups. Only affected for a Host Type
Type: SwitchParameter
Parameter Sets: AssociatedWith, PipelineInput
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseList only root(Top-level) Groups. Only affected for an Inventory Type
Type: SwitchParameter
Parameter Sets: AssociatedWith, PipelineInput
Aliases:
Required: False
Position: Named
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 (ascending 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: FalseResource object to which the search target associated with.
The resource is accepted following types:
InventoryGroupInventorySourceHost
Type: IResource
Parameter Sets: PipelineInput
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
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: FalseResource type name of the target.
Use in conjection with the -Id parameter.
Type: ResourceType
Parameter Sets: AssociatedWith
Aliases:
Accepted values: Inventory, Group, InventorySource, Host
Required: True
Position: 0
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.
Resource object to which the search target associated with.
See: -Resource parameter.