Setup ONTAP
ONTAP 9
Published: February 15, 2022
Source: docs.netapp.com
Decide whether to use System Manager or the ONTAP CLI for cluster setup
NetApp recommends using System Manager for cluster setup whenever possible to simplify the process. These procedures are for versions of System Manager that do not support initial cluster setup for your planned ONTAP deployment.
System Manager Support Requirements:
- Cluster setup is supported only for single nodes and HA pairs.
- When setting up node management manually via CLI, System Manager supports only IPv4 and not IPv6. However, if System Manager is launched after hardware setup using DHCP with an auto-assigned IP and Windows discovery, it can configure an IPv6 management address.
- In ONTAP 9.6 and earlier, System Manager does not support deployments requiring IPv6 networking.
- MetroCluster setup support is for MetroCluster IP configurations with two nodes at each site.
- In ONTAP 9.7 and earlier, System Manager does not support new cluster setup for MetroCluster configurations.
For FlexArray configurations on non-NetApp disks, the ONTAP CLI is required to configure root volumes on array LUNs, followed by the Cluster Setup wizard. Refer to the FlexArray Virtualization installation and requirements documentation for more information.
Before proceeding, ensure your new storage system is installed, cabled, and powered on according to your platform model's installation and setup instructions. Consult the AFF and FAS documentation.
Configure ONTAP on a new cluster
System Manager offers a straightforward workflow for setting up a new cluster and configuring storage.
In certain scenarios, such as specific MetroCluster deployments or clusters requiring IPv6 network addressing, the ONTAP CLI may be necessary for setup. Refer to additional details and steps for ONTAP CLI cluster setup.
Regardless of the method chosen (System Manager or CLI), the system must be installed and cabled according to the provided Installation and Setup Instructions. Cluster network interfaces on each node must also be configured for intra-cluster communication.
Assign a node-management IP address
Windows System:
Connect your Windows computer to the same subnet as the controllers. This assigns a node-management IP address.
- From your Windows system, open the Network drive to discover the nodes.
- Double-click the node to launch the cluster setup wizard.
Other systems:
Configure the node-management IP address for one node in your cluster. This IP address is used to launch the cluster setup wizard. Refer to "Creating the cluster on the first node" for details on assigning a node-management IP address.
Initialize the cluster
Initialize the cluster by setting an administrative password and configuring the cluster management and node management networks. DNS server for host name resolution and an NTP server for time synchronization can also be configured.
- Open a web browser and enter the configured node-management IP address:
https://node-management-IP
System Manager automatically discovers the remaining nodes. Initialize the storage system by configuring the cluster management network and node management IP addresses for all nodes.
Create your local tier
Create local tiers using available disks or SSDs. System Manager automatically calculates the optimal tier configuration based on your hardware.
- Click Dashboard and then click Prepare Storage.
- Accept the storage recommendation for your local tier.
Configure protocols
Enable desired protocols based on cluster licenses and create network interfaces for storage access.
- Click Dashboard and then click Configure Protocols.
- Enable iSCSI or FC for SAN access.
- Enable NFS or SMB for NAS access.
- Enable NVMe for FC-NVMe access.
Provision Storage
Provision storage based on installed licenses.
- Click Dashboard and then click Provision Storage.
- To provision SAN access, click Add LUNs.
- To provision NAS access, click Add Volumes.
- To provision NVMe storage, click Add Namespaces.
Configure ONTAP on a new cluster (Visual)
A visual element is presented showing "Configure ONTAP on a New Cluster" with "NetApp ONTAP 9 System Manager" branding, accompanied by the NetApp logo.
Set up the cluster with the ONTAP CLI
Setting up the cluster involves gathering information for configuration, creating the cluster on the first node, and joining remaining nodes.
Gather all relevant information using the cluster setup worksheets.
Cluster setup worksheets
These worksheets help record necessary values during setup. Default values can be used or overridden.
System defaults
System defaults are provided for the private cluster network. Using these is recommended unless specific requirements necessitate custom values. For clusters using network switches, ensure each switch uses a 9000 MTU size.
| Types of information | Your values |
|---|---|
| Private cluster network ports | |
| Cluster network netmask | |
| Cluster interface IP addresses (for each cluster network port on each node) | The IP addresses for each node must be on the same subnet. |
Cluster information
| Types of information | Your values |
|---|---|
| Cluster name | The name must begin with a letter and be fewer than 44 characters. It can include the following special characters: . - _ |
Feature license keys
License keys can be found on the NetApp Support Site under My Support > Software Licenses.
| Types of information | Your values |
|---|---|
| Feature license keys |
Admin storage virtual machine (SVM)
| Types of information | Your values |
|---|---|
| Cluster administrator password | The password for the admin account required for cluster administrator access. For security, recording passwords here is not recommended. Default rules: at least eight characters, including one letter and one number. |
| Cluster management interface port | The physical port connected to the data network for cluster administrator management. |
| Cluster management interface IP address | A unique IPv4 or IPv6 address for the cluster management interface, typically on the data network. Obtain from your organization's IP administrator. Example: 192.0.2.66 |
| Cluster management interface netmask (IPv4) | The subnet mask defining the range of valid IPv4 addresses on the cluster management network. Example: 255.255.255.0 |
| Cluster management interface netmask length (IPv6) | If using IPv6, this represents the prefix length defining the range of valid IPv6 addresses. Example: 64 |
| Cluster management interface default gateway | The IP address for the router on the cluster management network. |
| DNS domain name | Your network's DNS domain name. Must consist of alphanumeric characters. Separate multiple names with a comma or space. |
| Name server IP addresses | IP addresses of DNS name servers. Separate each address with a comma or space. |
Node information (for each node in the cluster)
| Types of information | Your values |
|---|---|
| Physical location of the controller (optional) | Description identifying the node's location (e.g., “Lab 5, Row 7, Rack B"). |
| Node management interface port | The physical port connected to the node management network for node administration. |
| Node management interface IP address | A unique IPv4 or IPv6 address for the node management interface on the management network. If the port is a data port, the IP should be on the data network. Obtain from your organization's IP administrator. Example: 192.0.2.66 |
| Node management interface netmask (IPv4) | The subnet mask defining the range of valid IP addresses on the node management network. If the port is a data port, the netmask should be for the data network. Example: 255.255.255.0 |
| Node management interface netmask length (IPv6) | If using IPv6, this represents the prefix length defining the range of valid IPv6 addresses on the node management network. Example: 64 |
| Node management interface default gateway | The IP address for the router on the node management network. |
NTP server information
| Types of information | Your values |
|---|---|
| NTP server addresses | IP addresses of Network Time Protocol (NTP) servers used to synchronize time across the cluster. |
Create the cluster on the first node
The Cluster Setup wizard guides you through creating the cluster on the first node, configuring the cluster network, creating the admin SVM, adding license keys, and setting up the node management interface.
- Power on all nodes to be added to the cluster to enable discovery.
- Connect to the console of the first node. The node boots, and the Cluster Setup wizard starts.
- Acknowledge the AutoSupport statement by typing
yes.AutoSupport is enabled by default. - Follow on-screen instructions to assign an IP address to the node.
- For GUI setup, follow browser instructions. For CLI setup, press Enter.
- Create a new cluster: type
create. - Accept system defaults or enter your own values.
- After setup, log in and verify cluster activity and node health using the ONTAP CLI command:
cluster show.
GUI setup: Access via browser at https://10.63.11.29
CLI setup: Press Enter. You will be prompted: "Do you want to create a new cluster or join an existing cluster? {create, join}:"
Example output:
cluster1::> cluster show
Node Health Eligibility
--------------------- ------- ------------
cluster1-01 true true
You can modify SVM values using the cluster setup command.
Join remaining nodes to the cluster
After creating a new cluster, use the Cluster Setup wizard to join each remaining node individually. The wizard configures each node's management interface.
Joining two nodes creates an HA pair. Joining four nodes creates two HA pairs. Refer to "Learn about HA" for more information.
Only one node can be joined at a time. The join operation must be completed for a node before starting the next.
Best Practice: For FAS2720 with 24 or fewer NL-SAS drives, verify storage configuration defaults to active/passive for optimal performance. See "Setting up an active-passive configuration on nodes using root-data partitioning" for details.
- Log in to the node to be joined. The Cluster Setup wizard starts on the console.
- Acknowledge the AutoSupport statement by typing
yes.AutoSupport is enabled by default. - Follow on-screen instructions to assign an IP address to the node.
- Join the node to the cluster: type
join. - Follow on-screen instructions to set up and join the node.
- Verify node health and eligibility with
cluster show.
Example output after joining the second node:
cluster1::> cluster show
Node Health Eligibility
--------------------- ------- ------------
cluster1-01 true true
cluster1-02 true true
Repeat this task for each remaining node.
Check your cluster with Active IQ Config Advisor
After joining all nodes, run Active IQ Config Advisor to validate your configuration and identify common errors.
Config Advisor is a web-based application installable on laptops, virtual machines, or servers, compatible with Windows, Linux, and Mac platforms. It runs commands to validate installation and check overall health, including cluster and storage switches.
- Download and install Active IQ Config Advisor.
- Launch Active IQ and set up a passphrase.
- Review settings and click Save.
- On the Objectives page, click ONTAP Post-Deployment Validation.
- Choose either Guided or Expert mode. Guided mode automatically discovers connected switches.
- Enter cluster credentials.
- (Optional) Click Form Validate.
- To collect data, click Save & Evaluate.
- After data collection, navigate to Job Monitor > Actions, view data via the Data View icon, and results via the Results icon.
- Resolve issues identified by Config Advisor.
Synchronize the system time across the cluster
Synchronizing time ensures all nodes have the same time, preventing CIFS and Kerberos failures. A Network Time Protocol (NTP) server should be set up at your site. Symmetric authentication is available starting with ONTAP 9.5.
For more information, see "Managing the cluster time (cluster administrators only)".
Synchronize time by associating the cluster with one or more NTP servers.
- Verify system time and time zone are correct for each node. All nodes should share the same time zone.
- Use the
cluster date showcommand to display current date, time, and time zone for each node. - Use the
cluster date modify -timezone GMTcommand to change the time zone for all nodes (example shown for GMT). - Associate the cluster with your NTP server using the
cluster time-service ntp server createcommand. - Without symmetric authentication:
cluster time-service ntp server create -server server_name - With symmetric authentication:
cluster time-service ntp server create -server server_ip_address -key-id key_id(Available from ONTAP 9.5; not in 9.4 or earlier). - Verify NTP server association:
cluster time-service ntp server show.
cluster1::> cluster date show
Node Date Time zone
----------------- ------------------- -----------------
cluster1-01 01/06/2015 09:35:15 America/New_York
cluster1-02 01/06/2015 09:35:15 America/New_York
cluster1-03 01/06/2015 09:35:15 America/New_York
cluster1-04 01/06/2015 09:35:15 America/New_York
4 entries were displayed.
If DNS is not configured, specify the NTP server IP address:
cluster1::> cluster time-service ntp server create -server ntp1.example.com
cluster1::> cluster time-service ntp server show
Server Version
-------------------- -----------
ntp1.example.com auto
Commands for managing symmetric authentication on NTP servers
Beginning with ONTAP 9.5, NTP version 3 (NTPv3) is supported, including symmetric authentication using SHA-1 keys for enhanced network security.
| To do this... | Use this command... |
|---|---|
| Configure an NTP server without symmetric authentication | cluster time-service ntp server create -server server_name |
| Configure an NTP server with symmetric authentication | cluster time-service ntp server create -server server_ip_address -key-id key_id |
| Enable symmetric authentication for an existing NTP server | cluster time-service ntp server modify -server server_name -key-id key_idAn existing NTP server can be modified to enable authentication by adding the required key-id. |
| Configure a shared NTP key | cluster time-service ntp key create -id shared_key_id -type shared_key_type -value shared_key_valueNote: Shared keys are referred to by an ID. The ID, its type, and value must be identical on both the node and the NTP server. |
| Configure an NTP server with an unknown key ID | cluster time-service ntp server create -server server_name -key-id key_id |
| Configure a server with a key ID not configured on the NTP server. | cluster time-service ntp server create -server server_name -key-id key_idNote: The key ID, type, and value must be identical to the key ID, type, and value configured on the NTP server. |
| Disable symmetric authentication | cluster time-service ntp server modify -server server_name -authentication disabled |
Additional system configuration tasks to complete
After setting up a cluster, use System Manager or the ONTAP CLI to continue configuration.
| System configuration task | Resource |
|---|---|
Configure networking:
|
Setting up the network |
| Set up the Service Processor | System administration |
| Lay out your aggregates | Disk and aggregate management |
| Create and configure data storage virtual machines (SVMs) | NFS configuration SMB configuration SAN administration |
| Configure event notifications | EMS configuration |
All SAN Array Software Configuration
Use the following procedures to configure an All SAN Array (ASA) using System Manager.
Supported ALL SAN Array configurations
NetApp All SAN Arrays (ASAs) are all-flash SAN-only solutions based on AFF NetApp platforms. ASA platforms support two-node switched or switchless clusters, configured for FC or iSCSI, and use symmetric active-active for multipathing. All paths are active/optimized, reducing I/O disruption during storage failover.
Related information
- NetApp Technical Report 4515: ONTAP AFF All SAN Array Systems
- NetApp Technical Report 4080: Best Practices for Scalable SAN ONTAP 9
Set up an ASA
All SAN Arrays (ASAs) follow the same setup procedure as non-ASA systems. System Manager guides you through initializing your cluster, creating a local tier, configuring protocols, and provisioning storage for your ASA. Refer to the steps for "Configure ONTAP".
ASA limitations and restrictions
Be aware of limitations for AFF All SAN Array (ASA) controllers prior to ONTAP 9.9.1.
ASAs do not support NVMe-oF protocol. With ONTAP 9.9.1, NVMe-oF protocol support is available.
Use tested and supported maximum configuration limits for AFF ASA controllers. For reliable operations, do not exceed current tested and supported limits listed in NetApp Hardware Universe.
Support for persistent ports
Beginning with ONTAP 9.8, persistent ports are enabled by default on ASAs configured for FC protocol. Persistent ports require zone membership identified by World Wide Port Name (WWPN).
Persistent ports reduce takeover impact by creating a shadow LIF on the HA partner's physical port. During a takeover, the shadow LIF assumes the original LIF's identity, including WWPN. This ensures the host sees the same number of paths, minimizing I/O disruption.
For persistent ports, the following FCP port characteristics should be identical within the HA pair:
- FCP port counts
- FCP port names
- FCP port speeds
- FCP LIF WWPN-based zoning
If these characteristics differ, the following EMS message is generated:
EMS : scsiblade.lif.persistent.ports.fcp.init.error
For more information on persistent ports, see NetApp Technical Report 4080: Best Practices for Scalable SAN ONTAP 9.
ASA host settings and utilities
Host settings for ASAs are the same as for other SAN hosts. Download NetApp Host Utilities software from the support site.
Ways to identify an ASA system
Identify an ASA system using System Manager or the ONTAP command line interface (CLI).
- From the System Manager dashboard, navigate to Cluster > Overview and select the system node. The PERSONALITY is displayed as All SAN Array.
- From the CLI, use the
san config showcommand. The "All SAN Array" value returns as true for ASA systems.
Copyright Information
Copyright © 2022 NetApp, Inc. All rights reserved. Printed in the U.S. No part of this document may be reproduced in any form or by any means-graphic, electronic, or mechanical, including photocopying, recording, taping, or storage in an electronic retrieval system-without prior written permission of the copyright owner.
Software derived from copyrighted NetApp material is subject to the following license and disclaimer:
THIS SOFTWARE IS PROVIDED BY NETAPP "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL NETAPP BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
NetApp reserves the right to change any products described herein at any time, and without notice. NetApp assumes no responsibility or liability arising from the use of products described herein, except as expressly agreed to in writing by NetApp. The use or purchase of this product does not convey a license under any patent rights, trademark rights, or any other intellectual property rights of NetApp.
The product described in this manual may be protected by one or more U.S. patents, foreign patents, or pending applications.
RESTRICTED RIGHTS LEGEND: Use, duplication, or disclosure by the government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.277-7103 (October 1988) and FAR 52-227-19 (June 1987).
Trademark Information
NETAPP, the NETAPP logo, and the marks listed at www.netapp.com/TM are trademarks of NetApp, Inc. Other company and product names may be trademarks of their respective owners.
