IpDiscoverySwitchingProfile (schema)

Name Description Type Notes

_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable

_create_user ID of the user who created this resource string Readonly

_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable

_last_modified_user ID of the user who last modified this resource string Readonly

_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST. array of ResourceLink Readonly

_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly

_revision Generation of this resource config

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. int

_schema Schema for this resource string Readonly

_self Link to this resource SelfResourceLink Readonly

_system_owned Indicates system owned resource boolean Readonly

arp_bindings_limit Number of IP addresses to be snooped via ARP snooping

Indicates the number of arp snooped IP addresses to be remembered per LogicalPort. Decreasing this value, will retain the latest bindings from the existing list of address bindings. Increasing this value will retain existing bindings and also learn any new address bindings discovered on the port until the new limit is reached. This limit only applies to IPv4 addresses and is independent of the nd_bindings_limit used for IPv6 snooping. int Minimum: 1
Maximum: 256
Default: "1"

arp_nd_binding_timeout ARP and ND cache timeout (in minutes)

This property controls the ARP and ND cache timeout period.It
is recommended that this property be greater than the ARP/ND
cache timeout on the VM.
int Minimum: 5
Maximum: 120
Default: "10"

arp_snooping_enabled Indicates whether ARP snooping is enabled boolean Default: "True"

description Description of this resource string Maximum length: 1024
Sortable

dhcp_snooping_enabled Indicates whether DHCP snooping is enabled boolean Default: "True"

dhcpv6_snooping_enabled Indicates if stateful DHCPv6 snooping is enabled

This option is the IPv6 equivalent of DHCP snooping. boolean Default: "False"

display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set string Maximum length: 255
Sortable

duplicate_ip_detection Controls whether duplicate IP detection should be enabled

Duplicate IP detection is used to determine if there is any IP conflict
with any other port on the same logical switch. If a conflict is detected,
then the IP is marked as a duplicate on the port where the IP was
discovered last. The duplicate IP will not be added to the realized
address binings for the port and hence will not be used in DFW rules or
other security configurations for the port.
DuplicateIPDetection

id Unique identifier of this resource string Sortable

nd_bindings_limit Number of IP addresses to be snooped via neighbor-discovery(ND) snooping

Indicates the number of neighbor-discovery snooped IP addresses to be remembered per LogicalPort. Decreasing this value, will retain the latest bindings from the existing list of address bindings. Increasing this value will retain existing bindings and also learn any new address bindings discovered on the port until the new limit is reached. This limit only applies to IPv6 addresses and is independent of the arp_bindings_limit used for IPv4 snooping. int Minimum: 2
Maximum: 15
Default: "3"

nd_snooping_enabled Indicates if neighbor discovery snooping is enabled

This option is the IPv6 equivalent of ARP snooping. boolean Default: "False"

required_capabilities array of string Readonly

resource_type Must be set to the value IpDiscoverySwitchingProfile string Required

tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

trust_on_first_use_enabled Controls whether trust-on-first-use should be enabled

ARP snooping being inherently susceptible to ARP spoofing,
uses a turst-on-fisrt-use (TOFU) paradigm where only the first IP address
discovered via ARP snooping is trusted. The remaining are ignored.
In order to allow for more flexibility, we allow the user to
configure how many ARP snooped address bindings should be trusted
for the lifetime of the logical port. This is controlled by the
arp_bindings_limit property in the IP Discovery profile. We refer
to this extension of TOFU as N-TOFU.
However, if TOFU is disabled, then N ARP snooped IP addresses will
be trusted until they are timed out, where N is configured by
arp_bindings_limit.
boolean Default: "True"

vm_tools_enabled Indicates whether fetching IP using vm-tools is enabled

This option is only supported on ESX where vm-tools is installed. boolean Default: "True"

vm_tools_v6_enabled Indicates whether fetching IPv6 addresses using vm-tools is enabled

This option is only supported on ESX where vm-tools is installed. boolean Default: "False"

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
arp_bindings_limit	Number of IP addresses to be snooped via ARP snooping Indicates the number of arp snooped IP addresses to be remembered per LogicalPort. Decreasing this value, will retain the latest bindings from the existing list of address bindings. Increasing this value will retain existing bindings and also learn any new address bindings discovered on the port until the new limit is reached. This limit only applies to IPv4 addresses and is independent of the nd_bindings_limit used for IPv6 snooping.	int	Minimum: 1 Maximum: 256 Default: "1"
arp_nd_binding_timeout	ARP and ND cache timeout (in minutes) This property controls the ARP and ND cache timeout period.It is recommended that this property be greater than the ARP/ND cache timeout on the VM.	int	Minimum: 5 Maximum: 120 Default: "10"
arp_snooping_enabled	Indicates whether ARP snooping is enabled	boolean	Default: "True"
description	Description of this resource	string	Maximum length: 1024 Sortable
dhcp_snooping_enabled	Indicates whether DHCP snooping is enabled	boolean	Default: "True"
dhcpv6_snooping_enabled	Indicates if stateful DHCPv6 snooping is enabled This option is the IPv6 equivalent of DHCP snooping.	boolean	Default: "False"
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
duplicate_ip_detection	Controls whether duplicate IP detection should be enabled Duplicate IP detection is used to determine if there is any IP conflict with any other port on the same logical switch. If a conflict is detected, then the IP is marked as a duplicate on the port where the IP was discovered last. The duplicate IP will not be added to the realized address binings for the port and hence will not be used in DFW rules or other security configurations for the port.	DuplicateIPDetection
id	Unique identifier of this resource	string	Sortable
nd_bindings_limit	Number of IP addresses to be snooped via neighbor-discovery(ND) snooping Indicates the number of neighbor-discovery snooped IP addresses to be remembered per LogicalPort. Decreasing this value, will retain the latest bindings from the existing list of address bindings. Increasing this value will retain existing bindings and also learn any new address bindings discovered on the port until the new limit is reached. This limit only applies to IPv6 addresses and is independent of the arp_bindings_limit used for IPv4 snooping.	int	Minimum: 2 Maximum: 15 Default: "3"
nd_snooping_enabled	Indicates if neighbor discovery snooping is enabled This option is the IPv6 equivalent of ARP snooping.	boolean	Default: "False"
required_capabilities		array of string	Readonly
resource_type	Must be set to the value IpDiscoverySwitchingProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
trust_on_first_use_enabled	Controls whether trust-on-first-use should be enabled ARP snooping being inherently susceptible to ARP spoofing, uses a turst-on-fisrt-use (TOFU) paradigm where only the first IP address discovered via ARP snooping is trusted. The remaining are ignored. In order to allow for more flexibility, we allow the user to configure how many ARP snooped address bindings should be trusted for the lifetime of the logical port. This is controlled by the arp_bindings_limit property in the IP Discovery profile. We refer to this extension of TOFU as N-TOFU. However, if TOFU is disabled, then N ARP snooped IP addresses will be trusted until they are timed out, where N is configured by arp_bindings_limit.	boolean	Default: "True"
vm_tools_enabled	Indicates whether fetching IP using vm-tools is enabled This option is only supported on ESX where vm-tools is installed.	boolean	Default: "True"
vm_tools_v6_enabled	Indicates whether fetching IPv6 addresses using vm-tools is enabled This option is only supported on ESX where vm-tools is installed.	boolean	Default: "False"