Skip to main content

Create a cluster

Contributors
PDFs

POST /cluster

Introduced In: 9.6

Creates a cluster.

Required properties

  • name

  • password

  • location

  • contact

  • dns_domains

  • name_servers

  • ntp_servers

  • license

  • configuration_backup

  • management_interface

  • nodes

  • timezone

Learn more

Parameters

Name Type In Required Description

single_node_cluster

boolean

query

False

Configures a single node cluster. All cluster ports are reassigned to the default network. The storage failover settings are configured to non-HA. The node reboots during this operation.

create_recommended_aggregates

boolean

query

False

Create aggregates based on an optimal layout recommended by the system.

  • Introduced in: 9.7

  • Default value:

keep_precluster_config

boolean

query

False

This is used to keep temporary configuration settings that allow initial setup including a node scoped certificate and possibly an automatically created node management interface. This is useful when creating a GUI that does not replace the node management interface using POST on /api/cluster, but instead creates the interface at another time. The certificate also relates to creating a web based GUI so that the certificate lasts through the entire workflow and is not replaced by the cluster scoped certificate during POST on /api/cluster. To remove the temporary configuration settings when a custom setup workflow is complete, set the remove_precluster_config query parameter in a PATCH on /api/cluster.

  • Introduced in: 9.12

  • Default value:

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

  • Default value: 1

  • Max value: 120

  • Min value: 0

Request Body

Name Type Description

_links

_links

_tags

array[string]

Tags are an optional way to track the uses of a resource. Tag values must be formatted as key:value strings.

auto_enable_activity_tracking

boolean

Indicates how new SVMs will default "auto_enable_activity_tracking" for new volumes.

auto_enable_analytics

boolean

Indicates how new SVMs will default "auto_enable_analytics" for new volumes.

certificate

certificate

Support for this field will be removed in a future release. Please use /api/cluster/web for this field. Certificate used by cluster and node management interfaces for TLS connection requests.

configuration_backup

configuration_backup

contact

string

dns_domains

array[string]

A list of DNS domains. Domain names have the following requirements:

  • The name must contain only the following characters: A through Z, a through z, 0 through 9, ".", "-" or "_".

  • The first character of each label, delimited by ".", must be one of the following characters: A through Z or a through z or 0 through 9.

  • The last character of each label, delimited by ".", must be one of the following characters: A through Z, a through z, or 0 through 9.

  • The top level domain must contain only the following characters: A through Z, a through z.

  • The system reserves the following names:"all", "local", and "localhost".

large_volume_supported

boolean

Specifies whether or not this cluster supports large size limits for volume(300TB), File/LUN(128TB).

license

license

License keys or NLF contents.

location

string

management_interface

management_interface

The management interface of the cluster. The subnet mask and gateway for this interface are used for the node management interfaces provided in the node configuration.

management_interfaces

array[management_interfaces]

metric

metric

Performance numbers, such as IOPS latency and throughput.

name

string

name_servers

array[string]

The list of IP addresses of the DNS servers. Addresses can be either IPv4 or IPv6 addresses.

nodes

array[nodes]

ntp_servers

array[string]

Host name, IPv4 address, or IPv6 address for the external NTP time servers.

password

string

Initial admin password used to create the cluster.

peering_policy

peering_policy

san_optimized

boolean

Specifies if this cluster is an All SAN Array.

statistics

statistics

These are raw performance numbers, such as IOPS latency and throughput. These numbers are aggregated across all nodes in the cluster and increase with the uptime of the cluster.

timezone

timezone

Provides the cluster-wide time zone information that localizes time found on messages displayed on each node's:

  • console messages;

  • logging to internal ONTAP log files; and

  • localized REST API full ISO-8601 date, time, and time zone format information. Machine-to-machine interfaces, such as file access protocols (NFS, CIFS), block access protocols (SAN), and other protocols such as Manage ONTAP (ONTAPI), use second or subsecond time values that are based on world time or UTC.

  • Introduced in: 9.7

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.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "_tags": [
    "team:csi",
    "environment:test"
  ],
  "certificate": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "string",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "configuration_backup": {
    "password": "yourpassword",
    "url": "http://10.224.65.198/backups",
    "username": "me"
  },
  "contact": "support@company.com",
  "dns_domains": [
    "example.com",
    "example2.example3.com"
  ],
  "license": {
    "keys": [
      "AMEPOSOIKLKGEEEEDGNDEKSJDE"
    ]
  },
  "location": "building 1",
  "management_interface": {
    "ip": {
      "address": "10.10.10.7",
      "gateway": "10.1.1.1",
      "netmask": "24"
    }
  },
  "management_interfaces": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "ip": {
        "address": "10.10.10.7"
      },
      "name": "lif1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  ],
  "metric": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "duration": "PT15S",
    "iops": {
      "read": 200,
      "total": 1000,
      "write": 100
    },
    "latency": {
      "read": 200,
      "total": 1000,
      "write": 100
    },
    "status": "ok",
    "throughput": {
      "read": 200,
      "total": 1000,
      "write": 100
    },
    "timestamp": "2017-01-25 06:20:13 -0500"
  },
  "name": "cluster1",
  "name_servers": [
    "10.224.65.20",
    "2001:db08:a0b:12f0::1"
  ],
  "nodes": [
    {
      "_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": {
        "board": "System Board XXVIII",
        "cpu": {
          "count": 20,
          "firmware_release": "string",
          "processor": "string"
        },
        "failed_fan": {
          "count": 1,
          "message": {
            "code": "111411207",
            "message": "There are no failed fans."
          }
        },
        "failed_power_supply": {
          "count": 1,
          "message": {
            "code": "111411208",
            "message": "There are no failed power supplies."
          }
        },
        "flash_cache": [
          {
            "capacity": 1024000000000,
            "device_id": 0,
            "firmware_file": "X9170_O000Z6300NVM",
            "firmware_version": "NA05",
            "hardware_revision": "A1",
            "model": "X1970A",
            "part_number": "119-00207",
            "serial_number": "A22P5061550000187",
            "slot": "6-1",
            "state": "string"
          }
        ],
        "frus": [
          {
            "id": "string",
            "state": "string",
            "type": "string"
          }
        ],
        "memory_size": 1024000000,
        "over_temperature": "string"
      },
      "date": "2019-04-17 11:49:26 -0400",
      "external_cache": {
        "is_enabled": 1,
        "is_hya_enabled": 1,
        "is_rewarm_enabled": 1
      },
      "ha": {
        "giveback": {
          "failure": {
            "code": 852126,
            "message": "Failed to initiate giveback. Run the \"storage failover show-giveback\" command for more information."
          },
          "state": "failed",
          "status": [
            {
              "aggregate": {
                "_links": {
                  "self": {
                    "href": "/api/resourcelink"
                  }
                },
                "name": "aggr1",
                "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
              },
              "error": {
                "code": "852126",
                "message": "string"
              },
              "state": "string"
            }
          ]
        },
        "interconnect": {
          "adapter": "MVIA-RDMA",
          "state": "string"
        },
        "partners": [
          {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "node1",
            "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
          }
        ],
        "ports": [
          {
            "number": 0,
            "state": "active"
          }
        ],
        "takeover": {
          "failure": {
            "code": 852130,
            "message": "Failed to initiate takeover. Run the \"storage failover show-takeover\" command for more information."
          },
          "state": "failed"
        },
        "takeover_check": {
          "reasons": [
            "string"
          ]
        }
      },
      "hw_assist": {
        "status": {
          "local": {
            "ip": "string",
            "state": "string"
          },
          "partner": {
            "ip": "string",
            "state": "string"
          }
        }
      },
      "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",
      "metric": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "duration": "PT15S",
        "processor_utilization": 13,
        "status": "ok",
        "timestamp": "2017-01-25 06:20:13 -0500",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "metrocluster": {
        "ports": [
          {
            "name": "e1b"
          }
        ],
        "type": "string"
      },
      "model": "FAS3070",
      "name": "node-01",
      "nvram": {
        "battery_state": "string",
        "id": 0
      },
      "owner": "Example Corp",
      "serial_number": "4048820-60-9",
      "service_processor": {
        "api_service": {
          "port": 0
        },
        "auto_config": {
          "ipv4_subnet": "ipv4_mgmt",
          "ipv6_subnet": "ipv6_mgmt"
        },
        "backup": {
          "state": "string",
          "version": "11.6"
        },
        "firmware_version": "string",
        "ipv4_interface": {
          "address": "10.10.10.7",
          "gateway": "10.1.1.1",
          "netmask": "255.255.0.0",
          "setup_state": "string"
        },
        "ipv6_interface": {
          "address": "fd20:8b1e:b255:5011:10:141:4:97",
          "gateway": "fd20:8b1e:b255:5011:10::1",
          "link_local_ip": "FE80::/10",
          "netmask": 64,
          "router_ip": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
          "setup_state": "string"
        },
        "last_update_state": "string",
        "link_status": "string",
        "mac_address": "string",
        "primary": {
          "state": "string",
          "version": "11.6"
        },
        "ssh_info": {
          "allowed_addresses": [
            "10.10.10.7/24"
          ]
        },
        "state": "string",
        "type": "string"
      },
      "snaplock": {
        "compliance_clock_time": "2018-06-04 15:00:00 -0400"
      },
      "state": "string",
      "statistics": {
        "processor_utilization_base": 12345123,
        "processor_utilization_raw": 13,
        "status": "ok",
        "timestamp": "2017-01-25 06:20:13 -0500"
      },
      "storage_configuration": "string",
      "system_aggregate": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "aggr1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "system_id": 92027651,
      "system_machine_type": "7Y56-CTOWW1",
      "uptime": 300536,
      "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412",
      "vendor_serial_number": 791603000068,
      "version": {
        "full": "NetApp Release 9.4.0: Sun Nov 05 18:20:57 UTC 2017",
        "generation": 9,
        "major": 4,
        "minor": 0,
        "patch": "P2"
      },
      "vm": {
        "account_id": "string",
        "deployment_id": "string",
        "fault_domain": "string",
        "instance_id": "string",
        "primary_ip": "string",
        "provider_type": "string",
        "update_domain": "string"
      }
    }
  ],
  "ntp_servers": [
    "time.nist.gov",
    "10.98.19.20",
    "2610:20:6F15:15::27"
  ],
  "password": "mypassword",
  "peering_policy": {
    "minimum_passphrase_length": 0
  },
  "statistics": {
    "iops_raw": {
      "read": 200,
      "total": 1000,
      "write": 100
    },
    "latency_raw": {
      "read": 200,
      "total": 1000,
      "write": 100
    },
    "status": "ok",
    "throughput_raw": {
      "read": 200,
      "total": 1000,
      "write": 100
    },
    "timestamp": "2017-01-25 06:20:13 -0500"
  },
  "timezone": {
    "name": "America/New_York"
  },
  "uuid": "1cd8a442-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,
    "patch": "P2"
  }
}

Response

Status: 202, Accepted
Name Type Description

job

job_link
Example response 
{
  "job": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "string"
  }
}

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Response

Status: 201, Created

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

262245

The value provided is invalid.

1179813

Fields set for one node must be set for all nodes.

1179817

The IP address, subnet mask, and gateway must all be provided for cluster manangement interface.

1179818

The IP address and gateway must be of the same family.

1179821

An IP address and subnet mask conflicts with an existing entry.

1179823

An invalid netmask was provided.

1179824

An invalid gateway was provided.

1179825

All management and cluster config IP addresses must belong to the same address family.

2097165

An NTP server could not be reached.

8847361

Too many DNS domains provided.

8847362

Too many name servers provided.

8847394

An invalid DNS domain was provided.

8978433

An invalid license key was provided.

9240587

A name must be provided.

9240594

An invalid name was provided.

39387137

The URL provided is invalid.

131727360

A node could not be added to the cluster. This is a generic code, see response message for details.

131727388

Hostnames for NTP servers cannot be used without DNS configured.

131727389

URL and username are required for configuration backup.

Also see the table of common errors in the Response body overview section of this documentation.

Name Type Description

error

returned_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

_links

Name Type Description

self

href

certificate

Support for this field will be removed in a future release. Please use /api/cluster/web for this field. Certificate used by cluster and node management interfaces for TLS connection requests.

Name Type Description

_links

_links

name

string

Certificate name

uuid

string

Certificate UUID

configuration_backup

Name Type Description

password

string

url

string

An external backup location for the cluster configuration. This is mostly required for single node clusters where node and cluster configuration backups cannot be copied to other nodes in the cluster.

username

string

validate_certificate

boolean

Use this parameter with the value "true" to validate the digital certificate of the remote server. Digital certificate validation is available only when the HTTPS protocol is used in the URL; it is disabled by default.

license

License keys or NLF contents.

Name Type Description

keys

array[string]

ip

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, the default value is 64 with a valid range of 1 to 127. Output is always the netmask length.

management_interface

The management interface of the cluster. The subnet mask and gateway for this interface are used for the node management interfaces provided in the node configuration.

Name Type Description

ip

ip

Object to setup an interface along with its default router.

ip

IP information

Name Type Description

address

string

IPv4 or IPv6 address

management_interfaces

A network interface. Either UUID or name may be supplied on input.

Name Type Description

_links

_links

ip

ip

IP information

name

string

The name of the interface. If only the name is provided, the SVM scope must be provided by the object this object is embedded in.

uuid

string

The UUID that uniquely identifies the interface.

iops

The rate of I/O operations observed at the storage object.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

latency

The round trip latency in microseconds observed at the storage object.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

throughput

The rate of throughput bytes per second observed at the storage object.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

metric

Performance numbers, such as IOPS latency and throughput.

Name Type Description

_links

_links

duration

string

The duration over which this sample is calculated. The time durations are represented in the ISO-8601 standard format. Samples can be calculated over the following durations:

iops

iops

The rate of I/O operations observed at the storage object.

latency

latency

The round trip latency in microseconds observed at the storage object.

status

string

Errors associated with the sample. For example, if the aggregation of data over multiple nodes fails, then any partial errors might return "ok" on success or "error" on an internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_ delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput

throughput

The rate of throughput bytes per second observed at the storage object.

timestamp

string

The timestamp of the performance data.

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.

cluster_interfaces

Network interface

Name Type Description

_links

_links

ip

ip

IP information

name

string

The name of the interface. If only the name is provided, the SVM scope must be provided by the object this object is embedded in.

uuid

string

The UUID that uniquely identifies the interface.

cpu

CPU information.

Name Type Description

count

integer

Number of CPUs on the node.

firmware_release

string

Firmware release number. Defined by the CPU manufacturer.

processor

string

CPU type on the node.

message

Name Type Description

code

string

Error code describing the current condition of chassis fans.

message

string

Message describing the current condition of chassis fans. It is only of use when failed_fan.count is not zero.

failed_fan

Name Type Description

count

integer

Specifies a count of the number of chassis fans that are not operating within the recommended RPM range.

message

message

message

Name Type Description

code

string

Error code describing the current condition of power supply.

message

string

Message describing the state of any power supplies that are currently degraded. It is only of use when failed_power_supply.count is not zero.

failed_power_supply

Name Type Description

count

integer

Number of failed power supply units.

message

message

flash_cache

Name Type Description

capacity

integer

Size in bytes

device_id

integer

firmware_file

string

firmware_version

string

hardware_revision

string

model

string

part_number

string

serial_number

string

slot

string

state

string

frus

Name Type Description

id

string

state

string

type

string

controller

Controller information

Name Type Description

board

string

Type of the system board. This is defined by vendor.

cpu

cpu

CPU information.

failed_fan

failed_fan

failed_power_supply

failed_power_supply

flash_cache

array[flash_cache]

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

frus

array[frus]

List of FRUs on the node. Only returned when requested by name.

memory_size

integer

Memory available on the node, in bytes.

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.

external_cache

Cache used for buffer management.

Name Type Description

is_enabled

boolean

Indicates whether the external cache is enabled.

is_hya_enabled

boolean

Indicates whether HyA caching is enabled.

is_rewarm_enabled

boolean

Indicates whether rewarm is enabled.

pcs_size

integer

PCS size in gigabytes.

failure

Indicates the failure code and message.

Name Type Description

code

integer

Message code

message

string

Detailed message based on the state.

aggregate

Aggregate name and UUID.

Name Type Description

_links

_links

name

string

uuid

string

error

Indicates the failed aggregate giveback code and message.

Name Type Description

code

string

Message code.

message

string

Detailed message based on the state.

status

Name Type Description

aggregate

aggregate

Aggregate name and UUID.

error

error

Indicates the failed aggregate giveback code and message.

state

string

Giveback state of the aggregate.

Possible values include no aggregates to giveback(nothing_to_giveback), failed to disable background disk firmware update(BDFU) on source node(failed_bdfu_source),

giveback delayed as disk firmware update is in progress on source node(delayed_bdfu_source), performing veto checks(running_checks).

giveback

Represents the state of the node that is giving storage back to its HA partner.

Name Type Description

failure

failure

Indicates the failure code and message.

state

string

status

array[status]

Giveback status of each aggregate.

interconnect

Name Type Description

adapter

string

HA interconnect device name.

state

string

Indicates the HA interconnect status.

partners

Name Type Description

_links

_links

name

string

uuid

string

ports

Name Type Description

number

integer

HA port number

state

string

HA port state:

  • down - Logical HA link is down.

  • initialized - Logical HA link is initialized. The physical link is up, but the subnet manager hasn't started to configure the port.

  • armed - Logical HA link is armed. The physical link is up and the subnet manager started but did not yet complete configuring the port.

  • active - Logical HA link is active.

  • reserved - Logical HA link is active, but the physical link is down.

takeover

This represents the state of the node that is taking over storage from its HA partner.

Name Type Description

failure

failure

Indicates the failure code and message.

state

string

takeover_check

The takeover check response.

Name Type Description

reasons

array[string]

Reasons why the takeover is not possible.

takeover_possible

boolean

Indicates whether the takeover is possible.

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.

giveback

giveback

Represents the state of the node that is giving storage back to its HA partner.

interconnect

interconnect

partners

array[partners]

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

ports

array[ports]

takeover

takeover

This represents the state of the node that is taking over storage from its HA partner.

takeover_check

takeover_check

The takeover check response.

local

Name Type Description

ip

string

The hardware assist IP address.

port

integer

The hardware assist port.

state

string

The hardware assist monitor status.

partner

Name Type Description

ip

string

The hardware assist IP address.

port

integer

The hardware assist port.

state

string

The hardware assist monitor status.

status

Name Type Description

enabled

boolean

Indicates whether hardware assist is enabled on the node.

local

local

partner

partner

hw_assist

The hardware assist information.

Name Type Description

status

status

management_interface

The management interface of the node to be added. The subnet mask is set based on the management interface of the cluster or the management 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. If only the name is provided, the SVM scope must be provided by the object this object is embedded in.

uuid

string

The UUID that uniquely identifies the interface.

metric

CPU performance for the nodes.

Name Type Description

_links

_links

duration

string

The duration over which this sample is calculated. The time durations are represented in the ISO-8601 standard format. Samples can be calculated over the following durations:

processor_utilization

integer

Average CPU Utilization for the node

status

string

Errors associated with the sample. For example, if the aggregation of data over multiple nodes fails, then any partial errors might return "ok" on success or "error" on an internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "inconsistent_delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "inconsistent_old_data" is returned when one or more nodes do not have the latest data.

timestamp

string

The timestamp of the performance data.

uuid

string

ports

Name Type Description

name

string

metrocluster

Metrocluster

Name Type Description

custom_vlan_capable

boolean

Indicates whether the MetroCluster over IP platform supports custom VLAN IDs.

ports

array[ports]

MetroCluster over IP ports.

type

string

The Metrocluster configuration type

nvram

Name Type Description

battery_state

string

Specifies status of the NVRAM battery. Possible values:

  • battery_ok

  • battery_partially_discharged

  • battery_fully_discharged

  • battery_not_present

  • battery_near_end_of_life

  • battery_at_end_of_life

  • battery_unknown

  • battery_over_charged

  • battery_fully_charged

id

integer

Vendor specific NVRAM ID of the node.

api_service

Provides the properties of the service processor (SP) or baseboard management controller (BMC) API service.

Name Type Description

enabled

boolean

Indicates whether the SP API service of the SP or BMC is enabled or disabled. When the SP API service is disabled, features such as network-based firmware updates and network-based down node log collection are not available, and the slower serial-interface is used for firmware updates and down node log collection.

limit_access

boolean

Restricts SP API service access to cluster nodes only. By default, limit_access is set to true.

port

integer

Specifies the port number on the SP or BMC used for the SP API service. By default, port 50000 is used.

auto_config

Provides the properties of the service processor auto configuration.

Name Type Description

ipv4_subnet

string

Indicates the service processor auto configuration IPv4 subnet name. To enable IPv4 auto-config give the subnet name, give the value as null or an empty string "" to disable auto-config.

ipv6_subnet

string

Indicates the service processor auto configuration IPv6 subnet name. To enable IPv6 auto-config give the subnet name, give the value as null or an empty string "" to disable auto-config.

backup

Provides the properties of the service processor backup partition.

Name Type Description

is_current

boolean

Indicates whether the service processor is currently booted from the backup partition.

state

string

Status of the backup partition.

version

string

Firmware version of the backup partition.

ipv4_interface

Object to set up an interface along with its default router.

Name Type Description

address

string

IPv4 address

enabled

boolean

Indicates whether the IPv4 interfaces is enabled. It expects dhcp_enabled as "true" or values for address, netmask and gateway when set to "true".

gateway

string

The IPv4 address of the default router.

netmask

string

Input as IPv4 mask (255.255.0.0). Output is always the netmask length.

setup_state

string

Indicates the setup state of the interface.

ipv6_interface

Object to setup an interface along with its default router.

Name Type Description

address

string

IPv6 address

enabled

boolean

Indicates whether the IPv6 interfaces is enabled. It expects values for address, netmask and gateway when set to "true".

gateway

string

The IPv6 address of the default router.

is_ipv6_ra_enabled

boolean

Indicates whether IPv6 RA is enabled.

link_local_ip

string

Link local IP address.

netmask

integer

The IPv6 netmask/prefix length. The default value is 64 with a valid range of 1 to 127.

router_ip

string

Router assigned IP address.

setup_state

string

Indicates the setup state of the interface.

primary

Provides the properties of the service processor primary partition.

Name Type Description

is_current

boolean

Indicates whether the service processor is currently booted from the primary partition.

state

string

Status of the primary partition.

version

string

Firmware version of the primary partition.

ssh_info

Service processor SSH allowed IP address configuration applied across the cluster.

Name Type Description

allowed_addresses

array[string]

Allowed IP addresses

web_service

Provides the properties of SP or BMC web service.

Name Type Description

enabled

boolean

Indicates whether the web service of the SP or BMC is enabled or disabled. When the web service is disabled, features such as network-based firmware updates and network-based down node log collection are not available, and the slower serial-interface is used for firmware updates and down node log collection.

limit_access

boolean

Restricts web service access to cluster nodes only. By default, limit_access is set to true.

service_processor

Name Type Description

api_service

api_service

Provides the properties of the service processor (SP) or baseboard management controller (BMC) API service.

auto_config

auto_config

Provides the properties of the service processor auto configuration.

autoupdate_enabled

boolean

Indicates whether the service processor can be automatically updated from ONTAP.

  • Introduced in: 9.10

  • x-ntap-readModify: true

  • x-nullable: true

backup

backup

Provides the properties of the service processor backup partition.

dhcp_enabled

boolean

Set to "true" to use DHCP to configure an IPv4 interface. Do not provide values for address, netmask and gateway when set to "true".

firmware_version

string

The version of firmware installed.

ipv4_interface

ipv4_interface

Object to set up an interface along with its default router.

ipv6_interface

ipv6_interface

Object to setup an interface along with its default router.

is_ip_configured

boolean

Indicates whether the service processor network is configured.

last_update_state

string

Provides the "update status" of the last service processor update.

link_status

string

mac_address

string

primary

primary

Provides the properties of the service processor primary partition.

ssh_info

ssh_info

Service processor SSH allowed IP address configuration applied across the cluster.

state

string

type

string

web_service

web_service

Provides the properties of SP or BMC web service.

snaplock

SnapLock-related properties.

Name Type Description

compliance_clock_time

string

SnapLock compliance clock time.

statistics

Raw CPU performance for the nodes.

Name Type Description

processor_utilization_base

integer

Base counter for CPU Utilization.

processor_utilization_raw

integer

Raw CPU Utilization for the node. This should be divided by the processor_utilization_base to calculate the percentage CPU utilization for the node.

status

string

Errors associated with the sample. For example, if the aggregation of data over multiple nodes fails, then any partial errors might return "ok" on success or "error" on an internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "inconsistent_delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "inconsistent_old_data" is returned when one or more nodes do not have the latest data.

timestamp

string

The timestamp of the performance data.

system_aggregate

Aggregate

Name Type Description

_links

_links

name

string

uuid

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.

patch

string

The patch portion of the version.

vm

Name Type Description

account_id

string

The cloud provider account ID.

deployment_id

string

The cloud provider deployment ID.

fault_domain

string

The VM fault domain.

instance_id

string

The cloud provider instance ID.

primary_ip

string

The VM primary IP address.

provider_type

string

Cloud provider where the VM is hosted.

update_domain

string

The VM update domain.

nodes

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

The current or "wall clock" time of the node in ISO-8601 date, time, and time zone format. The ISO-8601 date and time are localized based on the ONTAP cluster's timezone setting.

  • example: 2019-04-17 11:49:26 -0400

  • format: date-time

  • readOnly: 1

  • Introduced in: 9.6

  • x-nullable: true

disaggregated

boolean

Specifies whether the node is designed for disaggregated storage.

external_cache

external_cache

Cache used for buffer management.

ha

ha

hw_assist

hw_assist

The hardware assist information.

is_all_flash_optimized

boolean

Specifies whether the node is all flash optimized.

is_all_flash_select_optimized

boolean

Specifies whether the node is all flash select optimized.

is_capacity_optimized

boolean

Specifies whether the node is capacity optimized.

is_performance_optimized

boolean

Specifies whether the node is performance optimized.

is_spares_low

boolean

Specifies whether or not the node is in spares low condition.

location

string

management_interface

management_interface

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

management_interfaces

array[management_interfaces]

membership

string

Possible values:

  • available - A node 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. Provide a query on the "membership" property for available 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 might 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.

metric

metric

CPU performance for the nodes.

metrocluster

metrocluster

Metrocluster

model

string

name

string

nvram

nvram

owner

string

Owner of the node.

serial_number

string

service_processor

service_processor

snaplock

snaplock

SnapLock-related properties.

state

string

State of the node:

  • up - Node is up and operational.

  • booting - Node is booting up.

  • down - Node has stopped or is dumping core.

  • taken_over - Node has been taken over by its HA partner and is not yet waiting for giveback.

  • waiting_for_giveback - Node has been taken over by its HA partner and is waiting for the HA partner to giveback disks.

  • degraded - Node has one or more critical services offline.

  • unknown - Node or its HA partner cannot be contacted and there is no information on the node's state.

statistics

statistics

Raw CPU performance for the nodes.

storage_configuration

string

The storage configuration in the system. Possible values:

  • mixed_path

  • single_path

  • multi_path

  • tri_path

  • quad_path

  • mixed_path_ha

  • single_path_ha

  • multi_path_ha

  • tri_path_ha

  • quad_path_ha

  • unknown

  • virtual

system_aggregate

system_aggregate

Aggregate

system_id

string

system_machine_type

string

OEM system machine type.

uptime

integer

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

uuid

string

vendor_serial_number

string

OEM vendor serial number.

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.

vm

vm

peering_policy

Name Type Description

authentication_required

boolean

Indicates whether authentication is required in the communication between cluster peers. If true, authentication is required to establish communication between cluster peers.

encryption_required

boolean

Indicates whether encryption is required in the communication between cluster peers. If true, encryption is required to establish communication between cluster peers.

minimum_passphrase_length

integer

Minimum required length for a passphrase. For more information on password strength best practices, see: https://cheatsheetseries.owasp.org/cheatsheets/Authentication_Cheat_Sheet.html#implement-proper-password-strength-controls

iops_raw

The number of I/O operations observed at the storage object. This can be used along with delta time to calculate the rate of I/O operations per unit of time.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

latency_raw

The raw latency in microseconds observed at the storage object. This can be divided by the raw IOPS value to calculate the average latency per I/O operation.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

throughput_raw

Throughput bytes observed at the storage object. This can be used along with delta time to calculate the rate of throughput bytes per unit of time.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

statistics

These are raw performance numbers, such as IOPS latency and throughput. These numbers are aggregated across all nodes in the cluster and increase with the uptime of the cluster.

Name Type Description

iops_raw

iops_raw

The number of I/O operations observed at the storage object. This can be used along with delta time to calculate the rate of I/O operations per unit of time.

latency_raw

latency_raw

The raw latency in microseconds observed at the storage object. This can be divided by the raw IOPS value to calculate the average latency per I/O operation.

status

string

Errors associated with the sample. For example, if the aggregation of data over multiple nodes fails, then any partial errors might return "ok" on success or "error" on an internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_ delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput_raw

throughput_raw

Throughput bytes observed at the storage object. This can be used along with delta time to calculate the rate of throughput bytes per unit of time.

timestamp

string

The timestamp of the performance data.

timezone

Provides the cluster-wide time zone information that localizes time found on messages displayed on each node's:

  • console messages;

  • logging to internal ONTAP log files; and

  • localized REST API full ISO-8601 date, time, and time zone format information. Machine-to-machine interfaces, such as file access protocols (NFS, CIFS), block access protocols (SAN), and other protocols such as Manage ONTAP (ONTAPI), use second or subsecond time values that are based on world time or UTC.

Name Type Description

name

string

The ONTAP time zone name or identification in either IANA time zone format "Area/Location", or an ONTAP traditional time zone.

The initial first node in cluster setting for time zone is "Etc/UTC". "Etc/UTC" is the IANA timezone "Area/Location" specifier for Coordinated Universal Time (UTC), which is an offset of 0.

IANA time zone format

The IANA time zone, formatted as "Area/Location", is based on geographic areas that have had the same time zone offset for many years.

"Location" represents a compound name using additional forward slashes.

An example of the "Area/Location" time zone is "America/New_York" and represents most of the United States Eastern Time Zone. Examples of "Area/Location" with "Location" as a compound name are "America/Argentina/Buenos_Aires" and "America/Indiana/Indianapolis".

ONTAP traditional time zone

Examples of the traditional time zones are "EST5EDT" for the United States Eastern Time Zone and "CET" for Central European Time Zone.

  • example: America/New_York

  • Introduced in: 9.7

  • x-nullable: true

cluster

Complete cluster information

Name Type Description

_links

_links

_tags

array[string]

Tags are an optional way to track the uses of a resource. Tag values must be formatted as key:value strings.

auto_enable_activity_tracking

boolean

Indicates how new SVMs will default "auto_enable_activity_tracking" for new volumes.

auto_enable_analytics

boolean

Indicates how new SVMs will default "auto_enable_analytics" for new volumes.

certificate

certificate

Support for this field will be removed in a future release. Please use /api/cluster/web for this field. Certificate used by cluster and node management interfaces for TLS connection requests.

configuration_backup

configuration_backup

contact

string

dns_domains

array[string]

A list of DNS domains. Domain names have the following requirements:

  • The name must contain only the following characters: A through Z, a through z, 0 through 9, ".", "-" or "_".

  • The first character of each label, delimited by ".", must be one of the following characters: A through Z or a through z or 0 through 9.

  • The last character of each label, delimited by ".", must be one of the following characters: A through Z, a through z, or 0 through 9.

  • The top level domain must contain only the following characters: A through Z, a through z.

  • The system reserves the following names:"all", "local", and "localhost".

large_volume_supported

boolean

Specifies whether or not this cluster supports large size limits for volume(300TB), File/LUN(128TB).

license

license

License keys or NLF contents.

location

string

management_interface

management_interface

The management interface of the cluster. The subnet mask and gateway for this interface are used for the node management interfaces provided in the node configuration.

management_interfaces

array[management_interfaces]

metric

metric

Performance numbers, such as IOPS latency and throughput.

name

string

name_servers

array[string]

The list of IP addresses of the DNS servers. Addresses can be either IPv4 or IPv6 addresses.

nodes

array[nodes]

ntp_servers

array[string]

Host name, IPv4 address, or IPv6 address for the external NTP time servers.

password

string

Initial admin password used to create the cluster.

peering_policy

peering_policy

san_optimized

boolean

Specifies if this cluster is an All SAN Array.

statistics

statistics

These are raw performance numbers, such as IOPS latency and throughput. These numbers are aggregated across all nodes in the cluster and increase with the uptime of the cluster.

timezone

timezone

Provides the cluster-wide time zone information that localizes time found on messages displayed on each node's:

  • console messages;

  • logging to internal ONTAP log files; and

  • localized REST API full ISO-8601 date, time, and time zone format information. Machine-to-machine interfaces, such as file access protocols (NFS, CIFS), block access protocols (SAN), and other protocols such as Manage ONTAP (ONTAPI), use second or subsecond time values that are based on world time or UTC.

  • Introduced in: 9.7

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.
Name Type Description

_links

_links

uuid

string

The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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