PowervRACloud 1.5 Documentation

Add-vRA-Project-Administrator

Adds vRA Project Administrator in a particular Org

This cmdlet adds vRA Project Administrator in a particular Org

Syntax 

Add-vRA-Project-Administrator [[-Connection] <PSObject>] [-ProjectName] <String> [-Administrator] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-ProjectName vRA Project Name true false
-Administrator Member true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/02/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Add-vRA-Project-Administrator -ProjectName "ProjectName" -Administrator "email@vmware.com"

Top of page

Add-vRA-Project-Member

Adds vRA Project Member in a particular Org

This cmdlet adds vRA Project Member in a particular Org

Syntax 

Add-vRA-Project-Member [[-Connection] <PSObject>] [-ProjectName] <String> [-Member] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-ProjectName vRA Project Name true false
-Member Member true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/02/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Add-vRA-Project-Member -ProjectName "ProjectName" -Member "email@vmware.com"

Top of page

Change-vRA-DeploymentLease

Modifies vRA Deployment Lease in a particular Org

This cmdlet modifies vRA Deployment lease in a particular Org

Syntax 

Change-vRA-DeploymentLease [[-Connection] <PSObject>] [-DeploymentName] <String> [-LeaseExpiryDate] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-DeploymentName Deployment Name true false
-LeaseExpiryDate Lease Expiry Date (yyyy-mm-dd-Thh:mm:zz) true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 12/23/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Change-vRA-DeploymentLease -DeploymentName "DeploymentName" -LeaseExpiryDate "2021-01-06T19:13:00.000Z"

Top of page

Change-vRA-DeploymentOwner

Modifies vRA Deployment Owner in a particular Org

This cmdlet modifies vRA Deployment owner in a particular Org

Syntax 

Change-vRA-DeploymentOwner [[-Connection] <PSObject>] [-DeploymentName] <String> [-OwnerEmail] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-DeploymentName Deployment Name true false
-OwnerEmail Owner Email Address true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 12/24/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Change-vRA-DeploymentOwner -DeploymentName "DeploymentName" -OwnerEmail "abc@abc.com"

Top of page

Connect-vRA-Cloud

Connects to vRA Cloud and gets CSP Access Token to be used with APIs

This cmdlet creates $global:defaultvRAConnection object

Syntax 

Connect-vRA-Cloud [-APIToken] <SecureString> [[-Region] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-APIToken vRA Cloud API Token true false
-Region Deployment Name false false us

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.2 Date: 06/03/2021 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Connect-vRA-Cloud -APIToken $APIToken
Input APIToken as Secure String by using Read-Host "$APIToken = Read-Host -AsSecureString"

Top of page

Connect-vRA-Server

Connects to vRA Server and gets CSP Access Token to be used with APIs

This cmdlet creates $global:defaultvRAConnection object

Syntax 

Connect-vRA-Server [-Server] <String> [-Credential] <PSCredential> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Server vRA Server hostname or IP address true false
-Credential PSCredential object containing vRA Server Authentication credentials true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.2 Date: 06/03/2021 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Connect-vRA-Server -Server "vraserverfqdn" -Credential $credentials

Top of page

Create-vRA-DeploymentResourceSnapshot

Creates Snapshot for vRA Deployment Resource (vSphere Virtual Machine) in a particular Org

This cmdlet creates Snapshot for vRA Deployment Resource (vSphere Virtual Machine) in a particular Org

Syntax 

Create-vRA-DeploymentResourceSnapshot [[-Connection] <PSObject>] [-DeploymentName] <String> [-ResourceName] <String> [-SnapshotName] <String> [[-MemorySnapshot] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-DeploymentName Deployment Name true false
-ResourceName Deployment Resource Name true false
-SnapshotName Lease Expiry Date (yyyy-mm-dd-Thh:mm:zz) true false
-MemorySnapshot Lease Expiry Date (yyyy-mm-dd-Thh:mm:zz) false false false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 12/23/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Create-vRA-DeploymentResourceSnapshot -DeploymentName "DeploymentName" -ResourceName "ResourceName" -SnapshotName "SnapshotName"

Top of page

Delete-vRA-CodeStreamPipeline

Deletes a CodeStream Pipeline in a particular Org

This cmdlet deletes a CodeStream Pipeline in a particular Org

Syntax 

Delete-vRA-CodeStreamPipeline [[-Connection] <PSObject>] [-PipelineName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-PipelineName Deployment Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 06/02/2021 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Delete-vRA-CodeStreamPipeline -PipelineName "Test"

Top of page

Delete-vRA-DeploymentResourceSnapshot

Removes Snapshot for vRA Deployment Resource (vSphere Virtual Machine) in a particular Org

This cmdlet removes Snapshot for vRA Deployment Resource (vSphere Virtual Machine) in a particular Org

Syntax 

Delete-vRA-DeploymentResourceSnapshot [[-Connection] <PSObject>] [-DeploymentName] <String> [-ResourceName] <String> [-SnapshotName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-DeploymentName Deployment Name true false
-ResourceName Deployment Resource Name true false
-SnapshotName Lease Expiry Date (yyyy-mm-dd-Thh:mm:zz) true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 12/23/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Delete-vRA-DeploymentResourceSnapshot -DeploymentName "DeploymentName" -ResourceName "ResourceName" -SnapshotName "SnapshotName"

Top of page

Deploy-vRA-Blueprint

Provisions new vRA Deployment from a Blueprint with No Inputs in a particular Org

This cmdlet provisions new vRA Project Deployment from a Blueprint with No Inputs in a particular Org

Syntax 

Deploy-vRA-Blueprint [[-Connection] <PSObject>] [-BlueprintName] <String> [-DeploymentName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-BlueprintName vRA Blueprint Name true false
-DeploymentName vRA Deployment Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/02/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Deploy-vRA-Blueprint -BlueprintName "BlueprintName" -DeploymentName "Deployment Name"

Top of page

Disconnect-vRA-Cloud

Destroys $global:defaultvRAConnection object if it exists

REST is not connection oriented, so there really isnt a connect/disconnect concept. It destroys $global:defaultvRAConnection object if it exists

Syntax 

Disconnect-vRA-Cloud [<CommonParameters>]

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 01/13/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Disconnect-vRA-Cloud

Top of page

Execute-vRA-CodeStreamPipeline

Executes a CodeStream Pipeline with No Inputs in a particular Org

This cmdlet executes a CodeStream Pipeline with No Inputs in a particular Org

Syntax 

Execute-vRA-CodeStreamPipeline [[-Connection] <PSObject>] [-PipelineName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-PipelineName Deployment Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 06/03/2021 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Execute-vRA-CodeStreamPipeline -PipelineName "Test"

Top of page

Export-vRA-CodeStreamPipeline

Exports a CodeStream Pipeline in a particular Org As YAML

This cmdlet Exports a CodeStream Pipeline in a particular Org As YAML

Syntax 

Export-vRA-CodeStreamPipeline [[-Connection] <PSObject>] [-PipelineName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-PipelineName Deployment Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 05/28/2021 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Export-vRA-CodeStreamPipeline -PipelineName "Test"

Top of page

Get-vRA-BlueprintDetails

Returns vRA Blueprint Details in a particular Org

This cmdlet retrieves vRA Blueprint Details in a particular Org

Syntax 

Get-vRA-BlueprintDetails [[-Connection] <PSObject>] [-id] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-id vRA Blueprint ID true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-BlueprintDetails -id "Blueprint ID"
EXAMPLE 2 
Get-vRA-BlueprintDetails -id "Blueprint ID" | Select content | Format-list

Top of page

Get-vRA-BlueprintInputSchema

Returns vRA Blueprint Input Schema in a particular Org

This cmdlet retrieves vRA Blueprint Input Schema in a particular Org

Syntax 

Get-vRA-BlueprintInputSchema [[-Connection] <PSObject>] [-BlueprintName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-BlueprintName vRA Blueprint ID true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-BlueprintInputSchema -BlueprintName "Blueprint Name"

Top of page

Get-vRA-Blueprints

Returns all vRA Blueprints in a particular Org

This cmdlet retrieves all vRA Blueprints in a particular Org

Syntax 

Get-vRA-Blueprints [[-Connection] <PSObject>] [[-Size] <Int32>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-Size Response Page Size false false 200

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-Blueprints
EXAMPLE 2 
Get-vRA-Blueprints | where{$_.name -match "Test"}

Top of page

Get-vRA-BlueprintVersions

Returns vRA Blueprint Version Details in a particular Org

This cmdlet retrieves vRA Blueprint Version Details in a particular Org

Syntax 

Get-vRA-BlueprintVersions [[-Connection] <PSObject>] [-BlueprintName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-BlueprintName vRA Blueprint ID true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-BlueprintVersions -BlueprintName "Blueprint Name"

Top of page

Get-vRA-CloudAccounts

Returns all vRA Cloud Accounts in a particular Org

This cmdlet retrieves all vRA Cloud Accounts in a particular Org

Syntax 

Get-vRA-CloudAccounts [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-CloudAccounts
EXAMPLE 2 
Get-vRA-CloudAccounts | where{$_.name -match "Test"}

Top of page

Get-vRA-CloudZones

Returns all vRA Cloud Zones in a particular Org

This cmdlet retrieves all vRA Cloud Zones in a particular Org

Syntax 

Get-vRA-CloudZones [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-CloudZones
EXAMPLE 2 
Get-vRA-CloudZones | where{$_.name -match "Test"}

Top of page

Get-vRA-CodeStreamEndpointById

Returns a CodeStream Endpoint By Id in a particular Org

This cmdlet retrieves a CodeStream Endpoint By Id in a particular Org

Syntax 

Get-vRA-CodeStreamEndpointById [[-Connection] <PSObject>] [-Id] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-Id Deployment Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 05/28/2021 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-CodeStreamEndpointById -Id "xx333"

Top of page

Get-vRA-CodeStreamEndpointByName

Returns a CodeStream Endpoint By Name in a particular Org

This cmdlet retrieves a CodeStream Endpoint By Name in a particular Org

Syntax 

Get-vRA-CodeStreamEndpointByName [[-Connection] <PSObject>] [-EndpointName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-EndpointName Deployment Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 05/28/2021 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-CodeStreamEndpointByName -EndpointName "Test"

Top of page

Get-vRA-CodeStreamEndpointByProjectName

Returns a CodeStream Endpoint By Project Name in a particular Org

This cmdlet retrieves a CodeStream Endpoint By Project Name in a particular Org

Syntax 

Get-vRA-CodeStreamEndpointByProjectName [[-Connection] <PSObject>] [-ProjectName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-ProjectName Deployment Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 05/28/2021 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-CodeStreamEndpointByProjectName -ProjectName "Test"

Top of page

Get-vRA-CodeStreamEndpoints

Returns all CodeStream Endpoints in a particular Org

This cmdlet retrieves all CodeStream Endpoints in a particular Org

Syntax 

Get-vRA-CodeStreamEndpoints [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 05/28/2021 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-CodeStreamEndpoints
EXAMPLE 2 
Get-vRA-CodeStreamEndpoints | where{$_.name -match "Test"}

Top of page

Get-vRA-CodeStreamPipelineById

Returns a CodeStream Pipeline By Name in a particular Org

This cmdlet retrieves a CodeStream Pipeline By Name in a particular Org

Syntax 

Get-vRA-CodeStreamPipelineById [[-Connection] <PSObject>] [-Id] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-Id Deployment Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 05/28/2021 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-CodeStreamPipelineById -Id "33xxxx"

Top of page

Get-vRA-CodeStreamPipelineByName

Returns a CodeStream Pipeline By Name in a particular Org

This cmdlet retrieves a CodeStream Pipeline By Name in a particular Org

Syntax 

Get-vRA-CodeStreamPipelineByName [[-Connection] <PSObject>] [-PipelineName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-PipelineName Deployment Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 05/28/2021 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-CodeStreamPipelineByName -PipelineName "Test"

Top of page

Get-vRA-CodeStreamPipelineByProjectName

Returns a CodeStream Pipeline By Project Name in a particular Org

This cmdlet retrieves a CodeStream Pipeline By Project Name in a particular Org

Syntax 

Get-vRA-CodeStreamPipelineByProjectName [[-Connection] <PSObject>] [-ProjectName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-ProjectName Deployment Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 05/28/2021 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-CodeStreamPipelineByProjectName -ProjectName "Test"

Top of page

Get-vRA-CodeStreamPipelineExecution

Returns a CodeStream Executions of a Pipeline in a particular Org

This cmdlet retrieves a CodeStream Executions of a Pipeline in a particular Org

Syntax 

Get-vRA-CodeStreamPipelineExecution [[-Connection] <PSObject>] [-PipelineName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-PipelineName Deployment Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 05/28/2021 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-CodeStreamPipelineExecution -PipelineName "Test"

Top of page

Get-vRA-CodeStreamPipelines

Returns all CodeStream Pipelines in a particular Org

This cmdlet retrieves all CodeStream Pipelines in a particular Org

Syntax 

Get-vRA-CodeStreamPipelines [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 05/28/2021 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-CodeStreamPipelines
EXAMPLE 2 
Get-vRA-CodeStreamPipelines | where{$_.name -match "Test"}

Top of page

Get-vRA-Datacollectors

Returns all vRA Datacollectors in a particular Org

This cmdlet retrieves all vRA Datacollectors in a particular Org

Syntax 

Get-vRA-Datacollectors [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 01/13/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-Datacollectors
EXAMPLE 2 
Get-vRA-Datacollectors | where{$_.name -match "Test"}

Top of page

Get-vRA-DeploymentActionID

Returns vRA Deployment Actions in a particular Org

This cmdlet retrieves vRA Deployment Actions in a particular Org

Syntax 

Get-vRA-DeploymentActionID [[-Connection] <PSObject>] [-DeploymentName] <String> [-ActionID] <String> [[-Size] <Int32>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-DeploymentName Deployment Name true false
-ActionID Deployment Action ID true false
-Size Response Page Size false false 200

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 12/23/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-DeploymentActionID -DeploymentName "DeploymentName" -ActionID "Deployment.ChangeLease"
EXAMPLE 2 
Get-vRA-DeploymentActionID | where{$_.name -eq "DeploymentName"}

Top of page

Get-vRA-DeploymentActions

Returns available actions associated with a vRA Deployment in a particular Org

This cmdlet retrieves available actions associated with a vRA Deployment in a particular Org

Syntax 

Get-vRA-DeploymentActions [[-Connection] <PSObject>] [-DeploymentName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-DeploymentName vRA Deployment Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-DeploymentActions -DeploymentName "DeploymentName"

Top of page

Get-vRA-DeploymentFilters

Returns all vRA Deployments using Filter IDs in context of given User in a particular Org

This cmdlet retrieves all vRA Deployments using Filter IDs in context of given User in a particular Org

Syntax 

Get-vRA-DeploymentFilters [[-Connection] <PSObject>] [[-filterId] <String>] [[-Size] <Int32>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-filterId Filter false false projects
-Size Response Page Size false false 200

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-DeploymentFilters
EXAMPLE 2 
Get-vRA-DeploymentFilters -filterId "projects"

Top of page

Get-vRA-DeploymentFilterTypes

Returns all vRA Deployment Filter Types in context of given User in a particular Org

This cmdlet retrieves all vRA Deployment Filter Types in context of given User in a particular Org

Syntax 

Get-vRA-DeploymentFilterTypes [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-DeploymentFilterTypes

Top of page

Get-vRA-DeploymentRequests

Get vRA Deployment Requests in a particular Org

This cmdlet gets vRA Deployment Requests in a particular Org

Syntax 

Get-vRA-DeploymentRequests [[-Connection] <PSObject>] [-DeploymentName] <String> [-RequestID] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-DeploymentName Deployment Name true false
-RequestID Deployment Request ID true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 12/29/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-DeploymentRequests -DeploymentName "DeploymentName" -RequestID "Request ID"

Top of page

Get-vRA-DeploymentResourceActionID

Returns vRA Deployment Actions in a particular Org

This cmdlet retrieves vRA Deployment Actions in a particular Org

Syntax 

Get-vRA-DeploymentResourceActionID [[-Connection] <PSObject>] [-DeploymentName] <String> [-ResourceName] <String> [-ActionID] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-DeploymentName Deployment Name true false
-ResourceName Deployment Resource Name true false
-ActionID Deployment Action ID true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 12/23/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-DeploymentResourceActionID -DeploymentName "MMTest01" -ResourceName "ResourceName" -ActionID "Cloud.vSphere.Machine.Snapshot.Delete"

Top of page

Get-vRA-DeploymentResourceActions

Returns vRA Deployment Resource Actions in a particular Org

This cmdlet retrieves vRA Deployment Resource Actions in a particular Org

Syntax 

Get-vRA-DeploymentResourceActions [[-Connection] <PSObject>] [-DeploymentName] <String> [-ResourceName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-DeploymentName Deployment Name true false
-ResourceName Deployment Resource Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 12/23/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-DeploymentResourceActions -DeploymentName "DeploymentName" -ResourceName "ResourceName"

Top of page

Get-vRA-DeploymentResources

Returns resources associated with a vRA Deployment in a particular Org

This cmdlet retrieves resources associated with a vRA Deployment in a particular Org

Syntax 

Get-vRA-DeploymentResources [[-Connection] <PSObject>] [-DeploymentName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-DeploymentName vRA Deployment Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-DeploymentResources -DeploymentName "DeploymentName"

Top of page

Get-vRA-Deployments

Returns all vRA Deployments in a particular Org

This cmdlet retrieves all vRA Deployments in a particular Org

Syntax 

Get-vRA-Deployments [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.3 Date: 12/23/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-Deployments
EXAMPLE 2 
Get-vRA-Deployments | where{$_.name -match "Test"}

Top of page

Get-vRA-FabricFlavors

Returns all vRA Fabric Flavors in a particular Org

This cmdlet retrieves all vRA Fabric Flavors in a particular Org

Syntax 

Get-vRA-FabricFlavors [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-FabricFlavors
EXAMPLE 2 
Get-vRA-FabricFlavors | where {$_.name -match "Test"}

Top of page

Get-vRA-FabricImages

Returns all vRA Fabric Images in a particular Org

This cmdlet retrieves all vRA Fabric Images in a particular Org

Syntax 

Get-vRA-FabricImages [[-Connection] <PSObject>] [[-Size] <Int32>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-Size Response Page Size false false 2000

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.2 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-FabricImages
EXAMPLE 2 
Get-vRA-FabricImages | where{$_.externalRegionId -match "us-east-1"}

Top of page

Get-vRA-FabricImagesFilter

Returns all vRA Fabric Images using filters in a particular Org

This cmdlet retrieves all vRA Fabric Images using filters in a particular Org

Syntax 

Get-vRA-FabricImagesFilter [[-Connection] <PSObject>] [[-filtertype] <String>] [[-filtervalue] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-filtertype Filter false false name
-filtervalue Filter false false *

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-FabricImagesFilter
EXAMPLE 2 
Get-vRA-FabricImagesFilter -filtertype "name" -filtervalue "ImageName"

Top of page

Get-vRA-FabricNetworks

Returns all vRA Fabric Networks in a particular Org

This cmdlet retrieves all vRA Fabric Networks in a particular Org

Syntax 

Get-vRA-FabricNetworks [[-Connection] <PSObject>] [[-Size] <Int32>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-Size Response Page Size false false 2000

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.2 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-FabricNetworks

Top of page

Get-vRA-FabricNetworksFilter

Returns all vRA Fabric Networks using filters in a particular Org

This cmdlet retrieves all vRA Fabric Networks using filters in a particular Org

Syntax 

Get-vRA-FabricNetworksFilter [[-Connection] <PSObject>] [[-filtertype] <String>] [[-filtervalue] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-filtertype Filter false false name
-filtervalue Filter false false *

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-FabricNetworksFilter
EXAMPLE 2 
Get-vRA-FabricNetworksFilter -filtertype "name" -filtervalue "Network Name"

Top of page

Get-vRA-FabricvSphereDatastores

Returns all vRA Fabric vSphere Datastores in a particular Org

This cmdlet retrieves all vRA Fabric vSphere Datastores in a particular Org

Syntax 

Get-vRA-FabricvSphereDatastores [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-FabricvSphereDatastores
EXAMPLE 2 
Get-vRA-FabricvSphereDatastores | where {$_.type -match "vsan"}

Top of page

Get-vRA-FabricvSphereDatastoresFilter

Returns all vRA Fabric vSphere Datastores using filters in a particular Org

This cmdlet retrieves all vRA Fabric vSphere Datastores using filters in a particular Org

Syntax 

Get-vRA-FabricvSphereDatastoresFilter [[-Connection] <PSObject>] [[-filtertype] <String>] [[-filtervalue] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-filtertype Filter false false name
-filtervalue Filter false false *

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-FabricvSphereDatastoresFilter
EXAMPLE 2 
Get-vRA-FabricvSphereDatastoresFilter -filtertype name -filtervalue "vsanDatastore_cluster02"

Top of page

Get-vRA-FabricvSphereStoragePolicies

Returns all vRA Fabric vSphere Storage Policies in a particular Org

This cmdlet retrieves all vRA Fabric vSphere Storage Policies in a particular Org

Syntax 

Get-vRA-FabricvSphereStoragePolicies [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-FabricvSphereStoragePolicies
EXAMPLE 2 
Get-vRA-FabricvSphereStoragePolicies | where {$_.name -match "Test"}

Top of page

Get-vRA-FlavorProfiles

Returns all vRA FlavorProfiles in a particular Org

This cmdlet retrieves all vRA FlavorProfiles in a particular Org

Syntax 

Get-vRA-FlavorProfiles [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-FlavorProfiles
EXAMPLE 2 
Get-vRA-FlavorProfiles | where{$_.name -match "Test"}

Top of page

Get-vRA-Flavors

Returns all vRA Flavors in a particular Org

This cmdlet retrieves all vRA Flavors in a particular Org

Syntax 

Get-vRA-Flavors [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-Flavors
EXAMPLE 2 
Get-vRA-Flavors | where{$_.externalRegionId -match "us-east-1"}

Top of page

Get-vRA-ImageProfiles

Returns all vRA Image Profiles in a particular Org

This cmdlet retrieves all vRA Image Profiles in a particular Org

Syntax 

Get-vRA-ImageProfiles [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-ImageProfiles
EXAMPLE 2 
Get-vRA-ImageProfiles | where{$_.externalRegionId -match "us-east-1"}

Top of page

Get-vRA-Images

Returns all vRA Images in a particular Org

This cmdlet retrieves all vRA Images in a particular Org

Syntax 

Get-vRA-Images [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-Images
EXAMPLE 2 
Get-vRA-Images | where{$_.mapping -match "centos"}

Top of page

Get-vRA-Machines

Returns all vRA Machines in a particular Org

This cmdlet retrieves all vRA Machines in a particular Org

Syntax 

Get-vRA-Machines [[-Connection] <PSObject>] [[-Size] <Int32>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-Size Response Page Size false false 2000

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-Machines
EXAMPLE 2 
Get-vRA-Machines | where{$_.name -match "Test"}

Top of page

Get-vRA-MachineSnapshots

Returns vRA Machine Snapshots in a particular Org

This cmdlet retrieves vRA Machine Snapshots in a particular Org

Syntax 

Get-vRA-MachineSnapshots [[-Connection] <PSObject>] [-MachineName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-MachineName vRA Machine Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-MachineSnapshots -MachineName "Test"

Top of page

Get-vRA-NetworkDomains

Returns all vRA Network Domains in a particular Org

This cmdlet retrieves all vRA Network Domains in a particular Org

Syntax 

Get-vRA-NetworkDomains [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-NetworkDomains
EXAMPLE 2 
Get-vRA-NetworkDomains | where{$_.name -match "Test"}

Top of page

Get-vRA-NetworkProfiles

Returns all vRA Network Profiles in a particular Org

This cmdlet retrieves all vRA Network Profiles in a particular Org

Syntax 

Get-vRA-NetworkProfiles [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-NetworkProfiles
EXAMPLE 2 
Get-vRA-NetworkProfiles | where{$_.name -match "Test"}

Top of page

Get-vRA-Networks

Returns all vRA Networks in a particular Org

This cmdlet retrieves all vRA Networks in a particular Org

Syntax 

Get-vRA-Networks [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-Networks
EXAMPLE 2 
Get-vRA-Networks | where{$_.name -match "Test"}

Top of page

Get-vRA-Projects

Returns all vRA Projects in a particular Org

This cmdlet retrieves all vRA Projects in a particular Org

Syntax 

Get-vRA-Projects [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-Projects
EXAMPLE 2 
Get-vRA-Projects | where{$_.name -match "Test"}

Top of page

Get-vRA-Regions

Returns all vRA Regions in a particular Org

This cmdlet retrieves all vRA Regions in a particular Org

Syntax 

Get-vRA-Regions [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-Regions
EXAMPLE 2 
Get-vRA-Regions | where{$_.name -match "Test"}

Top of page

Get-vRA-Requests

Returns all vRA Requests in a particular Org

This cmdlet retrieves all vRA Requests in a particular Org

Syntax 

Get-vRA-Requests [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-Requests
EXAMPLE 2 
Get-vRA-Requests | where{$_.name -match "Provisioning"}

Top of page

Get-vRA-SecurityGroups

Returns all vRA Security Groups in a particular Org

This cmdlet retrieves all vRA Security Groups in a particular Org

Syntax 

Get-vRA-SecurityGroups [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-SecurityGroups
EXAMPLE 2 
Get-vRA-SecurityGroups | where{$_.name -match "Test"}

Top of page

Get-vRA-SingleDeployment

Returns single vRA Deployment in a particular Org

This cmdlet retrieves single vRA Deploymentin a particular Org

Syntax 

Get-vRA-SingleDeployment [[-Connection] <PSObject>] [-DeploymentName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-DeploymentName Deployment Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 12/24/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-SingleDeployment -DeploymentName "DeploymentName"

Top of page

Get-vRA-StorageProfiles

Returns all vRA Storage Profiles in a particular Org

This cmdlet retrieves all vRA Storage Profiles in a particular Org

Syntax 

Get-vRA-StorageProfiles [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-StorageProfiles
EXAMPLE 2 
Get-vRA-StorageProfiles | where{$_.name -match "Test"}

Top of page

Get-vRA-Tags

Returns all vRA Tags in a particular Org

This cmdlet retrieves all vRA Tags in a particular Org

Syntax 

Get-vRA-Tags [[-Connection] <PSObject>] [[-Size] <Int32>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-Size Response Page Size false false 2000

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.2 Date: 04/01/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-vRA-Tags

Top of page

Get-vRACloudCommands

Returns all cmdlets for vRA Cloud

This cmdlet will allow you to return all cmdlets included in the Power vRA Cloud Module

Syntax 

Get-vRACloudCommands [<CommonParameters>]

Note

You can either use this cmdlet or the Get-Command cmdlet as seen in Example 2

Examples

EXAMPLE 1 
Get-vRACloudCommands
EXAMPLE 2 
Get-Command -Module PowervRACloud

Top of page

Import-vRA-CodeStreamPipeline

Exports a CodeStream Pipeline in a particular Org As YAML

This cmdlet Imports a CodeStream Pipeline in a particular Org As YAML

Syntax 

Import-vRA-CodeStreamPipeline [[-Connection] <PSObject>] [-PipelineBody] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-PipelineBody Deployment Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 06/02/2021 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
$pipelineyaml = Get-Content pipeline.yaml | Out-String
Import-vRA-CodeStreamPipeline -PipelineBody $pipelineyaml

Top of page

New-vRA-Blueprint

Creates new simple vRA Blueprint with flavor and Image in a particular Org

This cmdlet creates new simple vRA Blueprint with flavor and Image in a particular Org

Syntax 

New-vRA-Blueprint [[-Connection] <PSObject>] [-ProjectName] <String> [-BlueprintName] <String> [-FlavorName] <String> [-ImageName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-ProjectName vRA Project Name true false
-BlueprintName vRA Blueprint Name true false
-FlavorName vRA Flavor Name true false
-ImageName vRA Image Mapping Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/02/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
New-vRA-Blueprint -ProjectName "ProjectName" -BlueprintName "BlueprintName" -FlavorName "small" -ImageName "ubuntu"

Top of page

New-vRA-CloudAccount-AWS

Creates new vRA Cloud Account for vSphere endpoint in a particular Org

This cmdlet creates new vRA Cloud Account for vSphere endpoint in a particular Org

Syntax 

New-vRA-CloudAccount-AWS [[-Connection] <PSObject>] [-CloudAccountName] <String> [-awsaccesskeyid] <String> [[-awssecretAccessKey] <SecureString>] [-awsregionid] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-CloudAccountName vRA Cloud Account Name true false
-awsaccesskeyid AWS Access Key true false
-awssecretAccessKey AWS Secret AccessKey false false
-awsregionid AWS Region ID true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 07/15/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
New-vRA-CloudAccount-AWS -CloudAccountName "CloudAccountName" -awsaccesskeyid "AWS Access Key" -awssecretAccessKey $awssecretAccessKey -awsregionid  "us-east-1" 
Use ConvertTo-SecureString "AWS Secret AccessKey" -AsPlainText -Force and store it in variable and pass that as an Input

Top of page

New-vRA-CloudAccount-NSXT

Creates new vRA Cloud Account for NSXT endpoint in a particular Org

This cmdlet creates new vRA Cloud Account for NSXT endpoint in a particular Org

Syntax 

New-vRA-CloudAccount-NSXT [[-Connection] <PSObject>] [-NSXTHostName] <String> [-Credential] <PSCredential> [-CloudProxyName] <String> [-CloudAccountName] <String> [-VCCloudAccountName] <String> [[-UsePolicyAPI] <String>] [[-AcceptSelfsignedCertificate] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-NSXTHostName NSXT Hostname Name true false
-Credential PSCredential object containing vCenter Authentication Credentials true false
-CloudProxyName vRA Cloudproxy Name true false
-CloudAccountName vRA Cloud Account Name true false
-VCCloudAccountName vCenter Cloud Account Name true false
-UsePolicyAPI Use Policy API Mode false false false
-AcceptSelfsignedCertificate Accept SelfSigned Certificate false false false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 12/22/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
New-vRA-CloudAccount-NSXT -NSXTHostName "NSXT FQDN" -Credential $Credential -CloudProxyName "Cloud Proxy Name" -CloudAccountName "CloudAccountName" -VCCloudAccountName "VC CloudAccount Name"-UsePolicyAPI "true" -AcceptSelfSignedCertificate "false" 
Use Get-Credential to add vCenter Credentials and pass it as Input Parameter $Credential = Get-Credential

Top of page

New-vRA-CloudAccount-VMC

Creates new vRA Cloud Account for VMC endpoint in a particular Org

This cmdlet creates new vRA Cloud Account for VMC endpoint in a particular Org

Syntax 

New-vRA-CloudAccount-VMC [[-Connection] <PSObject>] [-VMC_API_KEY] <SecureString> [-VMC_SDDC_Name] <String> [-vCenterHostname] <String> [-Credential] <PSCredential> [-VMC_NSX_IP] <String> [-CloudProxyName] <String> [-CloudAccountName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-VMC_API_KEY VMC API Key true false
-VMC_SDDC_Name VMC SDDC Name true false
-vCenterHostname vCenter Hostname Name true false
-Credential PSCredential object containing vCenter Authentication Credentials true false
-VMC_NSX_IP VMC NSX IP true false
-CloudProxyName vRA Cloudproxy Name true false
-CloudAccountName vRA Cloud Account Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 02/22/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
New-vRA-CloudAccount-VMC -VMC_API_KEY $VMC_API_Key -VMC_SDDC_Name "VMC SDDC Name" -vCenterHostname "vCenter FQDN" -Credential $Credential -VMC_NSX_IP "VMC NSX IP" -CloudProxyName "Cloud Proxy Name" -CloudAccountName "CloudAccountName"
Use Get-Credential to add vCenter Credentials and pass it as Input Parameter $Credential = Get-Credential
Use Read-Host to add VMC_API_Key as Secure String ; $VMC_API_Key = Read-Host -AsSecureString

Top of page

New-vRA-CloudAccount-vSphere

Creates new vRA Cloud Account for vSphere endpoint in a particular Org

This cmdlet creates new vRA Cloud Account for vSphere endpoint in a particular Org

Syntax 

New-vRA-CloudAccount-vSphere [[-Connection] <PSObject>] [-vCenterHostName] <String> [-Credential] <PSCredential> [-vcenterDCName] <String> [-CloudProxyName] <String> [-CloudAccountName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-vCenterHostName vCenter Hostname Name true false
-Credential PSCredential object containing vCenter Authentication Credentials true false
-vcenterDCName vCenter Datacenter Name true false
-CloudProxyName vRA Cloudproxy Name true false
-CloudAccountName vRA Cloud Account Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 01/13/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
New-vRA-CloudAccount-vSphere -vCenterHostName "vCenter FQDN" -Credential $Credential -vCenterDCName "vCenter Datacenter Name" -CloudProxyName "Cloud Proxy Name" -CloudAccountName "CloudAccountName"
Use Get-Credential to add vCenter Credentials and pass it as Input Parameter $Credential = Get-Credential

Top of page

New-vRA-FlavorProfiles-AWS

Creates new vRA Flavor Profiles for AWS endpoint in a particular Org

This cmdlet creates new vRA Flavor Profile for AWS endpoint in a particular Org

Syntax 

New-vRA-FlavorProfiles-AWS [[-Connection] <PSObject>] [-ProfileName] <String> [-FlavorName] <String> [-FlavorType] <String> [-RegionName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-ProfileName vRA Profile Name true false
-FlavorName vRA Flavor Name true false
-FlavorType vRA Flavor Type true false
-RegionName vRA Zone Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0New Date: 06/30/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
New-vRA-FlavorProfiles-AWS -ProfileName "ProfileName" -FlavorName "FlavorName" -FlavorType "EC2 Instance Type" -RegionName "vRA Zone Name"

Top of page

New-vRA-FlavorProfiles-VMC

Creates new vRA Flavor Profiles for VMC endpoint in a particular Org

This cmdlet creates new vRA Flavor Profile for VMC endpoint in a particular Org

Syntax 

New-vRA-FlavorProfiles-VMC [[-Connection] <PSObject>] [-ProfileName] <String> [-FlavorName] <String> [-FlavorCpu] <String> [-FlavorMemory] <String> [-RegionName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-ProfileName vRA Profile Name true false
-FlavorName vRA Flavor Name true false
-FlavorCpu vRA Flavor CPU Count true false
-FlavorMemory vRA Flavor Memory in MB true false
-RegionName vRA Zone Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 06/30/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
New-vRA-FlavorProfiles-VMC -ProfileName "ProfileName" -FlavorName "FlavorName" -FlavorCpu "CPUCount" -FlavorMemory "MemoryinMB" -RegionName "vRA Zone Name"

Top of page

New-vRA-FlavorProfiles-vSphere

Creates new vRA Flavor Profiles for vSphere endpoint in a particular Org

This cmdlet creates new vRA Flavor Profile for vSphere endpoint in a particular Org

Syntax 

New-vRA-FlavorProfiles-vSphere [[-Connection] <PSObject>] [-ProfileName] <String> [-FlavorName] <String> [-FlavorCpu] <String> [-FlavorMemory] <String> [-RegionName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-ProfileName vRA Profile Name true false
-FlavorName vRA Flavor Name true false
-FlavorCpu vRA Flavor CPU Count true false
-FlavorMemory vRA Flavor Memory in MB true false
-RegionName vRA Zone Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.2 Date: 04/02/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
New-vRA-FlavorProfiles-vSphere -ProfileName "ProfileName" -FlavorName "FlavorName" -FlavorCpu "CPUCount" -FlavorMemory "MemoryinMB" -RegionName "vRA Zone Name"

Top of page

New-vRA-ImageMapping

Creates new vRA Image Mapping in a particular Org

This cmdlet creates new vRA Image Mapping in a particular Org

Syntax 

New-vRA-ImageMapping [[-Connection] <PSObject>] [-ProfileName] <String> [-vRAImageName] <String> [-CloudAccountName] <String> [-VCImage] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-ProfileName vRA Profile Name true false
-vRAImageName vRA Image Name true false
-CloudAccountName vRA Cloud Account Name true false
-VCImage vCenter Image Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.2 Date: 04/02/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
New-vRA-ImageMapping -ProfileName "ProfileName" -vRAImageName "vRA Image Name" -CloudAccountName "vRA Cloud Account Name" -VCImage "vCenter Image Name"

Top of page

New-vRA-ImageMapping-AWS

Creates new vRA Image Mapping for AWS in a particular Org

This cmdlet creates new vRA Image Mapping for AWS in a particular Org

Syntax 

New-vRA-ImageMapping-AWS [[-Connection] <PSObject>] [-ProfileName] <String> [-vRAImageName] <String> [-CloudAccountName] <String> [-AMI] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-ProfileName vRA Profile Name true false
-vRAImageName vRA Image Name true false
-CloudAccountName vRA Cloud Account Name true false
-AMI AWS AMI ID true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 10/06/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
New-vRA-ImageMapping-AWS -ProfileName "ProfileName" -vRAImageName "vRA Image Name" -CloudAccountName "vRA Cloud Account Name" -AMI "ami-ubuntu-16.04-1.9.1-00-1516139717"

Top of page

New-vRA-ImageMapping-VMC

Creates new vRA Image Mapping for VMC endpoint in a particular Org

This cmdlet creates new vRA Image Mapping for VMC endpoint in a particular Org

Syntax 

New-vRA-ImageMapping-VMC [[-Connection] <PSObject>] [-ProfileName] <String> [-vRAImageName] <String> [-CloudAccountName] <String> [-VCImage] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-ProfileName vRA Profile Name true false
-vRAImageName vRA Image Name true false
-CloudAccountName vRA Cloud Account Name true false
-VCImage vCenter Image Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 06/30/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
New-vRA-ImageMapping-VMC -ProfileName "ProfileName" -vRAImageName "vRA Image Name" -CloudAccountName "vRA Cloud Account Name" -VCImage "vCenter Image Name"

Top of page

New-vRA-NetworkProfile

Creates new vRA Network Profile with an existing Network in a particular Org

This cmdlet creates new vRA Network Profile with an existing Network in a particular Org

Syntax 

New-vRA-NetworkProfile [[-Connection] <PSObject>] [-ProfileName] <String> [-CloudAccountName] <String> [-VCNetwork] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-ProfileName vRA Profile Name true false
-CloudAccountName vRA Cloud Account Name true false
-VCNetwork vCenter Network Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.2 Date: 04/02/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
New-vRA-NetworkProfile -ProfileName "ProfileName" -CloudAccountName "vRA Cloud Account Name" -VCNetwork "vCenter Network Name"

Top of page

New-vRA-NetworkProfile-AWS

Creates new vRA Network Profile with an existing Network in a particular Org

This cmdlet creates new vRA Network Profile with an existing Network in a particular Org

Syntax 

New-vRA-NetworkProfile-AWS [[-Connection] <PSObject>] [-ProfileName] <String> [-CloudAccountName] <String> [-AWSNetwork] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-ProfileName vRA Profile Name true false
-CloudAccountName vRA Cloud Account Name true false
-AWSNetwork AWS Network Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 07/07/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
New-vRA-NetworkProfile-AWS -ProfileName "ProfileName" -CloudAccountName "vRA Cloud Account Name" -AWSNetwork "AWS Network Name"

Top of page

New-vRA-NetworkProfile-VMC

Creates new vRA Network Profile for VMC with an existing Network in a particular Org

This cmdlet creates new vRA Network Profile for VMC with an existing Network in a particular Org

Syntax 

New-vRA-NetworkProfile-VMC [[-Connection] <PSObject>] [-ProfileName] <String> [-CloudAccountName] <String> [-VCNetwork] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-ProfileName vRA Profile Name true false
-CloudAccountName vRA Cloud Account Name true false
-VCNetwork vCenter Network Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 06/30/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
New-vRA-NetworkProfile-VMC -ProfileName "ProfileName" -CloudAccountName "vRA Cloud Account Name" -VCNetwork "vCenter Network Name"

Top of page

New-vRA-Project

Creates new vRA Project in a particular Org

This cmdlet creates new vRA Project in a particular Org

Syntax 

New-vRA-Project [[-Connection] <PSObject>] [-ProjectName] <String> [-ProjectDescription] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-ProjectName vRA Project Name true false
-ProjectDescription vRA Project Description true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 10/06/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
New-vRA-Project -ProjectName "ProjectName" -ProjectDescription "ProjectDescription"

Top of page

New-vRA-Project-With-Zone

Creates new vRA Project and adds the specified Zone in a particular Org

This cmdlet creates new vRA Project and adds the specified Zone in a particular Org

Syntax 

New-vRA-Project-With-Zone [[-Connection] <PSObject>] [-ProjectName] <String> [-Zonename] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-ProjectName vRA Project Name true false
-Zonename vRA Zone Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.2 Date: 04/02/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
New-vRA-Project-With-Zone -ProjectName "ProjectName" -Zonename "Zone Name"

Top of page

New-vRA-Server-CloudAccount-NSXT

Creates new vRA Cloud Account for NSXT endpoint in a particular Org

This cmdlet creates new vRA Cloud Account for NSXT endpoint in a particular Org

Syntax 

New-vRA-Server-CloudAccount-NSXT [[-Connection] <PSObject>] [-NSXTHostName] <String> [-Credential] <PSCredential> [-CloudAccountName] <String> [-VCCloudAccountName] <String> [[-UsePolicyAPI] <String>] [[-AcceptSelfsignedCertificate] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-NSXTHostName NSXT Hostname Name true false
-Credential PSCredential object containing vCenter Authentication Credentials true false
-CloudAccountName vRA Cloud Account Name true false
-VCCloudAccountName vCenter Cloud Account Name true false
-UsePolicyAPI Use Policy API Mode false false false
-AcceptSelfsignedCertificate Accept SelfSigned Certificate false false false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 12/22/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
New-vRA-Server-CloudAccount-NSXT -NSXTHostName "NSXT FQDN" -Credential $Credential -CloudAccountName "CloudAccountName" -VCCloudAccountName "VC CloudAccount Name"-UsePolicyAPI "true" -AcceptSelfSignedCertificate "false" 
Use Get-Credential to add vCenter Credentials and pass it as Input Parameter $Credential = Get-Credential

Top of page

New-vRA-Server-CloudAccount-VMC

Creates new vRA Cloud Account for VMC endpoint in a particular Org

This cmdlet creates new vRA Cloud Account for VMC endpoint in a particular Org

Syntax 

New-vRA-Server-CloudAccount-VMC [[-Connection] <PSObject>] [-VMC_API_KEY] <SecureString> [-VMC_SDDC_Name] <String> [-vCenterHostname] <String> [-Credential] <PSCredential> [-VMC_NSX_IP] <String> [-CloudAccountName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-VMC_API_KEY VMC API Key true false
-VMC_SDDC_Name VMC SDDC Name true false
-vCenterHostname vCenter Hostname Name true false
-Credential PSCredential object containing vCenter Authentication Credentials true false
-VMC_NSX_IP VMC NSX IP true false
-CloudAccountName vRA Cloud Account Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 04/03/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
New-vRA-Server-CloudAccount-VMC -VMC_API_KEY $VMC_API_Key -VMC_SDDC_Name "VMC SDDC Name" -vCenterHostname "vCenter FQDN" -Credential $Credential -VMC_NSX_IP "VMC NSX IP" -CloudAccountName "CloudAccountName"
Use Get-Credential to add vCenter Credentials and pass it as Input Parameter $Credential = Get-Credential
Use Read-Host to add VMC_API_Key as Secure String ; $VMC_API_Key = Read-Host -AsSecureString

Top of page

New-vRA-Server-CloudAccount-vSphere

Creates new vRA Cloud Account for vSphere endpoint in a particular Org

This cmdlet creates new vRA Cloud Account for vSphere endpoint in a particular Org

Syntax 

New-vRA-Server-CloudAccount-vSphere [[-Connection] <PSObject>] [-vCenterHostName] <String> [-Credential] <PSCredential> [-vcenterDCName] <String> [-CloudAccountName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-vCenterHostName vCenter Hostname Name true false
-Credential PSCredential object containing vCenter Authentication Credentials true false
-vcenterDCName vCenter Datacenter Name true false
-CloudAccountName vRA Cloud Account Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 04/03/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
New-vRA-Server-CloudAccount-vSphere -vCenterHostName "vCenter FQDN" -Credential $Credential -vCenterDCName "vCenter Datacenter Name" -CloudAccountName "CloudAccountName"
Use Get-Credential to add vCenter Credentials and pass it as Input Parameter $Credential = Get-Credential

Top of page

New-vRA-StorageProfile-AWS

Creates new vRA Storage Profile for AWS datastore in a particular Org

This cmdlet creates new vRA Storage Profile for AWS datastore in a particular Org

Syntax 

New-vRA-StorageProfile-AWS [[-Connection] <PSObject>] [-ProfileName] <String> [-CloudAccountName] <String> [-DeviceType] <String> [-VolumeType] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-ProfileName vRA Profile Name true false
-CloudAccountName vRA Cloud Account Name true false
-DeviceType AWS Device Type true false
-VolumeType AWS Volume Type true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 07/07/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
New-vRA-StorageProfile-AWS -ProfileName "ProfileName" -CloudAccountName "vRA Cloud Account Name" -DeviceType "EBS" -VolumeType "gp2"

Top of page

New-vRA-vSphereStorageProfile

Creates new vRA vSphere Storage Profile for vSphere datastore in a particular Org

This cmdlet creates new vRA vSphere Storage Profile for vSphere datastore in a particular Org

Syntax 

New-vRA-vSphereStorageProfile [[-Connection] <PSObject>] [-ProfileName] <String> [-CloudAccountName] <String> [-VCDatastore] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-ProfileName vRA Profile Name true false
-CloudAccountName vRA Cloud Account Name true false
-VCDatastore vCenter Network Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.2 Date: 04/02/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
New-vRA-vSphereStorageProfile -ProfileName "ProfileName" -CloudAccountName "vRA Cloud Account Name" -VCDatastore "vCenter Datastore Name"

Top of page

New-vRA-vSphereStorageProfile-VMC

Creates new vRA vSphere Storage Profile for VMC datastore in a particular Org

This cmdlet creates new vRA vSphere Storage Profile for VMC datastore in a particular Org

Syntax 

New-vRA-vSphereStorageProfile-VMC [[-Connection] <PSObject>] [-ProfileName] <String> [-CloudAccountName] <String> [-VCDatastore] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-ProfileName vRA Profile Name true false
-CloudAccountName vRA Cloud Account Name true false
-VCDatastore vCenter Network Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 06/30/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
New-vRA-vSphereStorageProfile-VMC -ProfileName "ProfileName" -CloudAccountName "vRA Cloud Account Name" -VCDatastore "vCenter Datastore Name"

Top of page

PowerOff-vRA-Deployment

Power Off vRA Deployment in a particular Org

This cmdlet powers Off vRA Deployment in a particular Org

Syntax 

PowerOff-vRA-Deployment [[-Connection] <PSObject>] [-DeploymentName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-DeploymentName Deployment Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 12/24/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
PowerOff-vRA-Deployment -DeploymentName "DeploymentName"

Top of page

PowerOff-vRA-DeploymentResource

Power Off vRA Deployment Resource (vSphere Virtual Machine) in a particular Org

This cmdlet powers off a vRA Deployment Resource (vSphere Virtual Machine) in a particular Org

Syntax 

PowerOff-vRA-DeploymentResource [[-Connection] <PSObject>] [-DeploymentName] <String> [-ResourceName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-DeploymentName Deployment Name true false
-ResourceName Deployment Resource Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 12/23/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
PowerOff-vRA-DeploymentResource -DeploymentName "DeploymentName" -ResourceName "ResourceName"

Top of page

PowerON-vRA-Deployment

Power ON vRA Deployment in a particular Org

This cmdlet powers ON vRA Deployment in a particular Org

Syntax 

PowerON-vRA-Deployment [[-Connection] <PSObject>] [-DeploymentName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-DeploymentName Deployment Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 12/24/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
PowerON-vRA-Deployment -DeploymentName "DeploymentName"

Top of page

PowerON-vRA-DeploymentResource

Power ON vRA Deployment Resource (vSphere Virtual Machine) in a particular Org

This cmdlet powers on a vRA Deployment Resource (vSphere Virtual Machine) in a particular Org

Syntax 

PowerON-vRA-DeploymentResource [[-Connection] <PSObject>] [-DeploymentName] <String> [-ResourceName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-DeploymentName Deployment Name true false
-ResourceName Deployment Resource Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 12/23/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
PowerON-vRA-DeploymentResource -DeploymentName "DeploymentName" -ResourceName "ResourceName"

Top of page

Reboot-vRA-DeploymentResource

Rebboot vRA Deployment Resource (vSphere Virtual Machine) in a particular Org

This cmdlet reboots a vRA Deployment Resource (vSphere Virtual Machine) in a particular Org

Syntax 

Reboot-vRA-DeploymentResource [[-Connection] <PSObject>] [-DeploymentName] <String> [-ResourceName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-DeploymentName Deployment Name true false
-ResourceName Deployment Resource Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 12/23/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Reboot-vRA-DeploymentResource -DeploymentName "DeploymentName" -ResourceName "ResourceName"

Top of page

Remove-vRA-Deployment

Deletes vRA Deployment in a particular Org

This cmdlet provisions destroys new vRA Deployment in a particular Org

Syntax 

Remove-vRA-Deployment [[-Connection] <PSObject>] [-DeploymentName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-DeploymentName vRA Deployment Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/02/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Remove-vRA-Deployment -DeploymentName "Deployment Name"

Top of page

Remove-vRA-Project-Administrator

Removes vRA Project Administrator in a particular Org

This cmdlet removes vRA Project Administrator in a particular Org

Syntax 

Remove-vRA-Project-Administrator [[-Connection] <PSObject>] [-ProjectName] <String> [-User] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-ProjectName vRA Project Name true false
-User Member true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/02/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Remove-vRA-Project-Administrator -ProjectName "ProjectName" -User "email@vmware.com"

Top of page

Remove-vRA-Project-Member

Removes vRA Project Member in a particular Org

This cmdlet removes vRA Project Member in a particular Org

Syntax 

Remove-vRA-Project-Member [[-Connection] <PSObject>] [-ProjectName] <String> [-User] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-ProjectName vRA Project Name true false
-User Member true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/02/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Remove-vRA-Project-Member -ProjectName "ProjectName" -User "email@vmware.com"

Top of page

Reset-vRA-DeploymentResource

Reset vRA Deployment Resource (vSphere Virtual Machine) in a particular Org

This cmdlet reset a vRA Deployment Resource (vSphere Virtual Machine) in a particular Org

Syntax 

Reset-vRA-DeploymentResource [[-Connection] <PSObject>] [-DeploymentName] <String> [-ResourceName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-DeploymentName Deployment Name true false
-ResourceName Deployment Resource Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 12/23/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Reset-vRA-DeploymentResource -DeploymentName "DeploymentName" -ResourceName "ResourceName"

Top of page

Revert-vRA-DeploymentResourceSnapshot

Revert to a Snapshot for vRA Deployment Resource (vSphere Virtual Machine) in a particular Org

This cmdlet reverts to a Snapshot for vRA Deployment Resource (vSphere Virtual Machine) in a particular Org

Syntax 

Revert-vRA-DeploymentResourceSnapshot [[-Connection] <PSObject>] [-DeploymentName] <String> [-ResourceName] <String> [-SnapshotName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-DeploymentName Deployment Name true false
-ResourceName Deployment Resource Name true false
-SnapshotName Lease Expiry Date (yyyy-mm-dd-Thh:mm:zz) true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 12/23/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Revert-vRA-DeploymentResourceSnapshot -DeploymentName "DeploymentName" -ResourceName "ResourceName" -SnapshotName "SnapshotName"

Top of page

Suspend-vRA-DeploymentResource

Suspend vRA Deployment Resource (vSphere Virtual Machine) in a particular Org

This cmdlet suspend a vRA Deployment Resource (vSphere Virtual Machine) in a particular Org

Syntax 

Suspend-vRA-DeploymentResource [[-Connection] <PSObject>] [-DeploymentName] <String> [-ResourceName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-DeploymentName Deployment Name true false
-ResourceName Deployment Resource Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 12/24/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Suspend-vRA-DeploymentResource -DeploymentName "DeploymentName" -ResourceName "ResourceName"

Top of page

Update-vRA-Project-ZoneConfig

Updates vRA Project Zone Configuration in a particular Org

This cmdlet updates vRA Project Zone Configuration in a particular Org

Syntax 

Update-vRA-Project-ZoneConfig [[-Connection] <PSObject>] [-ProjectName] <String> [-CloudAccountName] <String> [[-MemoryLimitMB] <Int32>] [[-maxNumberInstances] <Int32>] [[-Priority] <Int32>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRA Connection object false false $defaultvRAConnection
-ProjectName vRA Project Name true false
-CloudAccountName vRA Zone Name true false
-MemoryLimitMB MemoryLimit false false 0
-maxNumberInstances Max Number of Instances false false 0
-Priority Priority false false 0

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.1 Date: 04/02/2020 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Update-vRA-Project-ZoneConfig -ProjectName "ProjectName" -CloudAccountName "CloudAccount Name"
EXAMPLE 2 
Update-vRA-Project-ZoneConfig -ProjectName "ProjectName" -CloudAccountName "CloudAccount Name" -MemoryLimitMB 2048 -maxNumberInstances 20 -Priority 1

Top of page