Set-Host
SYNOPSIS
Modifies properties of a host.
SYNTAX
ModifyPropertiesByName (Default)
Set-Host [-Cluster] <Cluster> [-Name] <String> [-NewName <String>] [-Description <String>] [-Confirm] [-WhatIf]
[<CommonParameters>]
AddInitiatorsByName
Set-Host [-Cluster] <Cluster> [-Name] <String> [-InitiatorsToAdd <String[]>] [-Confirm] [-WhatIf]
[<CommonParameters>]
RemoveInitiatorsByName
Set-Host [-Cluster] <Cluster> [-Name] <String> [-InitiatorsToRemove <String[]>] [-Confirm] [-WhatIf]
[<CommonParameters>]
UpdateInitiatorsByName
Set-Host [-Cluster] <Cluster> [-Name] <String> [-InitiatorsToUpdate <String[]>] -ChapSingleUserName <String>
-ChapSinglePassword <String> [-ChapMutualUserName <String>] [-ChapMutualPassword <String>] [-Confirm]
[-WhatIf] [<CommonParameters>]
ModifyPropertiesById
Set-Host [-Cluster] <Cluster> -Id <String> [-NewName <String>] [-Description <String>] [-Confirm] [-WhatIf]
[<CommonParameters>]
AddInitiatorsById
Set-Host [-Cluster] <Cluster> -Id <String> [-InitiatorsToAdd <String[]>] [-Confirm] [-WhatIf]
[<CommonParameters>]
RemoveInitiatorsById
Set-Host [-Cluster] <Cluster> -Id <String> [-InitiatorsToRemove <String[]>] [-Confirm] [-WhatIf]
[<CommonParameters>]
UpdateInitiatorsById
Set-Host [-Cluster] <Cluster> -Id <String> [-InitiatorsToUpdate <String[]>] -ChapSingleUserName <String>
-ChapSinglePassword <String> [-ChapMutualUserName <String>] [-ChapMutualPassword <String>] [-Confirm]
[-WhatIf] [<CommonParameters>]
DESCRIPTION
Provides ability to change host name or description, add new initiators, remove existing initiators, or update iSCSI initiator CHAP information.
EXAMPLES
Example 1
PS C:\> Set-Host -Cluster $cluster -Name host1 -NewName newhost1
Where $cluster is a PowerStore cluster instance. Renames the host from host1 to newhost1.
Example 2
PS C:\> Set-Host -Cluster $cluster -Name host1 -InitiatorsToAdd 11:22:33:44:11:22:33:44
Where $cluster is a PowerStore cluster instance. Adds the FC initiator 11:22:33:44:11:22:33:44 to the host.
Example 3
PS C:\> Set-Host -Cluster $cluster -Name host1 -InitiatorsToAdd iqn.2020-01.com.example:init1, iqn.2020-01.com.example:init2
Where $cluster is a PowerStore cluster instance. Adds the iSCSI initiators iqn.2020-01.com.example:init1, iqn.2020-01.com.example:init2 to the host.
Example 4
PS C:\> Set-Host -Cluster $cluster -Name host1 -InitiatorsToRemove iqn.2020-01.com.example:init1
Where $cluster is a PowerStore cluster instance. Removes iSCSI initiator iqn.2020-01.com.example:init1 from the host.
Example 4
PS C:\> Set-Host -Cluster $cluster -Name host1 -InitiatorsToUpdate iqn.2020-01.com.example:init1 -ChapSingeUserName user1 -ChapSinglePassword password1
Where $cluster is a PowerStore cluster instance. Updates the host iSCSI initiator iqn.2020-01.com.example:init1 with the provided CHAP authentication information.
PARAMETERS
-Cluster
PowerStore cluster instance.
Type: Cluster
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
Host name.
Type: String
Parameter Sets: ModifyPropertiesByName, AddInitiatorsByName, RemoveInitiatorsByName, UpdateInitiatorsByName
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Id
Host Id.
Type: String
Parameter Sets: ModifyPropertiesById, AddInitiatorsById, RemoveInitiatorsById, UpdateInitiatorsById
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NewName
New name for host.
Type: String
Parameter Sets: ModifyPropertiesByName, ModifyPropertiesById
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description
Description.
Type: String
Parameter Sets: ModifyPropertiesByName, ModifyPropertiesById
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-InitiatorsToAdd
Initiators to add to host.
Type: String[]
Parameter Sets: AddInitiatorsById, AddInitiatorsByName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-InitiatorsToRemove
Initiators to remove from host.
Type: String[]
Parameter Sets: RemoveInitiatorsById, RemoveInitiatorsByName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-InitiatorsToUpdate
Initiators to update.
Type: String[]
Parameter Sets: UpdateInitiatorsById, UpdateInitiatorsByName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ChapSingleUserName
CHAP single user name.
Type: String
Parameter Sets: UpdateInitiatorsById, UpdateInitiatorsByName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-ChapSinglePassword
CHAP single password.
Type: String
Parameter Sets: UpdateInitiatorsById, UpdateInitiatorsByName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-ChapMutualUserName
CHAP mutual user name.
Type: String
Parameter Sets: UpdateInitiatorsById, UpdateInitiatorsByName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-ChapMutualPassword
CHAP mutual password.
Type: String
Parameter Sets: UpdateInitiatorsById, UpdateInitiatorsByName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.