< Back
Invoke-FreeIPAAPIhost_mod
Post
NAME Invoke-FreeIPAAPIhost_mod
SYNOPSIS
SYNTAX
Invoke-FreeIPAAPIhost_mod [[-desc] <String>] [[-locality] <String>] [[-location] <String>] [[-platform] <String>]
[[-os] <String>] [[-password] <SecureString>] [-random] [[-certificate] <String[]>] [[-krbprincipalname]
<String[]>] [[-macaddress] <String[]>] [[-sshpubkey] <String[]>] [[-class] <String[]>] [[-ipaassignedidview]
<String>] [[-auth_ind] <String[]>] [-requires_pre_auth] [-ok_as_delegate] [-ok_to_auth_as_delegate] [[-setattr]
<String[]>] [[-addattr] <String[]>] [[-delattr] <String[]>] [-rights] [-updatedns] [-all] [-raw] [[-version]
<String>] [-no_members] [-hostname] <String> [-FullResultsOutput] [<CommonParameters>]
DESCRIPTION
Modify information about a host.
PARAMETERS
-desc <String>
A description of this host
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-locality <String>
Host locality (e.g. "Baltimore, MD")
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-location <String>
Host location (e.g. "Lab 2")
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-platform <String>
Host hardware platform (e.g. "Lenovo T61")
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-os <String>
Host operating system and version (e.g. "Fedora 9")
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-password <SecureString>
Password used in bulk enrollment
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-random [<SwitchParameter>]
Generate a random password to be used in bulk enrollment
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-certificate <String[]>
Base-64 encoded host certificate
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-krbprincipalname <String[]>
Principal alias
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
-sshpubkey <String[]>
SSH public key
Required? false
Position? 10
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? 11
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ipaassignedidview <String>
Assigned ID View
Required? false
Position? 12
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? 13
Default value
Accept pipeline input? false
Accept wildcard characters? false
-requires_pre_auth [<SwitchParameter>]
Pre-authentication is required for the service
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ok_as_delegate [<SwitchParameter>]
Client credentials may be delegated to the service
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ok_to_auth_as_delegate [<SwitchParameter>]
The service is allowed to authenticate on behalf of a client
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-setattr <String[]>
Set an attribute to a name/value pair. Format is attr=value.
For multi-valued attributes, the command replaces the values already present.
Required? false
Position? 14
Default value
Accept pipeline input? false
Accept wildcard characters? false
-addattr <String[]>
Add an attribute/value pair. Format is attr=value. The attribute
must be part of the schema.
Required? false
Position? 15
Default value
Accept pipeline input? false
Accept wildcard characters? false
-delattr <String[]>
Delete an attribute/value pair. The option will be evaluated
last, after all sets and adds.
Required? false
Position? 16
Default value
Accept pipeline input? false
Accept wildcard characters? false
-rights [<SwitchParameter>]
Display the access rights of this entry (requires -all). See ipa man page for details.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-updatedns [<SwitchParameter>]
Update DNS entries
Required? false
Position? named
Default value False
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? 17
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
-hostname <String>
Host name
Required? true
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-FreeIPAAPIhost_mod [[-desc] <String>] [[-locality] <String>] [[-location] <String>] [[-platform] <String>]
[[-os] <String>] [[-password] <SecureString>] [-random] [[-certificate] <String[]>] [[-krbprincipalname]
<String[]>] [[-macaddress] <String[]>] [[-sshpubkey] <String[]>] [[-class] <String[]>] [[-ipaassignedidview]
<String>] [[-auth_ind] <String[]>] [-requires_pre_auth] [-ok_as_delegate] [-ok_to_auth_as_delegate] [[-setattr]
<String[]>] [[-addattr] <String[]>] [[-delattr] <String[]>] [-rights] [-updatedns] [-all] [-raw] [[-version]
<String>] [-no_members] [-hostname] <String> [-FullResultsOutput] [<CommonParameters>]
DESCRIPTION
Modify information about a host.
PARAMETERS
-desc <String>
A description of this host
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-locality <String>
Host locality (e.g. "Baltimore, MD")
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-location <String>
Host location (e.g. "Lab 2")
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-platform <String>
Host hardware platform (e.g. "Lenovo T61")
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-os <String>
Host operating system and version (e.g. "Fedora 9")
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-password <SecureString>
Password used in bulk enrollment
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-random [<SwitchParameter>]
Generate a random password to be used in bulk enrollment
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-certificate <String[]>
Base-64 encoded host certificate
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-krbprincipalname <String[]>
Principal alias
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
-sshpubkey <String[]>
SSH public key
Required? false
Position? 10
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? 11
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ipaassignedidview <String>
Assigned ID View
Required? false
Position? 12
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? 13
Default value
Accept pipeline input? false
Accept wildcard characters? false
-requires_pre_auth [<SwitchParameter>]
Pre-authentication is required for the service
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ok_as_delegate [<SwitchParameter>]
Client credentials may be delegated to the service
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ok_to_auth_as_delegate [<SwitchParameter>]
The service is allowed to authenticate on behalf of a client
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-setattr <String[]>
Set an attribute to a name/value pair. Format is attr=value.
For multi-valued attributes, the command replaces the values already present.
Required? false
Position? 14
Default value
Accept pipeline input? false
Accept wildcard characters? false
-addattr <String[]>
Add an attribute/value pair. Format is attr=value. The attribute
must be part of the schema.
Required? false
Position? 15
Default value
Accept pipeline input? false
Accept wildcard characters? false
-delattr <String[]>
Delete an attribute/value pair. The option will be evaluated
last, after all sets and adds.
Required? false
Position? 16
Default value
Accept pipeline input? false
Accept wildcard characters? false
-rights [<SwitchParameter>]
Display the access rights of this entry (requires -all). See ipa man page for details.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-updatedns [<SwitchParameter>]
Update DNS entries
Required? false
Position? named
Default value False
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? 17
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
-hostname <String>
Host name
Required? true
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