Files
ZertoApiWrapper/docs/Get-ZertoVirtualizationSite.md
T
2019-04-28 16:09:43 -04:00

6.5 KiB

external help file, Module Name, online version, schema
external help file Module Name online version schema
ZertoApiWrapper-help.xml ZertoApiWrapper https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoVirtualizationSite.md 2.0.0

Get-ZertoVirtualizationSite

SYNOPSIS

Returns information about the hypervisor site where the API is run and all the sites paired with this site. The information returned can be tailored to specific information about the resources managed at a specified site.

SYNTAX

main (Default)

Get-ZertoVirtualizationSite [<CommonParameters>]

folders

Get-ZertoVirtualizationSite -siteIdentifier <String> [-folders] [<CommonParameters>]

devices

Get-ZertoVirtualizationSite -siteIdentifier <String> [-devices] [-hostIdentifier <String>] [<CommonParameters>]

vms

Get-ZertoVirtualizationSite -siteIdentifier <String> [-vms] [<CommonParameters>]

resourcePools

Get-ZertoVirtualizationSite -siteIdentifier <String> [-resourcePools] [<CommonParameters>]

networks

Get-ZertoVirtualizationSite -siteIdentifier <String> [-networks] [<CommonParameters>]

hosts

Get-ZertoVirtualizationSite -siteIdentifier <String> [-hostIdentifier <String>] [-hosts] [<CommonParameters>]

hostClusters

Get-ZertoVirtualizationSite -siteIdentifier <String> [-hostClusters] [<CommonParameters>]

datastores

Get-ZertoVirtualizationSite -siteIdentifier <String> [-datastores] [<CommonParameters>]

datastoreClusters

Get-ZertoVirtualizationSite -siteIdentifier <String> [-datastoreClusters] [<CommonParameters>]

siteIdentifier

Get-ZertoVirtualizationSite -siteIdentifier <String> [<CommonParameters>]

DESCRIPTION

Returns information about the hypervisor site where the API is run and all the sites paired with this site. The information returned can be tailored to specific information about the resources managed at a specified site.

EXAMPLES

Example 1

PS C:\> Get-ZertoVirtualizationSite -siteIdentifier "MySiteIdentifier"

Returns information about the site with identifier "MySiteIdentifier"

Example 2

PS C:\> Get-ZertoVirtualizationSite -siteIdentifier "MySiteIdentifier" -datastoreClusters

Returns information about datastore clusters at site with site identifier "MySiteidentifier"

Example 3

PS C:\> Get-ZertoVirtualizationSite -siteIdentifier "MySiteIdentifier" -datastores

Returns information about datastores at site with site identifier "MySiteidentifier"

Example 4

PS C:\> Get-ZertoVirtualizationSite -siteIdentifier "MySiteIdentifier" -devices

Returns information about devices at site with site identifier "MySiteidentifier"

PARAMETERS

-datastoreClusters

When selected, will return all datastore clusters at the specified site.

Type: SwitchParameter
Parameter Sets: datastoreClusters
Aliases:

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

-datastores

When selected, will return all datastores at the specified site.

Type: SwitchParameter
Parameter Sets: datastores
Aliases:

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

-devices

When selected, will return all devices at the specified site.

Type: SwitchParameter
Parameter Sets: devices
Aliases:

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

-folders

Return all folders at the selected site.

Type: SwitchParameter
Parameter Sets: folders
Aliases:

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

-hostClusters

Return all host clusters at the selected site.

Type: SwitchParameter
Parameter Sets: hostClusters
Aliases:

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

-hostIdentifier

The identifier of the host at the selected site to return information for only one host.

Type: String
Parameter Sets: devices, hosts
Aliases: hostId

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

-hosts

Return all hosts at the selected site. If a host identifier is provided, return only that host.

Type: SwitchParameter
Parameter Sets: hosts
Aliases:

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

-networks

Return all networks at the selected site.

Type: SwitchParameter
Parameter Sets: networks
Aliases:

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

-resourcePools

Return all resource pools at the selected site.

Type: SwitchParameter
Parameter Sets: resourcePools
Aliases:

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

-siteIdentifier

The identifier of the Zerto Virtual Manager site.

Type: String
Parameter Sets: folders, devices, vms, resourcePools, networks, hosts, hostClusters, datastores, datastoreClusters, siteIdentifier
Aliases: siteId

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

-vms

Return all VMs at the selected site.

Type: SwitchParameter
Parameter Sets: vms
Aliases:

Required: True
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

System.Object

NOTES

Zerto REST API Virtualization Sites End Point Documentation