Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vcd Provider
  3. API Docs
  4. NsxtSecurityGroup
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

vcd.NsxtSecurityGroup

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

    Create NsxtSecurityGroup Resource

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

    Constructor syntax

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

@overload
def NsxtSecurityGroup(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      edge_gateway_id: Optional[str] = None,
                      description: Optional[str] = None,
                      member_org_network_ids: Optional[Sequence[str]] = None,
                      name: Optional[str] = None,
                      nsxt_security_group_id: Optional[str] = None,
                      org: Optional[str] = None,
                      vdc: Optional[str] = None)
    func NewNsxtSecurityGroup(ctx *Context, name string, args NsxtSecurityGroupArgs, opts ...ResourceOption) (*NsxtSecurityGroup, error)
    public NsxtSecurityGroup(string name, NsxtSecurityGroupArgs args, CustomResourceOptions? opts = null)
    public NsxtSecurityGroup(String name, NsxtSecurityGroupArgs args)
public NsxtSecurityGroup(String name, NsxtSecurityGroupArgs args, CustomResourceOptions options)

    type: vcd:NsxtSecurityGroup
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 NsxtSecurityGroupArgs
    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 NsxtSecurityGroupArgs
    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 NsxtSecurityGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NsxtSecurityGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NsxtSecurityGroupArgs
    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 nsxtSecurityGroupResource = new Vcd.NsxtSecurityGroup("nsxtSecurityGroupResource", new()
{
    EdgeGatewayId = "string",
    Description = "string",
    MemberOrgNetworkIds = new[]
    {
        "string",
    },
    Name = "string",
    NsxtSecurityGroupId = "string",
    Org = "string",
});

    example, err := vcd.NewNsxtSecurityGroup(ctx, "nsxtSecurityGroupResource", &vcd.NsxtSecurityGroupArgs{
	EdgeGatewayId: pulumi.String("string"),
	Description:   pulumi.String("string"),
	MemberOrgNetworkIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:                pulumi.String("string"),
	NsxtSecurityGroupId: pulumi.String("string"),
	Org:                 pulumi.String("string"),
})

    var nsxtSecurityGroupResource = new NsxtSecurityGroup("nsxtSecurityGroupResource", NsxtSecurityGroupArgs.builder()
    .edgeGatewayId("string")
    .description("string")
    .memberOrgNetworkIds("string")
    .name("string")
    .nsxtSecurityGroupId("string")
    .org("string")
    .build());

    nsxt_security_group_resource = vcd.NsxtSecurityGroup("nsxtSecurityGroupResource",
    edge_gateway_id="string",
    description="string",
    member_org_network_ids=["string"],
    name="string",
    nsxt_security_group_id="string",
    org="string")

    const nsxtSecurityGroupResource = new vcd.NsxtSecurityGroup("nsxtSecurityGroupResource", {
    edgeGatewayId: "string",
    description: "string",
    memberOrgNetworkIds: ["string"],
    name: "string",
    nsxtSecurityGroupId: "string",
    org: "string",
});

    type: vcd:NsxtSecurityGroup
properties:
    description: string
    edgeGatewayId: string
    memberOrgNetworkIds:
        - string
    name: string
    nsxtSecurityGroupId: string
    org: string

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

    EdgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    Description string
    An optional description of the Security Group
    MemberOrgNetworkIds List<string>
    A set of Org Network IDs
    Name string
    A unique name for Security Group
    NsxtSecurityGroupId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    Vdc string
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    EdgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    Description string
    An optional description of the Security Group
    MemberOrgNetworkIds []string
    A set of Org Network IDs
    Name string
    A unique name for Security Group
    NsxtSecurityGroupId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    Vdc string
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    edgeGatewayId String
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    description String
    An optional description of the Security Group
    memberOrgNetworkIds List<String>
    A set of Org Network IDs
    name String
    A unique name for Security Group
    nsxtSecurityGroupId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    vdc String
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    edgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    description string
    An optional description of the Security Group
    memberOrgNetworkIds string[]
    A set of Org Network IDs
    name string
    A unique name for Security Group
    nsxtSecurityGroupId string
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    vdc string
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    edge_gateway_id str
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    description str
    An optional description of the Security Group
    member_org_network_ids Sequence[str]
    A set of Org Network IDs
    name str
    A unique name for Security Group
    nsxt_security_group_id str
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    vdc str
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    edgeGatewayId String
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    description String
    An optional description of the Security Group
    memberOrgNetworkIds List<String>
    A set of Org Network IDs
    name String
    A unique name for Security Group
    nsxtSecurityGroupId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    vdc String
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    MemberVms List<NsxtSecurityGroupMemberVm>
    A set of member VMs (if exist). see Member VMs below for details.
    OwnerId string
    ID of VDC or VDC Group
    Id string
    The provider-assigned unique ID for this managed resource.
    MemberVms []NsxtSecurityGroupMemberVm
    A set of member VMs (if exist). see Member VMs below for details.
    OwnerId string
    ID of VDC or VDC Group
    id String
    The provider-assigned unique ID for this managed resource.
    memberVms List<NsxtSecurityGroupMemberVm>
    A set of member VMs (if exist). see Member VMs below for details.
    ownerId String
    ID of VDC or VDC Group
    id string
    The provider-assigned unique ID for this managed resource.
    memberVms NsxtSecurityGroupMemberVm[]
    A set of member VMs (if exist). see Member VMs below for details.
    ownerId string
    ID of VDC or VDC Group
    id str
    The provider-assigned unique ID for this managed resource.
    member_vms Sequence[NsxtSecurityGroupMemberVm]
    A set of member VMs (if exist). see Member VMs below for details.
    owner_id str
    ID of VDC or VDC Group
    id String
    The provider-assigned unique ID for this managed resource.
    memberVms List<Property Map>
    A set of member VMs (if exist). see Member VMs below for details.
    ownerId String
    ID of VDC or VDC Group

    Look up Existing NsxtSecurityGroup Resource

    Get an existing NsxtSecurityGroup 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?: NsxtSecurityGroupState, opts?: CustomResourceOptions): NsxtSecurityGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        edge_gateway_id: Optional[str] = None,
        member_org_network_ids: Optional[Sequence[str]] = None,
        member_vms: Optional[Sequence[NsxtSecurityGroupMemberVmArgs]] = None,
        name: Optional[str] = None,
        nsxt_security_group_id: Optional[str] = None,
        org: Optional[str] = None,
        owner_id: Optional[str] = None,
        vdc: Optional[str] = None) -> NsxtSecurityGroup
    func GetNsxtSecurityGroup(ctx *Context, name string, id IDInput, state *NsxtSecurityGroupState, opts ...ResourceOption) (*NsxtSecurityGroup, error)
    public static NsxtSecurityGroup Get(string name, Input<string> id, NsxtSecurityGroupState? state, CustomResourceOptions? opts = null)
    public static NsxtSecurityGroup get(String name, Output<String> id, NsxtSecurityGroupState state, CustomResourceOptions options)
    resources:  _:    type: vcd:NsxtSecurityGroup    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:
    Description string
    An optional description of the Security Group
    EdgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    MemberOrgNetworkIds List<string>
    A set of Org Network IDs
    MemberVms List<NsxtSecurityGroupMemberVm>
    A set of member VMs (if exist). see Member VMs below for details.
    Name string
    A unique name for Security Group
    NsxtSecurityGroupId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    OwnerId string
    ID of VDC or VDC Group
    Vdc string
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    Description string
    An optional description of the Security Group
    EdgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    MemberOrgNetworkIds []string
    A set of Org Network IDs
    MemberVms []NsxtSecurityGroupMemberVmArgs
    A set of member VMs (if exist). see Member VMs below for details.
    Name string
    A unique name for Security Group
    NsxtSecurityGroupId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    OwnerId string
    ID of VDC or VDC Group
    Vdc string
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    description String
    An optional description of the Security Group
    edgeGatewayId String
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    memberOrgNetworkIds List<String>
    A set of Org Network IDs
    memberVms List<NsxtSecurityGroupMemberVm>
    A set of member VMs (if exist). see Member VMs below for details.
    name String
    A unique name for Security Group
    nsxtSecurityGroupId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    ownerId String
    ID of VDC or VDC Group
    vdc String
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    description string
    An optional description of the Security Group
    edgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    memberOrgNetworkIds string[]
    A set of Org Network IDs
    memberVms NsxtSecurityGroupMemberVm[]
    A set of member VMs (if exist). see Member VMs below for details.
    name string
    A unique name for Security Group
    nsxtSecurityGroupId string
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    ownerId string
    ID of VDC or VDC Group
    vdc string
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    description str
    An optional description of the Security Group
    edge_gateway_id str
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    member_org_network_ids Sequence[str]
    A set of Org Network IDs
    member_vms Sequence[NsxtSecurityGroupMemberVmArgs]
    A set of member VMs (if exist). see Member VMs below for details.
    name str
    A unique name for Security Group
    nsxt_security_group_id str
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    owner_id str
    ID of VDC or VDC Group
    vdc str
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    description String
    An optional description of the Security Group
    edgeGatewayId String
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    memberOrgNetworkIds List<String>
    A set of Org Network IDs
    memberVms List<Property Map>
    A set of member VMs (if exist). see Member VMs below for details.
    name String
    A unique name for Security Group
    nsxtSecurityGroupId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    ownerId String
    ID of VDC or VDC Group
    vdc String
    The name of VDC to use, optional if defined at provider level. Deprecated in favor of edge_gateway_id field.

    Deprecated: Deprecated

    Supporting Types

    NsxtSecurityGroupMemberVm, NsxtSecurityGroupMemberVmArgs

    VappId string
    VappName string
    VmId string
    VmName string
    VappId string
    VappName string
    VmId string
    VmName string
    vappId String
    vappName String
    vmId String
    vmName String
    vappId string
    vappName string
    vmId string
    vmName string
    vappId String
    vappName String
    vmId String
    vmName String

    Package Details

    Repository
    vcd vmware/terraform-provider-vcd
    License
    Notes
    This Pulumi package is based on the vcd Terraform Provider.
    vcd logo
    vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
    vmware/terraform-provider-vcd