Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PolicyVniPool
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.PolicyVniPool

Explore with Pulumi AI

nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt

Create PolicyVniPool Resource

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

Constructor syntax

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

@overload
def PolicyVniPool(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  display_name: Optional[str] = None,
                  end: Optional[float] = None,
                  start: Optional[float] = None,
                  description: Optional[str] = None,
                  nsx_id: Optional[str] = None,
                  policy_vni_pool_id: Optional[str] = None,
                  tags: Optional[Sequence[PolicyVniPoolTagArgs]] = None)
func NewPolicyVniPool(ctx *Context, name string, args PolicyVniPoolArgs, opts ...ResourceOption) (*PolicyVniPool, error)
public PolicyVniPool(string name, PolicyVniPoolArgs args, CustomResourceOptions? opts = null)
public PolicyVniPool(String name, PolicyVniPoolArgs args)
public PolicyVniPool(String name, PolicyVniPoolArgs args, CustomResourceOptions options)

type: nsxt:PolicyVniPool
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 This property is required. PolicyVniPoolArgs
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 This property is required. PolicyVniPoolArgs
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 This property is required. PolicyVniPoolArgs
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 This property is required. PolicyVniPoolArgs
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. PolicyVniPoolArgs
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 policyVniPoolResource = new Nsxt.PolicyVniPool("policyVniPoolResource", new()
{
    DisplayName = "string",
    End = 0,
    Start = 0,
    Description = "string",
    NsxId = "string",
    PolicyVniPoolId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyVniPoolTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});
Copy
example, err := nsxt.NewPolicyVniPool(ctx, "policyVniPoolResource", &nsxt.PolicyVniPoolArgs{
DisplayName: pulumi.String("string"),
End: pulumi.Float64(0),
Start: pulumi.Float64(0),
Description: pulumi.String("string"),
NsxId: pulumi.String("string"),
PolicyVniPoolId: pulumi.String("string"),
Tags: .PolicyVniPoolTagArray{
&.PolicyVniPoolTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
})
Copy
var policyVniPoolResource = new PolicyVniPool("policyVniPoolResource", PolicyVniPoolArgs.builder()
    .displayName("string")
    .end(0)
    .start(0)
    .description("string")
    .nsxId("string")
    .policyVniPoolId("string")
    .tags(PolicyVniPoolTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());
Copy
policy_vni_pool_resource = nsxt.PolicyVniPool("policyVniPoolResource",
    display_name="string",
    end=0,
    start=0,
    description="string",
    nsx_id="string",
    policy_vni_pool_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])
Copy
const policyVniPoolResource = new nsxt.PolicyVniPool("policyVniPoolResource", {
    displayName: "string",
    end: 0,
    start: 0,
    description: "string",
    nsxId: "string",
    policyVniPoolId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});
Copy
type: nsxt:PolicyVniPool
properties:
    description: string
    displayName: string
    end: 0
    nsxId: string
    policyVniPoolId: string
    start: 0
    tags:
        - scope: string
          tag: string
Copy

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

DisplayName This property is required. string
Display name of the resource.
End This property is required. double
End value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
Start This property is required. double
Start value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
Description string
Description of the resource.
NsxId string
The NSX ID of this resource. If set, this ID will be used to create the policy resource.
PolicyVniPoolId string
Tags List<PolicyVniPoolTag>
A list of scope + tag pairs to associate with this resource.
DisplayName This property is required. string
Display name of the resource.
End This property is required. float64
End value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
Start This property is required. float64
Start value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
Description string
Description of the resource.
NsxId string
The NSX ID of this resource. If set, this ID will be used to create the policy resource.
PolicyVniPoolId string
Tags []PolicyVniPoolTagArgs
A list of scope + tag pairs to associate with this resource.
displayName This property is required. String
Display name of the resource.
end This property is required. Double
End value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
start This property is required. Double
Start value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
description String
Description of the resource.
nsxId String
The NSX ID of this resource. If set, this ID will be used to create the policy resource.
policyVniPoolId String
tags List<PolicyVniPoolTag>
A list of scope + tag pairs to associate with this resource.
displayName This property is required. string
Display name of the resource.
end This property is required. number
End value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
start This property is required. number
Start value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
description string
Description of the resource.
nsxId string
The NSX ID of this resource. If set, this ID will be used to create the policy resource.
policyVniPoolId string
tags PolicyVniPoolTag[]
A list of scope + tag pairs to associate with this resource.
display_name This property is required. str
Display name of the resource.
end This property is required. float
End value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
start This property is required. float
Start value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
description str
Description of the resource.
nsx_id str
The NSX ID of this resource. If set, this ID will be used to create the policy resource.
policy_vni_pool_id str
tags Sequence[PolicyVniPoolTagArgs]
A list of scope + tag pairs to associate with this resource.
displayName This property is required. String
Display name of the resource.
end This property is required. Number
End value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
start This property is required. Number
Start value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
description String
Description of the resource.
nsxId String
The NSX ID of this resource. If set, this ID will be used to create the policy resource.
policyVniPoolId String
tags List<Property Map>
A list of scope + tag pairs to associate with this resource.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Path string
The NSX path of the policy resource.
Revision double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Id string
The provider-assigned unique ID for this managed resource.
Path string
The NSX path of the policy resource.
Revision float64
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
id String
The provider-assigned unique ID for this managed resource.
path String
The NSX path of the policy resource.
revision Double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
id string
The provider-assigned unique ID for this managed resource.
path string
The NSX path of the policy resource.
revision number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
id str
The provider-assigned unique ID for this managed resource.
path str
The NSX path of the policy resource.
revision float
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
id String
The provider-assigned unique ID for this managed resource.
path String
The NSX path of the policy resource.
revision Number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

Look up Existing PolicyVniPool Resource

Get an existing PolicyVniPool 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?: PolicyVniPoolState, opts?: CustomResourceOptions): PolicyVniPool
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        end: Optional[float] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_vni_pool_id: Optional[str] = None,
        revision: Optional[float] = None,
        start: Optional[float] = None,
        tags: Optional[Sequence[PolicyVniPoolTagArgs]] = None) -> PolicyVniPool
func GetPolicyVniPool(ctx *Context, name string, id IDInput, state *PolicyVniPoolState, opts ...ResourceOption) (*PolicyVniPool, error)
public static PolicyVniPool Get(string name, Input<string> id, PolicyVniPoolState? state, CustomResourceOptions? opts = null)
public static PolicyVniPool get(String name, Output<String> id, PolicyVniPoolState state, CustomResourceOptions options)
resources:  _:    type: nsxt:PolicyVniPool    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:
Description string
Description of the resource.
DisplayName string
Display name of the resource.
End double
End value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
NsxId string
The NSX ID of this resource. If set, this ID will be used to create the policy resource.
Path string
The NSX path of the policy resource.
PolicyVniPoolId string
Revision double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Start double
Start value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
Tags List<PolicyVniPoolTag>
A list of scope + tag pairs to associate with this resource.
Description string
Description of the resource.
DisplayName string
Display name of the resource.
End float64
End value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
NsxId string
The NSX ID of this resource. If set, this ID will be used to create the policy resource.
Path string
The NSX path of the policy resource.
PolicyVniPoolId string
Revision float64
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Start float64
Start value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
Tags []PolicyVniPoolTagArgs
A list of scope + tag pairs to associate with this resource.
description String
Description of the resource.
displayName String
Display name of the resource.
end Double
End value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
nsxId String
The NSX ID of this resource. If set, this ID will be used to create the policy resource.
path String
The NSX path of the policy resource.
policyVniPoolId String
revision Double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
start Double
Start value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
tags List<PolicyVniPoolTag>
A list of scope + tag pairs to associate with this resource.
description string
Description of the resource.
displayName string
Display name of the resource.
end number
End value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
nsxId string
The NSX ID of this resource. If set, this ID will be used to create the policy resource.
path string
The NSX path of the policy resource.
policyVniPoolId string
revision number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
start number
Start value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
tags PolicyVniPoolTag[]
A list of scope + tag pairs to associate with this resource.
description str
Description of the resource.
display_name str
Display name of the resource.
end float
End value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
nsx_id str
The NSX ID of this resource. If set, this ID will be used to create the policy resource.
path str
The NSX path of the policy resource.
policy_vni_pool_id str
revision float
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
start float
Start value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
tags Sequence[PolicyVniPoolTagArgs]
A list of scope + tag pairs to associate with this resource.
description String
Description of the resource.
displayName String
Display name of the resource.
end Number
End value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
nsxId String
The NSX ID of this resource. If set, this ID will be used to create the policy resource.
path String
The NSX path of the policy resource.
policyVniPoolId String
revision Number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
start Number
Start value of VNI Pool range. Minimum: 75001, Maximum: 16777215.
tags List<Property Map>
A list of scope + tag pairs to associate with this resource.

Supporting Types

PolicyVniPoolTag
, PolicyVniPoolTagArgs

Scope string
Tag string
A list of scope + tag pairs to associate with this resource.
Scope string
Tag string
A list of scope + tag pairs to associate with this resource.
scope String
tag String
A list of scope + tag pairs to associate with this resource.
scope string
tag string
A list of scope + tag pairs to associate with this resource.
scope str
tag str
A list of scope + tag pairs to associate with this resource.
scope String
tag String
A list of scope + tag pairs to associate with this resource.

Package Details

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