Skip to content

Get-VmsFailoverGroup

SYNOPSIS

Gets one or more failover groups from the current Milestone XProtect VMS site.

SYNTAX

Get-VmsFailoverGroup [[-Id] <Guid>] [<CommonParameters>]

DESCRIPTION

The Get-VmsFailoverGroup cmdlet gets one or more existing failover groups, which can each contain one or more failover recording servers.

EXAMPLES

Example 1

Connect-ManagementServer -ShowDialog -AcceptEula

Get-VmsFailoverGroup | Where-Object Name -eq 'FO Group 1'

Prompts user to login to a Milestone VMS, then gets the failover group named 'FO Group 1' if it exists.

PARAMETERS

-Id

Specifies the ID of an existing failover group.

Type: Guid
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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

VideoOS.Platform.ConfigurationItems.FailoverGroup

NOTES

Online Help