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: Add-NsxVcdDfwSecurityTagVM-help.xml Module Name: VMware-NSXvCD-Module online version: https://mycloudrevolution.com/ schema: 2.0.0
Add-NsxVcdDfwSecurityTagVM¶
SYNOPSIS¶
SYNTAX¶
Add-NsxVcdDfwSecurityTagVM [-SecurityTagId] <String> [[-VmId] <String>] [<CommonParameters>]
DESCRIPTION¶
Add a VM to a Security Tag of the OrgVdc DFW.
PARAMETERS¶
-SecurityTagId¶
Id (objectId) of the Security Tag
Type: String
Parameter Sets: (All)
Aliases: objectId
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-VmId¶
Id (UUID) of the VM
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 : Add-NsxVcdDfwSecurityTagVM.ps1 Author : Markus Kraus Version : 1.0 State : Ready
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.
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: Format-XML-help.xml Module Name: VMware-NSXvCD-Module online version: https://mycloudrevolution.com/ schema: 2.0.0
Format-XML¶
SYNOPSIS¶
Accepts a string containing valid XML tags or an XMLElement object and outputs it as a formatted string including newline and indentation of child nodes.
SYNTAX¶
Format-XML [[-xml] <Object>] [-indent <Int32>] [<CommonParameters>]
DESCRIPTION¶
Valid XML returned by the NSX API is a single string with no newlines or indentation. While PowerNSX cmdlets typicallly emit an XMLElement object, which PowerShell outputs as formatted tables or lists when outputing to host, making normal human interaction easy, for output to file or debug stream, format-xml converts the API returned XML to more easily read formated XML complete with linebreaks and indentation.
As a side effect, this has the added benefit of being useable as an additional format handler on the PowerShell pipeline, so rather than displaying output objects using familiar table and list output formats, the user now has the option of displaying the native XML in a human readable format.
EXAMPLES¶
EXAMPLE 1¶
Get-NsxTransportZone | Format-Xml
Displays the XMLElement object returned by Get-NsxTransportZone as formatted XML.
PARAMETERS¶
-xml¶
String object containing valid XML, or XMLElement or XMLDocument object
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-indent¶
Number of whitespace charaters to indent child nodes by when formatting
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 2
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¶
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] [-OutputXML] [<CommonParameters>]
layer2Sections¶
Get-NsxVcdDfwRule -OrgVdcId <String> [-RuleId <String>] [-layer2Sections] [-OutputXML] [<CommonParameters>]
DESCRIPTION¶
Returnes the list 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
-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-NsxVcdDfwRule.ps1 Author : Markus Kraus Version : 1.0 State : Ready
external help file: Get-NsxVcdDfwSecurityGroups-help.xml Module Name: VMware-NSXvCD-Module online version: https://mycloudrevolution.com/ schema: 2.0.0
Get-NsxVcdDfwSecurityGroups¶
SYNOPSIS¶
SYNTAX¶
Get-NsxVcdDfwSecurityGroups [-OrgVdcId] <String> [-OutputXML] [<CommonParameters>]
DESCRIPTION¶
Returnes the Security Groups of the OrgVdc DFW.
EXAMPLES¶
EXAMPLE 1¶
Get-NsxVcdDfwSecurityGroups -OrgId OrgVdcId
EXAMPLE 2¶
Get-NsxVcdDfwSecurityGroups -OrgId OrgVdcId -OutputXML
EXAMPLE 3¶
Get-NsxVcdDfwSecurityGroups -OrgVdcId OrgVdcId | select objectId, name, @{N='type'; E= {$_.type.typeName}}
PARAMETERS¶
-OrgVdcId¶
Id of the OrgVdcId
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
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-NsxVcdDfwSecurityGroups.ps1 Author : Markus Kraus Version : 1.0 State : Ready
external help file: Get-NsxVcdDfwSecurityTagVMs-help.xml Module Name: VMware-NSXvCD-Module online version: https://mycloudrevolution.com/ schema: 2.0.0
Get-NsxVcdDfwSecurityTagVMs¶
SYNOPSIS¶
SYNTAX¶
Get-NsxVcdDfwSecurityTagVMs [-SecurityTagId] <Object> [-OutputXML] [<CommonParameters>]
DESCRIPTION¶
Returnes the Security Tag VMs of the OrgVdc DFW.
EXAMPLES¶
EXAMPLE 1¶
Get-NsxVcdDfwSecurityTagVMs -SecurityTagId SecurityTagId
EXAMPLE 2¶
Get-NsxVcdDfwSecurityTagVMs -SecurityTagId SecurityTagId -OutputXML
EXAMPLE 3¶
Get-NsxVcdDfwSecurityTags -OrgVdcId OrgVdcId | Get-NsxVcdDfwSecurityTagVMs | select objectId, objectTypeName, name
PARAMETERS¶
-SecurityTagId¶
Id (objectId) of the Security Tag
Type: Object
Parameter Sets: (All)
Aliases: objectId
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
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-NsxVcdDfwSecurityTagVMs.ps1 Author : Markus Kraus Version : 1.0 State : Ready
external help file: Get-NsxVcdDfwSecurityTags-help.xml Module Name: VMware-NSXvCD-Module online version: https://mycloudrevolution.com/ schema: 2.0.0
Get-NsxVcdDfwSecurityTags¶
SYNOPSIS¶
SYNTAX¶
Get-NsxVcdDfwSecurityTags [-OrgVdcId] <String> [-OutputXML] [<CommonParameters>]
DESCRIPTION¶
Returnes the Security tags of the OrgVdc DFW.
EXAMPLES¶
EXAMPLE 1¶
Get-NsxVcdDfwSecurityTags -OrgId OrgVdcId
EXAMPLE 2¶
Get-NsxVcdDfwSecurityTags -OrgId OrgVdcId -OutputXML
EXAMPLE 3¶
Get-NsxVcdDfwSecurityTags -OrgVdcId OrgVdcId | select objectId, name, description, vmCount
PARAMETERS¶
-OrgVdcId¶
Id of the OrgVdcId
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
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-NsxVcdDfwSecurityTags.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 the 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 list 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-NsxVcdApiCall-help.xml Module Name: VMware-NSXvCD-Module online version: https://mycloudrevolution.com/ schema: 2.0.0
Invoke-NsxVcdApiCall¶
SYNOPSIS¶
SYNTAX¶
Invoke-NsxVcdApiCall [[-Server] <String>] [[-Authorization] <String>] [-Uri] <String> [[-Accept] <String>]
[-Method] <String> [[-Body] <XmlDocument>] [<CommonParameters>]
DESCRIPTION¶
Helper Function to call the vCloud Director API.
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
-Body¶
Body of the API Call
Type: XmlDocument
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS¶
OUTPUTS¶
NOTES¶
File Name : Invoke-NsxVcdApiCall.ps1 Author : Markus Kraus Version : 1.1 State : Ready
external help file: New-NsxVcdApiConnection-help.xml Module Name: VMware-NSXvCD-Module online version: https://mycloudrevolution.com/ schema: 2.0.0
New-NsxVcdApiConnection¶
SYNOPSIS¶
SYNTAX¶
New-NsxVcdApiConnection [-Server] <String> [-Credential] <PSCredential> [<CommonParameters>]
DESCRIPTION¶
Connects to the API of your vCloud Director instance. The Session is saved for further use.
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-NsxVcdApiConnection.ps1 Author : Markus Kraus Version : 1.2 State : Ready
external help file: Remove-NsxVcdDfwSecurityTagVM-help.xml Module Name: VMware-NSXvCD-Module online version: https://mycloudrevolution.com/ schema: 2.0.0
Remove-NsxVcdDfwSecurityTagVM¶
SYNOPSIS¶
SYNTAX¶
Remove-NsxVcdDfwSecurityTagVM [-SecurityTagId] <String> [[-VmId] <String>] [<CommonParameters>]
DESCRIPTION¶
Remove a VM to a Security Tag of the OrgVdc DFW.
PARAMETERS¶
-SecurityTagId¶
Id (objectId) of the Security Tag
Type: String
Parameter Sets: (All)
Aliases: objectId
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-VmId¶
Id (UUID) of the VM
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 : Remove-NsxVcdDfwSecurityTagVM.ps1 Author : Markus Kraus Version : 1.0 State : Ready