## PowerCLI Reference

# Set-CIVAppNetwork

## Synopsis

This cmdlet modifies the configuration of the specified vApp networks.

Syntax

Set-CIVAppNetwork [-VAppNetwork] <CIVAppNetwork[]> [-RunAsync] [-Server <CIServer[]>] [-Description <String>] [-DnsSuffix <String>] [-PrimaryDns <IPAddress>] [-SecondaryDns <IPAddress>] [-StaticIPPool <IPRangeList>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-PipelineVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-CIVAppNetwork [-VAppNetwork] <CIVAppNetwork[]> [-RunAsync] [-Server <CIServer[]>] -ReplaceNetworkWithNewNetworkWithChangedName <String> [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-PipelineVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-CIVAppNetwork [-VAppNetwork] <CIVAppNetwork[]> [-RunAsync] [-Server <CIServer[]>] [-Fenced <Boolean>] [-FirewallEnabled <Boolean>] [-NatEnabled <Boolean>] [-ParentOrgVdcNetwork <OrgNetworkBase>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-PipelineVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-CIVAppNetwork
New-CIVAppNetwork
Remove-CIVAppNetwork

Detailed Description

This cmdlet modifies the configuration of the specified vApp networks.

Parameters

Name | Type | Description | Required? | Pipeline Input | Default Value
--- | --- | --- | --- | --- | ---
VAppNetwork | CIVAppNetwork[] | Specifies the vApp networks that you want to modify. | true | true (ByValue)
Confirm | SwitchParameter | If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation. | false | false
Description | String | Specifies new descriptions for the vApp networks that you want to modify. To delete the current value of this setting, pass an empty string. | false | false
DnsSuffix | String | 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. | false | false
Fenced | Boolean | Enables or disables fenced mode for the vApp networks. This parameter is only applicable when the connection type of the vApp network is direct. | false | false
FirewallEnabled | Boolean | Enables or disables the firewall service for the vApp networks that you want to modify. | false | false
InformationAction | ActionPreference |  | false | false
InformationVariable | String |  | false | false
NatEnabled | Boolean | Enables or disables the NAT service for the vApp networks that you want to modify. | false | false
ParentOrgVdcNetwork | OrgNetworkBase | 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. | false | false
PipelineVariable | String |  | false | false
PrimaryDns | IPAddress | 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. | false | false
ReplaceNetworkWithNewNetworkWithChangedName | String | 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. | true | false
RunAsync | SwitchParameter | 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. | false | false
SecondaryDns | IPAddress | 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. | false | false
Server | CIServer[] | Specifies the cloud servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-CIServer. | false | false
StaticIPPool | IPRangeList | 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. | false | false
WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | false

Return Type

Zero or more modified CIVAppNetwork objects

Notes

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 disables 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.

Copyright © VMware, Inc. All rights reserved.