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

nsxt.PolicyIpBlock

Explore with Pulumi AI

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

Create PolicyIpBlock Resource

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

Constructor syntax

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

@overload
def PolicyIpBlock(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  cidr: Optional[str] = None,
                  display_name: Optional[str] = None,
                  context: Optional[PolicyIpBlockContextArgs] = None,
                  description: Optional[str] = None,
                  nsx_id: Optional[str] = None,
                  policy_ip_block_id: Optional[str] = None,
                  tags: Optional[Sequence[PolicyIpBlockTagArgs]] = None,
                  visibility: Optional[str] = None)
func NewPolicyIpBlock(ctx *Context, name string, args PolicyIpBlockArgs, opts ...ResourceOption) (*PolicyIpBlock, error)
public PolicyIpBlock(string name, PolicyIpBlockArgs args, CustomResourceOptions? opts = null)
public PolicyIpBlock(String name, PolicyIpBlockArgs args)
public PolicyIpBlock(String name, PolicyIpBlockArgs args, CustomResourceOptions options)

type: nsxt:PolicyIpBlock
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. PolicyIpBlockArgs
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. PolicyIpBlockArgs
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. PolicyIpBlockArgs
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. PolicyIpBlockArgs
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. PolicyIpBlockArgs
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 policyIpBlockResource = new Nsxt.PolicyIpBlock("policyIpBlockResource", new()
{
    Cidr = "string",
    DisplayName = "string",
    Context = new Nsxt.Inputs.PolicyIpBlockContextArgs
    {
        ProjectId = "string",
    },
    Description = "string",
    NsxId = "string",
    PolicyIpBlockId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyIpBlockTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
    Visibility = "string",
});
Copy
example, err := nsxt.NewPolicyIpBlock(ctx, "policyIpBlockResource", &nsxt.PolicyIpBlockArgs{
	Cidr:        pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	Context: &nsxt.PolicyIpBlockContextArgs{
		ProjectId: pulumi.String("string"),
	},
	Description:     pulumi.String("string"),
	NsxId:           pulumi.String("string"),
	PolicyIpBlockId: pulumi.String("string"),
	Tags: nsxt.PolicyIpBlockTagArray{
		&nsxt.PolicyIpBlockTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
	Visibility: pulumi.String("string"),
})
Copy
var policyIpBlockResource = new PolicyIpBlock("policyIpBlockResource", PolicyIpBlockArgs.builder()
    .cidr("string")
    .displayName("string")
    .context(PolicyIpBlockContextArgs.builder()
        .projectId("string")
        .build())
    .description("string")
    .nsxId("string")
    .policyIpBlockId("string")
    .tags(PolicyIpBlockTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .visibility("string")
    .build());
Copy
policy_ip_block_resource = nsxt.PolicyIpBlock("policyIpBlockResource",
    cidr="string",
    display_name="string",
    context={
        "project_id": "string",
    },
    description="string",
    nsx_id="string",
    policy_ip_block_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }],
    visibility="string")
Copy
const policyIpBlockResource = new nsxt.PolicyIpBlock("policyIpBlockResource", {
    cidr: "string",
    displayName: "string",
    context: {
        projectId: "string",
    },
    description: "string",
    nsxId: "string",
    policyIpBlockId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
    visibility: "string",
});
Copy
type: nsxt:PolicyIpBlock
properties:
    cidr: string
    context:
        projectId: string
    description: string
    displayName: string
    nsxId: string
    policyIpBlockId: string
    tags:
        - scope: string
          tag: string
    visibility: string
Copy

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

Cidr This property is required. string
Network address and the prefix length which will be associated with a layer-2 broadcast domain.
DisplayName This property is required. string
The display name for the IP Block.
Context PolicyIpBlockContext
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.
PolicyIpBlockId string
ID of the IP Block.
Tags List<PolicyIpBlockTag>
A list of scope + tag pairs to associate with this IP Block.
Visibility string
Visibility of the IP Block. Valid options are PRIVATE, EXTERNAL or unset. Visibility cannot be changed once the block is associated with other resources.
Cidr This property is required. string
Network address and the prefix length which will be associated with a layer-2 broadcast domain.
DisplayName This property is required. string
The display name for the IP Block.
Context PolicyIpBlockContextArgs
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.
PolicyIpBlockId string
ID of the IP Block.
Tags []PolicyIpBlockTagArgs
A list of scope + tag pairs to associate with this IP Block.
Visibility string
Visibility of the IP Block. Valid options are PRIVATE, EXTERNAL or unset. Visibility cannot be changed once the block is associated with other resources.
cidr This property is required. String
Network address and the prefix length which will be associated with a layer-2 broadcast domain.
displayName This property is required. String
The display name for the IP Block.
context PolicyIpBlockContext
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.
policyIpBlockId String
ID of the IP Block.
tags List<PolicyIpBlockTag>
A list of scope + tag pairs to associate with this IP Block.
visibility String
Visibility of the IP Block. Valid options are PRIVATE, EXTERNAL or unset. Visibility cannot be changed once the block is associated with other resources.
cidr This property is required. string
Network address and the prefix length which will be associated with a layer-2 broadcast domain.
displayName This property is required. string
The display name for the IP Block.
context PolicyIpBlockContext
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.
policyIpBlockId string
ID of the IP Block.
tags PolicyIpBlockTag[]
A list of scope + tag pairs to associate with this IP Block.
visibility string
Visibility of the IP Block. Valid options are PRIVATE, EXTERNAL or unset. Visibility cannot be changed once the block is associated with other resources.
cidr This property is required. str
Network address and the prefix length which will be associated with a layer-2 broadcast domain.
display_name This property is required. str
The display name for the IP Block.
context PolicyIpBlockContextArgs
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_block_id str
ID of the IP Block.
tags Sequence[PolicyIpBlockTagArgs]
A list of scope + tag pairs to associate with this IP Block.
visibility str
Visibility of the IP Block. Valid options are PRIVATE, EXTERNAL or unset. Visibility cannot be changed once the block is associated with other resources.
cidr This property is required. String
Network address and the prefix length which will be associated with a layer-2 broadcast domain.
displayName This property is required. String
The display name for the IP Block.
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.
policyIpBlockId String
ID of the IP Block.
tags List<Property Map>
A list of scope + tag pairs to associate with this IP Block.
visibility String
Visibility of the IP Block. Valid options are PRIVATE, EXTERNAL or unset. Visibility cannot be changed once the block is associated with other resources.

