Spectra Logic

1-800-833-1132 : 1-303-449-6400

Modify Node

Description

Modify the node name or domain name for a specified node.

Note:

If an optional request parameter is not included, the previous setting is retained.

Requests

Syntax

PUT http[s]://{datapathDNSname}/_rest_/node/{node UUID or other unique attribute}/[?dns_name={string}][&name={string}]]

To determine the UUID for a node, see Get Nodes.

Request Parameters

Parameter	Description	Required
dns_name	The new domain name for the node. Notes:   § If a domain name isn't configured for a node, its data path IP address is used when the TCP/IP address of the node must be given to a client. § If a domain name is configured for a node, the domain name (or IP address) is used, regardless of whether the data path IP address changes after the domain name is configured. § Configuring a DNS name is necessary whenever the data path IP of the gateway is not the IP address that should be used by clients who want to communicate with it (for example, if a network address translation has been installed between clients and the gateway).	no
name	The new name for the node.	no

Responses

Response Elements

<Data>
   <DataPathHttpPort>{16-bit integer}</DataPathHttpPort>
   <DataPathHttpsPort>{16-bit integer}</DataPathHttpsPort>
   <DataPathIpAddress>{string}</DataPathIpAddress>
   <DnsName>{string}</DnsName>
   <Id>{string}</Id>
   <LastHeartbeat>{YYYY-MM-DDThh:mm:ss.xxxZ}</LastHeartbeat>
   <Name>{string}</Name>
   <SerialNumber>{string}</SerialNumber>
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	A container for the response.
DataPathHttpPort	The port used for HTTP. If not present in the response, then HTTP access is not configured.
DataPathHttpsPort	The port used for HTTPS. If not present in the response, then HTTPS access is not configured.
DataPathIpAddress	The IPv4 address for the BlackPearl data path.
DnsName	The domain name for the gateway.
Id	The UUID for the gateway.
LastHeartbeat	The date and time that the gateway last sent a heartbeat in the format YYYY-MM-DDThh:mm:ss.xxxZ.
Name	The name for the gateway.
SerialNumber	The serial number for the BlackPearl gateway.

Example

Sample Request

This request changes the name of the node with UUID 48db59bd-cd5d-481a-93a7-15caa0a8ab43 to ProductionBP.

GET http://blackpearl-hostname/_rest_/node/48db59bd-cd5d-481a-93a7-15caa0a8ab43/?name=ProductionBP HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <DataPathHttpPort/>
   <DataPathHttpsPort>443</DataPathHttpsPort>
   <DataPathIpAddress>10.1.16.1</DataPathIpAddress>
   <DnsName/>
   <Id>48db59bd-cd5d-481a-93a7-15caa0a8ab43</Id>
   <LastHeartbeat>2015-10-13 14:42:54.378</LastHeartbeat>
   <Name>ProductionBP</Name>
   <SerialNumber>5003048001fff43f</SerialNumber>
</Data>