vcd.NetworkPool
Explore with Pulumi AI
Create NetworkPool Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new NetworkPool(name: string, args: NetworkPoolArgs, opts?: CustomResourceOptions);
@overload
def NetworkPool(resource_name: str,
args: NetworkPoolArgs,
opts: Optional[ResourceOptions] = None)
@overload
def NetworkPool(resource_name: str,
opts: Optional[ResourceOptions] = None,
network_provider_id: Optional[str] = None,
type: Optional[str] = None,
backing: Optional[NetworkPoolBackingArgs] = None,
backing_selection_constraint: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
network_pool_id: Optional[str] = None)
func NewNetworkPool(ctx *Context, name string, args NetworkPoolArgs, opts ...ResourceOption) (*NetworkPool, error)
public NetworkPool(string name, NetworkPoolArgs args, CustomResourceOptions? opts = null)
public NetworkPool(String name, NetworkPoolArgs args)
public NetworkPool(String name, NetworkPoolArgs args, CustomResourceOptions options)
type: vcd:NetworkPool
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 NetworkPoolArgs
- 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 NetworkPoolArgs
- 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 NetworkPoolArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args NetworkPoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args NetworkPoolArgs
- 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 networkPoolResource = new Vcd.NetworkPool("networkPoolResource", new()
{
NetworkProviderId = "string",
Type = "string",
Backing = new Vcd.Inputs.NetworkPoolBackingArgs
{
DistributedSwitch = new Vcd.Inputs.NetworkPoolBackingDistributedSwitchArgs
{
Id = "string",
Name = "string",
Type = "string",
},
PortGroups = new[]
{
new Vcd.Inputs.NetworkPoolBackingPortGroupArgs
{
Id = "string",
Name = "string",
Type = "string",
},
},
RangeIds = new[]
{
new Vcd.Inputs.NetworkPoolBackingRangeIdArgs
{
EndId = 0,
StartId = 0,
},
},
TransportZone = new Vcd.Inputs.NetworkPoolBackingTransportZoneArgs
{
Id = "string",
Name = "string",
Type = "string",
},
},
BackingSelectionConstraint = "string",
Description = "string",
Name = "string",
NetworkPoolId = "string",
});
example, err := vcd.NewNetworkPool(ctx, "networkPoolResource", &vcd.NetworkPoolArgs{
NetworkProviderId: pulumi.String("string"),
Type: pulumi.String("string"),
Backing: &vcd.NetworkPoolBackingArgs{
DistributedSwitch: &vcd.NetworkPoolBackingDistributedSwitchArgs{
Id: pulumi.String("string"),
Name: pulumi.String("string"),
Type: pulumi.String("string"),
},
PortGroups: vcd.NetworkPoolBackingPortGroupArray{
&vcd.NetworkPoolBackingPortGroupArgs{
Id: pulumi.String("string"),
Name: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
RangeIds: vcd.NetworkPoolBackingRangeIdArray{
&vcd.NetworkPoolBackingRangeIdArgs{
EndId: pulumi.Float64(0),
StartId: pulumi.Float64(0),
},
},
TransportZone: &vcd.NetworkPoolBackingTransportZoneArgs{
Id: pulumi.String("string"),
Name: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
BackingSelectionConstraint: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
NetworkPoolId: pulumi.String("string"),
})
var networkPoolResource = new NetworkPool("networkPoolResource", NetworkPoolArgs.builder()
.networkProviderId("string")
.type("string")
.backing(NetworkPoolBackingArgs.builder()
.distributedSwitch(NetworkPoolBackingDistributedSwitchArgs.builder()
.id("string")
.name("string")
.type("string")
.build())
.portGroups(NetworkPoolBackingPortGroupArgs.builder()
.id("string")
.name("string")
.type("string")
.build())
.rangeIds(NetworkPoolBackingRangeIdArgs.builder()
.endId(0)
.startId(0)
.build())
.transportZone(NetworkPoolBackingTransportZoneArgs.builder()
.id("string")
.name("string")
.type("string")
.build())
.build())
.backingSelectionConstraint("string")
.description("string")
.name("string")
.networkPoolId("string")
.build());
network_pool_resource = vcd.NetworkPool("networkPoolResource",
network_provider_id="string",
type="string",
backing={
"distributed_switch": {
"id": "string",
"name": "string",
"type": "string",
},
"port_groups": [{
"id": "string",
"name": "string",
"type": "string",
}],
"range_ids": [{
"end_id": 0,
"start_id": 0,
}],
"transport_zone": {
"id": "string",
"name": "string",
"type": "string",
},
},
backing_selection_constraint="string",
description="string",
name="string",
network_pool_id="string")
const networkPoolResource = new vcd.NetworkPool("networkPoolResource", {
networkProviderId: "string",
type: "string",
backing: {
distributedSwitch: {
id: "string",
name: "string",
type: "string",
},
portGroups: [{
id: "string",
name: "string",
type: "string",
}],
rangeIds: [{
endId: 0,
startId: 0,
}],
transportZone: {
id: "string",
name: "string",
type: "string",
},
},
backingSelectionConstraint: "string",
description: "string",
name: "string",
networkPoolId: "string",
});
type: vcd:NetworkPool
properties:
backing:
distributedSwitch:
id: string
name: string
type: string
portGroups:
- id: string
name: string
type: string
rangeIds:
- endId: 0
startId: 0
transportZone:
id: string
name: string
type: string
backingSelectionConstraint: string
description: string
name: string
networkPoolId: string
networkProviderId: string
type: string
NetworkPool 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 NetworkPool resource accepts the following input properties:
- Network
Provider stringId - Id of the network provider (either vCenter or NSX-T manager)
- Type string
- Type of the network pool (one of
GENEVE
,VLAN
,PORTGROUP_BACKED
) - Backing
Network
Pool Backing - The components used by the network pool. See Backing below for details
- Backing
Selection stringConstraint - Define how the backing components are considered. It should be one of the following:
use-explicit-name
(Default) The backing components must be named explicitly;use-when-only-one
The automatically selected backing component will be used if there is only one available;use-first-available
Use the first available backing component.
- Description string
- Description of the network pool
- Name string
- Unique name of network pool
- Network
Pool stringId - (Computed) The ID of the backing element
- Network
Provider stringId - Id of the network provider (either vCenter or NSX-T manager)
- Type string
- Type of the network pool (one of
GENEVE
,VLAN
,PORTGROUP_BACKED
) - Backing
Network
Pool Backing Args - The components used by the network pool. See Backing below for details
- Backing
Selection stringConstraint - Define how the backing components are considered. It should be one of the following:
use-explicit-name
(Default) The backing components must be named explicitly;use-when-only-one
The automatically selected backing component will be used if there is only one available;use-first-available
Use the first available backing component.
- Description string
- Description of the network pool
- Name string
- Unique name of network pool
- Network
Pool stringId - (Computed) The ID of the backing element
- network
Provider StringId - Id of the network provider (either vCenter or NSX-T manager)
- type String
- Type of the network pool (one of
GENEVE
,VLAN
,PORTGROUP_BACKED
) - backing
Network
Pool Backing - The components used by the network pool. See Backing below for details
- backing
Selection StringConstraint - Define how the backing components are considered. It should be one of the following:
use-explicit-name
(Default) The backing components must be named explicitly;use-when-only-one
The automatically selected backing component will be used if there is only one available;use-first-available
Use the first available backing component.
- description String
- Description of the network pool
- name String
- Unique name of network pool
- network
Pool StringId - (Computed) The ID of the backing element
- network
Provider stringId - Id of the network provider (either vCenter or NSX-T manager)
- type string
- Type of the network pool (one of
GENEVE
,VLAN
,PORTGROUP_BACKED
) - backing
Network
Pool Backing - The components used by the network pool. See Backing below for details
- backing
Selection stringConstraint - Define how the backing components are considered. It should be one of the following:
use-explicit-name
(Default) The backing components must be named explicitly;use-when-only-one
The automatically selected backing component will be used if there is only one available;use-first-available
Use the first available backing component.
- description string
- Description of the network pool
- name string
- Unique name of network pool
- network
Pool stringId - (Computed) The ID of the backing element
- network_
provider_ strid - Id of the network provider (either vCenter or NSX-T manager)
- type str
- Type of the network pool (one of
GENEVE
,VLAN
,PORTGROUP_BACKED
) - backing
Network
Pool Backing Args - The components used by the network pool. See Backing below for details
- backing_
selection_ strconstraint - Define how the backing components are considered. It should be one of the following:
use-explicit-name
(Default) The backing components must be named explicitly;use-when-only-one
The automatically selected backing component will be used if there is only one available;use-first-available
Use the first available backing component.
- description str
- Description of the network pool
- name str
- Unique name of network pool
- network_
pool_ strid - (Computed) The ID of the backing element
- network
Provider StringId - Id of the network provider (either vCenter or NSX-T manager)
- type String
- Type of the network pool (one of
GENEVE
,VLAN
,PORTGROUP_BACKED
) - backing Property Map
- The components used by the network pool. See Backing below for details
- backing
Selection StringConstraint - Define how the backing components are considered. It should be one of the following:
use-explicit-name
(Default) The backing components must be named explicitly;use-when-only-one
The automatically selected backing component will be used if there is only one available;use-first-available
Use the first available backing component.
- description String
- Description of the network pool
- name String
- Unique name of network pool
- network
Pool StringId - (Computed) The ID of the backing element
Outputs
All input properties are implicitly available as output properties. Additionally, the NetworkPool resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Network
Provider stringName - Name of the network provider
- Network
Provider stringType - Type of network provider
- Promiscuous
Mode bool - Whether the network pool is in promiscuous mode
- Status string
- Status of the network pool
- Total
Backings doubleCount - Total number of backings
- Used
Backings doubleCount - Number of used backings
- Id string
- The provider-assigned unique ID for this managed resource.
- Network
Provider stringName - Name of the network provider
- Network
Provider stringType - Type of network provider
- Promiscuous
Mode bool - Whether the network pool is in promiscuous mode
- Status string
- Status of the network pool
- Total
Backings float64Count - Total number of backings
- Used
Backings float64Count - Number of used backings
- id String
- The provider-assigned unique ID for this managed resource.
- network
Provider StringName - Name of the network provider
- network
Provider StringType - Type of network provider
- promiscuous
Mode Boolean - Whether the network pool is in promiscuous mode
- status String
- Status of the network pool
- total
Backings DoubleCount - Total number of backings
- used
Backings DoubleCount - Number of used backings
- id string
- The provider-assigned unique ID for this managed resource.
- network
Provider stringName - Name of the network provider
- network
Provider stringType - Type of network provider
- promiscuous
Mode boolean - Whether the network pool is in promiscuous mode
- status string
- Status of the network pool
- total
Backings numberCount - Total number of backings
- used
Backings numberCount - Number of used backings
- id str
- The provider-assigned unique ID for this managed resource.
- network_
provider_ strname - Name of the network provider
- network_
provider_ strtype - Type of network provider
- promiscuous_
mode bool - Whether the network pool is in promiscuous mode
- status str
- Status of the network pool
- total_
backings_ floatcount - Total number of backings
- used_
backings_ floatcount - Number of used backings
- id String
- The provider-assigned unique ID for this managed resource.
- network
Provider StringName - Name of the network provider
- network
Provider StringType - Type of network provider
- promiscuous
Mode Boolean - Whether the network pool is in promiscuous mode
- status String
- Status of the network pool
- total
Backings NumberCount - Total number of backings
- used
Backings NumberCount - Number of used backings
Look up Existing NetworkPool Resource
Get an existing NetworkPool 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?: NetworkPoolState, opts?: CustomResourceOptions): NetworkPool
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
backing: Optional[NetworkPoolBackingArgs] = None,
backing_selection_constraint: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
network_pool_id: Optional[str] = None,
network_provider_id: Optional[str] = None,
network_provider_name: Optional[str] = None,
network_provider_type: Optional[str] = None,
promiscuous_mode: Optional[bool] = None,
status: Optional[str] = None,
total_backings_count: Optional[float] = None,
type: Optional[str] = None,
used_backings_count: Optional[float] = None) -> NetworkPool
func GetNetworkPool(ctx *Context, name string, id IDInput, state *NetworkPoolState, opts ...ResourceOption) (*NetworkPool, error)
public static NetworkPool Get(string name, Input<string> id, NetworkPoolState? state, CustomResourceOptions? opts = null)
public static NetworkPool get(String name, Output<String> id, NetworkPoolState state, CustomResourceOptions options)
resources: _: type: vcd:NetworkPool 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.
- Backing
Network
Pool Backing - The components used by the network pool. See Backing below for details
- Backing
Selection stringConstraint - Define how the backing components are considered. It should be one of the following:
use-explicit-name
(Default) The backing components must be named explicitly;use-when-only-one
The automatically selected backing component will be used if there is only one available;use-first-available
Use the first available backing component.
- Description string
- Description of the network pool
- Name string
- Unique name of network pool
- Network
Pool stringId - (Computed) The ID of the backing element
- Network
Provider stringId - Id of the network provider (either vCenter or NSX-T manager)
- Network
Provider stringName - Name of the network provider
- Network
Provider stringType - Type of network provider
- Promiscuous
Mode bool - Whether the network pool is in promiscuous mode
- Status string
- Status of the network pool
- Total
Backings doubleCount - Total number of backings
- Type string
- Type of the network pool (one of
GENEVE
,VLAN
,PORTGROUP_BACKED
) - Used
Backings doubleCount - Number of used backings
- Backing
Network
Pool Backing Args - The components used by the network pool. See Backing below for details
- Backing
Selection stringConstraint - Define how the backing components are considered. It should be one of the following:
use-explicit-name
(Default) The backing components must be named explicitly;use-when-only-one
The automatically selected backing component will be used if there is only one available;use-first-available
Use the first available backing component.
- Description string
- Description of the network pool
- Name string
- Unique name of network pool
- Network
Pool stringId - (Computed) The ID of the backing element
- Network
Provider stringId - Id of the network provider (either vCenter or NSX-T manager)
- Network
Provider stringName - Name of the network provider
- Network
Provider stringType - Type of network provider
- Promiscuous
Mode bool - Whether the network pool is in promiscuous mode
- Status string
- Status of the network pool
- Total
Backings float64Count - Total number of backings
- Type string
- Type of the network pool (one of
GENEVE
,VLAN
,PORTGROUP_BACKED
) - Used
Backings float64Count - Number of used backings
- backing
Network
Pool Backing - The components used by the network pool. See Backing below for details
- backing
Selection StringConstraint - Define how the backing components are considered. It should be one of the following:
use-explicit-name
(Default) The backing components must be named explicitly;use-when-only-one
The automatically selected backing component will be used if there is only one available;use-first-available
Use the first available backing component.
- description String
- Description of the network pool
- name String
- Unique name of network pool
- network
Pool StringId - (Computed) The ID of the backing element
- network
Provider StringId - Id of the network provider (either vCenter or NSX-T manager)
- network
Provider StringName - Name of the network provider
- network
Provider StringType - Type of network provider
- promiscuous
Mode Boolean - Whether the network pool is in promiscuous mode
- status String
- Status of the network pool
- total
Backings DoubleCount - Total number of backings
- type String
- Type of the network pool (one of
GENEVE
,VLAN
,PORTGROUP_BACKED
) - used
Backings DoubleCount - Number of used backings
- backing
Network
Pool Backing - The components used by the network pool. See Backing below for details
- backing
Selection stringConstraint - Define how the backing components are considered. It should be one of the following:
use-explicit-name
(Default) The backing components must be named explicitly;use-when-only-one
The automatically selected backing component will be used if there is only one available;use-first-available
Use the first available backing component.
- description string
- Description of the network pool
- name string
- Unique name of network pool
- network
Pool stringId - (Computed) The ID of the backing element
- network
Provider stringId - Id of the network provider (either vCenter or NSX-T manager)
- network
Provider stringName - Name of the network provider
- network
Provider stringType - Type of network provider
- promiscuous
Mode boolean - Whether the network pool is in promiscuous mode
- status string
- Status of the network pool
- total
Backings numberCount - Total number of backings
- type string
- Type of the network pool (one of
GENEVE
,VLAN
,PORTGROUP_BACKED
) - used
Backings numberCount - Number of used backings
- backing
Network
Pool Backing Args - The components used by the network pool. See Backing below for details
- backing_
selection_ strconstraint - Define how the backing components are considered. It should be one of the following:
use-explicit-name
(Default) The backing components must be named explicitly;use-when-only-one
The automatically selected backing component will be used if there is only one available;use-first-available
Use the first available backing component.
- description str
- Description of the network pool
- name str
- Unique name of network pool
- network_
pool_ strid - (Computed) The ID of the backing element
- network_
provider_ strid - Id of the network provider (either vCenter or NSX-T manager)
- network_
provider_ strname - Name of the network provider
- network_
provider_ strtype - Type of network provider
- promiscuous_
mode bool - Whether the network pool is in promiscuous mode
- status str
- Status of the network pool
- total_
backings_ floatcount - Total number of backings
- type str
- Type of the network pool (one of
GENEVE
,VLAN
,PORTGROUP_BACKED
) - used_
backings_ floatcount - Number of used backings
- backing Property Map
- The components used by the network pool. See Backing below for details
- backing
Selection StringConstraint - Define how the backing components are considered. It should be one of the following:
use-explicit-name
(Default) The backing components must be named explicitly;use-when-only-one
The automatically selected backing component will be used if there is only one available;use-first-available
Use the first available backing component.
- description String
- Description of the network pool
- name String
- Unique name of network pool
- network
Pool StringId - (Computed) The ID of the backing element
- network
Provider StringId - Id of the network provider (either vCenter or NSX-T manager)
- network
Provider StringName - Name of the network provider
- network
Provider StringType - Type of network provider
- promiscuous
Mode Boolean - Whether the network pool is in promiscuous mode
- status String
- Status of the network pool
- total
Backings NumberCount - Total number of backings
- type String
- Type of the network pool (one of
GENEVE
,VLAN
,PORTGROUP_BACKED
) - used
Backings NumberCount - Number of used backings
Supporting Types
NetworkPoolBacking, NetworkPoolBackingArgs
- Distributed
Switch NetworkPool Backing Distributed Switch - (Optional) A backing structure used for
VLAN
network pool - Port
Groups List<NetworkPool Backing Port Group> - (Optional) A list of backing structure used for
PORTGROUP_BACKED
network pool - Range
Ids List<NetworkPool Backing Range Id> - (Optional) A list of range IDs, required with
VLAN
network pools - Transport
Zone NetworkPool Backing Transport Zone - (Optional) A backing structure used for
GENEVE
network pool
- Distributed
Switch NetworkPool Backing Distributed Switch - (Optional) A backing structure used for
VLAN
network pool - Port
Groups []NetworkPool Backing Port Group - (Optional) A list of backing structure used for
PORTGROUP_BACKED
network pool - Range
Ids []NetworkPool Backing Range Id - (Optional) A list of range IDs, required with
VLAN
network pools - Transport
Zone NetworkPool Backing Transport Zone - (Optional) A backing structure used for
GENEVE
network pool
- distributed
Switch NetworkPool Backing Distributed Switch - (Optional) A backing structure used for
VLAN
network pool - port
Groups List<NetworkPool Backing Port Group> - (Optional) A list of backing structure used for
PORTGROUP_BACKED
network pool - range
Ids List<NetworkPool Backing Range Id> - (Optional) A list of range IDs, required with
VLAN
network pools - transport
Zone NetworkPool Backing Transport Zone - (Optional) A backing structure used for
GENEVE
network pool
- distributed
Switch NetworkPool Backing Distributed Switch - (Optional) A backing structure used for
VLAN
network pool - port
Groups NetworkPool Backing Port Group[] - (Optional) A list of backing structure used for
PORTGROUP_BACKED
network pool - range
Ids NetworkPool Backing Range Id[] - (Optional) A list of range IDs, required with
VLAN
network pools - transport
Zone NetworkPool Backing Transport Zone - (Optional) A backing structure used for
GENEVE
network pool
- distributed_
switch NetworkPool Backing Distributed Switch - (Optional) A backing structure used for
VLAN
network pool - port_
groups Sequence[NetworkPool Backing Port Group] - (Optional) A list of backing structure used for
PORTGROUP_BACKED
network pool - range_
ids Sequence[NetworkPool Backing Range Id] - (Optional) A list of range IDs, required with
VLAN
network pools - transport_
zone NetworkPool Backing Transport Zone - (Optional) A backing structure used for
GENEVE
network pool
- distributed
Switch Property Map - (Optional) A backing structure used for
VLAN
network pool - port
Groups List<Property Map> - (Optional) A list of backing structure used for
PORTGROUP_BACKED
network pool - range
Ids List<Property Map> - (Optional) A list of range IDs, required with
VLAN
network pools - transport
Zone Property Map - (Optional) A backing structure used for
GENEVE
network pool
NetworkPoolBackingDistributedSwitch, NetworkPoolBackingDistributedSwitchArgs
NetworkPoolBackingPortGroup, NetworkPoolBackingPortGroupArgs
NetworkPoolBackingRangeId, NetworkPoolBackingRangeIdArgs
NetworkPoolBackingTransportZone, NetworkPoolBackingTransportZoneArgs
Package Details
- Repository
- vcd vmware/terraform-provider-vcd
- License
- Notes
- This Pulumi package is based on the
vcd
Terraform Provider.