Welcome to my VMware-NSXvCD-Module

This the basic documentation of the ‘VMware-NSXvCD-Module’ PowerShell Module.

GitHub: https://github.com/mycloudrevolution/VMware-NSXvCD-Module

WebSite: https://mycloudrevolution.com/

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

external help file: Enable-NsxVcdDfw-help.xml Module Name: VMware-NSXvCD-Module online version: https://mycloudrevolution.com/ schema: 2.0.0

Enable-NsxVcdDfw

SYNOPSIS

SYNTAX

Enable-NsxVcdDfw [[-Id] <String>] [<CommonParameters>]

DESCRIPTION

Enables the Distributed Firewall for the OrgVdc.

EXAMPLES

EXAMPLE 1

Enable-NsxVcdDfw -Id OrgVdcId

PARAMETERS

-Id

Id of the OrgVdc

Type: String
Parameter Sets: (All)
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

File Name : Enable-NsxVcdDfw.ps1 Author : Markus Kraus Version : 0.2 State : Test

external help file: Get-NsxVcdDfwRule-help.xml Module Name: VMware-NSXvCD-Module online version: https://mycloudrevolution.com/ schema: 2.0.0

Get-NsxVcdDfwRule

SYNOPSIS

SYNTAX

layer3Sections

Get-NsxVcdDfwRule -OrgVdcId <String> [-RuleId <String>] [-layer3Sections] [<CommonParameters>]

layer2Sections

Get-NsxVcdDfwRule -OrgVdcId <String> [-RuleId <String>] [-layer2Sections] [<CommonParameters>]

DESCRIPTION

Returnes the of the Firewall Rules the OrgVdc DFW.

EXAMPLES

EXAMPLE 1

Get-NsxVcdDfwRule -OrgId OrgVdcId -layer3Sections

EXAMPLE 2

Get-NsxVcdDfwRule -OrgId OrgVdcId -layer2Sections

EXAMPLE 3

Get-NsxVcdDfwRule -OrgId OrgVdcId -layer2Sections -RuleId 1234

PARAMETERS

-OrgVdcId

Id of the OrgVdcId

Type: String
Parameter Sets: (All)
Aliases:

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

-RuleId

Rule Id of the OrgVdc DFW

Type: String
Parameter Sets: (All)
Aliases:

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

-layer3Sections

Display only layer3Sections

Type: SwitchParameter
Parameter Sets: layer3Sections
Aliases:

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

-layer2Sections

Display only layer2Sections

Type: SwitchParameter
Parameter Sets: layer2Sections
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

File Name : Get-NsxVcdDfwRule.ps1 Author : Markus Kraus Version : 1.0 State : Ready

external help file: Get-NsxVcdEdge-help.xml Module Name: VMware-NSXvCD-Module online version: https://mycloudrevolution.com/ schema: 2.0.0

Get-NsxVcdEdge

SYNOPSIS

SYNTAX

Get-NsxVcdEdge [[-Name] <String>] [[-OrgVdcName] <String>] [<CommonParameters>]

DESCRIPTION

Returnes Edge Gatways.

EXAMPLES

EXAMPLE 1

Get-NsxVcdEdge

EXAMPLE 2

Get-NsxVcdEdge -Name YourEdgeName

EXAMPLE 3

Get-NsxVcdEdge -OrgVdcName YourOrgName

EXAMPLE 4

Get-NsxVcdEdge | select Name, datacenterName, Id | ft -AutoSize

PARAMETERS

-Name

Name of the Edge Gateway

Type: String
Parameter Sets: (All)
Aliases:

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

-OrgVdcName

OrgVdc Name of the Edge Gateway

Type: String
Parameter Sets: (All)
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

File Name : Get-NsxVcdEdge.ps1 Author : Markus Kraus Version : 1.3 State : Ready

external help file: Get-NsxVcdEdgeDetails-help.xml Module Name: VMware-NSXvCD-Module online version: https://mycloudrevolution.com/ schema: 2.0.0

