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

nsxt.IpBlockSubnet

Explore with Pulumi AI

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

    Create IpBlockSubnet Resource

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

    Constructor syntax

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

@overload
def IpBlockSubnet(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  block_id: Optional[str] = None,
                  size: Optional[float] = None,
                  description: Optional[str] = None,
                  display_name: Optional[str] = None,
                  ip_block_subnet_id: Optional[str] = None,
                  tags: Optional[Sequence[IpBlockSubnetTagArgs]] = None)
    func NewIpBlockSubnet(ctx *Context, name string, args IpBlockSubnetArgs, opts ...ResourceOption) (*IpBlockSubnet, error)
    public IpBlockSubnet(string name, IpBlockSubnetArgs args, CustomResourceOptions? opts = null)
    public IpBlockSubnet(String name, IpBlockSubnetArgs args)
public IpBlockSubnet(String name, IpBlockSubnetArgs args, CustomResourceOptions options)

    type: nsxt:IpBlockSubnet
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 IpBlockSubnetArgs
    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 IpBlockSubnetArgs
    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 IpBlockSubnetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IpBlockSubnetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IpBlockSubnetArgs
    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 ipBlockSubnetResource = new Nsxt.IpBlockSubnet("ipBlockSubnetResource", new()
{
    BlockId = "string",
    Size = 0,
    Description = "string",
    DisplayName = "string",
    IpBlockSubnetId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.IpBlockSubnetTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewIpBlockSubnet(ctx, "ipBlockSubnetResource", &nsxt.IpBlockSubnetArgs{
	BlockId:         pulumi.String("string"),
	Size:            pulumi.Float64(0),
	Description:     pulumi.String("string"),
	DisplayName:     pulumi.String("string"),
	IpBlockSubnetId: pulumi.String("string"),
	Tags: nsxt.IpBlockSubnetTagArray{
		&nsxt.IpBlockSubnetTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var ipBlockSubnetResource = new IpBlockSubnet("ipBlockSubnetResource", IpBlockSubnetArgs.builder()
    .blockId("string")
    .size(0)
    .description("string")
    .displayName("string")
    .ipBlockSubnetId("string")
    .tags(IpBlockSubnetTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    ip_block_subnet_resource = nsxt.IpBlockSubnet("ipBlockSubnetResource",
    block_id="string",
    size=0,
    description="string",
    display_name="string",
    ip_block_subnet_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const ipBlockSubnetResource = new nsxt.IpBlockSubnet("ipBlockSubnetResource", {
    blockId: "string",
    size: 0,
    description: "string",
    displayName: "string",
    ipBlockSubnetId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:IpBlockSubnet
properties:
    blockId: string
    description: string
    displayName: string
    ipBlockSubnetId: string
    size: 0
    tags:
        - scope: string
          tag: string

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

    BlockId string
    Block id for which the subnet is created.
    Size double
    Represents the size or number of IP addresses in the subnet.
    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    IpBlockSubnetId string
    ID of the IP block subnet.
    Tags List<IpBlockSubnetTag>
    A list of scope + tag pairs to associate with this IP block subnet.
    BlockId string
    Block id for which the subnet is created.
    Size float64
    Represents the size or number of IP addresses in the subnet.
    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    IpBlockSubnetId string
    ID of the IP block subnet.
    Tags []IpBlockSubnetTagArgs
    A list of scope + tag pairs to associate with this IP block subnet.
    blockId String
    Block id for which the subnet is created.
    size Double
    Represents the size or number of IP addresses in the subnet.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    ipBlockSubnetId String
    ID of the IP block subnet.
    tags List<IpBlockSubnetTag>
    A list of scope + tag pairs to associate with this IP block subnet.
    blockId string
    Block id for which the subnet is created.
    size number
    Represents the size or number of IP addresses in the subnet.
    description string
    Description of this resource.
    displayName string
    The display name of this resource. Defaults to ID if not set.
    ipBlockSubnetId string
    ID of the IP block subnet.
    tags IpBlockSubnetTag[]
    A list of scope + tag pairs to associate with this IP block subnet.
    block_id str
    Block id for which the subnet is created.
    size float
    Represents the size or number of IP addresses in the subnet.
    description str
    Description of this resource.
    display_name str
    The display name of this resource. Defaults to ID if not set.
    ip_block_subnet_id str
    ID of the IP block subnet.
    tags Sequence[IpBlockSubnetTagArgs]
    A list of scope + tag pairs to associate with this IP block subnet.
    blockId String
    Block id for which the subnet is created.
    size Number
    Represents the size or number of IP addresses in the subnet.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    ipBlockSubnetId String
    ID of the IP block subnet.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this IP block subnet.

    Outputs

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

    AllocationRanges List<IpBlockSubnetAllocationRange>
    A collection of IPv4 Pool Ranges
    Cidr string
    Represents the size or number of IP addresses in the subnet. All subnets of the same block must have the same size, which must be a power of 2.
    Id string
    The provider-assigned unique ID for this managed resource.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    AllocationRanges []IpBlockSubnetAllocationRange
    A collection of IPv4 Pool Ranges
    Cidr string
    Represents the size or number of IP addresses in the subnet. All subnets of the same block must have the same size, which must be a power of 2.
    Id string
    The provider-assigned unique ID for this managed resource.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    allocationRanges List<IpBlockSubnetAllocationRange>
    A collection of IPv4 Pool Ranges
    cidr String
    Represents the size or number of IP addresses in the subnet. All subnets of the same block must have the same size, which must be a power of 2.
    id String
    The provider-assigned unique ID for this managed resource.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    allocationRanges IpBlockSubnetAllocationRange[]
    A collection of IPv4 Pool Ranges
    cidr string
    Represents the size or number of IP addresses in the subnet. All subnets of the same block must have the same size, which must be a power of 2.
    id string
    The provider-assigned unique ID for this managed resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    allocation_ranges Sequence[IpBlockSubnetAllocationRange]
    A collection of IPv4 Pool Ranges
    cidr str
    Represents the size or number of IP addresses in the subnet. All subnets of the same block must have the same size, which must be a power of 2.
    id str
    The provider-assigned unique ID for this managed resource.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    allocationRanges List<Property Map>
    A collection of IPv4 Pool Ranges
    cidr String
    Represents the size or number of IP addresses in the subnet. All subnets of the same block must have the same size, which must be a power of 2.
    id String
    The provider-assigned unique ID for this managed 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 IpBlockSubnet Resource

    Get an existing IpBlockSubnet 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?: IpBlockSubnetState, opts?: CustomResourceOptions): IpBlockSubnet
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocation_ranges: Optional[Sequence[IpBlockSubnetAllocationRangeArgs]] = None,
        block_id: Optional[str] = None,
        cidr: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        ip_block_subnet_id: Optional[str] = None,
        revision: Optional[float] = None,
        size: Optional[float] = None,
        tags: Optional[Sequence[IpBlockSubnetTagArgs]] = None) -> IpBlockSubnet
    func GetIpBlockSubnet(ctx *Context, name string, id IDInput, state *IpBlockSubnetState, opts ...ResourceOption) (*IpBlockSubnet, error)
    public static IpBlockSubnet Get(string name, Input<string> id, IpBlockSubnetState? state, CustomResourceOptions? opts = null)
    public static IpBlockSubnet get(String name, Output<String> id, IpBlockSubnetState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:IpBlockSubnet    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:
    AllocationRanges List<IpBlockSubnetAllocationRange>
    A collection of IPv4 Pool Ranges
    BlockId string
    Block id for which the subnet is created.
    Cidr string
    Represents the size or number of IP addresses in the subnet. All subnets of the same block must have the same size, which must be a power of 2.
    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    IpBlockSubnetId string
    ID of the IP 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
    Represents the size or number of IP addresses in the subnet.
    Tags List<IpBlockSubnetTag>
    A list of scope + tag pairs to associate with this IP block subnet.
    AllocationRanges []IpBlockSubnetAllocationRangeArgs
    A collection of IPv4 Pool Ranges
    BlockId string
    Block id for which the subnet is created.
    Cidr string
    Represents the size or number of IP addresses in the subnet. All subnets of the same block must have the same size, which must be a power of 2.
    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    IpBlockSubnetId string
    ID of the IP 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
    Represents the size or number of IP addresses in the subnet.
    Tags []IpBlockSubnetTagArgs
    A list of scope + tag pairs to associate with this IP block subnet.
    allocationRanges List<IpBlockSubnetAllocationRange>
    A collection of IPv4 Pool Ranges
    blockId String
    Block id for which the subnet is created.
    cidr String
    Represents the size or number of IP addresses in the subnet. All subnets of the same block must have the same size, which must be a power of 2.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    ipBlockSubnetId String
    ID of the IP 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
    Represents the size or number of IP addresses in the subnet.
    tags List<IpBlockSubnetTag>
    A list of scope + tag pairs to associate with this IP block subnet.
    allocationRanges IpBlockSubnetAllocationRange[]
    A collection of IPv4 Pool Ranges
    blockId string
    Block id for which the subnet is created.
    cidr string
    Represents the size or number of IP addresses in the subnet. All subnets of the same block must have the same size, which must be a power of 2.
    description string
    Description of this resource.
    displayName string
    The display name of this resource. Defaults to ID if not set.
    ipBlockSubnetId string
    ID of the IP 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
    Represents the size or number of IP addresses in the subnet.
    tags IpBlockSubnetTag[]
    A list of scope + tag pairs to associate with this IP block subnet.
    allocation_ranges Sequence[IpBlockSubnetAllocationRangeArgs]
    A collection of IPv4 Pool Ranges
    block_id str
    Block id for which the subnet is created.
    cidr str
    Represents the size or number of IP addresses in the subnet. All subnets of the same block must have the same size, which must be a power of 2.
    description str
    Description of this resource.
    display_name str
    The display name of this resource. Defaults to ID if not set.
    ip_block_subnet_id str
    ID of the IP 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
    Represents the size or number of IP addresses in the subnet.
    tags Sequence[IpBlockSubnetTagArgs]
    A list of scope + tag pairs to associate with this IP block subnet.
    allocationRanges List<Property Map>
    A collection of IPv4 Pool Ranges
    blockId String
    Block id for which the subnet is created.
    cidr String
    Represents the size or number of IP addresses in the subnet. All subnets of the same block must have the same size, which must be a power of 2.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    ipBlockSubnetId String
    ID of the IP 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
    Represents the size or number of IP addresses in the subnet.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this IP block subnet.

    Supporting Types

    IpBlockSubnetAllocationRange, IpBlockSubnetAllocationRangeArgs

    End string
    Start string
    End string
    Start string
    end String
    start String
    end string
    start string
    end str
    start str
    end String
    start String

    IpBlockSubnetTag, IpBlockSubnetTagArgs

    Scope string
    Tag string
    A list of scope + tag pairs to associate with this IP block subnet.
    Scope string
    Tag string
    A list of scope + tag pairs to associate with this IP block subnet.
    scope String
    tag String
    A list of scope + tag pairs to associate with this IP block subnet.
    scope string
    tag string
    A list of scope + tag pairs to associate with this IP block subnet.
    scope str
    tag str
    A list of scope + tag pairs to associate with this IP block subnet.
    scope String
    tag String
    A list of scope + tag pairs to associate with this IP 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