1. Packages
  2. Avi Provider
  3. API Docs
  4. Network
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

avi.Network

Explore with Pulumi AI

<!–

Copyright 2021 VMware, Inc.
SPDX-License-Identifier: Mozilla Public License 2.0

–>

layout: “avi”

page_title: “Avi: avi.Network” sidebar_current: “docs-avi-resource-network” description: |- Creates and manages Avi Network.

avi.Network

The Network resource allows the creation and management of Avi Network

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as avi from "@pulumi/avi";

const foo = new avi.Network("foo", {tenantRef: "/api/tenant/?name=admin"});
Copy
import pulumi
import pulumi_avi as avi

foo = avi.Network("foo", tenant_ref="/api/tenant/?name=admin")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v31/avi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avi.NewNetwork(ctx, "foo", &avi.NetworkArgs{
			TenantRef: pulumi.String("/api/tenant/?name=admin"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Avi = Pulumi.Avi;

return await Deployment.RunAsync(() => 
{
    var foo = new Avi.Network("foo", new()
    {
        TenantRef = "/api/tenant/?name=admin",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.Network;
import com.pulumi.avi.NetworkArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var foo = new Network("foo", NetworkArgs.builder()
            .tenantRef("/api/tenant/?name=admin")
            .build());

    }
}
Copy
resources:
  foo:
    type: avi:Network
    properties:
      tenantRef: /api/tenant/?name=admin
Copy

Create Network Resource

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

Constructor syntax

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

@overload
def Network(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            attrs: Optional[Sequence[NetworkAttrArgs]] = None,
            cloud_ref: Optional[str] = None,
            configpb_attributes: Optional[Sequence[NetworkConfigpbAttributeArgs]] = None,
            configured_subnets: Optional[Sequence[NetworkConfiguredSubnetArgs]] = None,
            dhcp_enabled: Optional[str] = None,
            exclude_discovered_subnets: Optional[str] = None,
            ip6_autocfg_enabled: Optional[str] = None,
            markers: Optional[Sequence[NetworkMarkerArgs]] = None,
            name: Optional[str] = None,
            network_id: Optional[str] = None,
            synced_from_se: Optional[str] = None,
            tenant_ref: Optional[str] = None,
            uuid: Optional[str] = None,
            vcenter_dvs: Optional[str] = None,
            vimgrnw_ref: Optional[str] = None,
            vrf_context_ref: Optional[str] = None)
func NewNetwork(ctx *Context, name string, args *NetworkArgs, opts ...ResourceOption) (*Network, error)
public Network(string name, NetworkArgs? args = null, CustomResourceOptions? opts = null)
public Network(String name, NetworkArgs args)
public Network(String name, NetworkArgs args, CustomResourceOptions options)
type: avi:Network
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args NetworkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args NetworkArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args NetworkArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args NetworkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. NetworkArgs
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 networkResource = new Avi.Network("networkResource", new()
{
    Attrs = new[]
    {
        new Avi.Inputs.NetworkAttrArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    CloudRef = "string",
    ConfigpbAttributes = new[]
    {
        new Avi.Inputs.NetworkConfigpbAttributeArgs
        {
            Version = "string",
        },
    },
    ConfiguredSubnets = new[]
    {
        new Avi.Inputs.NetworkConfiguredSubnetArgs
        {
            Prefixes = new[]
            {
                new Avi.Inputs.NetworkConfiguredSubnetPrefixArgs
                {
                    IpAddrs = new[]
                    {
                        new Avi.Inputs.NetworkConfiguredSubnetPrefixIpAddrArgs
                        {
                            Addr = "string",
                            Type = "string",
                        },
                    },
                    Mask = "string",
                },
            },
            StaticIpRanges = new[]
            {
                new Avi.Inputs.NetworkConfiguredSubnetStaticIpRangeArgs
                {
                    Ranges = new[]
                    {
                        new Avi.Inputs.NetworkConfiguredSubnetStaticIpRangeRangeArgs
                        {
                            Begins = new[]
                            {
                                new Avi.Inputs.NetworkConfiguredSubnetStaticIpRangeRangeBeginArgs
                                {
                                    Addr = "string",
                                    Type = "string",
                                },
                            },
                            Ends = new[]
                            {
                                new Avi.Inputs.NetworkConfiguredSubnetStaticIpRangeRangeEndArgs
                                {
                                    Addr = "string",
                                    Type = "string",
                                },
                            },
                        },
                    },
                    Type = "string",
                },
            },
        },
    },
    DhcpEnabled = "string",
    ExcludeDiscoveredSubnets = "string",
    Ip6AutocfgEnabled = "string",
    Markers = new[]
    {
        new Avi.Inputs.NetworkMarkerArgs
        {
            Key = "string",
            Values = new[]
            {
                "string",
            },
        },
    },
    Name = "string",
    NetworkId = "string",
    SyncedFromSe = "string",
    TenantRef = "string",
    Uuid = "string",
    VcenterDvs = "string",
    VimgrnwRef = "string",
    VrfContextRef = "string",
});
Copy
example, err := avi.NewNetwork(ctx, "networkResource", &avi.NetworkArgs{
Attrs: .NetworkAttrArray{
&.NetworkAttrArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
CloudRef: pulumi.String("string"),
ConfigpbAttributes: .NetworkConfigpbAttributeArray{
&.NetworkConfigpbAttributeArgs{
Version: pulumi.String("string"),
},
},
ConfiguredSubnets: .NetworkConfiguredSubnetArray{
&.NetworkConfiguredSubnetArgs{
Prefixes: .NetworkConfiguredSubnetPrefixArray{
&.NetworkConfiguredSubnetPrefixArgs{
IpAddrs: .NetworkConfiguredSubnetPrefixIpAddrArray{
&.NetworkConfiguredSubnetPrefixIpAddrArgs{
Addr: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Mask: pulumi.String("string"),
},
},
StaticIpRanges: .NetworkConfiguredSubnetStaticIpRangeArray{
&.NetworkConfiguredSubnetStaticIpRangeArgs{
Ranges: .NetworkConfiguredSubnetStaticIpRangeRangeArray{
&.NetworkConfiguredSubnetStaticIpRangeRangeArgs{
Begins: .NetworkConfiguredSubnetStaticIpRangeRangeBeginArray{
&.NetworkConfiguredSubnetStaticIpRangeRangeBeginArgs{
Addr: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Ends: .NetworkConfiguredSubnetStaticIpRangeRangeEndArray{
&.NetworkConfiguredSubnetStaticIpRangeRangeEndArgs{
Addr: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
},
},
Type: pulumi.String("string"),
},
},
},
},
DhcpEnabled: pulumi.String("string"),
ExcludeDiscoveredSubnets: pulumi.String("string"),
Ip6AutocfgEnabled: pulumi.String("string"),
Markers: .NetworkMarkerArray{
&.NetworkMarkerArgs{
Key: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Name: pulumi.String("string"),
NetworkId: pulumi.String("string"),
SyncedFromSe: pulumi.String("string"),
TenantRef: pulumi.String("string"),
Uuid: pulumi.String("string"),
VcenterDvs: pulumi.String("string"),
VimgrnwRef: pulumi.String("string"),
VrfContextRef: pulumi.String("string"),
})
Copy
var networkResource = new Network("networkResource", NetworkArgs.builder()
    .attrs(NetworkAttrArgs.builder()
        .key("string")
        .value("string")
        .build())
    .cloudRef("string")
    .configpbAttributes(NetworkConfigpbAttributeArgs.builder()
        .version("string")
        .build())
    .configuredSubnets(NetworkConfiguredSubnetArgs.builder()
        .prefixes(NetworkConfiguredSubnetPrefixArgs.builder()
            .ipAddrs(NetworkConfiguredSubnetPrefixIpAddrArgs.builder()
                .addr("string")
                .type("string")
                .build())
            .mask("string")
            .build())
        .staticIpRanges(NetworkConfiguredSubnetStaticIpRangeArgs.builder()
            .ranges(NetworkConfiguredSubnetStaticIpRangeRangeArgs.builder()
                .begins(NetworkConfiguredSubnetStaticIpRangeRangeBeginArgs.builder()
                    .addr("string")
                    .type("string")
                    .build())
                .ends(NetworkConfiguredSubnetStaticIpRangeRangeEndArgs.builder()
                    .addr("string")
                    .type("string")
                    .build())
                .build())
            .type("string")
            .build())
        .build())
    .dhcpEnabled("string")
    .excludeDiscoveredSubnets("string")
    .ip6AutocfgEnabled("string")
    .markers(NetworkMarkerArgs.builder()
        .key("string")
        .values("string")
        .build())
    .name("string")
    .networkId("string")
    .syncedFromSe("string")
    .tenantRef("string")
    .uuid("string")
    .vcenterDvs("string")
    .vimgrnwRef("string")
    .vrfContextRef("string")
    .build());
Copy
network_resource = avi.Network("networkResource",
    attrs=[{
        "key": "string",
        "value": "string",
    }],
    cloud_ref="string",
    configpb_attributes=[{
        "version": "string",
    }],
    configured_subnets=[{
        "prefixes": [{
            "ip_addrs": [{
                "addr": "string",
                "type": "string",
            }],
            "mask": "string",
        }],
        "static_ip_ranges": [{
            "ranges": [{
                "begins": [{
                    "addr": "string",
                    "type": "string",
                }],
                "ends": [{
                    "addr": "string",
                    "type": "string",
                }],
            }],
            "type": "string",
        }],
    }],
    dhcp_enabled="string",
    exclude_discovered_subnets="string",
    ip6_autocfg_enabled="string",
    markers=[{
        "key": "string",
        "values": ["string"],
    }],
    name="string",
    network_id="string",
    synced_from_se="string",
    tenant_ref="string",
    uuid="string",
    vcenter_dvs="string",
    vimgrnw_ref="string",
    vrf_context_ref="string")
Copy
const networkResource = new avi.Network("networkResource", {
    attrs: [{
        key: "string",
        value: "string",
    }],
    cloudRef: "string",
    configpbAttributes: [{
        version: "string",
    }],
    configuredSubnets: [{
        prefixes: [{
            ipAddrs: [{
                addr: "string",
                type: "string",
            }],
            mask: "string",
        }],
        staticIpRanges: [{
            ranges: [{
                begins: [{
                    addr: "string",
                    type: "string",
                }],
                ends: [{
                    addr: "string",
                    type: "string",
                }],
            }],
            type: "string",
        }],
    }],
    dhcpEnabled: "string",
    excludeDiscoveredSubnets: "string",
    ip6AutocfgEnabled: "string",
    markers: [{
        key: "string",
        values: ["string"],
    }],
    name: "string",
    networkId: "string",
    syncedFromSe: "string",
    tenantRef: "string",
    uuid: "string",
    vcenterDvs: "string",
    vimgrnwRef: "string",
    vrfContextRef: "string",
});
Copy
type: avi:Network
properties:
    attrs:
        - key: string
          value: string
    cloudRef: string
    configpbAttributes:
        - version: string
    configuredSubnets:
        - prefixes:
            - ipAddrs:
                - addr: string
                  type: string
              mask: string
          staticIpRanges:
            - ranges:
                - begins:
                    - addr: string
                      type: string
                  ends:
                    - addr: string
                      type: string
              type: string
    dhcpEnabled: string
    excludeDiscoveredSubnets: string
    ip6AutocfgEnabled: string
    markers:
        - key: string
          values:
            - string
    name: string
    networkId: string
    syncedFromSe: string
    tenantRef: string
    uuid: string
    vcenterDvs: string
    vimgrnwRef: string
    vrfContextRef: string
Copy

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

Attrs List<NetworkAttr>
Key/value network attributes. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
CloudRef string
It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes List<NetworkConfigpbAttribute>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfiguredSubnets List<NetworkConfiguredSubnet>
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
DhcpEnabled string
Select the ip address management scheme for this network. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ExcludeDiscoveredSubnets string
When selected, excludes all discovered subnets in this network from consideration for virtual service placement. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Ip6AutocfgEnabled string
Enable ipv6 auto configuration. Field introduced in 18.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Markers List<NetworkMarker>
List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
NetworkId string
SyncedFromSe string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
VcenterDvs string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
VimgrnwRef string
It is a reference to an object of type vimgrnwruntime. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
VrfContextRef string
It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Attrs []NetworkAttrArgs
Key/value network attributes. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
CloudRef string
It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes []NetworkConfigpbAttributeArgs
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfiguredSubnets []NetworkConfiguredSubnetArgs
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
DhcpEnabled string
Select the ip address management scheme for this network. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ExcludeDiscoveredSubnets string
When selected, excludes all discovered subnets in this network from consideration for virtual service placement. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Ip6AutocfgEnabled string
Enable ipv6 auto configuration. Field introduced in 18.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Markers []NetworkMarkerArgs
List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
NetworkId string
SyncedFromSe string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
VcenterDvs string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
VimgrnwRef string
It is a reference to an object of type vimgrnwruntime. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
VrfContextRef string
It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
attrs List<NetworkAttr>
Key/value network attributes. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
cloudRef String
It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<NetworkConfigpbAttribute>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configuredSubnets List<NetworkConfiguredSubnet>
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
dhcpEnabled String
Select the ip address management scheme for this network. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
excludeDiscoveredSubnets String
When selected, excludes all discovered subnets in this network from consideration for virtual service placement. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ip6AutocfgEnabled String
Enable ipv6 auto configuration. Field introduced in 18.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
markers List<NetworkMarker>
List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
networkId String
syncedFromSe String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vcenterDvs String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vimgrnwRef String
It is a reference to an object of type vimgrnwruntime. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vrfContextRef String
It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
attrs NetworkAttr[]
Key/value network attributes. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
cloudRef string
It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes NetworkConfigpbAttribute[]
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configuredSubnets NetworkConfiguredSubnet[]
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
dhcpEnabled string
Select the ip address management scheme for this network. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
excludeDiscoveredSubnets string
When selected, excludes all discovered subnets in this network from consideration for virtual service placement. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ip6AutocfgEnabled string
Enable ipv6 auto configuration. Field introduced in 18.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
markers NetworkMarker[]
List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
networkId string
syncedFromSe string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef string
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vcenterDvs string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vimgrnwRef string
It is a reference to an object of type vimgrnwruntime. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vrfContextRef string
It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
attrs Sequence[NetworkAttrArgs]
Key/value network attributes. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
cloud_ref str
It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpb_attributes Sequence[NetworkConfigpbAttributeArgs]
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configured_subnets Sequence[NetworkConfiguredSubnetArgs]
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
dhcp_enabled str
Select the ip address management scheme for this network. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
exclude_discovered_subnets str
When selected, excludes all discovered subnets in this network from consideration for virtual service placement. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ip6_autocfg_enabled str
Enable ipv6 auto configuration. Field introduced in 18.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
markers Sequence[NetworkMarkerArgs]
List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name str
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
network_id str
synced_from_se str
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenant_ref str
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid str
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vcenter_dvs str
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vimgrnw_ref str
It is a reference to an object of type vimgrnwruntime. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vrf_context_ref str
It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
attrs List<Property Map>
Key/value network attributes. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
cloudRef String
It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<Property Map>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configuredSubnets List<Property Map>
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
dhcpEnabled String
Select the ip address management scheme for this network. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
excludeDiscoveredSubnets String
When selected, excludes all discovered subnets in this network from consideration for virtual service placement. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ip6AutocfgEnabled String
Enable ipv6 auto configuration. Field introduced in 18.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
markers List<Property Map>
List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
networkId String
syncedFromSe String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vcenterDvs String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vimgrnwRef String
It is a reference to an object of type vimgrnwruntime. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vrfContextRef String
It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

Outputs

All input properties are implicitly available as output properties. Additionally, the Network 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 Network Resource

Get an existing Network 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?: NetworkState, opts?: CustomResourceOptions): Network
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attrs: Optional[Sequence[NetworkAttrArgs]] = None,
        cloud_ref: Optional[str] = None,
        configpb_attributes: Optional[Sequence[NetworkConfigpbAttributeArgs]] = None,
        configured_subnets: Optional[Sequence[NetworkConfiguredSubnetArgs]] = None,
        dhcp_enabled: Optional[str] = None,
        exclude_discovered_subnets: Optional[str] = None,
        ip6_autocfg_enabled: Optional[str] = None,
        markers: Optional[Sequence[NetworkMarkerArgs]] = None,
        name: Optional[str] = None,
        network_id: Optional[str] = None,
        synced_from_se: Optional[str] = None,
        tenant_ref: Optional[str] = None,
        uuid: Optional[str] = None,
        vcenter_dvs: Optional[str] = None,
        vimgrnw_ref: Optional[str] = None,
        vrf_context_ref: Optional[str] = None) -> Network
func GetNetwork(ctx *Context, name string, id IDInput, state *NetworkState, opts ...ResourceOption) (*Network, error)
public static Network Get(string name, Input<string> id, NetworkState? state, CustomResourceOptions? opts = null)
public static Network get(String name, Output<String> id, NetworkState state, CustomResourceOptions options)
resources:  _:    type: avi:Network    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Attrs List<NetworkAttr>
Key/value network attributes. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
CloudRef string
It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes List<NetworkConfigpbAttribute>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfiguredSubnets List<NetworkConfiguredSubnet>
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
DhcpEnabled string
Select the ip address management scheme for this network. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ExcludeDiscoveredSubnets string
When selected, excludes all discovered subnets in this network from consideration for virtual service placement. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Ip6AutocfgEnabled string
Enable ipv6 auto configuration. Field introduced in 18.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Markers List<NetworkMarker>
List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
NetworkId string
SyncedFromSe string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
VcenterDvs string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
VimgrnwRef string
It is a reference to an object of type vimgrnwruntime. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
VrfContextRef string
It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Attrs []NetworkAttrArgs
Key/value network attributes. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
CloudRef string
It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes []NetworkConfigpbAttributeArgs
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfiguredSubnets []NetworkConfiguredSubnetArgs
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
DhcpEnabled string
Select the ip address management scheme for this network. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ExcludeDiscoveredSubnets string
When selected, excludes all discovered subnets in this network from consideration for virtual service placement. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Ip6AutocfgEnabled string
Enable ipv6 auto configuration. Field introduced in 18.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Markers []NetworkMarkerArgs
List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
NetworkId string
SyncedFromSe string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
VcenterDvs string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
VimgrnwRef string
It is a reference to an object of type vimgrnwruntime. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
VrfContextRef string
It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
attrs List<NetworkAttr>
Key/value network attributes. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
cloudRef String
It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<NetworkConfigpbAttribute>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configuredSubnets List<NetworkConfiguredSubnet>
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
dhcpEnabled String
Select the ip address management scheme for this network. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
excludeDiscoveredSubnets String
When selected, excludes all discovered subnets in this network from consideration for virtual service placement. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ip6AutocfgEnabled String
Enable ipv6 auto configuration. Field introduced in 18.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
markers List<NetworkMarker>
List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
networkId String
syncedFromSe String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vcenterDvs String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vimgrnwRef String
It is a reference to an object of type vimgrnwruntime. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vrfContextRef String
It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
attrs NetworkAttr[]
Key/value network attributes. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
cloudRef string
It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes NetworkConfigpbAttribute[]
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configuredSubnets NetworkConfiguredSubnet[]
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
dhcpEnabled string
Select the ip address management scheme for this network. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
excludeDiscoveredSubnets string
When selected, excludes all discovered subnets in this network from consideration for virtual service placement. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ip6AutocfgEnabled string
Enable ipv6 auto configuration. Field introduced in 18.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
markers NetworkMarker[]
List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
networkId string
syncedFromSe string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef string
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vcenterDvs string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vimgrnwRef string
It is a reference to an object of type vimgrnwruntime. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vrfContextRef string
It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
attrs Sequence[NetworkAttrArgs]
Key/value network attributes. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
cloud_ref str
It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpb_attributes Sequence[NetworkConfigpbAttributeArgs]
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configured_subnets Sequence[NetworkConfiguredSubnetArgs]
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
dhcp_enabled str
Select the ip address management scheme for this network. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
exclude_discovered_subnets str
When selected, excludes all discovered subnets in this network from consideration for virtual service placement. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ip6_autocfg_enabled str
Enable ipv6 auto configuration. Field introduced in 18.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
markers Sequence[NetworkMarkerArgs]
List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name str
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
network_id str
synced_from_se str
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenant_ref str
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid str
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vcenter_dvs str
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vimgrnw_ref str
It is a reference to an object of type vimgrnwruntime. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vrf_context_ref str
It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
attrs List<Property Map>
Key/value network attributes. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
cloudRef String
It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<Property Map>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configuredSubnets List<Property Map>
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
dhcpEnabled String
Select the ip address management scheme for this network. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
excludeDiscoveredSubnets String
When selected, excludes all discovered subnets in this network from consideration for virtual service placement. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ip6AutocfgEnabled String
Enable ipv6 auto configuration. Field introduced in 18.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
markers List<Property Map>
List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
networkId String
syncedFromSe String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vcenterDvs String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vimgrnwRef String
It is a reference to an object of type vimgrnwruntime. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
vrfContextRef String
It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

Supporting Types

NetworkAttr
, NetworkAttrArgs

Key This property is required. string
Value string
Key This property is required. string
Value string
key This property is required. String
value String
key This property is required. string
value string
key This property is required. str
value str
key This property is required. String
value String

NetworkConfigpbAttribute
, NetworkConfigpbAttributeArgs

Version string
Version string
version String
version string
version String

NetworkConfiguredSubnet
, NetworkConfiguredSubnetArgs

NetworkConfiguredSubnetPrefix
, NetworkConfiguredSubnetPrefixArgs

IpAddrs This property is required. List<NetworkConfiguredSubnetPrefixIpAddr>
Mask This property is required. string
IpAddrs This property is required. []NetworkConfiguredSubnetPrefixIpAddr
Mask This property is required. string
ipAddrs This property is required. List<NetworkConfiguredSubnetPrefixIpAddr>
mask This property is required. String
ipAddrs This property is required. NetworkConfiguredSubnetPrefixIpAddr[]
mask This property is required. string
ip_addrs This property is required. Sequence[NetworkConfiguredSubnetPrefixIpAddr]
mask This property is required. str
ipAddrs This property is required. List<Property Map>
mask This property is required. String

NetworkConfiguredSubnetPrefixIpAddr
, NetworkConfiguredSubnetPrefixIpAddrArgs

Addr This property is required. string
Type This property is required. string
Addr This property is required. string
Type This property is required. string
addr This property is required. String
type This property is required. String
addr This property is required. string
type This property is required. string
addr This property is required. str
type This property is required. str
addr This property is required. String
type This property is required. String

NetworkConfiguredSubnetStaticIpRange
, NetworkConfiguredSubnetStaticIpRangeArgs

ranges This property is required. List<Property Map>
type String

NetworkConfiguredSubnetStaticIpRangeRange
, NetworkConfiguredSubnetStaticIpRangeRangeArgs

begins This property is required. List<Property Map>
ends This property is required. List<Property Map>

NetworkConfiguredSubnetStaticIpRangeRangeBegin
, NetworkConfiguredSubnetStaticIpRangeRangeBeginArgs

Addr This property is required. string
Type This property is required. string
Addr This property is required. string
Type This property is required. string
addr This property is required. String
type This property is required. String
addr This property is required. string
type This property is required. string
addr This property is required. str
type This property is required. str
addr This property is required. String
type This property is required. String

NetworkConfiguredSubnetStaticIpRangeRangeEnd
, NetworkConfiguredSubnetStaticIpRangeRangeEndArgs

Addr This property is required. string
Type This property is required. string
Addr This property is required. string
Type This property is required. string
addr This property is required. String
type This property is required. String
addr This property is required. string
type This property is required. string
addr This property is required. str
type This property is required. str
addr This property is required. String
type This property is required. String

NetworkMarker
, NetworkMarkerArgs

Key This property is required. string
Values List<string>
Key This property is required. string
Values []string
key This property is required. String
values List<String>
key This property is required. string
values string[]
key This property is required. str
values Sequence[str]
key This property is required. String
values List<String>

Package Details

Repository
avi vmware/terraform-provider-avi
License
Notes
This Pulumi package is based on the avi Terraform Provider.