Set-HostGroup

SYNOPSIS

Modifies properties of a host group.

SYNTAX

ModifyPropertiesByName (Default)

Set-HostGroup [-Cluster] <Cluster> [-Name] <String> [-NewName <String>] [-Description <String>] [-Confirm]
 [-WhatIf] [<CommonParameters>]

AddHostsByName

Set-HostGroup [-Cluster] <Cluster> [-Name] <String> [-HostNamesToAdd <String[]>] [-HostIdsToAdd <String[]>]
 [-Confirm] [-WhatIf] [<CommonParameters>]

RemoveHostsByName

Set-HostGroup [-Cluster] <Cluster> [-Name] <String> [-HostNamesToRemove <String[]>]
 [-HostIdsToRemove <String[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

ModifyPropertiesById

Set-HostGroup [-Cluster] <Cluster> -Id <String> [-NewName <String>] [-Description <String>] [-Confirm]
 [-WhatIf] [<CommonParameters>]

AddHostsById

Set-HostGroup [-Cluster] <Cluster> -Id <String> [-HostNamesToAdd <String[]>] [-HostIdsToAdd <String[]>]
 [-Confirm] [-WhatIf] [<CommonParameters>]

RemoveHostsById

Set-HostGroup [-Cluster] <Cluster> -Id <String> [-HostNamesToRemove <String[]>] [-HostIdsToRemove <String[]>]
 [-Confirm] [-WhatIf] [<CommonParameters>]

DESCRIPTION

Provides ability to change host group name or description, add hosts to or remove hosts from the host group.

EXAMPLES

Example 1

PS C:\> Set-HostGroup -Cluster $cluster -Name name1 -NewName newname1 -Description "Example host group"

Where $cluster is a PowerStore cluster instance. Renames host group name1 to newname1 and updates the description.

Example 2

PS C:\> Set-HostGroup -Cluster $cluster -Name name1 -HostNamesToAdd host1,host2

Where $cluster is a PowerStore cluster instance. Adds hosts host1,host2 to host group name1.

Example 3

PS C:\> Set-HostGroup -Cluster $cluster -Name name1 -HostIdsToRemove uudi1

Where $cluster is a PowerStore cluster instance. Removes host with Id uuid1 from host group name1.

Example 4

PS C:\> Set-HostGroup -Cluster $cluster -Id uudi1 -HostNamesToRemove name1

Where $cluster is a PowerStore cluster instance. Removes host named name1 from host group with Id uuid1.

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 group name.

Type: String
Parameter Sets: ModifyPropertiesByName, AddHostsByName, RemoveHostsByName
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id

Host group Id.

Type: String
Parameter Sets: ModifyPropertiesById, AddHostsById, RemoveHostsById
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NewName

New host group name.

Type: String
Parameter Sets: ModifyPropertiesByName, ModifyPropertiesById
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

Host group description.

Type: String
Parameter Sets: ModifyPropertiesByName, ModifyPropertiesById
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HostNamesToAdd

List of host names to add.

Type: String[]
Parameter Sets: AddHostsById, AddHostsByName
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HostNamesToRemove

List of host names to remove.

Type: String[]
Parameter Sets: RemoveHostsById, RemoveHostsByName
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HostIdsToAdd

List of host Ids to add.

Type: String[]
Parameter Sets: AddHostsById, AddHostsByName
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HostIdsToRemove

List of host Ids to remove.

Type: String[]
Parameter Sets: RemoveHostsById, RemoveHostsByName
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
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: None
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: None
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.

INPUTS

None

OUTPUTS

Dell.PowerStore.Management.Model.HostGroup

NOTES