Update NDRA Profile

Update NDRAProfile

Request:

Method:

PUT

URI Path(s):

/api/v1/ipv6/nd-ra-profiles/<nd-ra-profile-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

NDRAProfile+

NDRAProfile (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
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
dns_config	DNS Configuration	RaDNSConfig
id	Unique identifier of this resource	string	Sortable
ra_config	RA Configuration	RAConfig	Required
ra_mode	RA Mode	RAMode	Required Default: "SLAAC_DNS_THROUGH_RA"
reachable_timer	Reachable timer Neighbour reachable time duration in milliseconds. A value of 0 means unspecified.	integer	Minimum: 0 Maximum: 3600000 Default: "0"
resource_type	Must be set to the value NDRAProfile	string
retransmit_interval	Retransmission interval The time, in milliseconds, between retransmitted neighbour solicitation messages.	integer	Minimum: 0 Maximum: 4294967295 Default: "1000"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

PUT https://<nsx-mgr>/api/v1/ipv6/nd-ra-profiles/65fb67d8-0485-4c23-8e59-b9ccd8799a4c { "resource_type": "NDRAProfile", "id": "65fb67d8-0485-4c23-8e59-b9ccd8799a4c", "ra_mode": "DISABLED", "ra_config": { "ra_interval": 600000, "hop_limit": 64, "router_lifetime": 1800, "prefix_lifetime": 2592000, "prefix_preferred_time": 604800 }, "dns_config": { "domain_name": []. "domain_name_lifetime": 1800000, "dns_server": []. "dns_server_lifetime": 1800000 }, "reachable_timer": 0, "retransmit_interval": 0, }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

NDRAProfile+

NDRAProfile (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
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
dns_config	DNS Configuration	RaDNSConfig
id	Unique identifier of this resource	string	Sortable
ra_config	RA Configuration	RAConfig	Required
ra_mode	RA Mode	RAMode	Required Default: "SLAAC_DNS_THROUGH_RA"
reachable_timer	Reachable timer Neighbour reachable time duration in milliseconds. A value of 0 means unspecified.	integer	Minimum: 0 Maximum: 3600000 Default: "0"
resource_type	Must be set to the value NDRAProfile	string
retransmit_interval	Retransmission interval The time, in milliseconds, between retransmitted neighbour solicitation messages.	integer	Minimum: 0 Maximum: 4294967295 Default: "1000"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "resource_type": "NDRAProfile", "id": "65fb67d8-0485-4c23-8e59-b9ccd8799a4c", "ra_mode": "DISABLED", "ra_config": { "ra_interval": 600000, "hop_limit": 64, "router_lifetime": 1800, "prefix_lifetime": 2592000, "prefix_preferred_time": 604800 }, "dns_config": { "domain_name": []. "domain_name_lifetime": 1800000, "dns_server": []. "dns_server_lifetime": 1800000 }, "reachable_timer": 0, "retransmit_interval": 0, "_create_time": 1457391214234, "_last_modified_user": "admin", "_system_owned": false, "_last_modified_time": 1457391214234, "_create_user": "admin", "_revision": 1 }

Update NDRA Profile

Request:

NDRAProfile (schema)

Example Request:

Successful Response:

NDRAProfile (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: