Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PolicyIpPool
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.PolicyIpPool

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

    Create PolicyIpPool Resource

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

    Constructor syntax

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

@overload
def PolicyIpPool(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 display_name: Optional[str] = None,
                 context: Optional[PolicyIpPoolContextArgs] = None,
                 description: Optional[str] = None,
                 nsx_id: Optional[str] = None,
                 policy_ip_pool_id: Optional[str] = None,
                 tags: Optional[Sequence[PolicyIpPoolTagArgs]] = None)
    func NewPolicyIpPool(ctx *Context, name string, args PolicyIpPoolArgs, opts ...ResourceOption) (*PolicyIpPool, error)
    public PolicyIpPool(string name, PolicyIpPoolArgs args, CustomResourceOptions? opts = null)
    public PolicyIpPool(String name, PolicyIpPoolArgs args)
public PolicyIpPool(String name, PolicyIpPoolArgs args, CustomResourceOptions options)

    type: nsxt:PolicyIpPool
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 PolicyIpPoolArgs
    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 PolicyIpPoolArgs
    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 PolicyIpPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyIpPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyIpPoolArgs
    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 policyIpPoolResource = new Nsxt.PolicyIpPool("policyIpPoolResource", new()
{
    DisplayName = "string",
    Context = new Nsxt.Inputs.PolicyIpPoolContextArgs
    {
        ProjectId = "string",
    },
    Description = "string",
    NsxId = "string",
    PolicyIpPoolId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyIpPoolTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewPolicyIpPool(ctx, "policyIpPoolResource", &nsxt.PolicyIpPoolArgs{
	DisplayName: pulumi.String("string"),
	Context: &nsxt.PolicyIpPoolContextArgs{
		ProjectId: pulumi.String("string"),
	},
	Description:    pulumi.String("string"),
	NsxId:          pulumi.String("string"),
	PolicyIpPoolId: pulumi.String("string"),
	Tags: nsxt.PolicyIpPoolTagArray{
		&nsxt.PolicyIpPoolTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var policyIpPoolResource = new PolicyIpPool("policyIpPoolResource", PolicyIpPoolArgs.builder()
    .displayName("string")
    .context(PolicyIpPoolContextArgs.builder()
        .projectId("string")
        .build())
    .description("string")
    .nsxId("string")
    .policyIpPoolId("string")
    .tags(PolicyIpPoolTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    policy_ip_pool_resource = nsxt.PolicyIpPool("policyIpPoolResource",
    display_name="string",
    context={
        "project_id": "string",
    },
    description="string",
    nsx_id="string",
    policy_ip_pool_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const policyIpPoolResource = new nsxt.PolicyIpPool("policyIpPoolResource", {
    displayName: "string",
    context: {
        projectId: "string",
    },
    description: "string",
    nsxId: "string",
    policyIpPoolId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:PolicyIpPool
properties:
    context:
        projectId: string
    description: string
    displayName: string
    nsxId: string
    policyIpPoolId: string
    tags:
        - scope: string
          tag: string

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

    DisplayName string
    The display name for the IP Pool.
    Context PolicyIpPoolContext
    The context which the object belongs to
    Description string
    Description of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyIpPoolId string
    ID of the IP Pool.
    Tags List<PolicyIpPoolTag>
    A list of scope + tag pairs to associate with this IP Pool.
    DisplayName string
    The display name for the IP Pool.
    Context PolicyIpPoolContextArgs
    The context which the object belongs to
    Description string
    Description of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyIpPoolId string
    ID of the IP Pool.
    Tags []PolicyIpPoolTagArgs
    A list of scope + tag pairs to associate with this IP Pool.
    displayName String
    The display name for the IP Pool.
    context PolicyIpPoolContext
    The context which the object belongs to
    description String
    Description of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyIpPoolId String
    ID of the IP Pool.
    tags List<PolicyIpPoolTag>
    A list of scope + tag pairs to associate with this IP Pool.
    displayName string
    The display name for the IP Pool.
    context PolicyIpPoolContext
    The context which the object belongs to
    description string
    Description of the resource.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyIpPoolId string
    ID of the IP Pool.
    tags PolicyIpPoolTag[]
    A list of scope + tag pairs to associate with this IP Pool.
    display_name str
    The display name for the IP Pool.
    context PolicyIpPoolContextArgs
    The context which the object belongs to
    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 resource.
    policy_ip_pool_id str
    ID of the IP Pool.
    tags Sequence[PolicyIpPoolTagArgs]
    A list of scope + tag pairs to associate with this IP Pool.
    displayName String
    The display name for the IP Pool.
    context Property Map
    The context which the object belongs to
    description String
    Description of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyIpPoolId String
    ID of the IP Pool.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this IP Pool.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the resource.
    RealizedId string
    The id of realized pool object. This id should be used in nsxt.getTransportNode 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 resource.
    RealizedId string
    The id of realized pool object. This id should be used in nsxt.getTransportNode 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 resource.
    realizedId String
    The id of realized pool object. This id should be used in nsxt.getTransportNode 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 resource.
    realizedId string
    The id of realized pool object. This id should be used in nsxt.getTransportNode 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 resource.
    realized_id str
    The id of realized pool object. This id should be used in nsxt.getTransportNode 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 resource.
    realizedId String
    The id of realized pool object. This id should be used in nsxt.getTransportNode 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 PolicyIpPool Resource

    Get an existing PolicyIpPool 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?: PolicyIpPoolState, opts?: CustomResourceOptions): PolicyIpPool
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        context: Optional[PolicyIpPoolContextArgs] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_ip_pool_id: Optional[str] = None,
        realized_id: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[PolicyIpPoolTagArgs]] = None) -> PolicyIpPool
    func GetPolicyIpPool(ctx *Context, name string, id IDInput, state *PolicyIpPoolState, opts ...ResourceOption) (*PolicyIpPool, error)
    public static PolicyIpPool Get(string name, Input<string> id, PolicyIpPoolState? state, CustomResourceOptions? opts = null)
    public static PolicyIpPool get(String name, Output<String> id, PolicyIpPoolState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyIpPool    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Context PolicyIpPoolContext
    The context which the object belongs to
    Description string
    Description of the resource.
    DisplayName string
    The display name for the IP Pool.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    Path string
    The NSX path of the resource.
    PolicyIpPoolId string
    ID of the IP Pool.
    RealizedId string
    The id of realized pool object. This id should be used in nsxt.getTransportNode resource.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags List<PolicyIpPoolTag>
    A list of scope + tag pairs to associate with this IP Pool.
    Context PolicyIpPoolContextArgs
    The context which the object belongs to
    Description string
    Description of the resource.
    DisplayName string
    The display name for the IP Pool.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    Path string
    The NSX path of the resource.
    PolicyIpPoolId string
    ID of the IP Pool.
    RealizedId string
    The id of realized pool object. This id should be used in nsxt.getTransportNode resource.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags []PolicyIpPoolTagArgs
    A list of scope + tag pairs to associate with this IP Pool.
    context PolicyIpPoolContext
    The context which the object belongs to
    description String
    Description of the resource.
    displayName String
    The display name for the IP Pool.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path String
    The NSX path of the resource.
    policyIpPoolId String
    ID of the IP Pool.
    realizedId String
    The id of realized pool object. This id should be used in nsxt.getTransportNode resource.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags List<PolicyIpPoolTag>
    A list of scope + tag pairs to associate with this IP Pool.
    context PolicyIpPoolContext
    The context which the object belongs to
    description string
    Description of the resource.
    displayName string
    The display name for the IP Pool.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path string
    The NSX path of the resource.
    policyIpPoolId string
    ID of the IP Pool.
    realizedId string
    The id of realized pool object. This id should be used in nsxt.getTransportNode resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags PolicyIpPoolTag[]
    A list of scope + tag pairs to associate with this IP Pool.
    context PolicyIpPoolContextArgs
    The context which the object belongs to
    description str
    Description of the resource.
    display_name str
    The display name for the IP Pool.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path str
    The NSX path of the resource.
    policy_ip_pool_id str
    ID of the IP Pool.
    realized_id str
    The id of realized pool object. This id should be used in nsxt.getTransportNode resource.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags Sequence[PolicyIpPoolTagArgs]
    A list of scope + tag pairs to associate with this IP Pool.
    context Property Map
    The context which the object belongs to
    description String
    Description of the resource.
    displayName String
    The display name for the IP Pool.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path String
    The NSX path of the resource.
    policyIpPoolId String
    ID of the IP Pool.
    realizedId String
    The id of realized pool object. This id should be used in nsxt.getTransportNode resource.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this IP Pool.

    Supporting Types

    PolicyIpPoolContext, PolicyIpPoolContextArgs

    ProjectId string
    The ID of the project which the object belongs to
    ProjectId string
    The ID of the project which the object belongs to
    projectId String
    The ID of the project which the object belongs to
    projectId string
    The ID of the project which the object belongs to
    project_id str
    The ID of the project which the object belongs to
    projectId String
    The ID of the project which the object belongs to

    PolicyIpPoolTag, PolicyIpPoolTagArgs

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

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    nsxt logo
    nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
    vmware/terraform-provider-nsxt