Welcome to my PowerShell Module for Veeam Availability Orchestrator

This the basic documentation of the ‘PowerVAO’ PowerShell Module.

GitHub: https://github.com/mycloudrevolution/PowerVAO/

WebSite: https://mycloudrevolution.com/

The main documentation for the module is organized into a couple sections:

• Feature Documentation

---

external help file: Get-VaoFailoverPlan-help.xml Module Name: PowerVAO online version: https://mycloudrevolution.com/ schema: 2.0.0

---

Get-VaoFailoverPlan

SYNOPSIS

SYNTAX

Get-VaoFailoverPlan [[-SiteID] <String>] [<CommonParameters>]

DESCRIPTION

Get Veeam Availability Orchestrator Failover Plans

EXAMPLES

EXAMPLE 1

Get-VaoFailoverPlan | Select-Object name, id, planState, planStateDetails, scheduleEnabled, siteId | ft -AutoSize

EXAMPLE 2

Get-VaoFailoverPlan -SiteID 850316df-d73f-4e8b-b8bc-7b1815fb0a9e | Select-Object name, id, planState, planStateDetails, scheduleEnabled, siteId | ft -AutoSize

PARAMETERS

-SiteID

Optional Veeam Availability Orchestrator Site ID

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
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 (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

File Name : Get-VaoFailoverPlan.psm1 Author : Markus Kraus Version : 1.0 State : Ready

RELATED LINKS

https://mycloudrevolution.com/

---

external help file: Get-VaoSite-help.xml Module Name: PowerVAO online version: https://mycloudrevolution.com/ schema: 2.0.0

---

Get-VaoSite

SYNOPSIS

SYNTAX

Get-VaoSite [[-SiteID] <String>] [<CommonParameters>]

DESCRIPTION

Get Veeam Availability Orchestrator Sites

EXAMPLES

EXAMPLE 1

Get-VaoSite | Select-Object name, id, serverName, type | ft -AutoSize

EXAMPLE 2

Get-VaoSite -SiteID 850316df-d73f-4e8b-b8bc-7b1815fb0a9e | Select-Object name, id, serverName, type | ft -AutoSize

PARAMETERS

-SiteID

Optional Veeam Availability Orchestrator Site ID

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
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 (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

File Name : Get-VaoSite.psm1 Author : Markus Kraus Version : 1.0 State : Ready

RELATED LINKS

https://mycloudrevolution.com/

---

external help file: Invoke-VaoApiCall-help.xml Module Name: PowerVAO online version: https://mycloudrevolution.com/ schema: 2.0.0

---

Invoke-VaoApiCall

SYNOPSIS

SYNTAX

Invoke-VaoApiCall [[-Server] <String>] [[-Token] <String>] [-Uri] <String> [[-Accept] <String>]
 [-Method] <String> [[-Body] <Object>] [<CommonParameters>]

DESCRIPTION

Helper function to call the Veeam Availability Orchestrator API.

EXAMPLES

EXAMPLE 1

Invoke-VaoApiCall -Uri "/v1/About" -Method Get

PARAMETERS

-Server

FQDN of the Veeam Availability Orchestrator Instance

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: $Global:VaoApiConnection.Server
Accept pipeline input: False
Accept wildcard characters: False

-Token

Bearer Token for the Veeam Availability Orchestrator Instance

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: $Global:VaoApiConnection.access_token
Accept pipeline input: False
Accept wildcard characters: False

-Uri

API Uri for the Call

Type: String
Parameter Sets: (All)
Aliases:

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

-Accept

Accept Header for the API Call

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: Application/json, text/json, text/html, application/xml, text/xml
Accept pipeline input: False
Accept wildcard characters: False

-Method

Method of the API Call

Type: String
Parameter Sets: (All)
Aliases:

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

-Body

Body of the API Call

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
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 (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

File Name : Invoke-VaoApiCall.psm1 Author : Markus Kraus Version : 1.0 State : Ready

RELATED LINKS

https://mycloudrevolution.com/

https://helpcenter.veeam.com/docs/vao/restapi/overview.html?ver=10

---

external help file: New-VaoApiConnection-help.xml Module Name: PowerVAO online version: https://mycloudrevolution.com/ schema: 2.0.0

---

New-VaoApiConnection

SYNOPSIS

SYNTAX

New-VaoApiConnection [-Server] <String> [[-Token] <String>] [-Credential] <PSCredential> [<CommonParameters>]

DESCRIPTION

Connecto to Veeam Availability Orchestrator API.

EXAMPLES

EXAMPLE 1

$YourCredentials = Get-Credential

New-VaoApiConnection -Server “vao01.lab.local” -Credential $YourCredentials

PARAMETERS

-Server

FQDN of the Veeam Availability Orchestrator Instance

Type: String
Parameter Sets: (All)
Aliases:

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

-Token

Existing Token for renewal (not yet implemented)

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: $Global:VaoApiConnection.Token
Accept pipeline input: False
Accept wildcard characters: False

-Credential

Credential for the Veeam Availability Orchestrator Instance

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
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 (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

File Name : New-VaoApiConnectionl.psm1 Author : Markus Kraus Version : 1.0 State : Ready

RELATED LINKS

https://mycloudrevolution.com/

https://helpcenter.veeam.com/docs/vao/restapi/overview.html?ver=10

---

external help file: Set-VaoFailoverPlan-help.xml Module Name: PowerVAO online version: https://mycloudrevolution.com/ schema: 2.0.0

---

Set-VaoFailoverPlan

SYNOPSIS

SYNTAX

Enable

Set-VaoFailoverPlan -PlanID <String> [-Enable] [<CommonParameters>]

Disable

Set-VaoFailoverPlan -PlanID <String> [-Disable] [<CommonParameters>]

DESCRIPTION

Modify Veeam Availability Orchestrator FailoverPlan

EXAMPLES

EXAMPLE 1

Set-VaoFailoverPlan -PlanID ed799d88-30f0-4494-b183-124e171afa91 -Enable

EXAMPLE 2

Set-VaoFailoverPlan -PlanID ed799d88-30f0-4494-b183-124e171afa91 -Disable

PARAMETERS

-PlanID

Failover Plan ID

Type: String
Parameter Sets: (All)
Aliases:

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

-Enable

Enable Failover Plan

Type: SwitchParameter
Parameter Sets: Enable
Aliases:

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

-Disable

Disable Failover Plan

Type: SwitchParameter
Parameter Sets: Disable
Aliases:

Required: True
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 (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

File Name : Set-VaoFailoverPlan.psm1 Author : Markus Kraus Version : 1.0 State : Ready

RELATED LINKS

https://mycloudrevolution.com/