1. Packages
  2. Nsxt Provider
  3. API Docs
  4. IpDiscoverySwitchingProfile
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware

nsxt.IpDiscoverySwitchingProfile

Explore with Pulumi AI

Create IpDiscoverySwitchingProfile Resource

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

Constructor syntax

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

@overload
def IpDiscoverySwitchingProfile(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                arp_bindings_limit: Optional[float] = None,
                                arp_snooping_enabled: Optional[bool] = None,
                                description: Optional[str] = None,
                                dhcp_snooping_enabled: Optional[bool] = None,
                                display_name: Optional[str] = None,
                                ip_discovery_switching_profile_id: Optional[str] = None,
                                tags: Optional[Sequence[IpDiscoverySwitchingProfileTagArgs]] = None,
                                vm_tools_enabled: Optional[bool] = None)
func NewIpDiscoverySwitchingProfile(ctx *Context, name string, args *IpDiscoverySwitchingProfileArgs, opts ...ResourceOption) (*IpDiscoverySwitchingProfile, error)
public IpDiscoverySwitchingProfile(string name, IpDiscoverySwitchingProfileArgs? args = null, CustomResourceOptions? opts = null)
public IpDiscoverySwitchingProfile(String name, IpDiscoverySwitchingProfileArgs args)
public IpDiscoverySwitchingProfile(String name, IpDiscoverySwitchingProfileArgs args, CustomResourceOptions options)
type: nsxt:IpDiscoverySwitchingProfile
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 IpDiscoverySwitchingProfileArgs
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 IpDiscoverySwitchingProfileArgs
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 IpDiscoverySwitchingProfileArgs
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 IpDiscoverySwitchingProfileArgs
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. IpDiscoverySwitchingProfileArgs
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 ipDiscoverySwitchingProfileResource = new Nsxt.IpDiscoverySwitchingProfile("ipDiscoverySwitchingProfileResource", new()
{
    ArpBindingsLimit = 0,
    ArpSnoopingEnabled = false,
    Description = "string",
    DhcpSnoopingEnabled = false,
    DisplayName = "string",
    IpDiscoverySwitchingProfileId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.IpDiscoverySwitchingProfileTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
    VmToolsEnabled = false,
});
Copy
example, err := nsxt.NewIpDiscoverySwitchingProfile(ctx, "ipDiscoverySwitchingProfileResource", &nsxt.IpDiscoverySwitchingProfileArgs{
	ArpBindingsLimit:              pulumi.Float64(0),
	ArpSnoopingEnabled:            pulumi.Bool(false),
	Description:                   pulumi.String("string"),
	DhcpSnoopingEnabled:           pulumi.Bool(false),
	DisplayName:                   pulumi.String("string"),
	IpDiscoverySwitchingProfileId: pulumi.String("string"),
	Tags: nsxt.IpDiscoverySwitchingProfileTagArray{
		&nsxt.IpDiscoverySwitchingProfileTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
	VmToolsEnabled: pulumi.Bool(false),
})
Copy
var ipDiscoverySwitchingProfileResource = new IpDiscoverySwitchingProfile("ipDiscoverySwitchingProfileResource", IpDiscoverySwitchingProfileArgs.builder()
    .arpBindingsLimit(0)
    .arpSnoopingEnabled(false)
    .description("string")
    .dhcpSnoopingEnabled(false)
    .displayName("string")
    .ipDiscoverySwitchingProfileId("string")
    .tags(IpDiscoverySwitchingProfileTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .vmToolsEnabled(false)
    .build());
Copy
ip_discovery_switching_profile_resource = nsxt.IpDiscoverySwitchingProfile("ipDiscoverySwitchingProfileResource",
    arp_bindings_limit=0,
    arp_snooping_enabled=False,
    description="string",
    dhcp_snooping_enabled=False,
    display_name="string",
    ip_discovery_switching_profile_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }],
    vm_tools_enabled=False)
Copy
const ipDiscoverySwitchingProfileResource = new nsxt.IpDiscoverySwitchingProfile("ipDiscoverySwitchingProfileResource", {
    arpBindingsLimit: 0,
    arpSnoopingEnabled: false,
    description: "string",
    dhcpSnoopingEnabled: false,
    displayName: "string",
    ipDiscoverySwitchingProfileId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
    vmToolsEnabled: false,
});
Copy
type: nsxt:IpDiscoverySwitchingProfile
properties:
    arpBindingsLimit: 0
    arpSnoopingEnabled: false
    description: string
    dhcpSnoopingEnabled: false
    displayName: string
    ipDiscoverySwitchingProfileId: string
    tags:
        - scope: string
          tag: string
    vmToolsEnabled: false
Copy

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

