< Back
Invoke-FreeIPAAPIhostgroup_find
Post
NAME Invoke-FreeIPAAPIhostgroup_find
SYNOPSIS
SYNTAX
Invoke-FreeIPAAPIhostgroup_find [[-hostgroup_name] <String>] [[-desc] <String>] [[-timelimit] <Int32>]
[[-sizelimit] <Int32>] [-all] [-raw] [[-version] <String>] [-no_members] [-pkey_only] [[-hosts] <String[]>]
[[-no_hosts] <String[]>] [[-hostgroups] <String[]>] [[-no_hostgroups] <String[]>] [[-in_hostgroups] <String[]>]
[[-not_in_hostgroups] <String[]>] [[-in_netgroups] <String[]>] [[-not_in_netgroups] <String[]>] [[-in_hbacrules]
<String[]>] [[-not_in_hbacrules] <String[]>] [[-in_sudorules] <String[]>] [[-not_in_sudorules] <String[]>]
[[-criteria] <String>] [-FullResultsOutput] [<CommonParameters>]
DESCRIPTION
Search for hostgroups.
PARAMETERS
-hostgroup_name <String>
Name of host-group
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-desc <String>
A description of this host-group
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-timelimit <Int32>
Time limit of search in seconds (0 is unlimited)
Required? false
Position? 3
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-sizelimit <Int32>
Maximum number of entries returned (0 is unlimited)
Required? false
Position? 4
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-all [<SwitchParameter>]
Retrieve and print all attributes from the server. Affects command output.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-raw [<SwitchParameter>]
Print entries as stored on the server. Only affects output format.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-version <String>
Client version. Used to determine if server will accept request.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-no_members [<SwitchParameter>]
Suppress processing of membership attributes.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-pkey_only [<SwitchParameter>]
Results should contain primary key attribute only ("hostgroup-name")
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-hosts <String[]>
Search for host groups with these member hosts.
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-no_hosts <String[]>
Search for host groups without these member hosts.
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-hostgroups <String[]>
Search for host groups with these member host groups.
Required? false
Position? 8
Default value
Accept pipeline input? false
Accept wildcard characters? false
-no_hostgroups <String[]>
Search for host groups without these member host groups.
Required? false
Position? 9
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_hostgroups <String[]>
Search for host groups with these member of host groups.
Required? false
Position? 10
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_hostgroups <String[]>
Search for host groups without these member of host groups.
Required? false
Position? 11
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_netgroups <String[]>
Search for host groups with these member of netgroups.
Required? false
Position? 12
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_netgroups <String[]>
Search for host groups without these member of netgroups.
Required? false
Position? 13
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_hbacrules <String[]>
Search for host groups with these member of HBAC rules.
Required? false
Position? 14
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_hbacrules <String[]>
Search for host groups without these member of HBAC rules.
Required? false
Position? 15
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_sudorules <String[]>
Search for host groups with these member of sudo rules.
Required? false
Position? 16
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_sudorules <String[]>
Search for host groups without these member of sudo rules.
Required? false
Position? 17
Default value
Accept pipeline input? false
Accept wildcard characters? false
-criteria <String>
A string searched in all relevant object attributes
Required? false
Position? 18
Default value
Accept pipeline input? false
Accept wildcard characters? false
-FullResultsOutput [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Management.Automation.PSObject
RELATED LINKS
SYNOPSIS
SYNTAX
Invoke-FreeIPAAPIhostgroup_find [[-hostgroup_name] <String>] [[-desc] <String>] [[-timelimit] <Int32>]
[[-sizelimit] <Int32>] [-all] [-raw] [[-version] <String>] [-no_members] [-pkey_only] [[-hosts] <String[]>]
[[-no_hosts] <String[]>] [[-hostgroups] <String[]>] [[-no_hostgroups] <String[]>] [[-in_hostgroups] <String[]>]
[[-not_in_hostgroups] <String[]>] [[-in_netgroups] <String[]>] [[-not_in_netgroups] <String[]>] [[-in_hbacrules]
<String[]>] [[-not_in_hbacrules] <String[]>] [[-in_sudorules] <String[]>] [[-not_in_sudorules] <String[]>]
[[-criteria] <String>] [-FullResultsOutput] [<CommonParameters>]
DESCRIPTION
Search for hostgroups.
PARAMETERS
-hostgroup_name <String>
Name of host-group
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-desc <String>
A description of this host-group
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-timelimit <Int32>
Time limit of search in seconds (0 is unlimited)
Required? false
Position? 3
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-sizelimit <Int32>
Maximum number of entries returned (0 is unlimited)
Required? false
Position? 4
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-all [<SwitchParameter>]
Retrieve and print all attributes from the server. Affects command output.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-raw [<SwitchParameter>]
Print entries as stored on the server. Only affects output format.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-version <String>
Client version. Used to determine if server will accept request.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-no_members [<SwitchParameter>]
Suppress processing of membership attributes.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-pkey_only [<SwitchParameter>]
Results should contain primary key attribute only ("hostgroup-name")
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-hosts <String[]>
Search for host groups with these member hosts.
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-no_hosts <String[]>
Search for host groups without these member hosts.
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-hostgroups <String[]>
Search for host groups with these member host groups.
Required? false
Position? 8
Default value
Accept pipeline input? false
Accept wildcard characters? false
-no_hostgroups <String[]>
Search for host groups without these member host groups.
Required? false
Position? 9
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_hostgroups <String[]>
Search for host groups with these member of host groups.
Required? false
Position? 10
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_hostgroups <String[]>
Search for host groups without these member of host groups.
Required? false
Position? 11
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_netgroups <String[]>
Search for host groups with these member of netgroups.
Required? false
Position? 12
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_netgroups <String[]>
Search for host groups without these member of netgroups.
Required? false
Position? 13
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_hbacrules <String[]>
Search for host groups with these member of HBAC rules.
Required? false
Position? 14
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_hbacrules <String[]>
Search for host groups without these member of HBAC rules.
Required? false
Position? 15
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_sudorules <String[]>
Search for host groups with these member of sudo rules.
Required? false
Position? 16
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_sudorules <String[]>
Search for host groups without these member of sudo rules.
Required? false
Position? 17
Default value
Accept pipeline input? false
Accept wildcard characters? false
-criteria <String>
A string searched in all relevant object attributes
Required? false
Position? 18
Default value
Accept pipeline input? false
Accept wildcard characters? false
-FullResultsOutput [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Management.Automation.PSObject
RELATED LINKS