nsxt 3.8.1, Apr 30 25

nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

nsxt.IpBlock

Explore with Pulumi AI

nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

Create IpBlock Resource

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

Constructor syntax

new IpBlock(name: string, args: IpBlockArgs, opts?: CustomResourceOptions);

@overload
def IpBlock(resource_name: str,
            args: IpBlockArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def IpBlock(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            cidr: Optional[str] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            ip_block_id: Optional[str] = None,
            tags: Optional[Sequence[IpBlockTagArgs]] = None)

func NewIpBlock(ctx *Context, name string, args IpBlockArgs, opts ...ResourceOption) (*IpBlock, error)

public IpBlock(string name, IpBlockArgs args, CustomResourceOptions? opts = null)

public IpBlock(String name, IpBlockArgs args)
public IpBlock(String name, IpBlockArgs args, CustomResourceOptions options)

type: nsxt:IpBlock
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 IpBlockArgs: 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 IpBlockArgs: 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 IpBlockArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args IpBlockArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args IpBlockArgs: 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 ipBlockResource = new Nsxt.IpBlock("ipBlockResource", new()
{
    Cidr = "string",
    Description = "string",
    DisplayName = "string",
    IpBlockId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.IpBlockTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

example, err := nsxt.NewIpBlock(ctx, "ipBlockResource", &nsxt.IpBlockArgs{
	Cidr:        pulumi.String("string"),
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	IpBlockId:   pulumi.String("string"),
	Tags: nsxt.IpBlockTagArray{
		&nsxt.IpBlockTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

var ipBlockResource = new IpBlock("ipBlockResource", IpBlockArgs.builder()
    .cidr("string")
    .description("string")
    .displayName("string")
    .ipBlockId("string")
    .tags(IpBlockTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

ip_block_resource = nsxt.IpBlock("ipBlockResource",
    cidr="string",
    description="string",
    display_name="string",
    ip_block_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

const ipBlockResource = new nsxt.IpBlock("ipBlockResource", {
    cidr: "string",
    description: "string",
    displayName: "string",
    ipBlockId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

type: nsxt:IpBlock
properties:
    cidr: string
    description: string
    displayName: string
    ipBlockId: string
    tags:
        - scope: string
          tag: string

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

Cidr string: Represents network address and the prefix length which will be associated with a layer-2 broadcast domain.
Description string: Description of this resource.
DisplayName string: The display name of this resource. Defaults to ID if not set.
IpBlockId string: ID of the IP block.
Tags List<IpBlockTag>: A list of scope + tag pairs to associate with this IP block.

Cidr string: Represents network address and the prefix length which will be associated with a layer-2 broadcast domain.
Description string: Description of this resource.
DisplayName string: The display name of this resource. Defaults to ID if not set.
IpBlockId string: ID of the IP block.
Tags []IpBlockTagArgs: A list of scope + tag pairs to associate with this IP block.

cidr String: Represents network address and the prefix length which will be associated with a layer-2 broadcast domain.
description String: Description of this resource.
displayName String: The display name of this resource. Defaults to ID if not set.
ipBlockId String: ID of the IP block.
tags List<IpBlockTag>: A list of scope + tag pairs to associate with this IP block.

cidr string: Represents network address and the prefix length which will be associated with a layer-2 broadcast domain.
description string: Description of this resource.
displayName string: The display name of this resource. Defaults to ID if not set.
ipBlockId string: ID of the IP block.
tags IpBlockTag[]: A list of scope + tag pairs to associate with this IP block.

cidr str: Represents network address and the prefix length which will be associated with a layer-2 broadcast domain.
description str: Description of this resource.
display_name str: The display name of this resource. Defaults to ID if not set.
ip_block_id str: ID of the IP block.
tags Sequence[IpBlockTagArgs]: A list of scope + tag pairs to associate with this IP block.

cidr String: Represents network address and the prefix length which will be associated with a layer-2 broadcast domain.
description String: Description of this resource.
displayName String: The display name of this resource. Defaults to ID if not set.
ipBlockId String: ID of the IP block.
tags List<Property Map>: A list of scope + tag pairs to associate with this IP block.

Outputs

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

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.

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.

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.

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.

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.

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 IpBlock Resource

Get an existing IpBlock 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?: IpBlockState, opts?: CustomResourceOptions): IpBlock

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cidr: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        ip_block_id: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[IpBlockTagArgs]] = None) -> IpBlock

func GetIpBlock(ctx *Context, name string, id IDInput, state *IpBlockState, opts ...ResourceOption) (*IpBlock, error)

public static IpBlock Get(string name, Input<string> id, IpBlockState? state, CustomResourceOptions? opts = null)

public static IpBlock get(String name, Output<String> id, IpBlockState state, CustomResourceOptions options)

resources:  _:    type: nsxt:IpBlock    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:

Cidr string: Represents network address and the prefix length which will be associated with a layer-2 broadcast domain.
Description string: Description of this resource.
DisplayName string: The display name of this resource. Defaults to ID if not set.
IpBlockId string: ID of the IP block.
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<IpBlockTag>: A list of scope + tag pairs to associate with this IP block.

Cidr string: Represents network address and the prefix length which will be associated with a layer-2 broadcast domain.
Description string: Description of this resource.
DisplayName string: The display name of this resource. Defaults to ID if not set.
IpBlockId string: ID of the IP block.
Revision float64: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Tags []IpBlockTagArgs: A list of scope + tag pairs to associate with this IP block.

cidr String: Represents network address and the prefix length which will be associated with a layer-2 broadcast domain.
description String: Description of this resource.
displayName String: The display name of this resource. Defaults to ID if not set.
ipBlockId String: ID of the IP block.
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<IpBlockTag>: A list of scope + tag pairs to associate with this IP block.

cidr string: Represents network address and the prefix length which will be associated with a layer-2 broadcast domain.
description string: Description of this resource.
displayName string: The display name of this resource. Defaults to ID if not set.
ipBlockId string: ID of the IP block.
revision number: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
tags IpBlockTag[]: A list of scope + tag pairs to associate with this IP block.

cidr str: Represents network address and the prefix length which will be associated with a layer-2 broadcast domain.
description str: Description of this resource.
display_name str: The display name of this resource. Defaults to ID if not set.
ip_block_id str: ID of the IP block.
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[IpBlockTagArgs]: A list of scope + tag pairs to associate with this IP block.

cidr String: Represents network address and the prefix length which will be associated with a layer-2 broadcast domain.
description String: Description of this resource.
displayName String: The display name of this resource. Defaults to ID if not set.
ipBlockId String: ID of the IP block.
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 block.

Supporting Types

IpBlockTag, IpBlockTagArgs

Scope string
Tag string: A list of scope + tag pairs to associate with this IP block.

Scope string
Tag string: A list of scope + tag pairs to associate with this IP block.

scope String
tag String: A list of scope + tag pairs to associate with this IP block.

scope string
tag string: A list of scope + tag pairs to associate with this IP block.

scope str
tag str: A list of scope + tag pairs to associate with this IP block.

scope String
tag String: A list of scope + tag pairs to associate with this IP block.

Package Details

Repository: nsxt vmware/terraform-provider-nsxt
License
Notes: This Pulumi package is based on the nsxt Terraform Provider.

nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

vmware/terraform-provider-nsxt

nsxt.IpBlock

On this page

On this page

Create IpBlock Resource

Constructor syntax

Parameters

Constructor example

IpBlock Resource Properties

Inputs

Outputs

Look up Existing IpBlock Resource

Supporting Types

IpBlockTag, IpBlockTagArgs

Package Details

On this page

On this page