Outputs

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

Get an existing PolicyIpBlock 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?: PolicyIpBlockState, opts?: CustomResourceOptions): PolicyIpBlock
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cidr: Optional[str] = None,
        context: Optional[PolicyIpBlockContextArgs] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_ip_block_id: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[PolicyIpBlockTagArgs]] = None,
        visibility: Optional[str] = None) -> PolicyIpBlock
func GetPolicyIpBlock(ctx *Context, name string, id IDInput, state *PolicyIpBlockState, opts ...ResourceOption) (*PolicyIpBlock, error)
public static PolicyIpBlock Get(string name, Input<string> id, PolicyIpBlockState? state, CustomResourceOptions? opts = null)
public static PolicyIpBlock get(String name, Output<String> id, PolicyIpBlockState state, CustomResourceOptions options)
resources:  _:    type: nsxt:PolicyIpBlock    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:
Cidr string
Network address and the prefix length which will be associated with a layer-2 broadcast domain.
Context PolicyIpBlockContext
The context which the object belongs to
Description string
Description of the resource.
DisplayName string
The display name for the IP Block.
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.
PolicyIpBlockId 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<PolicyIpBlockTag>
A list of scope + tag pairs to associate with this IP Block.
Visibility string
Visibility of the IP Block. Valid options are PRIVATE, EXTERNAL or unset. Visibility cannot be changed once the block is associated with other resources.
Cidr string
Network address and the prefix length which will be associated with a layer-2 broadcast domain.
Context PolicyIpBlockContextArgs
The context which the object belongs to
Description string
Description of the resource.
DisplayName string
The display name for the IP Block.
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.
PolicyIpBlockId 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 []PolicyIpBlockTagArgs
A list of scope + tag pairs to associate with this IP Block.
Visibility string
Visibility of the IP Block. Valid options are PRIVATE, EXTERNAL or unset. Visibility cannot be changed once the block is associated with other resources.
cidr String
Network address and the prefix length which will be associated with a layer-2 broadcast domain.
context PolicyIpBlockContext
The context which the object belongs to
description String
Description of the resource.
displayName String
The display name for the IP Block.
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.
policyIpBlockId 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<PolicyIpBlockTag>
A list of scope + tag pairs to associate with this IP Block.
visibility String
Visibility of the IP Block. Valid options are PRIVATE, EXTERNAL or unset. Visibility cannot be changed once the block is associated with other resources.
cidr string
Network address and the prefix length which will be associated with a layer-2 broadcast domain.
context PolicyIpBlockContext
The context which the object belongs to
description string
Description of the resource.
displayName string
The display name for the IP Block.
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.
policyIpBlockId 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 PolicyIpBlockTag[]
A list of scope + tag pairs to associate with this IP Block.
visibility string
Visibility of the IP Block. Valid options are PRIVATE, EXTERNAL or unset. Visibility cannot be changed once the block is associated with other resources.
cidr str
Network address and the prefix length which will be associated with a layer-2 broadcast domain.
context PolicyIpBlockContextArgs
The context which the object belongs to
description str
Description of the resource.
display_name str
The display name for the IP Block.
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_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[PolicyIpBlockTagArgs]
A list of scope + tag pairs to associate with this IP Block.
visibility str
Visibility of the IP Block. Valid options are PRIVATE, EXTERNAL or unset. Visibility cannot be changed once the block is associated with other resources.
cidr String
Network address and the prefix length which will be associated with a layer-2 broadcast domain.
context Property Map
The context which the object belongs to
description String
Description of the resource.
displayName String
The display name for the IP Block.
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.
policyIpBlockId 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.
visibility String
Visibility of the IP Block. Valid options are PRIVATE, EXTERNAL or unset. Visibility cannot be changed once the block is associated with other resources.

Supporting Types

PolicyIpBlockContext
, PolicyIpBlockContextArgs

ProjectId This property is required. string
The ID of the project which the object belongs to
ProjectId This property is required. string
The ID of the project which the object belongs to
projectId This property is required. String
The ID of the project which the object belongs to
projectId This property is required. string
The ID of the project which the object belongs to
project_id This property is required. str
The ID of the project which the object belongs to
projectId This property is required. String
The ID of the project which the object belongs to

PolicyIpBlockTag
, PolicyIpBlockTagArgs

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.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt