PUT Update netmap node description
The Update Netmap Node Description Service API is used to alter the descriptive information for a node.
Method | URI |
---|---|
PUT |
/cdwebconsole/svc/netmapnodedesc |
The following example shows the Command:
curl -X 'PUT' \
'https://172.20.186.131:9443/cdwebconsole/svc/netmapnodedesc' \
-H 'Authorization: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhZG1pbmlzdHJhdG9yOjE3Mi4yMC4xODYuMTMxOjEzNjM6NjM0NzcyNDctNmRmNi00NmNjLWE0N2ItNmJlYWY4NWNhNzI0IiwiZXhwIjoxNzE0MzEwOTIxfQ.-fy690RvFX-upIXGFg0E5jmGDMCG-wjqFQiho94NbaQc4kDlTtSBhajZ3DszR22m4VYNubyhAKpxxdQaM45KOg' \
-H 'Content-Type: application/json' \
-H 'X-XSRF-TOKEN: eec54ba9-b90d-4553-9360-d6889ec8ac07' \
-d '{"nodeName":"CDWBM-01","contactName":"CDUser","contactPhone":"1234567890","netmapNodeDescription":"This is CDUser node."}'
Parameter Name | Required/Optional | Description | Valid values |
---|---|---|---|
nodeName |
Required |
Specifies the name of the node. |
Either in lower case or upper case or mixed case Sample Value: CDWBM-01 |
contactName | Optional | Specifies the contact name to provide additional general information about an Adjacent Node entry. | Sample Value: CDUser |
contactPhone | Optional | Specifies the contact phone information about a node. | Sample Value: 1234567890 |
netmapNodeDescription | Optional | Specifies the descriptive information about the node. | This is CDUser node. |
The following example shows the SHTTP User Request:
{
"nodeName": "CDWBM-01",
"contactName": "CDUser",
"contactPhone": "1234567890",
"netmapNodeDescription": "This is CDUser node."
}
The following example shows the Sample Response:
[
{
"messageCode": 200,
"message": "The Netmap Node Description has been successfully updated"
}
]