ArpBindingsLimit double
Limit for the amount of ARP bindings.
ArpSnoopingEnabled bool
A boolean flag iIndicates whether ARP snooping is enabled.
Description string
Description of this resource.
DhcpSnoopingEnabled bool
A boolean flag iIndicates whether DHCP snooping is enabled.
DisplayName string
The display name of this resource. Defaults to ID if not set.
IpDiscoverySwitchingProfileId string
ID of the IP discovery switching profile.
Tags List<IpDiscoverySwitchingProfileTag>
A list of scope + tag pairs to associate with this IP discovery switching profile.
VmToolsEnabled bool
A boolean flag iIndicates whether VM tools will be enabled. This option is only supported on ESX where vm-tools is installed.
ArpBindingsLimit float64
Limit for the amount of ARP bindings.
ArpSnoopingEnabled bool
A boolean flag iIndicates whether ARP snooping is enabled.
Description string
Description of this resource.
DhcpSnoopingEnabled bool
A boolean flag iIndicates whether DHCP snooping is enabled.
DisplayName string
The display name of this resource. Defaults to ID if not set.
IpDiscoverySwitchingProfileId string
ID of the IP discovery switching profile.
Tags []IpDiscoverySwitchingProfileTagArgs
A list of scope + tag pairs to associate with this IP discovery switching profile.
VmToolsEnabled bool
A boolean flag iIndicates whether VM tools will be enabled. This option is only supported on ESX where vm-tools is installed.
arpBindingsLimit Double
Limit for the amount of ARP bindings.
arpSnoopingEnabled Boolean
A boolean flag iIndicates whether ARP snooping is enabled.
description String
Description of this resource.
dhcpSnoopingEnabled Boolean
A boolean flag iIndicates whether DHCP snooping is enabled.
displayName String
The display name of this resource. Defaults to ID if not set.
ipDiscoverySwitchingProfileId String
ID of the IP discovery switching profile.
tags List<IpDiscoverySwitchingProfileTag>
A list of scope + tag pairs to associate with this IP discovery switching profile.
vmToolsEnabled Boolean
A boolean flag iIndicates whether VM tools will be enabled. This option is only supported on ESX where vm-tools is installed.
arpBindingsLimit number
Limit for the amount of ARP bindings.
arpSnoopingEnabled boolean
A boolean flag iIndicates whether ARP snooping is enabled.
description string
Description of this resource.
dhcpSnoopingEnabled boolean
A boolean flag iIndicates whether DHCP snooping is enabled.
displayName string
The display name of this resource. Defaults to ID if not set.
ipDiscoverySwitchingProfileId string
ID of the IP discovery switching profile.
tags IpDiscoverySwitchingProfileTag[]
A list of scope + tag pairs to associate with this IP discovery switching profile.
vmToolsEnabled boolean
A boolean flag iIndicates whether VM tools will be enabled. This option is only supported on ESX where vm-tools is installed.
arp_bindings_limit float
Limit for the amount of ARP bindings.
arp_snooping_enabled bool
A boolean flag iIndicates whether ARP snooping is enabled.
description str
Description of this resource.
dhcp_snooping_enabled bool
A boolean flag iIndicates whether DHCP snooping is enabled.
display_name str
The display name of this resource. Defaults to ID if not set.
ip_discovery_switching_profile_id str
ID of the IP discovery switching profile.
tags Sequence[IpDiscoverySwitchingProfileTagArgs]
A list of scope + tag pairs to associate with this IP discovery switching profile.
vm_tools_enabled bool
A boolean flag iIndicates whether VM tools will be enabled. This option is only supported on ESX where vm-tools is installed.
arpBindingsLimit Number
Limit for the amount of ARP bindings.
arpSnoopingEnabled Boolean
A boolean flag iIndicates whether ARP snooping is enabled.
description String
Description of this resource.
dhcpSnoopingEnabled Boolean
A boolean flag iIndicates whether DHCP snooping is enabled.
displayName String
The display name of this resource. Defaults to ID if not set.
ipDiscoverySwitchingProfileId String
ID of the IP discovery switching profile.
tags List<Property Map>
A list of scope + tag pairs to associate with this IP discovery switching profile.
vmToolsEnabled Boolean
A boolean flag iIndicates whether VM tools will be enabled. This option is only supported on ESX where vm-tools is installed.

Outputs

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

Get an existing IpDiscoverySwitchingProfile 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?: IpDiscoverySwitchingProfileState, opts?: CustomResourceOptions): IpDiscoverySwitchingProfile
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arp_bindings_limit: Optional[float] = None,
        arp_snooping_enabled: Optional[bool] = None,
        description: Optional[str] = None,
        dhcp_snooping_enabled: Optional[bool] = None,
        display_name: Optional[str] = None,
        ip_discovery_switching_profile_id: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[IpDiscoverySwitchingProfileTagArgs]] = None,
        vm_tools_enabled: Optional[bool] = None) -> IpDiscoverySwitchingProfile
func GetIpDiscoverySwitchingProfile(ctx *Context, name string, id IDInput, state *IpDiscoverySwitchingProfileState, opts ...ResourceOption) (*IpDiscoverySwitchingProfile, error)
public static IpDiscoverySwitchingProfile Get(string name, Input<string> id, IpDiscoverySwitchingProfileState? state, CustomResourceOptions? opts = null)
public static IpDiscoverySwitchingProfile get(String name, Output<String> id, IpDiscoverySwitchingProfileState state, CustomResourceOptions options)
resources:  _:    type: nsxt:IpDiscoverySwitchingProfile    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:
ArpBindingsLimit double
Limit for the amount of ARP bindings.
ArpSnoopingEnabled bool
A boolean flag iIndicates whether ARP snooping is enabled.
Description string
Description of this resource.
DhcpSnoopingEnabled bool
A boolean flag iIndicates whether DHCP snooping is enabled.
DisplayName string
The display name of this resource. Defaults to ID if not set.
IpDiscoverySwitchingProfileId string
ID of the IP discovery switching profile.
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<IpDiscoverySwitchingProfileTag>
A list of scope + tag pairs to associate with this IP discovery switching profile.
VmToolsEnabled bool
A boolean flag iIndicates whether VM tools will be enabled. This option is only supported on ESX where vm-tools is installed.
ArpBindingsLimit float64
Limit for the amount of ARP bindings.
ArpSnoopingEnabled bool
A boolean flag iIndicates whether ARP snooping is enabled.
Description string
Description of this resource.
DhcpSnoopingEnabled bool
A boolean flag iIndicates whether DHCP snooping is enabled.
DisplayName string
The display name of this resource. Defaults to ID if not set.
IpDiscoverySwitchingProfileId string
ID of the IP discovery switching profile.
Revision float64
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Tags []IpDiscoverySwitchingProfileTagArgs
A list of scope + tag pairs to associate with this IP discovery switching profile.
VmToolsEnabled bool
A boolean flag iIndicates whether VM tools will be enabled. This option is only supported on ESX where vm-tools is installed.
arpBindingsLimit Double
Limit for the amount of ARP bindings.
arpSnoopingEnabled Boolean
A boolean flag iIndicates whether ARP snooping is enabled.
description String
Description of this resource.
dhcpSnoopingEnabled Boolean
A boolean flag iIndicates whether DHCP snooping is enabled.
displayName String
The display name of this resource. Defaults to ID if not set.
ipDiscoverySwitchingProfileId String
ID of the IP discovery switching profile.
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<IpDiscoverySwitchingProfileTag>
A list of scope + tag pairs to associate with this IP discovery switching profile.
vmToolsEnabled Boolean
A boolean flag iIndicates whether VM tools will be enabled. This option is only supported on ESX where vm-tools is installed.
arpBindingsLimit number
Limit for the amount of ARP bindings.
arpSnoopingEnabled boolean
A boolean flag iIndicates whether ARP snooping is enabled.
description string
Description of this resource.
dhcpSnoopingEnabled boolean
A boolean flag iIndicates whether DHCP snooping is enabled.
displayName string
The display name of this resource. Defaults to ID if not set.
ipDiscoverySwitchingProfileId string
ID of the IP discovery switching profile.
revision number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
tags IpDiscoverySwitchingProfileTag[]
A list of scope + tag pairs to associate with this IP discovery switching profile.
vmToolsEnabled boolean
A boolean flag iIndicates whether VM tools will be enabled. This option is only supported on ESX where vm-tools is installed.
arp_bindings_limit float
Limit for the amount of ARP bindings.
arp_snooping_enabled bool
A boolean flag iIndicates whether ARP snooping is enabled.
description str
Description of this resource.
dhcp_snooping_enabled bool
A boolean flag iIndicates whether DHCP snooping is enabled.
display_name str
The display name of this resource. Defaults to ID if not set.
ip_discovery_switching_profile_id str
ID of the IP discovery switching profile.
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[IpDiscoverySwitchingProfileTagArgs]
A list of scope + tag pairs to associate with this IP discovery switching profile.
vm_tools_enabled bool
A boolean flag iIndicates whether VM tools will be enabled. This option is only supported on ESX where vm-tools is installed.
arpBindingsLimit Number
Limit for the amount of ARP bindings.
arpSnoopingEnabled Boolean
A boolean flag iIndicates whether ARP snooping is enabled.
description String
Description of this resource.
dhcpSnoopingEnabled Boolean
A boolean flag iIndicates whether DHCP snooping is enabled.
displayName String
The display name of this resource. Defaults to ID if not set.
ipDiscoverySwitchingProfileId String
ID of the IP discovery switching profile.
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 discovery switching profile.
vmToolsEnabled Boolean
A boolean flag iIndicates whether VM tools will be enabled. This option is only supported on ESX where vm-tools is installed.

Supporting Types

IpDiscoverySwitchingProfileTag
, IpDiscoverySwitchingProfileTagArgs

Scope string
Tag string
A list of scope + tag pairs to associate with this IP discovery switching profile.
Scope string
Tag string
A list of scope + tag pairs to associate with this IP discovery switching profile.
scope String
tag String
A list of scope + tag pairs to associate with this IP discovery switching profile.
scope string
tag string
A list of scope + tag pairs to associate with this IP discovery switching profile.
scope str
tag str
A list of scope + tag pairs to associate with this IP discovery switching profile.
scope String
tag String
A list of scope + tag pairs to associate with this IP discovery switching profile.

Package Details

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