Skip to main content
A newer release of this product is available.

Retrieve nodes in a cluster

Contributors

GET /cluster/nodes

Retrieves the nodes in the cluster.

Learn more

Parameters

Name Type In Required Description

ha.auto_giveback

boolean

query

False

Filter by ha.auto_giveback

ha.enabled

boolean

query

False

Filter by ha.enabled

ha.partners.name

string

query

False

Filter by ha.partners.name

ha.partners.uuid

string

query

False

Filter by ha.partners.uuid

uptime

integer

query

False

Filter by uptime

date

string

query

False

Filter by date

membership

string

query

False

Filter by membership

serial_number

string

query

False

Filter by serial_number

controller.over_temperature

string

query

False

Filter by controller.over_temperature

controller.flash_cache.serial_number

string

query

False

Filter by controller.flash_cache.serial_number

controller.flash_cache.hardware_revision

string

query

False

Filter by controller.flash_cache.hardware_revision

controller.flash_cache.capacity

integer

query

False

Filter by controller.flash_cache.capacity

controller.flash_cache.model

string

query

False

Filter by controller.flash_cache.model

controller.flash_cache.slot

string

query

False

Filter by controller.flash_cache.slot

controller.flash_cache.state

string

query

False

Filter by controller.flash_cache.state

controller.flash_cache.firmware_version

string

query

False

Filter by controller.flash_cache.firmware_version

controller.flash_cache.part_number

string

query

False

Filter by controller.flash_cache.part_number

controller.frus.id

integer

query

False

Filter by controller.frus.id

controller.frus.type

string

query

False

Filter by controller.frus.type

controller.frus.state

string

query

False

Filter by controller.frus.state

location

string

query

False

Filter by location

model

string

query

False

Filter by model

management_interfaces.ip.address

string

query

False

Filter by management_interfaces.ip.address

management_interfaces.uuid

string

query

False

Filter by management_interfaces.uuid

management_interfaces.name

string

query

False

Filter by management_interfaces.name

service_processor.link_status

string

query

False

Filter by service_processor.link_status

service_processor.state

string

query

False

Filter by service_processor.state

service_processor.firmware_version

string

query

False

Filter by service_processor.firmware_version

service_processor.dhcp_enabled

boolean

query

False

Filter by service_processor.dhcp_enabled

service_processor.ipv4_interface.address

string

query

False

Filter by service_processor.ipv4_interface.address

service_processor.ipv4_interface.netmask

string

query

False

Filter by service_processor.ipv4_interface.netmask

service_processor.ipv4_interface.gateway

string

query

False

Filter by service_processor.ipv4_interface.gateway

service_processor.mac_address

string

query

False

Filter by service_processor.mac_address

service_processor.ipv6_interface.address

string

query

False

Filter by service_processor.ipv6_interface.address

service_processor.ipv6_interface.netmask

string

query

False

Filter by service_processor.ipv6_interface.netmask

service_processor.ipv6_interface.gateway

string

query

False

Filter by service_processor.ipv6_interface.gateway

name

string

query

False

Filter by name

version.minor

integer

query

False

Filter by version.minor

version.full

string

query

False

Filter by version.full

version.major

integer

query

False

Filter by version.major

version.generation

integer

query

False

Filter by version.generation

cluster_interfaces.ip.address

string

query

False

Filter by cluster_interfaces.ip.address

cluster_interfaces.uuid

string

query

False

Filter by cluster_interfaces.uuid

cluster_interfaces.name

string

query

False

Filter by cluster_interfaces.name

uuid

string

query

False

Filter by uuid

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

records

array[records]

Example response
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "cluster_interface": {
        "ip": {
          "address": "10.10.10.7"
        }
      },
      "cluster_interfaces": [
        {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "ip": {
            "address": "10.10.10.7"
          },
          "name": "lif1",
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        }
      ],
      "controller": {
        "flash_cache": [
          {
            "capacity": 1024000000000,
            "firmware_version": "NA05",
            "hardware_revision": "A1",
            "model": "X1970A",
            "part_number": "119-00207",
            "serial_number": "A22P5061550000187",
            "slot": "6-1",
            "state": "string"
          }
        ],
        "frus": [
          {
            "id": 0,
            "state": "string",
            "type": "string"
          }
        ],
        "over_temperature": "string"
      },
      "date": "2017-01-25 11:20:13 +0400",
      "ha": {
        "partners": [
          {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "node1",
            "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
          }
        ]
      },
      "location": "rack 2 row 5",
      "management_interface": {
        "ip": {
          "address": "10.10.10.7"
        }
      },
      "management_interfaces": [
        {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "ip": {
            "address": "10.10.10.7"
          },
          "name": "lif1",
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        }
      ],
      "membership": "string",
      "model": "FAS3070",
      "name": "node-01",
      "serial_number": "4048820-60-9",
      "service_processor": {
        "firmware_version": "string",
        "ipv4_interface": {
          "address": "10.10.10.7",
          "gateway": "10.1.1.1",
          "netmask": "24"
        },
        "ipv6_interface": {
          "address": "10.10.10.7",
          "gateway": "10.1.1.1",
          "netmask": "24"
        },
        "link_status": "string",
        "mac_address": "string",
        "state": "string"
      },
      "uptime": 300536,
      "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412",
      "version": {
        "full": "NetApp Release 9.4.0: Sun Nov 05 18:20:57 UTC 2017",
        "generation": 9,
        "major": 4,
        "minor": 0
      }
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

error

Example error
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

Name Type Description

next

href

self

href

Name Type Description

self

href

node_setup_ip

The IP configuration for cluster setup.

Name Type Description

address

string

IPv4 or IPv6 address

cluster_interface

The cluster network IP address of the node to be added.

Name Type Description

ip

node_setup_ip

The IP configuration for cluster setup.

ip

IP information

Name Type Description

address

string

IPv4 or IPv6 address

cluster_interfaces

Network interface

Name Type Description

_links

_links

ip

ip

IP information

name

string

The name of the interface.

uuid

string

The UUID that uniquely identifies the interface.

flash_cache

Name Type Description

capacity

integer

Size in bytes

firmware_version

string

hardware_revision

string

model

string

part_number

string

serial_number

string

slot

string

state

string

frus

Name Type Description

id

integer

state

string

type

string

controller

Controller information

Name Type Description

flash_cache

array[flash_cache]

A list of Flash-Cache devices. Only returned when requested by name.

frus

array[frus]

A list of frus in the node. Only returned when requested by name.

over_temperature

string

Specifies whether the hardware is currently operating outside of its recommended temperature range. The hardware shuts down if the temperature exceeds critical thresholds.

partners

Name Type Description

_links

_links

name

string

uuid

string

ha

Name Type Description

auto_giveback

boolean

Specifies whether giveback is automatically initiated when the node that owns the storage is ready.

enabled

boolean

Specifies whether or not storage failover is enabled.

partners

array[partners]

The nodes in this node's High Availability (HA) group.

management_interface

The management interface of the node to be added. The netmask is set based on the management interface of the cluster or the managment interfaces of other nodes.

Name Type Description

ip

node_setup_ip

The IP configuration for cluster setup.

management_interfaces

Network interface

Name Type Description

_links

_links

ip

ip

IP information

name

string

The name of the interface.

uuid

string

The UUID that uniquely identifies the interface.

ipv4_interface

Object to setup an interface along with its default router.

Name Type Description

address

string

IPv4 or IPv6 address

gateway

string

The IPv4 or IPv6 address of the default router.

netmask

string

Input as netmask length (16) or IPv4 mask (255.255.0.0). For IPv6, you must set the netmask length. The default value is 64. Output is always netmask length.

ipv6_interface

Object to setup an interface along with its default router.

Name Type Description

address

string

IPv4 or IPv6 address

gateway

string

The IPv4 or IPv6 address of the default router.

netmask

string

Input as netmask length (16) or IPv4 mask (255.255.0.0). For IPv6, you must set the netmask length. The default value is 64. Output is always netmask length.

service_processor

Name Type Description

dhcp_enabled

boolean

Set to true to use DHCP to configure an IPv4 interface.

firmware_version

string

The version of firmware installed.

ipv4_interface

ipv4_interface

Object to setup an interface along with its default router.

ipv6_interface

ipv6_interface

Object to setup an interface along with its default router.

link_status

string

mac_address

string

state

string

version

This returns the cluster version information. When the cluster has more than one node, the cluster version is equivalent to the lowest of generation, major, and minor versions on all nodes.

Name Type Description

full

string

The full cluster version string.

generation

integer

The generation portion of the version.

major

integer

The major portion of the version.

minor

integer

The minor portion of the version.

records

Complete node information

Name Type Description

_links

_links

cluster_interface

cluster_interface

The cluster network IP address of the node to be added.

cluster_interfaces

array[cluster_interfaces]

controller

controller

Controller information

date

string

Specifies the ISO-8601 format date and time on the node.

ha

ha

location

string

management_interface

management_interface

The management interface of the node to be added. The netmask is set based on the management interface of the cluster or the managment interfaces of other nodes.

management_interfaces

array[management_interfaces]

membership

string

Possible values:

  • available - If a node is available, this means it is detected on the internal cluster network and can be added to the cluster. Nodes that have a membership of "available" are not returned when a GET request is called when the cluster exists. A query on the "membership" property for available must be provided to scan for nodes on the cluster network. Nodes that have a membership of "available" are returned automatically before a cluster is created.

  • joining - Joining nodes are in the process of being added to the cluster. The node may be progressing through the steps to become a member or might have failed. The job to add the node or create the cluster provides details on the current progress of the node.

  • member - Nodes that are members have successfully joined the cluster.

model

string

name

string

serial_number

string

service_processor

service_processor

uptime

integer

The total time, in seconds, that the node has been up.

uuid

string

version

version

This returns the cluster version information. When the cluster has more than one node, the cluster version is equivalent to the lowest of generation, major, and minor versions on all nodes.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.