NAME

Get-DcsHostGroup

SYNOPSIS

Returns data for a specific host group or all host groups in the server group of the specified connection.

SYNTAX

Get-DcsHostGroup   [ -Group <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns data for a specific host group or all host groups in the server group of the specified connection. If no parameters are specified, data for all host groups in the server group of the default connection will be returned.

PARAMETERS

-Group<Object>
HostGroupData object, name, or ID that identifies the host group. If specified, only data for that host group will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

HostGroupData : The object that identifies and describes the host group.

OUTPUTS

HostGroupData : The object that identifies and describes the host group.

NOTES

Also see Add-DcsHostGroup, Add-DcsHostToGroup, Remove-DcsHostGroup, Remove-DcsHostFromGroup, Set-DcsHostGroupProperties.

EXAMPLES


-------------- Example 1 Returns data for a host group specified by name --------------
Get-DcsHostGroup -Group "HostGroup1"
		

The cmdlet is invoked with the Group parameter specified as "HostGroup1" to return the HostGroupData object for the host group named "HostGroup1".

Alias:HostGroup1
Description:
Sequencenumber:5006
Id:{04dcdfbf-109b-4a9c-9fd2-64ac9f5b5d8c}
Caption:HostGroup1
ExtendedCaption:HostGroup1
Internal:False
   

-------------- Example 2 Returns data for all host groups. --------------
Get-DcsHostGroup
		

The cmdlet is invoked without parameters to return the HostGroupData objects for all host groups in the server group of the default connection. Data for two host groups are returned.

Alias:HostGroup1
Description:
Sequencenumber:5006
Id:{04dcdfbf-109b-4a9c-9fd2-64ac9f5b5d8c}
Caption:HostGroup1
ExtendedCaption:HostGroup1
Internal:False
   
Alias:HostGroup2
Description:
Sequencenumber:5008
Id:{39662275-2f40-407b-ae12-d4557efde87c}
Caption:HostGroup2
ExtendedCaption:HostGroup2
Internal:False