1. Packages
  2. Vcd Provider
  3. API Docs
  4. NsxtNetworkImported
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vcd.NsxtNetworkImported

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

    Create NsxtNetworkImported Resource

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

    Constructor syntax

    new NsxtNetworkImported(name: string, args: NsxtNetworkImportedArgs, opts?: CustomResourceOptions);
    @overload
    def NsxtNetworkImported(resource_name: str,
                            args: NsxtNetworkImportedArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def NsxtNetworkImported(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            gateway: Optional[str] = None,
                            prefix_length: Optional[float] = None,
                            dual_stack_enabled: Optional[bool] = None,
                            nsxt_network_imported_id: Optional[str] = None,
                            description: Optional[str] = None,
                            dvpg_name: Optional[str] = None,
                            dns2: Optional[str] = None,
                            name: Optional[str] = None,
                            nsxt_logical_switch_name: Optional[str] = None,
                            dns_suffix: Optional[str] = None,
                            org: Optional[str] = None,
                            owner_id: Optional[str] = None,
                            dns1: Optional[str] = None,
                            secondary_gateway: Optional[str] = None,
                            secondary_prefix_length: Optional[str] = None,
                            secondary_static_ip_pools: Optional[Sequence[NsxtNetworkImportedSecondaryStaticIpPoolArgs]] = None,
                            static_ip_pools: Optional[Sequence[NsxtNetworkImportedStaticIpPoolArgs]] = None,
                            vdc: Optional[str] = None)
    func NewNsxtNetworkImported(ctx *Context, name string, args NsxtNetworkImportedArgs, opts ...ResourceOption) (*NsxtNetworkImported, error)
    public NsxtNetworkImported(string name, NsxtNetworkImportedArgs args, CustomResourceOptions? opts = null)
    public NsxtNetworkImported(String name, NsxtNetworkImportedArgs args)
    public NsxtNetworkImported(String name, NsxtNetworkImportedArgs args, CustomResourceOptions options)
    
    type: vcd:NsxtNetworkImported
    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 NsxtNetworkImportedArgs
    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 NsxtNetworkImportedArgs
    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 NsxtNetworkImportedArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NsxtNetworkImportedArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NsxtNetworkImportedArgs
    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 nsxtNetworkImportedResource = new Vcd.NsxtNetworkImported("nsxtNetworkImportedResource", new()
    {
        Gateway = "string",
        PrefixLength = 0,
        DualStackEnabled = false,
        NsxtNetworkImportedId = "string",
        Description = "string",
        DvpgName = "string",
        Dns2 = "string",
        Name = "string",
        NsxtLogicalSwitchName = "string",
        DnsSuffix = "string",
        Org = "string",
        OwnerId = "string",
        Dns1 = "string",
        SecondaryGateway = "string",
        SecondaryPrefixLength = "string",
        SecondaryStaticIpPools = new[]
        {
            new Vcd.Inputs.NsxtNetworkImportedSecondaryStaticIpPoolArgs
            {
                EndAddress = "string",
                StartAddress = "string",
            },
        },
        StaticIpPools = new[]
        {
            new Vcd.Inputs.NsxtNetworkImportedStaticIpPoolArgs
            {
                EndAddress = "string",
                StartAddress = "string",
            },
        },
    });
    
    example, err := vcd.NewNsxtNetworkImported(ctx, "nsxtNetworkImportedResource", &vcd.NsxtNetworkImportedArgs{
    	Gateway:               pulumi.String("string"),
    	PrefixLength:          pulumi.Float64(0),
    	DualStackEnabled:      pulumi.Bool(false),
    	NsxtNetworkImportedId: pulumi.String("string"),
    	Description:           pulumi.String("string"),
    	DvpgName:              pulumi.String("string"),
    	Dns2:                  pulumi.String("string"),
    	Name:                  pulumi.String("string"),
    	NsxtLogicalSwitchName: pulumi.String("string"),
    	DnsSuffix:             pulumi.String("string"),
    	Org:                   pulumi.String("string"),
    	OwnerId:               pulumi.String("string"),
    	Dns1:                  pulumi.String("string"),
    	SecondaryGateway:      pulumi.String("string"),
    	SecondaryPrefixLength: pulumi.String("string"),
    	SecondaryStaticIpPools: vcd.NsxtNetworkImportedSecondaryStaticIpPoolArray{
    		&vcd.NsxtNetworkImportedSecondaryStaticIpPoolArgs{
    			EndAddress:   pulumi.String("string"),
    			StartAddress: pulumi.String("string"),
    		},
    	},
    	StaticIpPools: vcd.NsxtNetworkImportedStaticIpPoolArray{
    		&vcd.NsxtNetworkImportedStaticIpPoolArgs{
    			EndAddress:   pulumi.String("string"),
    			StartAddress: pulumi.String("string"),
    		},
    	},
    })
    
    var nsxtNetworkImportedResource = new NsxtNetworkImported("nsxtNetworkImportedResource", NsxtNetworkImportedArgs.builder()
        .gateway("string")
        .prefixLength(0)
        .dualStackEnabled(false)
        .nsxtNetworkImportedId("string")
        .description("string")
        .dvpgName("string")
        .dns2("string")
        .name("string")
        .nsxtLogicalSwitchName("string")
        .dnsSuffix("string")
        .org("string")
        .ownerId("string")
        .dns1("string")
        .secondaryGateway("string")
        .secondaryPrefixLength("string")
        .secondaryStaticIpPools(NsxtNetworkImportedSecondaryStaticIpPoolArgs.builder()
            .endAddress("string")
            .startAddress("string")
            .build())
        .staticIpPools(NsxtNetworkImportedStaticIpPoolArgs.builder()
            .endAddress("string")
            .startAddress("string")
            .build())
        .build());
    
    nsxt_network_imported_resource = vcd.NsxtNetworkImported("nsxtNetworkImportedResource",
        gateway="string",
        prefix_length=0,
        dual_stack_enabled=False,
        nsxt_network_imported_id="string",
        description="string",
        dvpg_name="string",
        dns2="string",
        name="string",
        nsxt_logical_switch_name="string",
        dns_suffix="string",
        org="string",
        owner_id="string",
        dns1="string",
        secondary_gateway="string",
        secondary_prefix_length="string",
        secondary_static_ip_pools=[{
            "end_address": "string",
            "start_address": "string",
        }],
        static_ip_pools=[{
            "end_address": "string",
            "start_address": "string",
        }])
    
    const nsxtNetworkImportedResource = new vcd.NsxtNetworkImported("nsxtNetworkImportedResource", {
        gateway: "string",
        prefixLength: 0,
        dualStackEnabled: false,
        nsxtNetworkImportedId: "string",
        description: "string",
        dvpgName: "string",
        dns2: "string",
        name: "string",
        nsxtLogicalSwitchName: "string",
        dnsSuffix: "string",
        org: "string",
        ownerId: "string",
        dns1: "string",
        secondaryGateway: "string",
        secondaryPrefixLength: "string",
        secondaryStaticIpPools: [{
            endAddress: "string",
            startAddress: "string",
        }],
        staticIpPools: [{
            endAddress: "string",
            startAddress: "string",
        }],
    });
    
    type: vcd:NsxtNetworkImported
    properties:
        description: string
        dns1: string
        dns2: string
        dnsSuffix: string
        dualStackEnabled: false
        dvpgName: string
        gateway: string
        name: string
        nsxtLogicalSwitchName: string
        nsxtNetworkImportedId: string
        org: string
        ownerId: string
        prefixLength: 0
        secondaryGateway: string
        secondaryPrefixLength: string
        secondaryStaticIpPools:
            - endAddress: string
              startAddress: string
        staticIpPools:
            - endAddress: string
              startAddress: string
    

    NsxtNetworkImported 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 NsxtNetworkImported resource accepts the following input properties:

    Gateway string
    The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)
    PrefixLength double
    The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).
    Description string
    An optional description of the network
    Dns1 string
    First DNS server to use.
    Dns2 string
    Second DNS server to use.
    DnsSuffix string
    A FQDN for the virtual machines on this network
    DualStackEnabled bool
    Enables Dual-Stack mode so that one can configure one IPv4 and one IPv6 networks. Note In such case IPv4 addresses must be used in gateway, prefix_length and static_ip_pool while IPv6 addresses in secondary_gateway, secondary_prefix_length and secondary_static_ip_pool fields.
    DvpgName string

    Unique name of an existing Distributed Virtual Port Group (DVPG). Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in dvpg_id attribute.

    One of nsxt_logical_switch_name or dvpg_name must be provided.

    Name string
    A unique name for the network
    NsxtLogicalSwitchName string

    Unique name of an existing NSX-T segment. Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in nsxt_logical_switch_id attribute.

    This resource will fail if multiple segments with the same name are available. One can rename them in NSX-T manager to make them unique.

    NsxtNetworkImportedId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    OwnerId string
    VDC or VDC Group ID. Always takes precedence over vdc fields (in resource and inherited from provider configuration)
    SecondaryGateway string
    IPv6 gateway when Dual-Stack mode is enabled
    SecondaryPrefixLength string
    IPv6 prefix length when Dual-Stack mode is enabled
    SecondaryStaticIpPools List<NsxtNetworkImportedSecondaryStaticIpPool>

    One or more IPv6 static pools when Dual-Stack mode is enabled

    When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g. 2002::1234:abcd:ffff:c0a6:121 will be converted to 2002:0:0:1234:abcd:ffff:c0a6:121)

    StaticIpPools List<NsxtNetworkImportedStaticIpPool>
    A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.
    Vdc string
    The name of VDC to use. Deprecated in favor of new field owner_id which supports VDC and VDC Group IDs.

    Deprecated: Deprecated

    Gateway string
    The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)
    PrefixLength float64
    The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).
    Description string
    An optional description of the network
    Dns1 string
    First DNS server to use.
    Dns2 string
    Second DNS server to use.
    DnsSuffix string
    A FQDN for the virtual machines on this network
    DualStackEnabled bool
    Enables Dual-Stack mode so that one can configure one IPv4 and one IPv6 networks. Note In such case IPv4 addresses must be used in gateway, prefix_length and static_ip_pool while IPv6 addresses in secondary_gateway, secondary_prefix_length and secondary_static_ip_pool fields.
    DvpgName string

    Unique name of an existing Distributed Virtual Port Group (DVPG). Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in dvpg_id attribute.

    One of nsxt_logical_switch_name or dvpg_name must be provided.

    Name string
    A unique name for the network
    NsxtLogicalSwitchName string

    Unique name of an existing NSX-T segment. Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in nsxt_logical_switch_id attribute.

    This resource will fail if multiple segments with the same name are available. One can rename them in NSX-T manager to make them unique.

    NsxtNetworkImportedId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    OwnerId string
    VDC or VDC Group ID. Always takes precedence over vdc fields (in resource and inherited from provider configuration)
    SecondaryGateway string
    IPv6 gateway when Dual-Stack mode is enabled
    SecondaryPrefixLength string
    IPv6 prefix length when Dual-Stack mode is enabled
    SecondaryStaticIpPools []NsxtNetworkImportedSecondaryStaticIpPoolArgs

    One or more IPv6 static pools when Dual-Stack mode is enabled

    When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g. 2002::1234:abcd:ffff:c0a6:121 will be converted to 2002:0:0:1234:abcd:ffff:c0a6:121)

    StaticIpPools []NsxtNetworkImportedStaticIpPoolArgs
    A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.
    Vdc string
    The name of VDC to use. Deprecated in favor of new field owner_id which supports VDC and VDC Group IDs.

    Deprecated: Deprecated

    gateway String
    The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)
    prefixLength Double
    The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).
    description String
    An optional description of the network
    dns1 String
    First DNS server to use.
    dns2 String
    Second DNS server to use.
    dnsSuffix String
    A FQDN for the virtual machines on this network
    dualStackEnabled Boolean
    Enables Dual-Stack mode so that one can configure one IPv4 and one IPv6 networks. Note In such case IPv4 addresses must be used in gateway, prefix_length and static_ip_pool while IPv6 addresses in secondary_gateway, secondary_prefix_length and secondary_static_ip_pool fields.
    dvpgName String

    Unique name of an existing Distributed Virtual Port Group (DVPG). Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in dvpg_id attribute.

    One of nsxt_logical_switch_name or dvpg_name must be provided.

    name String
    A unique name for the network
    nsxtLogicalSwitchName String

    Unique name of an existing NSX-T segment. Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in nsxt_logical_switch_id attribute.

    This resource will fail if multiple segments with the same name are available. One can rename them in NSX-T manager to make them unique.

    nsxtNetworkImportedId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    ownerId String
    VDC or VDC Group ID. Always takes precedence over vdc fields (in resource and inherited from provider configuration)
    secondaryGateway String
    IPv6 gateway when Dual-Stack mode is enabled
    secondaryPrefixLength String
    IPv6 prefix length when Dual-Stack mode is enabled
    secondaryStaticIpPools List<NsxtNetworkImportedSecondaryStaticIpPool>

    One or more IPv6 static pools when Dual-Stack mode is enabled

    When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g. 2002::1234:abcd:ffff:c0a6:121 will be converted to 2002:0:0:1234:abcd:ffff:c0a6:121)

    staticIpPools List<NsxtNetworkImportedStaticIpPool>
    A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.
    vdc String
    The name of VDC to use. Deprecated in favor of new field owner_id which supports VDC and VDC Group IDs.

    Deprecated: Deprecated

    gateway string
    The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)
    prefixLength number
    The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).
    description string
    An optional description of the network
    dns1 string
    First DNS server to use.
    dns2 string
    Second DNS server to use.
    dnsSuffix string
    A FQDN for the virtual machines on this network
    dualStackEnabled boolean
    Enables Dual-Stack mode so that one can configure one IPv4 and one IPv6 networks. Note In such case IPv4 addresses must be used in gateway, prefix_length and static_ip_pool while IPv6 addresses in secondary_gateway, secondary_prefix_length and secondary_static_ip_pool fields.
    dvpgName string

    Unique name of an existing Distributed Virtual Port Group (DVPG). Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in dvpg_id attribute.

    One of nsxt_logical_switch_name or dvpg_name must be provided.

    name string
    A unique name for the network
    nsxtLogicalSwitchName string

    Unique name of an existing NSX-T segment. Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in nsxt_logical_switch_id attribute.

    This resource will fail if multiple segments with the same name are available. One can rename them in NSX-T manager to make them unique.

    nsxtNetworkImportedId string
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    ownerId string
    VDC or VDC Group ID. Always takes precedence over vdc fields (in resource and inherited from provider configuration)
    secondaryGateway string
    IPv6 gateway when Dual-Stack mode is enabled
    secondaryPrefixLength string
    IPv6 prefix length when Dual-Stack mode is enabled
    secondaryStaticIpPools NsxtNetworkImportedSecondaryStaticIpPool[]

    One or more IPv6 static pools when Dual-Stack mode is enabled

    When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g. 2002::1234:abcd:ffff:c0a6:121 will be converted to 2002:0:0:1234:abcd:ffff:c0a6:121)

    staticIpPools NsxtNetworkImportedStaticIpPool[]
    A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.
    vdc string
    The name of VDC to use. Deprecated in favor of new field owner_id which supports VDC and VDC Group IDs.

    Deprecated: Deprecated

    gateway str
    The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)
    prefix_length float
    The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).
    description str
    An optional description of the network
    dns1 str
    First DNS server to use.
    dns2 str
    Second DNS server to use.
    dns_suffix str
    A FQDN for the virtual machines on this network
    dual_stack_enabled bool
    Enables Dual-Stack mode so that one can configure one IPv4 and one IPv6 networks. Note In such case IPv4 addresses must be used in gateway, prefix_length and static_ip_pool while IPv6 addresses in secondary_gateway, secondary_prefix_length and secondary_static_ip_pool fields.
    dvpg_name str

    Unique name of an existing Distributed Virtual Port Group (DVPG). Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in dvpg_id attribute.

    One of nsxt_logical_switch_name or dvpg_name must be provided.

    name str
    A unique name for the network
    nsxt_logical_switch_name str

    Unique name of an existing NSX-T segment. Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in nsxt_logical_switch_id attribute.

    This resource will fail if multiple segments with the same name are available. One can rename them in NSX-T manager to make them unique.

    nsxt_network_imported_id str
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    owner_id str
    VDC or VDC Group ID. Always takes precedence over vdc fields (in resource and inherited from provider configuration)
    secondary_gateway str
    IPv6 gateway when Dual-Stack mode is enabled
    secondary_prefix_length str
    IPv6 prefix length when Dual-Stack mode is enabled
    secondary_static_ip_pools Sequence[NsxtNetworkImportedSecondaryStaticIpPoolArgs]

    One or more IPv6 static pools when Dual-Stack mode is enabled

    When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g. 2002::1234:abcd:ffff:c0a6:121 will be converted to 2002:0:0:1234:abcd:ffff:c0a6:121)

    static_ip_pools Sequence[NsxtNetworkImportedStaticIpPoolArgs]
    A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.
    vdc str
    The name of VDC to use. Deprecated in favor of new field owner_id which supports VDC and VDC Group IDs.

    Deprecated: Deprecated

    gateway String
    The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)
    prefixLength Number
    The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).
    description String
    An optional description of the network
    dns1 String
    First DNS server to use.
    dns2 String
    Second DNS server to use.
    dnsSuffix String
    A FQDN for the virtual machines on this network
    dualStackEnabled Boolean
    Enables Dual-Stack mode so that one can configure one IPv4 and one IPv6 networks. Note In such case IPv4 addresses must be used in gateway, prefix_length and static_ip_pool while IPv6 addresses in secondary_gateway, secondary_prefix_length and secondary_static_ip_pool fields.
    dvpgName String

    Unique name of an existing Distributed Virtual Port Group (DVPG). Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in dvpg_id attribute.

    One of nsxt_logical_switch_name or dvpg_name must be provided.

    name String
    A unique name for the network
    nsxtLogicalSwitchName String

    Unique name of an existing NSX-T segment. Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in nsxt_logical_switch_id attribute.

    This resource will fail if multiple segments with the same name are available. One can rename them in NSX-T manager to make them unique.

    nsxtNetworkImportedId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    ownerId String
    VDC or VDC Group ID. Always takes precedence over vdc fields (in resource and inherited from provider configuration)
    secondaryGateway String
    IPv6 gateway when Dual-Stack mode is enabled
    secondaryPrefixLength String
    IPv6 prefix length when Dual-Stack mode is enabled
    secondaryStaticIpPools List<Property Map>

    One or more IPv6 static pools when Dual-Stack mode is enabled

    When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g. 2002::1234:abcd:ffff:c0a6:121 will be converted to 2002:0:0:1234:abcd:ffff:c0a6:121)

    staticIpPools List<Property Map>
    A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.
    vdc String
    The name of VDC to use. Deprecated in favor of new field owner_id which supports VDC and VDC Group IDs.

    Deprecated: Deprecated

    Outputs

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

    DvpgId string
    ID of Distributed Virtual Port Group used by this network
    Id string
    The provider-assigned unique ID for this managed resource.
    NsxtLogicalSwitchId string
    ID of NSX-T logical switch used by this network
    DvpgId string
    ID of Distributed Virtual Port Group used by this network
    Id string
    The provider-assigned unique ID for this managed resource.
    NsxtLogicalSwitchId string
    ID of NSX-T logical switch used by this network
    dvpgId String
    ID of Distributed Virtual Port Group used by this network
    id String
    The provider-assigned unique ID for this managed resource.
    nsxtLogicalSwitchId String
    ID of NSX-T logical switch used by this network
    dvpgId string
    ID of Distributed Virtual Port Group used by this network
    id string
    The provider-assigned unique ID for this managed resource.
    nsxtLogicalSwitchId string
    ID of NSX-T logical switch used by this network
    dvpg_id str
    ID of Distributed Virtual Port Group used by this network
    id str
    The provider-assigned unique ID for this managed resource.
    nsxt_logical_switch_id str
    ID of NSX-T logical switch used by this network
    dvpgId String
    ID of Distributed Virtual Port Group used by this network
    id String
    The provider-assigned unique ID for this managed resource.
    nsxtLogicalSwitchId String
    ID of NSX-T logical switch used by this network

    Look up Existing NsxtNetworkImported Resource

    Get an existing NsxtNetworkImported 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?: NsxtNetworkImportedState, opts?: CustomResourceOptions): NsxtNetworkImported
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            dns1: Optional[str] = None,
            dns2: Optional[str] = None,
            dns_suffix: Optional[str] = None,
            dual_stack_enabled: Optional[bool] = None,
            dvpg_id: Optional[str] = None,
            dvpg_name: Optional[str] = None,
            gateway: Optional[str] = None,
            name: Optional[str] = None,
            nsxt_logical_switch_id: Optional[str] = None,
            nsxt_logical_switch_name: Optional[str] = None,
            nsxt_network_imported_id: Optional[str] = None,
            org: Optional[str] = None,
            owner_id: Optional[str] = None,
            prefix_length: Optional[float] = None,
            secondary_gateway: Optional[str] = None,
            secondary_prefix_length: Optional[str] = None,
            secondary_static_ip_pools: Optional[Sequence[NsxtNetworkImportedSecondaryStaticIpPoolArgs]] = None,
            static_ip_pools: Optional[Sequence[NsxtNetworkImportedStaticIpPoolArgs]] = None,
            vdc: Optional[str] = None) -> NsxtNetworkImported
    func GetNsxtNetworkImported(ctx *Context, name string, id IDInput, state *NsxtNetworkImportedState, opts ...ResourceOption) (*NsxtNetworkImported, error)
    public static NsxtNetworkImported Get(string name, Input<string> id, NsxtNetworkImportedState? state, CustomResourceOptions? opts = null)
    public static NsxtNetworkImported get(String name, Output<String> id, NsxtNetworkImportedState state, CustomResourceOptions options)
    resources:  _:    type: vcd:NsxtNetworkImported    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:
    Description string
    An optional description of the network
    Dns1 string
    First DNS server to use.
    Dns2 string
    Second DNS server to use.
    DnsSuffix string
    A FQDN for the virtual machines on this network
    DualStackEnabled bool
    Enables Dual-Stack mode so that one can configure one IPv4 and one IPv6 networks. Note In such case IPv4 addresses must be used in gateway, prefix_length and static_ip_pool while IPv6 addresses in secondary_gateway, secondary_prefix_length and secondary_static_ip_pool fields.
    DvpgId string
    ID of Distributed Virtual Port Group used by this network
    DvpgName string

    Unique name of an existing Distributed Virtual Port Group (DVPG). Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in dvpg_id attribute.

    One of nsxt_logical_switch_name or dvpg_name must be provided.

    Gateway string
    The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)
    Name string
    A unique name for the network
    NsxtLogicalSwitchId string
    ID of NSX-T logical switch used by this network
    NsxtLogicalSwitchName string

    Unique name of an existing NSX-T segment. Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in nsxt_logical_switch_id attribute.

    This resource will fail if multiple segments with the same name are available. One can rename them in NSX-T manager to make them unique.

    NsxtNetworkImportedId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    OwnerId string
    VDC or VDC Group ID. Always takes precedence over vdc fields (in resource and inherited from provider configuration)
    PrefixLength double
    The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).
    SecondaryGateway string
    IPv6 gateway when Dual-Stack mode is enabled
    SecondaryPrefixLength string
    IPv6 prefix length when Dual-Stack mode is enabled
    SecondaryStaticIpPools List<NsxtNetworkImportedSecondaryStaticIpPool>

    One or more IPv6 static pools when Dual-Stack mode is enabled

    When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g. 2002::1234:abcd:ffff:c0a6:121 will be converted to 2002:0:0:1234:abcd:ffff:c0a6:121)

    StaticIpPools List<NsxtNetworkImportedStaticIpPool>
    A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.
    Vdc string
    The name of VDC to use. Deprecated in favor of new field owner_id which supports VDC and VDC Group IDs.

    Deprecated: Deprecated

    Description string
    An optional description of the network
    Dns1 string
    First DNS server to use.
    Dns2 string
    Second DNS server to use.
    DnsSuffix string
    A FQDN for the virtual machines on this network
    DualStackEnabled bool
    Enables Dual-Stack mode so that one can configure one IPv4 and one IPv6 networks. Note In such case IPv4 addresses must be used in gateway, prefix_length and static_ip_pool while IPv6 addresses in secondary_gateway, secondary_prefix_length and secondary_static_ip_pool fields.
    DvpgId string
    ID of Distributed Virtual Port Group used by this network
    DvpgName string

    Unique name of an existing Distributed Virtual Port Group (DVPG). Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in dvpg_id attribute.

    One of nsxt_logical_switch_name or dvpg_name must be provided.

    Gateway string
    The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)
    Name string
    A unique name for the network
    NsxtLogicalSwitchId string
    ID of NSX-T logical switch used by this network
    NsxtLogicalSwitchName string

    Unique name of an existing NSX-T segment. Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in nsxt_logical_switch_id attribute.

    This resource will fail if multiple segments with the same name are available. One can rename them in NSX-T manager to make them unique.

    NsxtNetworkImportedId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    OwnerId string
    VDC or VDC Group ID. Always takes precedence over vdc fields (in resource and inherited from provider configuration)
    PrefixLength float64
    The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).
    SecondaryGateway string
    IPv6 gateway when Dual-Stack mode is enabled
    SecondaryPrefixLength string
    IPv6 prefix length when Dual-Stack mode is enabled
    SecondaryStaticIpPools []NsxtNetworkImportedSecondaryStaticIpPoolArgs

    One or more IPv6 static pools when Dual-Stack mode is enabled

    When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g. 2002::1234:abcd:ffff:c0a6:121 will be converted to 2002:0:0:1234:abcd:ffff:c0a6:121)

    StaticIpPools []NsxtNetworkImportedStaticIpPoolArgs
    A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.
    Vdc string
    The name of VDC to use. Deprecated in favor of new field owner_id which supports VDC and VDC Group IDs.

    Deprecated: Deprecated

    description String
    An optional description of the network
    dns1 String
    First DNS server to use.
    dns2 String
    Second DNS server to use.
    dnsSuffix String
    A FQDN for the virtual machines on this network
    dualStackEnabled Boolean
    Enables Dual-Stack mode so that one can configure one IPv4 and one IPv6 networks. Note In such case IPv4 addresses must be used in gateway, prefix_length and static_ip_pool while IPv6 addresses in secondary_gateway, secondary_prefix_length and secondary_static_ip_pool fields.
    dvpgId String
    ID of Distributed Virtual Port Group used by this network
    dvpgName String

    Unique name of an existing Distributed Virtual Port Group (DVPG). Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in dvpg_id attribute.

    One of nsxt_logical_switch_name or dvpg_name must be provided.

    gateway String
    The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)
    name String
    A unique name for the network
    nsxtLogicalSwitchId String
    ID of NSX-T logical switch used by this network
    nsxtLogicalSwitchName String

    Unique name of an existing NSX-T segment. Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in nsxt_logical_switch_id attribute.

    This resource will fail if multiple segments with the same name are available. One can rename them in NSX-T manager to make them unique.

    nsxtNetworkImportedId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    ownerId String
    VDC or VDC Group ID. Always takes precedence over vdc fields (in resource and inherited from provider configuration)
    prefixLength Double
    The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).
    secondaryGateway String
    IPv6 gateway when Dual-Stack mode is enabled
    secondaryPrefixLength String
    IPv6 prefix length when Dual-Stack mode is enabled
    secondaryStaticIpPools List<NsxtNetworkImportedSecondaryStaticIpPool>

    One or more IPv6 static pools when Dual-Stack mode is enabled

    When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g. 2002::1234:abcd:ffff:c0a6:121 will be converted to 2002:0:0:1234:abcd:ffff:c0a6:121)

    staticIpPools List<NsxtNetworkImportedStaticIpPool>
    A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.
    vdc String
    The name of VDC to use. Deprecated in favor of new field owner_id which supports VDC and VDC Group IDs.

    Deprecated: Deprecated

    description string
    An optional description of the network
    dns1 string
    First DNS server to use.
    dns2 string
    Second DNS server to use.
    dnsSuffix string
    A FQDN for the virtual machines on this network
    dualStackEnabled boolean
    Enables Dual-Stack mode so that one can configure one IPv4 and one IPv6 networks. Note In such case IPv4 addresses must be used in gateway, prefix_length and static_ip_pool while IPv6 addresses in secondary_gateway, secondary_prefix_length and secondary_static_ip_pool fields.
    dvpgId string
    ID of Distributed Virtual Port Group used by this network
    dvpgName string

    Unique name of an existing Distributed Virtual Port Group (DVPG). Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in dvpg_id attribute.

    One of nsxt_logical_switch_name or dvpg_name must be provided.

    gateway string
    The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)
    name string
    A unique name for the network
    nsxtLogicalSwitchId string
    ID of NSX-T logical switch used by this network
    nsxtLogicalSwitchName string

    Unique name of an existing NSX-T segment. Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in nsxt_logical_switch_id attribute.

    This resource will fail if multiple segments with the same name are available. One can rename them in NSX-T manager to make them unique.

    nsxtNetworkImportedId string
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    ownerId string
    VDC or VDC Group ID. Always takes precedence over vdc fields (in resource and inherited from provider configuration)
    prefixLength number
    The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).
    secondaryGateway string
    IPv6 gateway when Dual-Stack mode is enabled
    secondaryPrefixLength string
    IPv6 prefix length when Dual-Stack mode is enabled
    secondaryStaticIpPools NsxtNetworkImportedSecondaryStaticIpPool[]

    One or more IPv6 static pools when Dual-Stack mode is enabled

    When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g. 2002::1234:abcd:ffff:c0a6:121 will be converted to 2002:0:0:1234:abcd:ffff:c0a6:121)

    staticIpPools NsxtNetworkImportedStaticIpPool[]
    A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.
    vdc string
    The name of VDC to use. Deprecated in favor of new field owner_id which supports VDC and VDC Group IDs.

    Deprecated: Deprecated

    description str
    An optional description of the network
    dns1 str
    First DNS server to use.
    dns2 str
    Second DNS server to use.
    dns_suffix str
    A FQDN for the virtual machines on this network
    dual_stack_enabled bool
    Enables Dual-Stack mode so that one can configure one IPv4 and one IPv6 networks. Note In such case IPv4 addresses must be used in gateway, prefix_length and static_ip_pool while IPv6 addresses in secondary_gateway, secondary_prefix_length and secondary_static_ip_pool fields.
    dvpg_id str
    ID of Distributed Virtual Port Group used by this network
    dvpg_name str

    Unique name of an existing Distributed Virtual Port Group (DVPG). Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in dvpg_id attribute.

    One of nsxt_logical_switch_name or dvpg_name must be provided.

    gateway str
    The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)
    name str
    A unique name for the network
    nsxt_logical_switch_id str
    ID of NSX-T logical switch used by this network
    nsxt_logical_switch_name str

    Unique name of an existing NSX-T segment. Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in nsxt_logical_switch_id attribute.

    This resource will fail if multiple segments with the same name are available. One can rename them in NSX-T manager to make them unique.

    nsxt_network_imported_id str
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    owner_id str
    VDC or VDC Group ID. Always takes precedence over vdc fields (in resource and inherited from provider configuration)
    prefix_length float
    The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).
    secondary_gateway str
    IPv6 gateway when Dual-Stack mode is enabled
    secondary_prefix_length str
    IPv6 prefix length when Dual-Stack mode is enabled
    secondary_static_ip_pools Sequence[NsxtNetworkImportedSecondaryStaticIpPoolArgs]

    One or more IPv6 static pools when Dual-Stack mode is enabled

    When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g. 2002::1234:abcd:ffff:c0a6:121 will be converted to 2002:0:0:1234:abcd:ffff:c0a6:121)

    static_ip_pools Sequence[NsxtNetworkImportedStaticIpPoolArgs]
    A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.
    vdc str
    The name of VDC to use. Deprecated in favor of new field owner_id which supports VDC and VDC Group IDs.

    Deprecated: Deprecated

    description String
    An optional description of the network
    dns1 String
    First DNS server to use.
    dns2 String
    Second DNS server to use.
    dnsSuffix String
    A FQDN for the virtual machines on this network
    dualStackEnabled Boolean
    Enables Dual-Stack mode so that one can configure one IPv4 and one IPv6 networks. Note In such case IPv4 addresses must be used in gateway, prefix_length and static_ip_pool while IPv6 addresses in secondary_gateway, secondary_prefix_length and secondary_static_ip_pool fields.
    dvpgId String
    ID of Distributed Virtual Port Group used by this network
    dvpgName String

    Unique name of an existing Distributed Virtual Port Group (DVPG). Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in dvpg_id attribute.

    One of nsxt_logical_switch_name or dvpg_name must be provided.

    gateway String
    The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)
    name String
    A unique name for the network
    nsxtLogicalSwitchId String
    ID of NSX-T logical switch used by this network
    nsxtLogicalSwitchName String

    Unique name of an existing NSX-T segment. Note it will never be refreshed because API does not allow reading this name after it is consumed. Instead ID will be stored in nsxt_logical_switch_id attribute.

    This resource will fail if multiple segments with the same name are available. One can rename them in NSX-T manager to make them unique.

    nsxtNetworkImportedId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    ownerId String
    VDC or VDC Group ID. Always takes precedence over vdc fields (in resource and inherited from provider configuration)
    prefixLength Number
    The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).
    secondaryGateway String
    IPv6 gateway when Dual-Stack mode is enabled
    secondaryPrefixLength String
    IPv6 prefix length when Dual-Stack mode is enabled
    secondaryStaticIpPools List<Property Map>

    One or more IPv6 static pools when Dual-Stack mode is enabled

    When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g. 2002::1234:abcd:ffff:c0a6:121 will be converted to 2002:0:0:1234:abcd:ffff:c0a6:121)

    staticIpPools List<Property Map>
    A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.
    vdc String
    The name of VDC to use. Deprecated in favor of new field owner_id which supports VDC and VDC Group IDs.

    Deprecated: Deprecated

    Supporting Types

    NsxtNetworkImportedSecondaryStaticIpPool, NsxtNetworkImportedSecondaryStaticIpPoolArgs

    EndAddress string
    End address of the IP range
    StartAddress string
    Start address of the IP range
    EndAddress string
    End address of the IP range
    StartAddress string
    Start address of the IP range
    endAddress String
    End address of the IP range
    startAddress String
    Start address of the IP range
    endAddress string
    End address of the IP range
    startAddress string
    Start address of the IP range
    end_address str
    End address of the IP range
    start_address str
    Start address of the IP range
    endAddress String
    End address of the IP range
    startAddress String
    Start address of the IP range

    NsxtNetworkImportedStaticIpPool, NsxtNetworkImportedStaticIpPoolArgs

    EndAddress string
    End address of the IP range
    StartAddress string
    Start address of the IP range
    EndAddress string
    End address of the IP range
    StartAddress string
    Start address of the IP range
    endAddress String
    End address of the IP range
    startAddress String
    Start address of the IP range
    endAddress string
    End address of the IP range
    startAddress string
    Start address of the IP range
    end_address str
    End address of the IP range
    start_address str
    Start address of the IP range
    endAddress String
    End address of the IP range
    startAddress String
    Start address of the IP range

    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