Create IP Discovery Profile

Required	Parameter Name	Type	Description
required	ip-discovery-profile-id	string	IP Discovery Profile ID

{
    "_create_time": 0,
    "_create_user": "string",
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_protection": "string",
    "_revision": 0,
    "_schema": "string",
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_system_owned": false,
    "arp_nd_binding_timeout": 0,
    "children": [
        {
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_protection": "string",
            "_revision": 0,
            "_schema": "string",
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "marked_for_delete": false,
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ]
        }
    ],
    "description": "string",
    "display_name": "string",
    "duplicate_ip_detection": {
        "duplicate_ip_detection_enabled": false
    },
    "id": "string",
    "ip_v4_discovery_options": {
        "arp_snooping_config": {
            "arp_binding_limit": 0,
            "arp_snooping_enabled": false
        },
        "dhcp_snooping_enabled": false,
        "vmtools_enabled": false
    },
    "ip_v6_discovery_options": {
        "dhcp_snooping_v6_enabled": false,
        "nd_snooping_config": {
            "nd_snooping_enabled": false,
            "nd_snooping_limit": 0
        },
        "vmtools_v6_enabled": false
    },
    "marked_for_delete": false,
    "parent_path": "string",
    "path": "string",
    "relative_path": "string",
    "resource_type": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "tofu_enabled": false
}

Required	Property Name	Type	Description
optional	_create_time	integer	Timestamp of resource creation
optional	_create_user	string	ID of the user who created this resource
optional	_last_modified_time	integer	Timestamp of last modification
optional	_last_modified_user	string	ID of the user who last modified this resource
optional	_links	array of ResourceLink	The server will populate this field when returing the resource. Ignored on PUT and POST.
optional	_protection	string	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.
optional	_revision	integer	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.
optional	_schema	string	Schema for this resource
optional	_self	SelfResourceLink	Link to this resource
optional	_system_owned	boolean	Indicates system owned resource
optional	arp_nd_binding_timeout	integer	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.
optional	children	array of ChildPolicyConfigResource	subtree for this type within policy tree containing nested elements.
optional	description	string	Description of this resource
optional	display_name	string	Defaults to ID if not set
optional	duplicate_ip_detection	DuplicateIPDetectionOptions	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.rt.
optional	id	string	Unique identifier of this resource
optional	ip_v4_discovery_options	IPv4DiscoveryOptions	Indicates IPv4 Discovery options
optional	ip_v6_discovery_options	IPv6DiscoveryOptions	Indicates IPv6 Discovery options
optional	marked_for_delete	boolean	Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.
optional	parent_path	string	Path of its parent
optional	path	string	Absolute path of this object
optional	relative_path	string	Path relative from its parent
optional	resource_type	string	The type of this resource.
optional	tags	array of Tag	Opaque identifiers meaningful to the API user
optional	tofu_enabled	boolean	Indicates whether “Trust on First Use(TOFU)” paradigm is enabled.

Response

Response Body

200 OK returns IPDiscoveryProfile

{
    "_create_time": 0,
    "_create_user": "string",
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_protection": "string",
    "_revision": 0,
    "_schema": "string",
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_system_owned": false,
    "arp_nd_binding_timeout": 0,
    "children": [
        {
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_protection": "string",
            "_revision": 0,
            "_schema": "string",
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "marked_for_delete": false,
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ]
        }
    ],
    "description": "string",
    "display_name": "string",
    "duplicate_ip_detection": {
        "duplicate_ip_detection_enabled": false
    },
    "id": "string",
    "ip_v4_discovery_options": {
        "arp_snooping_config": {
            "arp_binding_limit": 0,
            "arp_snooping_enabled": false
        },
        "dhcp_snooping_enabled": false,
        "vmtools_enabled": false
    },
    "ip_v6_discovery_options": {
        "dhcp_snooping_v6_enabled": false,
        "nd_snooping_config": {
            "nd_snooping_enabled": false,
            "nd_snooping_limit": 0
        },
        "vmtools_v6_enabled": false
    },
    "marked_for_delete": false,
    "parent_path": "string",
    "path": "string",
    "relative_path": "string",
    "resource_type": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "tofu_enabled": false
}

Property Name	Type	Description
_create_time	integer	Timestamp of resource creation
_create_user	string	ID of the user who created this resource
_last_modified_time	integer	Timestamp of last modification
_last_modified_user	string	ID of the user who last modified this resource
_links	array of ResourceLink	The server will populate this field when returing the resource. Ignored on PUT and POST.
_protection	string	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.
_revision	integer	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.
_schema	string	Schema for this resource
_self	SelfResourceLink	Link to this resource
_system_owned	boolean	Indicates system owned resource
arp_nd_binding_timeout	integer	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.
children	array of ChildPolicyConfigResource	subtree for this type within policy tree containing nested elements.
description	string	Description of this resource
display_name	string	Defaults to ID if not set
duplicate_ip_detection	DuplicateIPDetectionOptions	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.rt.
id	string	Unique identifier of this resource
ip_v4_discovery_options	IPv4DiscoveryOptions	Indicates IPv4 Discovery options
ip_v6_discovery_options	IPv6DiscoveryOptions	Indicates IPv6 Discovery options
marked_for_delete	boolean	Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.
parent_path	string	Path of its parent
path	string	Absolute path of this object
relative_path	string	Path relative from its parent
resource_type	string	The type of this resource.
tags	array of Tag	Opaque identifiers meaningful to the API user
tofu_enabled	boolean	Indicates whether “Trust on First Use(TOFU)” paradigm is enabled.

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"_create_time":0,"_create_user":"string","_last_modified_time":0,"_last_modified_user":"string","_links":[{"action":"string","href":"string","rel":"string"}],"_protection":"string","_revision":0,"_schema":"string","_self":{"action":"string","href":"string","rel":"string"},"_system_owned":false,"arp_nd_binding_timeout":0,"children":[{"_create_time":0,"_create_user":"string","_last_modified_time":0,"_last_modified_user":"string","_links":[{"action":"string","href":"string","rel":"string"}],"_protection":"string","_revision":0,"_schema":"string","_self":{"action":"string","href":"string","rel":"string"},"_system_owned":false,"description":"string","display_name":"string","id":"string","marked_for_delete":false,"resource_type":"string","tags":[{"scope":"string","tag":"string"}]}],"description":"string","display_name":"string","duplicate_ip_detection":{"duplicate_ip_detection_enabled":false},"id":"string","ip_v4_discovery_options":{"arp_snooping_config":{"arp_binding_limit":0,"arp_snooping_enabled":false},"dhcp_snooping_enabled":false,"vmtools_enabled":false},"ip_v6_discovery_options":{"dhcp_snooping_v6_enabled":false,"nd_snooping_config":{"nd_snooping_enabled":false,"nd_snooping_limit":0},"vmtools_v6_enabled":false},"marked_for_delete":false,"parent_path":"string","path":"string","relative_path":"string","resource_type":"string","tags":[{"scope":"string","tag":"string"}],"tofu_enabled":false}' https://nsxmanager.your.domain/policy/api/v1/infra/ip-discovery-profiles/{ip-discovery-profile-id}

Errors

Code	Returns	Description
412	PreconditionFailed	Not available
500	InternalServerError	The server encountered an unexpected condition which prevented it from fulfilling the request.
503	ServiceUnavailable	The server is currently unavailable (because it is overloaded or down for maintenance).
400	BadRequest	The request cannot be fulfilled due to bad syntax.
403	Forbidden	The server understood the request, but is refusing to fulfill it.
404	NotFound	The requested resource could not be found but may be available again in the future.

IP Discovery Profiles Operations

put

Create IP Discovery Profile

delete

Delete IP Discovery Profile

get

Get IP Discovery Profile

get

List IP Discovery Profiles

patch

Update IP Discovery Profile

Create IP Discovery Profile

On This Page

Request

URL

Path Parameters

Request Body

Response

Response Body

cURL Command

Errors

On This Page

IP Discovery Profiles Operations

Was this page helpful?