Get-NsxVcdEdgeDetails

SYNOPSIS

SYNTAX

Get-NsxVcdEdgeDetails [-Id] <String> [<CommonParameters>]

DESCRIPTION

Returnes Details of the Edge Gatway.

EXAMPLES

EXAMPLE 1

Get-NsxVcdEdgeDetails -Id EdgeId

EXAMPLE 2

Get-NsxVcdEdge | Get-NsxVcdEdgeDetails | ft -AutoSize

PARAMETERS

-Id

Id of the Edge Gateway

Note: You can list all Ids of your edges by: ‘Get-NsxVcdEdge | select Name, datacenterName, Id’

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

File Name : Get-NsxVcdEdgeDetails.ps1 Author : Markus Kraus Version : 1.1 State : Ready

external help file: Get-NsxVcdEdgeFirewallRule-help.xml Module Name: VMware-NSXvCD-Module online version: https://mycloudrevolution.com/ schema: 2.0.0

Get-NsxVcdEdgeFirewallRule

SYNOPSIS

SYNTAX

Get-NsxVcdEdgeFirewallRule [-Id] <String> [[-RuleId] <Int64>] [-OutputXML] [<CommonParameters>]

DESCRIPTION

Returnes the of the Firewall Rules of the Edge Gatway.

EXAMPLES

EXAMPLE 1

Get-NsxVcdEdgeFirewallRule -Id EdgeId

EXAMPLE 2

Get-NsxVcdEdge | Get-NsxVcdEdgeFirewallRule | ft -AutoSize

PARAMETERS

-Id

Id of the Edge Gateway

Note: You can list all Ids of your edges by: ‘Get-NsxVcdEdge | select Name, datacenterName, Id’

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-RuleId

RuleId of the Firewall Rule

Type: Int64
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-OutputXML

Output the result as XML

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

File Name : Get-NsxVcdEdgeFirewallRule.ps1 Author : Markus Kraus Version : 1.2 State : Ready

external help file: Get-NsxVcdEdgeFirewallRuleDetails-help.xml Module Name: VMware-NSXvCD-Module online version: https://mycloudrevolution.com/ schema: 2.0.0

Get-NsxVcdEdgeFirewallRuleDetails

SYNOPSIS

SYNTAX

Get-NsxVcdEdgeFirewallRuleDetails [-Id] <String> [-RuleId] <Int64> [<CommonParameters>]

DESCRIPTION

Returnes Details of a Firewall Rule of the Edge Gatway.

Note: Only User Rules can be displayed

EXAMPLES

EXAMPLE 1

Get-NsxVcdEdgeFirewallRuleDetails -Id EdgeId  -RuleId FirewallRuleId

EXAMPLE 2

Get-NsxVcdEdge | Get-NsxVcdEdgeFirewallRuleDetails -RuleId FirewallRuleId

PARAMETERS

-Id

Id of the Edge Gateway

Note: You can list all Ids of your edges by: ‘Get-NsxVcdEdge | select Name, datacenterName, Id’

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-RuleId

RuleId of the Firewall Rule

Type: Int64
Parameter Sets: (All)
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

File Name : Get-NsxVcdEdgeFirewallRuleDetails.ps1 Author : Markus Kraus Version : 1.0 State : Ready

external help file: Get-NsxVcdEdgeFirewallRuleStats-help.xml Module Name: VMware-NSXvCD-Module online version: https://mycloudrevolution.com/ schema: 2.0.0

Get-NsxVcdEdgeFirewallRuleStats

SYNOPSIS

SYNTAX

Get-NsxVcdEdgeFirewallRuleStats [-Id] <String> [-RuleId] <Int64> [<CommonParameters>]

DESCRIPTION

Returnes the Stats of the Firewall Rule of the Edge Gatway.

EXAMPLES

EXAMPLE 1

