PolicyNetworkSpan

nsxt 3.12.0, May 18 26

Viewing docs for nsxt 3.12.0
published on Monday, May 18, 2026 by vmware

Create PolicyNetworkSpan Resource

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

Constructor syntax

new PolicyNetworkSpan(name: string, args: PolicyNetworkSpanArgs, opts?: CustomResourceOptions);

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

@overload
def PolicyNetworkSpan(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      display_name: Optional[str] = None,
                      description: Optional[str] = None,
                      exclusive: Optional[bool] = None,
                      nsx_id: Optional[str] = None,
                      policy_network_span_id: Optional[str] = None,
                      tags: Optional[Sequence[PolicyNetworkSpanTagArgs]] = None)

func NewPolicyNetworkSpan(ctx *Context, name string, args PolicyNetworkSpanArgs, opts ...ResourceOption) (*PolicyNetworkSpan, error)

public PolicyNetworkSpan(string name, PolicyNetworkSpanArgs args, CustomResourceOptions? opts = null)

public PolicyNetworkSpan(String name, PolicyNetworkSpanArgs args)
public PolicyNetworkSpan(String name, PolicyNetworkSpanArgs args, CustomResourceOptions options)

type: nsxt:PolicyNetworkSpan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "nsxt_policynetworkspan" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args PolicyNetworkSpanArgs: 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 PolicyNetworkSpanArgs: 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 PolicyNetworkSpanArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args PolicyNetworkSpanArgs: 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 policyNetworkSpanResource = new Nsxt.PolicyNetworkSpan("policyNetworkSpanResource", new()
{
    DisplayName = "string",
    Description = "string",
    Exclusive = false,
    NsxId = "string",
    PolicyNetworkSpanId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyNetworkSpanTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

example, err := nsxt.NewPolicyNetworkSpan(ctx, "policyNetworkSpanResource", &nsxt.PolicyNetworkSpanArgs{
	DisplayName:         pulumi.String("string"),
	Description:         pulumi.String("string"),
	Exclusive:           pulumi.Bool(false),
	NsxId:               pulumi.String("string"),
	PolicyNetworkSpanId: pulumi.String("string"),
	Tags: nsxt.PolicyNetworkSpanTagArray{
		&nsxt.PolicyNetworkSpanTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

resource "nsxt_policynetworkspan" "policyNetworkSpanResource" {
  display_name           = "string"
  description            = "string"
  exclusive              = false
  nsx_id                 = "string"
  policy_network_span_id = "string"
  tags {
    scope = "string"
    tag   = "string"
  }
}

var policyNetworkSpanResource = new PolicyNetworkSpan("policyNetworkSpanResource", PolicyNetworkSpanArgs.builder()
    .displayName("string")
    .description("string")
    .exclusive(false)
    .nsxId("string")
    .policyNetworkSpanId("string")
    .tags(PolicyNetworkSpanTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

policy_network_span_resource = nsxt.PolicyNetworkSpan("policyNetworkSpanResource",
    display_name="string",
    description="string",
    exclusive=False,
    nsx_id="string",
    policy_network_span_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

const policyNetworkSpanResource = new nsxt.PolicyNetworkSpan("policyNetworkSpanResource", {
    displayName: "string",
    description: "string",
    exclusive: false,
    nsxId: "string",
    policyNetworkSpanId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

type: nsxt:PolicyNetworkSpan
properties:
    description: string
    displayName: string
    exclusive: false
    nsxId: string
    policyNetworkSpanId: string
    tags:
        - scope: string
          tag: string

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

DisplayName string: Display name of the resource.
Description string: Description of the resource.
Exclusive bool: When exclusive span enabled, VC clusters in the span are not shared across other Span including system default span.
NsxId string: The NSX ID of this resource. If set, this ID will be used to create the resource.
PolicyNetworkSpanId string: ID of the resource.
Tags List<PolicyNetworkSpanTag>: A list of scope + tag pairs to associate with this resource.

DisplayName string: Display name of the resource.
Description string: Description of the resource.
Exclusive bool: When exclusive span enabled, VC clusters in the span are not shared across other Span including system default span.
NsxId string: The NSX ID of this resource. If set, this ID will be used to create the resource.
PolicyNetworkSpanId string: ID of the resource.
Tags []PolicyNetworkSpanTagArgs: A list of scope + tag pairs to associate with this resource.

display_name string: Display name of the resource.
description string: Description of the resource.
exclusive bool: When exclusive span enabled, VC clusters in the span are not shared across other Span including system default span.
nsx_id string: The NSX ID of this resource. If set, this ID will be used to create the resource.
policy_network_span_id string: ID of the resource.
tags list(object): A list of scope + tag pairs to associate with this resource.

displayName String: Display name of the resource.
description String: Description of the resource.
exclusive Boolean: When exclusive span enabled, VC clusters in the span are not shared across other Span including system default span.
nsxId String: The NSX ID of this resource. If set, this ID will be used to create the resource.
policyNetworkSpanId String: ID of the resource.
tags List<PolicyNetworkSpanTag>: A list of scope + tag pairs to associate with this resource.

displayName string: Display name of the resource.
description string: Description of the resource.
exclusive boolean: When exclusive span enabled, VC clusters in the span are not shared across other Span including system default span.
nsxId string: The NSX ID of this resource. If set, this ID will be used to create the resource.
policyNetworkSpanId string: ID of the resource.
tags PolicyNetworkSpanTag[]: A list of scope + tag pairs to associate with this resource.

display_name str: Display name of the resource.
description str: Description of the resource.
exclusive bool: When exclusive span enabled, VC clusters in the span are not shared across other Span including system default span.
nsx_id str: The NSX ID of this resource. If set, this ID will be used to create the resource.
policy_network_span_id str: ID of the resource.
tags Sequence[PolicyNetworkSpanTagArgs]: A list of scope + tag pairs to associate with this resource.

displayName String: Display name of the resource.
description String: Description of the resource.
exclusive Boolean: When exclusive span enabled, VC clusters in the span are not shared across other Span including system default span.
nsxId String: The NSX ID of this resource. If set, this ID will be used to create the resource.
policyNetworkSpanId String: ID of the resource.
tags List<Property Map>: A list of scope + tag pairs to associate with this resource.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Path string: The NSX path of the policy 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 policy 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 policy 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 String: The provider-assigned unique ID for this managed resource.
path String: The NSX path of the policy 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 policy 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 policy 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 policy 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 PolicyNetworkSpan Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        exclusive: Optional[bool] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_network_span_id: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[PolicyNetworkSpanTagArgs]] = None) -> PolicyNetworkSpan

func GetPolicyNetworkSpan(ctx *Context, name string, id IDInput, state *PolicyNetworkSpanState, opts ...ResourceOption) (*PolicyNetworkSpan, error)

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

public static PolicyNetworkSpan get(String name, Output<String> id, PolicyNetworkSpanState state, CustomResourceOptions options)

resources:  _:    type: nsxt:PolicyNetworkSpan    get:      id: ${id}

import {
  to = nsxt_policynetworkspan.example
  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:

Description string: Description of the resource.
DisplayName string: Display name of the resource.
Exclusive bool: When exclusive span enabled, VC clusters in the span are not shared across other Span including system default span.
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 policy resource.
PolicyNetworkSpanId string: ID 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.
Tags List<PolicyNetworkSpanTag>: A list of scope + tag pairs to associate with this resource.

Description string: Description of the resource.
DisplayName string: Display name of the resource.
Exclusive bool: When exclusive span enabled, VC clusters in the span are not shared across other Span including system default span.
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 policy resource.
PolicyNetworkSpanId string: ID 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.
Tags []PolicyNetworkSpanTagArgs: A list of scope + tag pairs to associate with this resource.

description string: Description of the resource.
display_name string: Display name of the resource.
exclusive bool: When exclusive span enabled, VC clusters in the span are not shared across other Span including system default span.
nsx_id 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 policy resource.
policy_network_span_id string: ID 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.
tags list(object): A list of scope + tag pairs to associate with this resource.

description String: Description of the resource.
displayName String: Display name of the resource.
exclusive Boolean: When exclusive span enabled, VC clusters in the span are not shared across other Span including system default span.
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 policy resource.
policyNetworkSpanId String: ID 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.
tags List<PolicyNetworkSpanTag>: A list of scope + tag pairs to associate with this resource.

description string: Description of the resource.
displayName string: Display name of the resource.
exclusive boolean: When exclusive span enabled, VC clusters in the span are not shared across other Span including system default span.
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 policy resource.
policyNetworkSpanId string: ID 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.
tags PolicyNetworkSpanTag[]: A list of scope + tag pairs to associate with this resource.

description str: Description of the resource.
display_name str: Display name of the resource.
exclusive bool: When exclusive span enabled, VC clusters in the span are not shared across other Span including system default span.
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 policy resource.
policy_network_span_id str: ID 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.
tags Sequence[PolicyNetworkSpanTagArgs]: A list of scope + tag pairs to associate with this resource.

description String: Description of the resource.
displayName String: Display name of the resource.
exclusive Boolean: When exclusive span enabled, VC clusters in the span are not shared across other Span including system default span.
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 policy resource.
policyNetworkSpanId String: ID 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.
tags List<Property Map>: A list of scope + tag pairs to associate with this resource.

Supporting Types

PolicyNetworkSpanTag, PolicyNetworkSpanTagArgs

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

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

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

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

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

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

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

Package Details

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

Viewing docs for nsxt 3.12.0
published on Monday, May 18, 2026 by vmware

Schema (JSON)

vmware/terraform-provider-nsxt

nsxt.PolicyNetworkSpan

On this page

On this page

Create PolicyNetworkSpan Resource

Constructor syntax

Parameters

Constructor example

PolicyNetworkSpan Resource Properties

Inputs

Outputs

Look up Existing PolicyNetworkSpan Resource

Supporting Types

PolicyNetworkSpanTag, PolicyNetworkSpanTagArgs

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

nsxt.PolicyNetworkSpan

On this page

On this page

Create PolicyNetworkSpan Resource

Constructor syntax

Parameters

Constructor example

PolicyNetworkSpan Resource Properties

Inputs

Outputs

Look up Existing PolicyNetworkSpan Resource

Supporting Types

PolicyNetworkSpanTag, PolicyNetworkSpanTagArgs

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.