Skip to main content

Retrieve the nodes in a cluster

Contributors
PDFs

GET /cluster/nodes

Introduced In: 9.6

Retrieves the nodes in the cluster.

Expensive properties

There is an added computational cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the fields query parameter. See Requesting specific fields to learn more.

  • statistics.*

  • metric.*

  • system node show

Parameters

Name Type In Required Description

management_interfaces.uuid

string

query

False

Filter by management_interfaces.uuid

management_interfaces.ip.address

string

query

False

Filter by management_interfaces.ip.address

management_interfaces.name

string

query

False

Filter by management_interfaces.name

owner

string

query

False

Filter by owner

  • Introduced in: 9.9

controller.board

string

query

False

Filter by controller.board

  • Introduced in: 9.9

controller.over_temperature

string

query

False

Filter by controller.over_temperature

controller.failed_fan.message.code

string

query

False

Filter by controller.failed_fan.message.code

  • Introduced in: 9.9

controller.failed_fan.message.message

string

query

False

Filter by controller.failed_fan.message.message

  • Introduced in: 9.9

controller.failed_fan.count

integer

query

False

Filter by controller.failed_fan.count

  • Introduced in: 9.9

controller.failed_power_supply.count

integer

query

False

Filter by controller.failed_power_supply.count

  • Introduced in: 9.9

controller.failed_power_supply.message.code

string

query

False

Filter by controller.failed_power_supply.message.code

  • Introduced in: 9.9

controller.failed_power_supply.message.message

string

query

False

Filter by controller.failed_power_supply.message.message

  • Introduced in: 9.9

controller.frus.type

string

query

False

Filter by controller.frus.type

controller.frus.state

string

query

False

Filter by controller.frus.state

controller.frus.id

string

query

False

Filter by controller.frus.id

controller.cpu.firmware_release

string

query

False

Filter by controller.cpu.firmware_release

  • Introduced in: 9.9

controller.cpu.count

integer

query

False

Filter by controller.cpu.count

  • Introduced in: 9.9

controller.cpu.processor

string

query

False

Filter by controller.cpu.processor

  • Introduced in: 9.9

controller.flash_cache.firmware_version

string

query

False

Filter by controller.flash_cache.firmware_version

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.state

string

query

False

Filter by controller.flash_cache.state

controller.flash_cache.slot

string

query

False

Filter by controller.flash_cache.slot

controller.flash_cache.firmware_file

string

query

False

Filter by controller.flash_cache.firmware_file

  • Introduced in: 9.9

controller.flash_cache.device_id

integer

query

False

Filter by controller.flash_cache.device_id

  • Introduced in: 9.9

controller.flash_cache.model

string

query

False

Filter by controller.flash_cache.model

controller.flash_cache.serial_number

string

query

False

Filter by controller.flash_cache.serial_number

controller.flash_cache.part_number

string

query

False

Filter by controller.flash_cache.part_number

controller.memory_size

integer

query

False

Filter by controller.memory_size

  • Introduced in: 9.9

cluster_interfaces.uuid

string

query

False

Filter by cluster_interfaces.uuid

cluster_interfaces.ip.address

string

query

False

Filter by cluster_interfaces.ip.address

cluster_interfaces.name

string

query

False

Filter by cluster_interfaces.name

name

string

query

False

Filter by name

model

string

query

False

Filter by model

state

string

query

False

Filter by state

  • Introduced in: 9.7

date

string

query

False

Filter by date

vm.provider_type

string

query

False

Filter by vm.provider_type

  • Introduced in: 9.7

membership

string

query

False

Filter by membership

nvram.battery_state

string

query

False

Filter by nvram.battery_state

  • Introduced in: 9.9

nvram.id

integer

query

False

Filter by nvram.id

  • Introduced in: 9.9

snaplock.compliance_clock_time

string

query

False

Filter by snaplock.compliance_clock_time

  • Introduced in: 9.12

service_processor.backup.state

string

query

False

Filter by service_processor.backup.state

  • Introduced in: 9.10

service_processor.backup.is_current

boolean

query

False

Filter by service_processor.backup.is_current

  • Introduced in: 9.10

service_processor.backup.version

string

query

False

Filter by service_processor.backup.version

  • Introduced in: 9.10

service_processor.type

string

query

False

Filter by service_processor.type

  • Introduced in: 9.10

service_processor.api_service.port

integer

query

False

Filter by service_processor.api_service.port

  • Introduced in: 9.11

service_processor.api_service.limit_access

boolean

query

False

Filter by service_processor.api_service.limit_access

  • Introduced in: 9.11

service_processor.api_service.enabled

boolean

query

False

Filter by service_processor.api_service.enabled

  • Introduced in: 9.11

service_processor.last_update_state

string

query

False

Filter by service_processor.last_update_state

  • Introduced in: 9.10

service_processor.autoupdate_enabled

boolean

query

False

Filter by service_processor.autoupdate_enabled

  • Introduced in: 9.10

service_processor.auto_config.ipv4_subnet

string

query

False

Filter by service_processor.auto_config.ipv4_subnet

  • Introduced in: 9.11

service_processor.auto_config.ipv6_subnet

string

query

False

Filter by service_processor.auto_config.ipv6_subnet

  • Introduced in: 9.11

service_processor.web_service.enabled

boolean

query

False

Filter by service_processor.web_service.enabled

  • Introduced in: 9.14

service_processor.web_service.limit_access

boolean

query

False

Filter by service_processor.web_service.limit_access

  • Introduced in: 9.14

service_processor.state

string

query

False

Filter by service_processor.state

service_processor.link_status

string

query

False

Filter by service_processor.link_status

service_processor.ipv4_interface.enabled

boolean

query

False

Filter by service_processor.ipv4_interface.enabled

  • Introduced in: 9.15

service_processor.ipv4_interface.setup_state

string

query

False

Filter by service_processor.ipv4_interface.setup_state

  • Introduced in: 9.15

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.firmware_version

string

query

False

Filter by service_processor.firmware_version

service_processor.ipv6_interface.is_ipv6_ra_enabled

boolean

query

False

Filter by service_processor.ipv6_interface.is_ipv6_ra_enabled

  • Introduced in: 9.15

service_processor.ipv6_interface.address

string

query

False

Filter by service_processor.ipv6_interface.address

service_processor.ipv6_interface.netmask

integer

query

False

Filter by service_processor.ipv6_interface.netmask

service_processor.ipv6_interface.enabled

boolean

query

False

Filter by service_processor.ipv6_interface.enabled

  • Introduced in: 9.15

service_processor.ipv6_interface.router_ip

string

query

False

Filter by service_processor.ipv6_interface.router_ip

  • Introduced in: 9.15

service_processor.ipv6_interface.gateway

string

query

False

Filter by service_processor.ipv6_interface.gateway

service_processor.ipv6_interface.setup_state

string

query

False

Filter by service_processor.ipv6_interface.setup_state

  • Introduced in: 9.15

service_processor.ipv6_interface.link_local_ip

string

query

False

Filter by service_processor.ipv6_interface.link_local_ip

  • Introduced in: 9.15

service_processor.is_ip_configured

boolean

query

False

Filter by service_processor.is_ip_configured

  • Introduced in: 9.10

service_processor.primary.state

string

query

False

Filter by service_processor.primary.state

  • Introduced in: 9.10

service_processor.primary.version

string

query

False

Filter by service_processor.primary.version

  • Introduced in: 9.10

service_processor.primary.is_current

boolean

query

False

Filter by service_processor.primary.is_current

  • Introduced in: 9.10

service_processor.dhcp_enabled

boolean

query

False

Filter by service_processor.dhcp_enabled

service_processor.mac_address

string

query

False

Filter by service_processor.mac_address

service_processor.ssh_info.allowed_addresses

string

query

False

Filter by service_processor.ssh_info.allowed_addresses

  • Introduced in: 9.10

system_aggregate.uuid

string

query

False

Filter by system_aggregate.uuid

  • Introduced in: 9.14

system_aggregate.name

string

query

False

Filter by system_aggregate.name

  • Introduced in: 9.14

location

string

query

False

Filter by location

metrocluster.custom_vlan_capable

boolean

query

False

Filter by metrocluster.custom_vlan_capable

  • Introduced in: 9.8

metrocluster.type

string

query

False

Filter by metrocluster.type

  • Introduced in: 9.8

metrocluster.ports.name

string

query

False

Filter by metrocluster.ports.name

  • Introduced in: 9.8

vendor_serial_number

string

query

False

Filter by vendor_serial_number

  • Introduced in: 9.7

system_machine_type

string

query

False

Filter by system_machine_type

  • Introduced in: 9.7

metric.timestamp

string

query

False

Filter by metric.timestamp

  • Introduced in: 9.8

metric.status

string

query

False

Filter by metric.status

  • Introduced in: 9.8

metric.uuid

string

query

False

Filter by metric.uuid

  • Introduced in: 9.10

metric.processor_utilization

integer

query

False

Filter by metric.processor_utilization

  • Introduced in: 9.8

metric.duration

string

query

False

Filter by metric.duration

  • Introduced in: 9.8

hw_assist.status.partner.state

string

query

False

Filter by hw_assist.status.partner.state

  • Introduced in: 9.11

hw_assist.status.partner.port

integer

query

False

Filter by hw_assist.status.partner.port

  • Introduced in: 9.11

hw_assist.status.partner.ip

string

query

False

Filter by hw_assist.status.partner.ip

  • Introduced in: 9.11

hw_assist.status.local.state

string

query

False

Filter by hw_assist.status.local.state

  • Introduced in: 9.11

hw_assist.status.local.port

integer

query

False

Filter by hw_assist.status.local.port

  • Introduced in: 9.11

hw_assist.status.local.ip

string

query

False

Filter by hw_assist.status.local.ip

  • Introduced in: 9.11

hw_assist.status.enabled

boolean

query

False

Filter by hw_assist.status.enabled

  • Introduced in: 9.11

storage_configuration

string

query

False

Filter by storage_configuration

  • Introduced in: 9.9

uptime

integer

query

False

Filter by uptime

is_spares_low