< Back
Invoke-FreeIPAAPIhost_find
Post
NAME Invoke-FreeIPAAPIhost_find
SYNOPSIS
SYNTAX
Invoke-FreeIPAAPIhost_find [[-hostname] <String>] [[-desc] <String>] [[-locality] <String>] [[-location] <String>]
[[-platform] <String>] [[-os] <String>] [[-password] <SecureString>] [[-certificate] <String[]>] [[-macaddress]
<String[]>] [[-class] <String[]>] [[-ipaassignedidview] <String>] [[-auth_ind] <String[]>] [[-timelimit] <Int32>]
[[-sizelimit] <Int32>] [-all] [-raw] [[-version] <String>] [-no_members] [-pkey_only] [[-in_hostgroups]
<String[]>] [[-not_in_hostgroups] <String[]>] [[-in_netgroups] <String[]>] [[-not_in_netgroups] <String[]>]
[[-in_roles] <String[]>] [[-not_in_roles] <String[]>] [[-in_hbacrules] <String[]>] [[-not_in_hbacrules]
<String[]>] [[-in_sudorules] <String[]>] [[-not_in_sudorules] <String[]>] [[-enroll_by_users] <String[]>]
[[-not_enroll_by_users] <String[]>] [[-man_by_hosts] <String[]>] [[-not_man_by_hosts] <String[]>] [[-man_hosts]
<String[]>] [[-not_man_hosts] <String[]>] [[-criteria] <String>] [-FullResultsOutput] [<CommonParameters>]
DESCRIPTION
Search for hosts.
PARAMETERS
-hostname <String>
Host name
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-desc <String>
A description of this host
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-locality <String>
Host locality (e.g. "Baltimore, MD")
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-location <String>
Host location (e.g. "Lab 2")
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-platform <String>
Host hardware platform (e.g. "Lenovo T61")
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-os <String>
Host operating system and version (e.g. "Fedora 9")
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-password <SecureString>
Password used in bulk enrollment
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-certificate <String[]>
Base-64 encoded host certificate
Required? false
Position? 8
Default value
Accept pipeline input? false
Accept wildcard characters? false
-macaddress <String[]>
Hardware MAC address(es) on this host
Required? false
Position? 9
Default value
Accept pipeline input? false
Accept wildcard characters? false
-class <String[]>
Host category (semantics placed on this attribute are for local interpretation)
Required? false
Position? 10
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ipaassignedidview <String>
Assigned ID View
Required? false
Position? 11
Default value
Accept pipeline input? false
Accept wildcard characters? false
-auth_ind <String[]>
Defines a whitelist for Authentication Indicators. Use 'otp' to allow OTP-based 2FA authentications. Use
'radius' to allow RADIUS-based 2FA authentications. Other values may be used for custom configurations.
Required? false
Position? 12
Default value
Accept pipeline input? false
Accept wildcard characters? false
-timelimit <Int32>
Time limit of search in seconds (0 is unlimited)
Required? false
Position? 13
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-sizelimit <Int32>
Maximum number of entries returned (0 is unlimited)
Required? false
Position? 14
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? 15
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 ("hostname")
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-in_hostgroups <String[]>
Search for hosts with these member of host groups.
Required? false
Position? 16
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_hostgroups <String[]>
Search for hosts without these member of host groups.
Required? false
Position? 17
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_netgroups <String[]>
Search for hosts with these member of netgroups.
Required? false
Position? 18
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_netgroups <String[]>
Search for hosts without these member of netgroups.
Required? false
Position? 19
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_roles <String[]>
Search for hosts with these member of roles.
Required? false
Position? 20
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_roles <String[]>
Search for hosts without these member of roles.
Required? false
Position? 21
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_hbacrules <String[]>
Search for hosts with these member of HBAC rules.
Required? false
Position? 22
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_hbacrules <String[]>
Search for hosts without these member of HBAC rules.
Required? false
Position? 23
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_sudorules <String[]>
Search for hosts with these member of sudo rules.
Required? false
Position? 24
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_sudorules <String[]>
Search for hosts without these member of sudo rules.
Required? false
Position? 25
Default value
Accept pipeline input? false
Accept wildcard characters? false
-enroll_by_users <String[]>
Search for hosts with these enrolled by users.
Required? false
Position? 26
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_enroll_by_users <String[]>
Search for hosts without these enrolled by users.
Required? false
Position? 27
Default value
Accept pipeline input? false
Accept wildcard characters? false
-man_by_hosts <String[]>
Search for hosts with these managed by hosts.
Required? false
Position? 28
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_man_by_hosts <String[]>
Search for hosts without these managed by hosts.
Required? false
Position? 29
Default value
Accept pipeline input? false
Accept wildcard characters? false
-man_hosts <String[]>
Search for hosts with these managing hosts.
Required? false
Position? 30
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_man_hosts <String[]>
Search for hosts without these managing hosts.
Required? false
Position? 31
Default value
Accept pipeline input? false
Accept wildcard characters? false
-criteria <String>
A string searched in all relevant object attributes
Required? false
Position? 32
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-FreeIPAAPIhost_find [[-hostname] <String>] [[-desc] <String>] [[-locality] <String>] [[-location] <String>]
[[-platform] <String>] [[-os] <String>] [[-password] <SecureString>] [[-certificate] <String[]>] [[-macaddress]
<String[]>] [[-class] <String[]>] [[-ipaassignedidview] <String>] [[-auth_ind] <String[]>] [[-timelimit] <Int32>]
[[-sizelimit] <Int32>] [-all] [-raw] [[-version] <String>] [-no_members] [-pkey_only] [[-in_hostgroups]
<String[]>] [[-not_in_hostgroups] <String[]>] [[-in_netgroups] <String[]>] [[-not_in_netgroups] <String[]>]
[[-in_roles] <String[]>] [[-not_in_roles] <String[]>] [[-in_hbacrules] <String[]>] [[-not_in_hbacrules]
<String[]>] [[-in_sudorules] <String[]>] [[-not_in_sudorules] <String[]>] [[-enroll_by_users] <String[]>]
[[-not_enroll_by_users] <String[]>] [[-man_by_hosts] <String[]>] [[-not_man_by_hosts] <String[]>] [[-man_hosts]
<String[]>] [[-not_man_hosts] <String[]>] [[-criteria] <String>] [-FullResultsOutput] [<CommonParameters>]
DESCRIPTION
Search for hosts.
PARAMETERS
-hostname <String>
Host name
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-desc <String>
A description of this host
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-locality <String>
Host locality (e.g. "Baltimore, MD")
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-location <String>
Host location (e.g. "Lab 2")
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-platform <String>
Host hardware platform (e.g. "Lenovo T61")
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-os <String>
Host operating system and version (e.g. "Fedora 9")
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-password <SecureString>
Password used in bulk enrollment
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-certificate <String[]>
Base-64 encoded host certificate
Required? false
Position? 8
Default value
Accept pipeline input? false
Accept wildcard characters? false
-macaddress <String[]>
Hardware MAC address(es) on this host
Required? false
Position? 9
Default value
Accept pipeline input? false
Accept wildcard characters? false
-class <String[]>
Host category (semantics placed on this attribute are for local interpretation)
Required? false
Position? 10
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ipaassignedidview <String>
Assigned ID View
Required? false
Position? 11
Default value
Accept pipeline input? false
Accept wildcard characters? false
-auth_ind <String[]>
Defines a whitelist for Authentication Indicators. Use 'otp' to allow OTP-based 2FA authentications. Use
'radius' to allow RADIUS-based 2FA authentications. Other values may be used for custom configurations.
Required? false
Position? 12
Default value
Accept pipeline input? false
Accept wildcard characters? false
-timelimit <Int32>
Time limit of search in seconds (0 is unlimited)
Required? false
Position? 13
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-sizelimit <Int32>
Maximum number of entries returned (0 is unlimited)
Required? false
Position? 14
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? 15
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 ("hostname")
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-in_hostgroups <String[]>
Search for hosts with these member of host groups.
Required? false
Position? 16
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_hostgroups <String[]>
Search for hosts without these member of host groups.
Required? false
Position? 17
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_netgroups <String[]>
Search for hosts with these member of netgroups.
Required? false
Position? 18
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_netgroups <String[]>
Search for hosts without these member of netgroups.
Required? false
Position? 19
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_roles <String[]>
Search for hosts with these member of roles.
Required? false
Position? 20
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_roles <String[]>
Search for hosts without these member of roles.
Required? false
Position? 21
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_hbacrules <String[]>
Search for hosts with these member of HBAC rules.
Required? false
Position? 22
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_hbacrules <String[]>
Search for hosts without these member of HBAC rules.
Required? false
Position? 23
Default value
Accept pipeline input? false
Accept wildcard characters? false
-in_sudorules <String[]>
Search for hosts with these member of sudo rules.
Required? false
Position? 24
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_in_sudorules <String[]>
Search for hosts without these member of sudo rules.
Required? false
Position? 25
Default value
Accept pipeline input? false
Accept wildcard characters? false
-enroll_by_users <String[]>
Search for hosts with these enrolled by users.
Required? false
Position? 26
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_enroll_by_users <String[]>
Search for hosts without these enrolled by users.
Required? false
Position? 27
Default value
Accept pipeline input? false
Accept wildcard characters? false
-man_by_hosts <String[]>
Search for hosts with these managed by hosts.
Required? false
Position? 28
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_man_by_hosts <String[]>
Search for hosts without these managed by hosts.
Required? false
Position? 29
Default value
Accept pipeline input? false
Accept wildcard characters? false
-man_hosts <String[]>
Search for hosts with these managing hosts.
Required? false
Position? 30
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_man_hosts <String[]>
Search for hosts without these managing hosts.
Required? false
Position? 31
Default value
Accept pipeline input? false
Accept wildcard characters? false
-criteria <String>
A string searched in all relevant object attributes
Required? false
Position? 32
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