Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vcd Provider
  3. API Docs
  4. VappOrgNetwork
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

vcd.VappOrgNetwork

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

    Create VappOrgNetwork Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VappOrgNetwork(name: string, args: VappOrgNetworkArgs, opts?: CustomResourceOptions);
    @overload
def VappOrgNetwork(resource_name: str,
                   args: VappOrgNetworkArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def VappOrgNetwork(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   org_network_name: Optional[str] = None,
                   vapp_name: Optional[str] = None,
                   is_fenced: Optional[bool] = None,
                   org: Optional[str] = None,
                   reboot_vapp_on_removal: Optional[bool] = None,
                   retain_ip_mac_enabled: Optional[bool] = None,
                   vapp_org_network_id: Optional[str] = None,
                   vdc: Optional[str] = None)
    func NewVappOrgNetwork(ctx *Context, name string, args VappOrgNetworkArgs, opts ...ResourceOption) (*VappOrgNetwork, error)
    public VappOrgNetwork(string name, VappOrgNetworkArgs args, CustomResourceOptions? opts = null)
    public VappOrgNetwork(String name, VappOrgNetworkArgs args)
public VappOrgNetwork(String name, VappOrgNetworkArgs args, CustomResourceOptions options)

    type: vcd:VappOrgNetwork
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VappOrgNetworkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VappOrgNetworkArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VappOrgNetworkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VappOrgNetworkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VappOrgNetworkArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var vappOrgNetworkResource = new Vcd.VappOrgNetwork("vappOrgNetworkResource", new()
{
    OrgNetworkName = "string",
    VappName = "string",
    IsFenced = false,
    Org = "string",
    RebootVappOnRemoval = false,
    RetainIpMacEnabled = false,
    VappOrgNetworkId = "string",
    Vdc = "string",
});

    example, err := vcd.NewVappOrgNetwork(ctx, "vappOrgNetworkResource", &vcd.VappOrgNetworkArgs{
	OrgNetworkName:      pulumi.String("string"),
	VappName:            pulumi.String("string"),
	IsFenced:            pulumi.Bool(false),
	Org:                 pulumi.String("string"),
	RebootVappOnRemoval: pulumi.Bool(false),
	RetainIpMacEnabled:  pulumi.Bool(false),
	VappOrgNetworkId:    pulumi.String("string"),
	Vdc:                 pulumi.String("string"),
})

    var vappOrgNetworkResource = new VappOrgNetwork("vappOrgNetworkResource", VappOrgNetworkArgs.builder()
    .orgNetworkName("string")
    .vappName("string")
    .isFenced(false)
    .org("string")
    .rebootVappOnRemoval(false)
    .retainIpMacEnabled(false)
    .vappOrgNetworkId("string")
    .vdc("string")
    .build());

    vapp_org_network_resource = vcd.VappOrgNetwork("vappOrgNetworkResource",
    org_network_name="string",
    vapp_name="string",
    is_fenced=False,
    org="string",
    reboot_vapp_on_removal=False,
    retain_ip_mac_enabled=False,
    vapp_org_network_id="string",
    vdc="string")

    const vappOrgNetworkResource = new vcd.VappOrgNetwork("vappOrgNetworkResource", {
    orgNetworkName: "string",
    vappName: "string",
    isFenced: false,
    org: "string",
    rebootVappOnRemoval: false,
    retainIpMacEnabled: false,
    vappOrgNetworkId: "string",
    vdc: "string",
});

    type: vcd:VappOrgNetwork
properties:
    isFenced: false
    org: string
    orgNetworkName: string
    rebootVappOnRemoval: false
    retainIpMacEnabled: false
    vappName: string
    vappOrgNetworkId: string
    vdc: string

    VappOrgNetwork Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The VappOrgNetwork resource accepts the following input properties:

    OrgNetworkName string
    An Org network name to which vApp network is connected. If not configured, then an isolated network is created.
    VappName string
    The vApp this network belongs to.
    IsFenced bool
    Fencing allows identical virtual machines in different vApp networks connect to organization VDC networks that are accessed in this vApp. Default is false.
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    RebootVappOnRemoval bool
    VCD 10.4.1+ API prohibits removal of vApp network from a powered on vApp. Set to true to power off the vApp during vApp network removal. If the vApp's original state was powered on, it will be powered back on after removing the network. (default false) Note. It only affects delete operation for the resource and will never power cycle vApp during update operations. Changing this value will cause plan change, but update will be a no-op operation.
    RetainIpMacEnabled bool
    Specifies whether the network resources such as IP/MAC of router will be retained across deployments. Configurable when is_fenced is true.
    VappOrgNetworkId string
    Vdc string
    The name of VDC to use, optional if defined at provider level.
    OrgNetworkName string
    An Org network name to which vApp network is connected. If not configured, then an isolated network is created.
    VappName string
    The vApp this network belongs to.
    IsFenced bool
    Fencing allows identical virtual machines in different vApp networks connect to organization VDC networks that are accessed in this vApp. Default is false.
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    RebootVappOnRemoval bool
    VCD 10.4.1+ API prohibits removal of vApp network from a powered on vApp. Set to true to power off the vApp during vApp network removal. If the vApp's original state was powered on, it will be powered back on after removing the network. (default false) Note. It only affects delete operation for the resource and will never power cycle vApp during update operations. Changing this value will cause plan change, but update will be a no-op operation.
    RetainIpMacEnabled bool
    Specifies whether the network resources such as IP/MAC of router will be retained across deployments. Configurable when is_fenced is true.
    VappOrgNetworkId string
    Vdc string
    The name of VDC to use, optional if defined at provider level.
    orgNetworkName String
    An Org network name to which vApp network is connected. If not configured, then an isolated network is created.
    vappName String
    The vApp this network belongs to.
    isFenced Boolean
    Fencing allows identical virtual machines in different vApp networks connect to organization VDC networks that are accessed in this vApp. Default is false.
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    rebootVappOnRemoval Boolean
    VCD 10.4.1+ API prohibits removal of vApp network from a powered on vApp. Set to true to power off the vApp during vApp network removal. If the vApp's original state was powered on, it will be powered back on after removing the network. (default false) Note. It only affects delete operation for the resource and will never power cycle vApp during update operations. Changing this value will cause plan change, but update will be a no-op operation.
    retainIpMacEnabled Boolean
    Specifies whether the network resources such as IP/MAC of router will be retained across deployments. Configurable when is_fenced is true.
    vappOrgNetworkId String
    vdc String
    The name of VDC to use, optional if defined at provider level.
    orgNetworkName string
    An Org network name to which vApp network is connected. If not configured, then an isolated network is created.
    vappName string
    The vApp this network belongs to.
    isFenced boolean
    Fencing allows identical virtual machines in different vApp networks connect to organization VDC networks that are accessed in this vApp. Default is false.
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    rebootVappOnRemoval boolean
    VCD 10.4.1+ API prohibits removal of vApp network from a powered on vApp. Set to true to power off the vApp during vApp network removal. If the vApp's original state was powered on, it will be powered back on after removing the network. (default false) Note. It only affects delete operation for the resource and will never power cycle vApp during update operations. Changing this value will cause plan change, but update will be a no-op operation.
    retainIpMacEnabled boolean
    Specifies whether the network resources such as IP/MAC of router will be retained across deployments. Configurable when is_fenced is true.
    vappOrgNetworkId string
    vdc string
    The name of VDC to use, optional if defined at provider level.
    org_network_name str
    An Org network name to which vApp network is connected. If not configured, then an isolated network is created.
    vapp_name str
    The vApp this network belongs to.
    is_fenced bool
    Fencing allows identical virtual machines in different vApp networks connect to organization VDC networks that are accessed in this vApp. Default is false.
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    reboot_vapp_on_removal bool
    VCD 10.4.1+ API prohibits removal of vApp network from a powered on vApp. Set to true to power off the vApp during vApp network removal. If the vApp's original state was powered on, it will be powered back on after removing the network. (default false) Note. It only affects delete operation for the resource and will never power cycle vApp during update operations. Changing this value will cause plan change, but update will be a no-op operation.
    retain_ip_mac_enabled bool
    Specifies whether the network resources such as IP/MAC of router will be retained across deployments. Configurable when is_fenced is true.
    vapp_org_network_id str
    vdc str
    The name of VDC to use, optional if defined at provider level.
    orgNetworkName String
    An Org network name to which vApp network is connected. If not configured, then an isolated network is created.
    vappName String
    The vApp this network belongs to.
    isFenced Boolean
    Fencing allows identical virtual machines in different vApp networks connect to organization VDC networks that are accessed in this vApp. Default is false.
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    rebootVappOnRemoval Boolean
    VCD 10.4.1+ API prohibits removal of vApp network from a powered on vApp. Set to true to power off the vApp during vApp network removal. If the vApp's original state was powered on, it will be powered back on after removing the network. (default false) Note. It only affects delete operation for the resource and will never power cycle vApp during update operations. Changing this value will cause plan change, but update will be a no-op operation.
    retainIpMacEnabled Boolean
    Specifies whether the network resources such as IP/MAC of router will be retained across deployments. Configurable when is_fenced is true.
    vappOrgNetworkId String
    vdc String
    The name of VDC to use, optional if defined at provider level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VappOrgNetwork resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing VappOrgNetwork Resource

    Get an existing VappOrgNetwork resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: VappOrgNetworkState, opts?: CustomResourceOptions): VappOrgNetwork
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        is_fenced: Optional[bool] = None,
        org: Optional[str] = None,
        org_network_name: Optional[str] = None,
        reboot_vapp_on_removal: Optional[bool] = None,
        retain_ip_mac_enabled: Optional[bool] = None,
        vapp_name: Optional[str] = None,
        vapp_org_network_id: Optional[str] = None,
        vdc: Optional[str] = None) -> VappOrgNetwork
    func GetVappOrgNetwork(ctx *Context, name string, id IDInput, state *VappOrgNetworkState, opts ...ResourceOption) (*VappOrgNetwork, error)
    public static VappOrgNetwork Get(string name, Input<string> id, VappOrgNetworkState? state, CustomResourceOptions? opts = null)
    public static VappOrgNetwork get(String name, Output<String> id, VappOrgNetworkState state, CustomResourceOptions options)
    resources:  _:    type: vcd:VappOrgNetwork    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    IsFenced bool
    Fencing allows identical virtual machines in different vApp networks connect to organization VDC networks that are accessed in this vApp. Default is false.
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    OrgNetworkName string
    An Org network name to which vApp network is connected. If not configured, then an isolated network is created.
    RebootVappOnRemoval bool
    VCD 10.4.1+ API prohibits removal of vApp network from a powered on vApp. Set to true to power off the vApp during vApp network removal. If the vApp's original state was powered on, it will be powered back on after removing the network. (default false) Note. It only affects delete operation for the resource and will never power cycle vApp during update operations. Changing this value will cause plan change, but update will be a no-op operation.
    RetainIpMacEnabled bool
    Specifies whether the network resources such as IP/MAC of router will be retained across deployments. Configurable when is_fenced is true.
    VappName string
    The vApp this network belongs to.
    VappOrgNetworkId string
    Vdc string
    The name of VDC to use, optional if defined at provider level.
    IsFenced bool
    Fencing allows identical virtual machines in different vApp networks connect to organization VDC networks that are accessed in this vApp. Default is false.
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    OrgNetworkName string
    An Org network name to which vApp network is connected. If not configured, then an isolated network is created.
    RebootVappOnRemoval bool
    VCD 10.4.1+ API prohibits removal of vApp network from a powered on vApp. Set to true to power off the vApp during vApp network removal. If the vApp's original state was powered on, it will be powered back on after removing the network. (default false) Note. It only affects delete operation for the resource and will never power cycle vApp during update operations. Changing this value will cause plan change, but update will be a no-op operation.
    RetainIpMacEnabled bool
    Specifies whether the network resources such as IP/MAC of router will be retained across deployments. Configurable when is_fenced is true.
    VappName string
    The vApp this network belongs to.
    VappOrgNetworkId string
    Vdc string
    The name of VDC to use, optional if defined at provider level.
    isFenced Boolean
    Fencing allows identical virtual machines in different vApp networks connect to organization VDC networks that are accessed in this vApp. Default is false.
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    orgNetworkName String
    An Org network name to which vApp network is connected. If not configured, then an isolated network is created.
    rebootVappOnRemoval Boolean
    VCD 10.4.1+ API prohibits removal of vApp network from a powered on vApp. Set to true to power off the vApp during vApp network removal. If the vApp's original state was powered on, it will be powered back on after removing the network. (default false) Note. It only affects delete operation for the resource and will never power cycle vApp during update operations. Changing this value will cause plan change, but update will be a no-op operation.
    retainIpMacEnabled Boolean
    Specifies whether the network resources such as IP/MAC of router will be retained across deployments. Configurable when is_fenced is true.
    vappName String
    The vApp this network belongs to.
    vappOrgNetworkId String
    vdc String
    The name of VDC to use, optional if defined at provider level.
    isFenced boolean
    Fencing allows identical virtual machines in different vApp networks connect to organization VDC networks that are accessed in this vApp. Default is false.
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    orgNetworkName string
    An Org network name to which vApp network is connected. If not configured, then an isolated network is created.
    rebootVappOnRemoval boolean
    VCD 10.4.1+ API prohibits removal of vApp network from a powered on vApp. Set to true to power off the vApp during vApp network removal. If the vApp's original state was powered on, it will be powered back on after removing the network. (default false) Note. It only affects delete operation for the resource and will never power cycle vApp during update operations. Changing this value will cause plan change, but update will be a no-op operation.
    retainIpMacEnabled boolean
    Specifies whether the network resources such as IP/MAC of router will be retained across deployments. Configurable when is_fenced is true.
    vappName string
    The vApp this network belongs to.
    vappOrgNetworkId string
    vdc string
    The name of VDC to use, optional if defined at provider level.
    is_fenced bool
    Fencing allows identical virtual machines in different vApp networks connect to organization VDC networks that are accessed in this vApp. Default is false.
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    org_network_name str
    An Org network name to which vApp network is connected. If not configured, then an isolated network is created.
    reboot_vapp_on_removal bool
    VCD 10.4.1+ API prohibits removal of vApp network from a powered on vApp. Set to true to power off the vApp during vApp network removal. If the vApp's original state was powered on, it will be powered back on after removing the network. (default false) Note. It only affects delete operation for the resource and will never power cycle vApp during update operations. Changing this value will cause plan change, but update will be a no-op operation.
    retain_ip_mac_enabled bool
    Specifies whether the network resources such as IP/MAC of router will be retained across deployments. Configurable when is_fenced is true.
    vapp_name str
    The vApp this network belongs to.
    vapp_org_network_id str
    vdc str
    The name of VDC to use, optional if defined at provider level.
    isFenced Boolean
    Fencing allows identical virtual machines in different vApp networks connect to organization VDC networks that are accessed in this vApp. Default is false.
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    orgNetworkName String
    An Org network name to which vApp network is connected. If not configured, then an isolated network is created.
    rebootVappOnRemoval Boolean
    VCD 10.4.1+ API prohibits removal of vApp network from a powered on vApp. Set to true to power off the vApp during vApp network removal. If the vApp's original state was powered on, it will be powered back on after removing the network. (default false) Note. It only affects delete operation for the resource and will never power cycle vApp during update operations. Changing this value will cause plan change, but update will be a no-op operation.
    retainIpMacEnabled Boolean
    Specifies whether the network resources such as IP/MAC of router will be retained across deployments. Configurable when is_fenced is true.
    vappName String
    The vApp this network belongs to.
    vappOrgNetworkId String
    vdc String
    The name of VDC to use, optional if defined at provider level.

    Package Details

    Repository
    vcd vmware/terraform-provider-vcd
    License
    Notes
    This Pulumi package is based on the vcd Terraform Provider.
    vcd logo
    vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
    vmware/terraform-provider-vcd