Set-CIVAppNetwork Command | Vmware PowerCLI Reference

Set-CIVAppNetwork

This cmdlet modifies the configuration of the specified vApp networks.

Syntax

Set-CIVAppNetwork
-VAppNetwork < CIVAppNetwork[] >
[-Description < String > ]
[-DnsSuffix < String > ]
[-PrimaryDns < IPAddress > ]
[-ProgressAction < ActionPreference > ]
[-RunAsync ]
[-SecondaryDns < IPAddress > ]
[-Server < CIServer[] > ]
[-StaticIPPool < IPRangeList > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 VAppNetwork CIVAppNetwork[] named
  • pipeline
 Specifies the vApp networks that you want to modify.
optional Description String named
Specifies new descriptions for the vApp networks that you want to modify. To delete the current value of this setting, pass an empty string.
optional DnsSuffix String named
Specifies new DNS suffixes for the vApp networks that you want to modify. To delete the current value of this setting, pass an empty string.
optional PrimaryDns IPAddress named
Specifies new primary DNSs for the vApp networks that you want to modify. To delete the current value of this setting, pass an empty string.
optional ProgressAction ActionPreference named
optional RunAsync SwitchParameter named
Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.
optional SecondaryDns IPAddress named
Specifies new secondary DNSs for the vApp networks that you want to modify. To delete the current value of this setting, pass an empty string.
optional Server CIServer[] named
Specifies the cloud servers on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-CIServer.
optional StaticIPPool IPRangeList named
Specifies new ranges of static IP addresses for the vApp networks to allocate to virtual machines. To delete the current value of this setting, pass an empty string.
Set-CIVAppNetwork
-ReplaceNetworkWithNewNetworkWithChangedName < String >
-VAppNetwork < CIVAppNetwork[] >
[-ProgressAction < ActionPreference > ]
[-RunAsync ]
[-Server < CIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 ReplaceNetworkWithNewNetworkWithChangedName String named
Specifies new names for the vApp networks that you want to modify. When this parameter is specified, the operation replaces each of the specified vApp networks with a new one with the specified name. Each new network has identical settings with the network it replaces but the new network has a new name, ID, and HREF. Services outside vCloud Director which track the initial vApp network by ID or HREF might lose track of the renamed vApp network. After renaming the vApp networks, you cannot restore their IDs and HREFs to their initial values. Caution: Make sure that you understand the operation and its effects before renaming vApp networks.
required
 VAppNetwork CIVAppNetwork[] named
  • pipeline
 Specifies the vApp networks that you want to modify.
optional ProgressAction ActionPreference named
optional RunAsync SwitchParameter named
Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.
optional Server CIServer[] named
Specifies the cloud servers on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-CIServer.
Set-CIVAppNetwork
-VAppNetwork < CIVAppNetwork[] >
[-Fenced < Boolean > ]
[-FirewallEnabled < Boolean > ]
[-NatEnabled < Boolean > ]
[-ParentOrgVdcNetwork < OrgNetworkBase > ]
[-ProgressAction < ActionPreference > ]
[-RunAsync ]
[-Server < CIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 VAppNetwork CIVAppNetwork[] named
  • pipeline
 Specifies the vApp networks that you want to modify.
optional Fenced Boolean named
Activates or deactivates fenced mode for the vApp networks. This parameter is only applicable when the connection type of the vApp network is direct.
optional FirewallEnabled Boolean named
Activates or deactivates the firewall service for the vApp networks that you want to modify.
optional NatEnabled Boolean named
Activates or deactivates the NAT service for the vApp networks that you want to modify.
optional ParentOrgVdcNetwork OrgNetworkBase named
Specifies a new parent organization vDC network to which the vApp networks connect. Pass $null if you want to change the type of the vApp networks to isolated.
optional ProgressAction ActionPreference named
optional RunAsync SwitchParameter named
Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.
optional Server CIServer[] named
Specifies the cloud servers on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-CIServer.

Output

VMware.VimAutomation.Cloud.Types.V1.CIVAppNetwork

Examples

Example 1 

$myVAppNetwork = Get-CIVAppNetwork -Name 'MyVAppNetwork'
$myVAppNetwork | Set-CIVAppNetwork  -Description 'This my routed network with updated configuration.' -DnsSuffix 'mydomain.com'  -PrimaryDns '192.168.3.1' -SecondaryDns '192.168.3.2' -StaticIPPool '192.168.3.100 - 192.168.3.120'

Modifies the configuration of the specified vApp network.

Example 2 

$myVAppNetwork = Get-CIVAppNetwork -Name 'MyVAppNetwork'
$parentOrgNetwork = Get-OrgNetwork -Name 'MyParentOrganizationNetwork'
$myVAppNetwork | Set-CIVAppNetwork -ParentOrgNetwork $parentOrgNetwork

Changes the parent organization network for the specified vApp.

Example 3 

$myVAppNetwork = Get-CIVAppNetwork -Name 'MyVAppNetwork'
$myVAppNetwork | Set-CIVAppNetwork -ParentOrgNetwork $null

Transforms the specified routed network into an isolated network.

Example 4 

$myVAppNetwork = Get-CIVAppNetwork -Name 'MyVAppNetwork'
$myVAppNetwork | Set-CIVAppNetwork -Fenced:$true -FirewallEnabled:$false

Turns on fence mode for the specified direct vApp network and deactivates the firewall service.

Example 5 

$myVAppNetwork = Get-CIVAppNetwork -Name 'MyVAppNetwork'
$myVAppNetwork | Set-CIVAppNetwork -ReplaceNetworkWithNewNetworkWithChangedName MyRenamedVAppNetwork

Renames the specified network by replacing it with an identical vApp network named MyRenamedVAppNetwork.

Related Commands

CIVApp

This cmdlet retrieves virtual appliances in the cloud.

This cmdlet imports a virtual machine from the underlying vSphere to the cloud.

This cmdlet creates a new vApp.

This cmdlet removes vApps from the cloud.

This cmdlet restarts the specified vApp.

This cmdlet modifies the configuration of the specified vApps in the cloud.

This cmdlet starts the specified vApp.

This cmdlet stops the specified vApp.

This cmdlet suspends the specified vApp.

CIVAppGuest

This cmdlet restarts the guest operating systems of all virtual machines in the specified vApp.

This cmdlet shuts down the guest operating systems of all virtual machines in the specified vApp.

CIVAppNetwork

This cmdlet retrieves the vApp networks available on a vCloud Director server.

This cmdlet creates a new vApp network.

This cmdlet removes the specified vApp networks if they are not in use.

This cmdlet modifies the configuration of the specified vApp networks.

CIVAppStartRule

This cmdlet retrieves the start rules for virtual machines in a specified vApp.

This cmdlet modifies the start rules for virtual machines in the specified vApp.

CIVAppTemplate

This cmdlet retrieves vApp templates.

This cmdlet imports a virtual machine or an OVF package from vCenter Server to vCloud Director as a vApp template.

This cmdlet creates a new vApp template.

This cmdlet removes the specified vApp template.

This cmdlet modifies the configuration of the specified vApp template.