1. Packages
  2. Vcd Provider
  3. API Docs
  4. getNsxtSegmentSecurityProfile
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vcd.getNsxtSegmentSecurityProfile

Explore with Pulumi AI

Provides a VMware Cloud Director NSX-T Segment Security Profile data source. This can be used to read NSX-T Segment Profile definitions.

Supported in provider v3.11+.

Example Usage

Segment Security Profile)

import * as pulumi from "@pulumi/pulumi";
import * as vcd from "@pulumi/vcd";

const nsxt = vcd.getNsxtManager({
    name: "nsxManager1",
});
const first = nsxt.then(nsxt => vcd.getNsxtSegmentSecurityProfile({
    name: "segment-security-profile-0",
    nsxtManagerId: nsxt.id,
}));
Copy
import pulumi
import pulumi_vcd as vcd

nsxt = vcd.get_nsxt_manager(name="nsxManager1")
first = vcd.get_nsxt_segment_security_profile(name="segment-security-profile-0",
    nsxt_manager_id=nsxt.id)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vcd/v3/vcd"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		nsxt, err := vcd.GetNsxtManager(ctx, &vcd.GetNsxtManagerArgs{
			Name: "nsxManager1",
		}, nil)
		if err != nil {
			return err
		}
		_, err = vcd.GetNsxtSegmentSecurityProfile(ctx, &vcd.GetNsxtSegmentSecurityProfileArgs{
			Name:          "segment-security-profile-0",
			NsxtManagerId: pulumi.StringRef(nsxt.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vcd = Pulumi.Vcd;

return await Deployment.RunAsync(() => 
{
    var nsxt = Vcd.GetNsxtManager.Invoke(new()
    {
        Name = "nsxManager1",
    });

    var first = Vcd.GetNsxtSegmentSecurityProfile.Invoke(new()
    {
        Name = "segment-security-profile-0",
        NsxtManagerId = nsxt.Apply(getNsxtManagerResult => getNsxtManagerResult.Id),
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vcd.VcdFunctions;
import com.pulumi.vcd.inputs.GetNsxtManagerArgs;
import com.pulumi.vcd.inputs.GetNsxtSegmentSecurityProfileArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var nsxt = VcdFunctions.getNsxtManager(GetNsxtManagerArgs.builder()
            .name("nsxManager1")
            .build());

        final var first = VcdFunctions.getNsxtSegmentSecurityProfile(GetNsxtSegmentSecurityProfileArgs.builder()
            .name("segment-security-profile-0")
            .nsxtManagerId(nsxt.applyValue(getNsxtManagerResult -> getNsxtManagerResult.id()))
            .build());

    }
}
Copy
variables:
  nsxt:
    fn::invoke:
      function: vcd:getNsxtManager
      arguments:
        name: nsxManager1
  first:
    fn::invoke:
      function: vcd:getNsxtSegmentSecurityProfile
      arguments:
        name: segment-security-profile-0
        nsxtManagerId: ${nsxt.id}
Copy

Using getNsxtSegmentSecurityProfile

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getNsxtSegmentSecurityProfile(args: GetNsxtSegmentSecurityProfileArgs, opts?: InvokeOptions): Promise<GetNsxtSegmentSecurityProfileResult>
function getNsxtSegmentSecurityProfileOutput(args: GetNsxtSegmentSecurityProfileOutputArgs, opts?: InvokeOptions): Output<GetNsxtSegmentSecurityProfileResult>
Copy
def get_nsxt_segment_security_profile(bpdu_filter_allow_lists: Optional[Sequence[str]] = None,
                                      id: Optional[str] = None,
                                      name: Optional[str] = None,
                                      nsxt_manager_id: Optional[str] = None,
                                      vdc_group_id: Optional[str] = None,
                                      vdc_id: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetNsxtSegmentSecurityProfileResult
def get_nsxt_segment_security_profile_output(bpdu_filter_allow_lists: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                      id: Optional[pulumi.Input[str]] = None,
                                      name: Optional[pulumi.Input[str]] = None,
                                      nsxt_manager_id: Optional[pulumi.Input[str]] = None,
                                      vdc_group_id: Optional[pulumi.Input[str]] = None,
                                      vdc_id: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetNsxtSegmentSecurityProfileResult]
Copy
func GetNsxtSegmentSecurityProfile(ctx *Context, args *GetNsxtSegmentSecurityProfileArgs, opts ...InvokeOption) (*GetNsxtSegmentSecurityProfileResult, error)
func GetNsxtSegmentSecurityProfileOutput(ctx *Context, args *GetNsxtSegmentSecurityProfileOutputArgs, opts ...InvokeOption) GetNsxtSegmentSecurityProfileResultOutput
Copy

> Note: This function is named GetNsxtSegmentSecurityProfile in the Go SDK.

public static class GetNsxtSegmentSecurityProfile 
{
    public static Task<GetNsxtSegmentSecurityProfileResult> InvokeAsync(GetNsxtSegmentSecurityProfileArgs args, InvokeOptions? opts = null)
    public static Output<GetNsxtSegmentSecurityProfileResult> Invoke(GetNsxtSegmentSecurityProfileInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNsxtSegmentSecurityProfileResult> getNsxtSegmentSecurityProfile(GetNsxtSegmentSecurityProfileArgs args, InvokeOptions options)
public static Output<GetNsxtSegmentSecurityProfileResult> getNsxtSegmentSecurityProfile(GetNsxtSegmentSecurityProfileArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: vcd:index/getNsxtSegmentSecurityProfile:getNsxtSegmentSecurityProfile
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
The name of Segment Profile
BpduFilterAllowLists List<string>
Pre-defined list of allowed MAC addresses to be excluded from BPDU filtering.
Id string
NsxtManagerId string
Segment Profile search context. Use when searching by NSX-T manager
VdcGroupId string

Segment Profile search context. Use when searching by VDC group

Note: only one of nsxt_manager_id, vdc_id, vdc_group_id can be used

VdcId string
Segment Profile search context. Use when searching by VDC
Name This property is required. string
The name of Segment Profile
BpduFilterAllowLists []string
Pre-defined list of allowed MAC addresses to be excluded from BPDU filtering.
Id string
NsxtManagerId string
Segment Profile search context. Use when searching by NSX-T manager
VdcGroupId string

Segment Profile search context. Use when searching by VDC group

Note: only one of nsxt_manager_id, vdc_id, vdc_group_id can be used

VdcId string
Segment Profile search context. Use when searching by VDC
name This property is required. String
The name of Segment Profile
bpduFilterAllowLists List<String>
Pre-defined list of allowed MAC addresses to be excluded from BPDU filtering.
id String
nsxtManagerId String
Segment Profile search context. Use when searching by NSX-T manager
vdcGroupId String

Segment Profile search context. Use when searching by VDC group

Note: only one of nsxt_manager_id, vdc_id, vdc_group_id can be used

vdcId String
Segment Profile search context. Use when searching by VDC
name This property is required. string
The name of Segment Profile
bpduFilterAllowLists string[]
Pre-defined list of allowed MAC addresses to be excluded from BPDU filtering.
id string
nsxtManagerId string
Segment Profile search context. Use when searching by NSX-T manager
vdcGroupId string

Segment Profile search context. Use when searching by VDC group

Note: only one of nsxt_manager_id, vdc_id, vdc_group_id can be used

vdcId string
Segment Profile search context. Use when searching by VDC
name This property is required. str
The name of Segment Profile
bpdu_filter_allow_lists Sequence[str]
Pre-defined list of allowed MAC addresses to be excluded from BPDU filtering.
id str
nsxt_manager_id str
Segment Profile search context. Use when searching by NSX-T manager
vdc_group_id str

Segment Profile search context. Use when searching by VDC group

Note: only one of nsxt_manager_id, vdc_id, vdc_group_id can be used

vdc_id str
Segment Profile search context. Use when searching by VDC
name This property is required. String
The name of Segment Profile
bpduFilterAllowLists List<String>
Pre-defined list of allowed MAC addresses to be excluded from BPDU filtering.
id String
nsxtManagerId String
Segment Profile search context. Use when searching by NSX-T manager
vdcGroupId String

Segment Profile search context. Use when searching by VDC group

Note: only one of nsxt_manager_id, vdc_id, vdc_group_id can be used

vdcId String
Segment Profile search context. Use when searching by VDC

getNsxtSegmentSecurityProfile Result

The following output properties are available:

Description string
Description of Segment Security Profile
Id string
IsBpduFilterEnabled bool
Defines whether BPDU filter is enabled.
IsDhcpV4ClientBlockEnabled bool
Defines whether DHCP Client block IPv4 is enabled. This filters DHCP Client IPv4 traffic.
IsDhcpV4ServerBlockEnabled bool
Defines whether DHCP Server block IPv4 is enabled. This filters DHCP Server IPv4 traffic.
IsDhcpV6ClientBlockEnabled bool
Defines whether DHCP Client block IPv6 is enabled. This filters DHCP Client IPv6 traffic.
IsDhcpV6ServerBlockEnabled bool
Defines whether DHCP Server block IPv6 is enabled. This filters DHCP Server IPv6 traffic.
IsNonIpTrafficBlockEnabled bool
Defines whether non IP traffic block is enabled. If true, it blocks all traffic except IP/(G)ARP/BPDU.
IsRaGuardEnabled bool
Defines whether Router Advertisement Guard is enabled. This filters DHCP Server IPv6 traffic.
IsRateLimittingEnabled bool
Defines whether Rate Limiting is enabled.
Name string
RxBroadcastLimit double
Incoming broadcast traffic limit in packets per second.
RxMulticastLimit double
Incoming multicast traffic limit in packets per second.
TxBroadcastLimit double
Outgoing broadcast traffic limit in packets per second.
TxMulticastLimit double
Outgoing multicast traffic limit in packets per second.
BpduFilterAllowLists List<string>
Pre-defined list of allowed MAC addresses to be excluded from BPDU filtering.
NsxtManagerId string
VdcGroupId string
VdcId string
Description string
Description of Segment Security Profile
Id string
IsBpduFilterEnabled bool
Defines whether BPDU filter is enabled.
IsDhcpV4ClientBlockEnabled bool
Defines whether DHCP Client block IPv4 is enabled. This filters DHCP Client IPv4 traffic.
IsDhcpV4ServerBlockEnabled bool
Defines whether DHCP Server block IPv4 is enabled. This filters DHCP Server IPv4 traffic.
IsDhcpV6ClientBlockEnabled bool
Defines whether DHCP Client block IPv6 is enabled. This filters DHCP Client IPv6 traffic.
IsDhcpV6ServerBlockEnabled bool
Defines whether DHCP Server block IPv6 is enabled. This filters DHCP Server IPv6 traffic.
IsNonIpTrafficBlockEnabled bool
Defines whether non IP traffic block is enabled. If true, it blocks all traffic except IP/(G)ARP/BPDU.
IsRaGuardEnabled bool
Defines whether Router Advertisement Guard is enabled. This filters DHCP Server IPv6 traffic.
IsRateLimittingEnabled bool
Defines whether Rate Limiting is enabled.
Name string
RxBroadcastLimit float64
Incoming broadcast traffic limit in packets per second.
RxMulticastLimit float64
Incoming multicast traffic limit in packets per second.
TxBroadcastLimit float64
Outgoing broadcast traffic limit in packets per second.
TxMulticastLimit float64
Outgoing multicast traffic limit in packets per second.
BpduFilterAllowLists []string
Pre-defined list of allowed MAC addresses to be excluded from BPDU filtering.
NsxtManagerId string
VdcGroupId string
VdcId string
description String
Description of Segment Security Profile
id String
isBpduFilterEnabled Boolean
Defines whether BPDU filter is enabled.
isDhcpV4ClientBlockEnabled Boolean
Defines whether DHCP Client block IPv4 is enabled. This filters DHCP Client IPv4 traffic.
isDhcpV4ServerBlockEnabled Boolean
Defines whether DHCP Server block IPv4 is enabled. This filters DHCP Server IPv4 traffic.
isDhcpV6ClientBlockEnabled Boolean
Defines whether DHCP Client block IPv6 is enabled. This filters DHCP Client IPv6 traffic.
isDhcpV6ServerBlockEnabled Boolean
Defines whether DHCP Server block IPv6 is enabled. This filters DHCP Server IPv6 traffic.
isNonIpTrafficBlockEnabled Boolean
Defines whether non IP traffic block is enabled. If true, it blocks all traffic except IP/(G)ARP/BPDU.
isRaGuardEnabled Boolean
Defines whether Router Advertisement Guard is enabled. This filters DHCP Server IPv6 traffic.
isRateLimittingEnabled Boolean
Defines whether Rate Limiting is enabled.
name String
rxBroadcastLimit Double
Incoming broadcast traffic limit in packets per second.
rxMulticastLimit Double
Incoming multicast traffic limit in packets per second.
txBroadcastLimit Double
Outgoing broadcast traffic limit in packets per second.
txMulticastLimit Double
Outgoing multicast traffic limit in packets per second.
bpduFilterAllowLists List<String>
Pre-defined list of allowed MAC addresses to be excluded from BPDU filtering.
nsxtManagerId String
vdcGroupId String
vdcId String
description string
Description of Segment Security Profile
id string
isBpduFilterEnabled boolean
Defines whether BPDU filter is enabled.
isDhcpV4ClientBlockEnabled boolean
Defines whether DHCP Client block IPv4 is enabled. This filters DHCP Client IPv4 traffic.
isDhcpV4ServerBlockEnabled boolean
Defines whether DHCP Server block IPv4 is enabled. This filters DHCP Server IPv4 traffic.
isDhcpV6ClientBlockEnabled boolean
Defines whether DHCP Client block IPv6 is enabled. This filters DHCP Client IPv6 traffic.
isDhcpV6ServerBlockEnabled boolean
Defines whether DHCP Server block IPv6 is enabled. This filters DHCP Server IPv6 traffic.
isNonIpTrafficBlockEnabled boolean
Defines whether non IP traffic block is enabled. If true, it blocks all traffic except IP/(G)ARP/BPDU.
isRaGuardEnabled boolean
Defines whether Router Advertisement Guard is enabled. This filters DHCP Server IPv6 traffic.
isRateLimittingEnabled boolean
Defines whether Rate Limiting is enabled.
name string
rxBroadcastLimit number
Incoming broadcast traffic limit in packets per second.
rxMulticastLimit number
Incoming multicast traffic limit in packets per second.
txBroadcastLimit number
Outgoing broadcast traffic limit in packets per second.
txMulticastLimit number
Outgoing multicast traffic limit in packets per second.
bpduFilterAllowLists string[]
Pre-defined list of allowed MAC addresses to be excluded from BPDU filtering.
nsxtManagerId string
vdcGroupId string
vdcId string
description str
Description of Segment Security Profile
id str
is_bpdu_filter_enabled bool
Defines whether BPDU filter is enabled.
is_dhcp_v4_client_block_enabled bool
Defines whether DHCP Client block IPv4 is enabled. This filters DHCP Client IPv4 traffic.
is_dhcp_v4_server_block_enabled bool
Defines whether DHCP Server block IPv4 is enabled. This filters DHCP Server IPv4 traffic.
is_dhcp_v6_client_block_enabled bool
Defines whether DHCP Client block IPv6 is enabled. This filters DHCP Client IPv6 traffic.
is_dhcp_v6_server_block_enabled bool
Defines whether DHCP Server block IPv6 is enabled. This filters DHCP Server IPv6 traffic.
is_non_ip_traffic_block_enabled bool
Defines whether non IP traffic block is enabled. If true, it blocks all traffic except IP/(G)ARP/BPDU.
is_ra_guard_enabled bool
Defines whether Router Advertisement Guard is enabled. This filters DHCP Server IPv6 traffic.
is_rate_limitting_enabled bool
Defines whether Rate Limiting is enabled.
name str
rx_broadcast_limit float
Incoming broadcast traffic limit in packets per second.
rx_multicast_limit float
Incoming multicast traffic limit in packets per second.
tx_broadcast_limit float
Outgoing broadcast traffic limit in packets per second.
tx_multicast_limit float
Outgoing multicast traffic limit in packets per second.
bpdu_filter_allow_lists Sequence[str]
Pre-defined list of allowed MAC addresses to be excluded from BPDU filtering.
nsxt_manager_id str
vdc_group_id str
vdc_id str
description String
Description of Segment Security Profile
id String
isBpduFilterEnabled Boolean
Defines whether BPDU filter is enabled.
isDhcpV4ClientBlockEnabled Boolean
Defines whether DHCP Client block IPv4 is enabled. This filters DHCP Client IPv4 traffic.
isDhcpV4ServerBlockEnabled Boolean
Defines whether DHCP Server block IPv4 is enabled. This filters DHCP Server IPv4 traffic.
isDhcpV6ClientBlockEnabled Boolean
Defines whether DHCP Client block IPv6 is enabled. This filters DHCP Client IPv6 traffic.
isDhcpV6ServerBlockEnabled Boolean
Defines whether DHCP Server block IPv6 is enabled. This filters DHCP Server IPv6 traffic.
isNonIpTrafficBlockEnabled Boolean
Defines whether non IP traffic block is enabled. If true, it blocks all traffic except IP/(G)ARP/BPDU.
isRaGuardEnabled Boolean
Defines whether Router Advertisement Guard is enabled. This filters DHCP Server IPv6 traffic.
isRateLimittingEnabled Boolean
Defines whether Rate Limiting is enabled.
name String
rxBroadcastLimit Number
Incoming broadcast traffic limit in packets per second.
rxMulticastLimit Number
Incoming multicast traffic limit in packets per second.
txBroadcastLimit Number
Outgoing broadcast traffic limit in packets per second.
txMulticastLimit Number
Outgoing multicast traffic limit in packets per second.
bpduFilterAllowLists List<String>
Pre-defined list of allowed MAC addresses to be excluded from BPDU filtering.
nsxtManagerId String
vdcGroupId String
vdcId String

Package Details

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