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

nsxt.PolicyIpPoolBlockSubnet

Explore with Pulumi AI

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

    Create PolicyIpPoolBlockSubnet Resource

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

    Constructor syntax

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

@overload
def PolicyIpPoolBlockSubnet(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            block_path: Optional[str] = None,
                            display_name: Optional[str] = None,
                            pool_path: Optional[str] = None,
                            size: Optional[float] = None,
                            auto_assign_gateway: Optional[bool] = None,
                            context: Optional[PolicyIpPoolBlockSubnetContextArgs] = None,
                            description: Optional[str] = None,
                            nsx_id: Optional[str] = None,
                            policy_ip_pool_block_subnet_id: Optional[str] = None,
                            tags: Optional[Sequence[PolicyIpPoolBlockSubnetTagArgs]] = None)
    func NewPolicyIpPoolBlockSubnet(ctx *Context, name string, args PolicyIpPoolBlockSubnetArgs, opts ...ResourceOption) (*PolicyIpPoolBlockSubnet, error)
    public PolicyIpPoolBlockSubnet(string name, PolicyIpPoolBlockSubnetArgs args, CustomResourceOptions? opts = null)
    public PolicyIpPoolBlockSubnet(String name, PolicyIpPoolBlockSubnetArgs args)
public PolicyIpPoolBlockSubnet(String name, PolicyIpPoolBlockSubnetArgs args, CustomResourceOptions options)

    type: nsxt:PolicyIpPoolBlockSubnet
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 PolicyIpPoolBlockSubnetArgs
    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 PolicyIpPoolBlockSubnetArgs
    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 PolicyIpPoolBlockSubnetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyIpPoolBlockSubnetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyIpPoolBlockSubnetArgs
    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 policyIpPoolBlockSubnetResource = new Nsxt.PolicyIpPoolBlockSubnet("policyIpPoolBlockSubnetResource", new()
{
    BlockPath = "string",
    DisplayName = "string",
    PoolPath = "string",
    Size = 0,
    AutoAssignGateway = false,
    Context = new Nsxt.Inputs.PolicyIpPoolBlockSubnetContextArgs
    {
        ProjectId = "string",
    },
    Description = "string",
    NsxId = "string",
    PolicyIpPoolBlockSubnetId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyIpPoolBlockSubnetTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewPolicyIpPoolBlockSubnet(ctx, "policyIpPoolBlockSubnetResource", &nsxt.PolicyIpPoolBlockSubnetArgs{
	BlockPath:         pulumi.String("string"),
	DisplayName:       pulumi.String("string"),
	PoolPath:          pulumi.String("string"),
	Size:              pulumi.Float64(0),
	AutoAssignGateway: pulumi.Bool(false),
	Context: &nsxt.PolicyIpPoolBlockSubnetContextArgs{
		ProjectId: pulumi.String("string"),
	},
	Description:               pulumi.String("string"),
	NsxId:                     pulumi.String("string"),
	PolicyIpPoolBlockSubnetId: pulumi.String("string"),
	Tags: nsxt.PolicyIpPoolBlockSubnetTagArray{
		&nsxt.PolicyIpPoolBlockSubnetTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var policyIpPoolBlockSubnetResource = new PolicyIpPoolBlockSubnet("policyIpPoolBlockSubnetResource", PolicyIpPoolBlockSubnetArgs.builder()
    .blockPath("string")
    .displayName("string")
    .poolPath("string")
    .size(0)
    .autoAssignGateway(false)
    .context(PolicyIpPoolBlockSubnetContextArgs.builder()
        .projectId("string")
        .build())
    .description("string")
    .nsxId("string")
    .policyIpPoolBlockSubnetId("string")
    .tags(PolicyIpPoolBlockSubnetTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    policy_ip_pool_block_subnet_resource = nsxt.PolicyIpPoolBlockSubnet("policyIpPoolBlockSubnetResource",
    block_path="string",
    display_name="string",
    pool_path="string",
    size=0,
    auto_assign_gateway=False,
    context={
        "project_id": "string",
    },
    description="string",
    nsx_id="string",
    policy_ip_pool_block_subnet_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const policyIpPoolBlockSubnetResource = new nsxt.PolicyIpPoolBlockSubnet("policyIpPoolBlockSubnetResource", {
    blockPath: "string",
    displayName: "string",
    poolPath: "string",
    size: 0,
    autoAssignGateway: false,
    context: {
        projectId: "string",
    },
    description: "string",
    nsxId: "string",
    policyIpPoolBlockSubnetId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:PolicyIpPoolBlockSubnet
properties:
    autoAssignGateway: false
    blockPath: string
    context:
        projectId: string
    description: string
    displayName: string
    nsxId: string
    policyIpPoolBlockSubnetId: string
    poolPath: string
    size: 0
    tags:
        - scope: string
          tag: string

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

    BlockPath string
    The Policy path to the IP Block for this Block Subnet.
    DisplayName string
    The display name for the Block Subnet.
    PoolPath string
    The Policy path to the IP Pool for this Block Subnet.
    Size double
    The size of this Block Subnet. Must be a power of 2
    AutoAssignGateway bool
    A boolean flag to toggle auto-assignment of the Gateway IP for this Subnet
    Context PolicyIpPoolBlockSubnetContext
    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.
    PolicyIpPoolBlockSubnetId string
    ID of this Block Subnet.
    Tags List<PolicyIpPoolBlockSubnetTag>
    A list of scope + tag pairs to associate with this Block Subnet.
    BlockPath string
    The Policy path to the IP Block for this Block Subnet.
    DisplayName string
    The display name for the Block Subnet.
    PoolPath string
    The Policy path to the IP Pool for this Block Subnet.
    Size float64
    The size of this Block Subnet. Must be a power of 2
    AutoAssignGateway bool
    A boolean flag to toggle auto-assignment of the Gateway IP for this Subnet
    Context PolicyIpPoolBlockSubnetContextArgs
    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.
    PolicyIpPoolBlockSubnetId string
    ID of this Block Subnet.
    Tags []PolicyIpPoolBlockSubnetTagArgs
    A list of scope + tag pairs to associate with this Block Subnet.
    blockPath String
    The Policy path to the IP Block for this Block Subnet.
    displayName String
    The display name for the Block Subnet.
    poolPath String
    The Policy path to the IP Pool for this Block Subnet.
    size Double
    The size of this Block Subnet. Must be a power of 2
    autoAssignGateway Boolean
    A boolean flag to toggle auto-assignment of the Gateway IP for this Subnet
    context PolicyIpPoolBlockSubnetContext
    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.
    policyIpPoolBlockSubnetId String
    ID of this Block Subnet.
    tags List<PolicyIpPoolBlockSubnetTag>
    A list of scope + tag pairs to associate with this Block Subnet.
    blockPath string
    The Policy path to the IP Block for this Block Subnet.
    displayName string
    The display name for the Block Subnet.
    poolPath string
    The Policy path to the IP Pool for this Block Subnet.
    size number
    The size of this Block Subnet. Must be a power of 2
    autoAssignGateway boolean
    A boolean flag to toggle auto-assignment of the Gateway IP for this Subnet
    context PolicyIpPoolBlockSubnetContext
    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.
    policyIpPoolBlockSubnetId string
    ID of this Block Subnet.
    tags PolicyIpPoolBlockSubnetTag[]
    A list of scope + tag pairs to associate with this Block Subnet.
    block_path str
    The Policy path to the IP Block for this Block Subnet.
    display_name str
    The display name for the Block Subnet.
    pool_path str
    The Policy path to the IP Pool for this Block Subnet.
    size float
    The size of this Block Subnet. Must be a power of 2
    auto_assign_gateway bool
    A boolean flag to toggle auto-assignment of the Gateway IP for this Subnet
    context PolicyIpPoolBlockSubnetContextArgs
    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_block_subnet_id str
    ID of this Block Subnet.
    tags Sequence[PolicyIpPoolBlockSubnetTagArgs]
    A list of scope + tag pairs to associate with this Block Subnet.
    blockPath String
    The Policy path to the IP Block for this Block Subnet.
    displayName String
    The display name for the Block Subnet.
    poolPath String
    The Policy path to the IP Pool for this Block Subnet.
    size Number
    The size of this Block Subnet. Must be a power of 2
    autoAssignGateway Boolean
    A boolean flag to toggle auto-assignment of the Gateway IP for this Subnet
    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.
    policyIpPoolBlockSubnetId String
    ID of this Block Subnet.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this Block Subnet.

    Outputs

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

    Get an existing PolicyIpPoolBlockSubnet 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?: PolicyIpPoolBlockSubnetState, opts?: CustomResourceOptions): PolicyIpPoolBlockSubnet
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_assign_gateway: Optional[bool] = None,
        block_path: Optional[str] = None,
        context: Optional[PolicyIpPoolBlockSubnetContextArgs] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_ip_pool_block_subnet_id: Optional[str] = None,
        pool_path: Optional[str] = None,
        revision: Optional[float] = None,
        size: Optional[float] = None,
        tags: Optional[Sequence[PolicyIpPoolBlockSubnetTagArgs]] = None) -> PolicyIpPoolBlockSubnet
    func GetPolicyIpPoolBlockSubnet(ctx *Context, name string, id IDInput, state *PolicyIpPoolBlockSubnetState, opts ...ResourceOption) (*PolicyIpPoolBlockSubnet, error)
    public static PolicyIpPoolBlockSubnet Get(string name, Input<string> id, PolicyIpPoolBlockSubnetState? state, CustomResourceOptions? opts = null)
    public static PolicyIpPoolBlockSubnet get(String name, Output<String> id, PolicyIpPoolBlockSubnetState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyIpPoolBlockSubnet    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:
    AutoAssignGateway bool
    A boolean flag to toggle auto-assignment of the Gateway IP for this Subnet
    BlockPath string
    The Policy path to the IP Block for this Block Subnet.
    Context PolicyIpPoolBlockSubnetContext
    The context which the object belongs to
    Description string
    Description of the resource.
    DisplayName string
    The display name for the Block Subnet.
    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.
    PolicyIpPoolBlockSubnetId string
    ID of this Block Subnet.
    PoolPath string
    The Policy path to the IP Pool for this Block Subnet.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Size double
    The size of this Block Subnet. Must be a power of 2
    Tags List<PolicyIpPoolBlockSubnetTag>
    A list of scope + tag pairs to associate with this Block Subnet.
    AutoAssignGateway bool
    A boolean flag to toggle auto-assignment of the Gateway IP for this Subnet
    BlockPath string
    The Policy path to the IP Block for this Block Subnet.
    Context PolicyIpPoolBlockSubnetContextArgs
    The context which the object belongs to
    Description string
    Description of the resource.
    DisplayName string
    The display name for the Block Subnet.
    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.
    PolicyIpPoolBlockSubnetId string
    ID of this Block Subnet.
    PoolPath string
    The Policy path to the IP Pool for this Block Subnet.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Size float64
    The size of this Block Subnet. Must be a power of 2
    Tags []PolicyIpPoolBlockSubnetTagArgs
    A list of scope + tag pairs to associate with this Block Subnet.
    autoAssignGateway Boolean
    A boolean flag to toggle auto-assignment of the Gateway IP for this Subnet
    blockPath String
    The Policy path to the IP Block for this Block Subnet.
    context PolicyIpPoolBlockSubnetContext
    The context which the object belongs to
    description String
    Description of the resource.
    displayName String
    The display name for the Block Subnet.
    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.
    policyIpPoolBlockSubnetId String
    ID of this Block Subnet.
    poolPath String
    The Policy path to the IP Pool for this Block Subnet.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    size Double
    The size of this Block Subnet. Must be a power of 2
    tags List<PolicyIpPoolBlockSubnetTag>
    A list of scope + tag pairs to associate with this Block Subnet.
    autoAssignGateway boolean
    A boolean flag to toggle auto-assignment of the Gateway IP for this Subnet
    blockPath string
    The Policy path to the IP Block for this Block Subnet.
    context PolicyIpPoolBlockSubnetContext
    The context which the object belongs to
    description string
    Description of the resource.
    displayName string
    The display name for the Block Subnet.
    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.
    policyIpPoolBlockSubnetId string
    ID of this Block Subnet.
    poolPath string
    The Policy path to the IP Pool for this Block Subnet.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    size number
    The size of this Block Subnet. Must be a power of 2
    tags PolicyIpPoolBlockSubnetTag[]
    A list of scope + tag pairs to associate with this Block Subnet.
    auto_assign_gateway bool
    A boolean flag to toggle auto-assignment of the Gateway IP for this Subnet
    block_path str
    The Policy path to the IP Block for this Block Subnet.
    context PolicyIpPoolBlockSubnetContextArgs
    The context which the object belongs to
    description str
    Description of the resource.
    display_name str
    The display name for the Block Subnet.
    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_block_subnet_id str
    ID of this Block Subnet.
    pool_path str
    The Policy path to the IP Pool for this Block Subnet.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    size float
    The size of this Block Subnet. Must be a power of 2
    tags Sequence[PolicyIpPoolBlockSubnetTagArgs]
    A list of scope + tag pairs to associate with this Block Subnet.
    autoAssignGateway Boolean
    A boolean flag to toggle auto-assignment of the Gateway IP for this Subnet
    blockPath String
    The Policy path to the IP Block for this Block Subnet.
    context Property Map
    The context which the object belongs to
    description String
    Description of the resource.
    displayName String
    The display name for the Block Subnet.
    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.
    policyIpPoolBlockSubnetId String
    ID of this Block Subnet.
    poolPath String
    The Policy path to the IP Pool for this Block Subnet.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    size Number
    The size of this Block Subnet. Must be a power of 2
    tags List<Property Map>
    A list of scope + tag pairs to associate with this Block Subnet.

    Supporting Types

    PolicyIpPoolBlockSubnetContext, PolicyIpPoolBlockSubnetContextArgs

    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

    PolicyIpPoolBlockSubnetTag, PolicyIpPoolBlockSubnetTagArgs

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

    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