Get-NsxVcdEdgeFirewallRuleStats -Id EdgeId -RuleId FirewallRuleId

EXAMPLE 2

Get-NsxVcdEdge | where {$_.name -like EdgeName} | Get-NsxVcdEdgeFirewallRuleStats -RuleId FirewallRuleId

PARAMETERS

-Id

Id of the Edge Gateway

Note: You can list all Ids of your edges by: ‘Get-NsxVcdEdge | select Name, datacenterName, Id’

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-RuleId

RuleId of the Firewall Rule

Type: Int64
Parameter Sets: (All)
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

File Name : Get-NsxVcdEdgeFirewallRuleStats.ps1 Author : Markus Kraus Version : 1.2 State : Ready

external help file: Get-NsxVcdEdgeNatRule-help.xml Module Name: VMware-NSXvCD-Module online version: https://mycloudrevolution.com/ schema: 2.0.0

Get-NsxVcdEdgeNatRule

SYNOPSIS

SYNTAX

Get-NsxVcdEdgeNatRule [[-Id] <String>] [<CommonParameters>]

DESCRIPTION

Returnes all NAT Rules of the Edge Gatway.

EXAMPLES

EXAMPLE 1

Get-NsxVcdEdgeNatRule -Id EdgeId

EXAMPLE 2

Get-NsxVcdEdge -OrgVdcName OrgVdcName | Get-NsxVcdEdgeNatRule | ft -AutoSize

PARAMETERS

-Id

Id of the Edge Gateway

Note: You can list all Ids of your edges by: ‘Get-NsxVcdEdge | select Name, datacenterName, Id’

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

File Name : Get-NsxVcdEdgeNatRule.ps1 Author : Markus Kraus Version : 1.1 State : Ready

external help file: Invoke-ApiCall-help.xml Module Name: VMware-NSXvCD-Module online version: https://mycloudrevolution.com/ schema: 2.0.0

Invoke-ApiCall

SYNOPSIS

SYNTAX

Invoke-ApiCall [[-Server] <String>] [[-Authorization] <String>] [-Uri] <String> [[-Accept] <String>]
 [-Method] <String> [<CommonParameters>]

DESCRIPTION

Helper Function to call the vCloud Director API.

EXAMPLES

EXAMPLE 1

Invoke-ApiCall -Uri "/network/edges/$Id/nat/config" -Method "Get"

PARAMETERS

-Server

FQDN of the vCloud Director Instance

Type: String
Parameter Sets: (All)
Aliases:

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

-Authorization

API Authorization String

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: $Global:ApiConnection.Authorization
Accept pipeline input: False
Accept wildcard characters: False

-Uri

API Uri

Type: String
Parameter Sets: (All)
Aliases:

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

-Accept

Accept Header fot the API Call

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: Application/*+xml
Accept pipeline input: False
Accept wildcard characters: False

-Method

Method of the API Call

Type: String
Parameter Sets: (All)
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

File Name : Invoke-ApiCall.ps1 Author : Markus Kraus Version : 1.1 State : Ready

external help file: New-ApiConnection-help.xml Module Name: VMware-NSXvCD-Module online version: https://mycloudrevolution.com/ schema: 2.0.0

New-ApiConnection

SYNOPSIS

SYNTAX

New-ApiConnection [-Server] <String> [-Credential] <PSCredential> [<CommonParameters>]

DESCRIPTION

Connects to the API of your vCloud Director instance. The Session is saved for further use.

EXAMPLES

EXAMPLE 1

New-ApiConnection -Server ServerFQDN -Credential $Credential

PARAMETERS

-Server

FQDN of the vCloud Director Instance

Type: String
Parameter Sets: (All)
Aliases:

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

-Credential

API Credentials for the vCloud Director Instance

Note: Username needs to be: <User>@<Org> (Administrtator@system)

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

File Name : New-ApiConnection.ps1 Author : Markus Kraus Version : 1.2 State : Ready