SolidFire and Element Software Documentation 12.5
Release notes
What's new
Concepts
Product overview
Architecture and components
SolidFire software interfaces
SolidFire Active IQ
Management node for Element software
Management services for SolidFire all-flash storage
Nodes
Clusters
Security
Accounts and permissions
Storage
Volumes
Virtual volumes (vVols)
Volume access groups
Initiators
Data protection
Performance and quality of service
Requirements
Networking requirements
Switch configuration for clusters running Element software
Network port requirements
Try it out
Try storage features using Element Demo Node
Install and maintain hardware
H410S and H610S hardware information
Install H410S and H610S nodes
Replace a H410S node
Replace a H610S node
Replace drives
Replace a power supply unit
SF-series hardware information
Replace a chassis
Replace drives
Replace a power supply unit
Return to Factory Image information
Configure the Return to Factory Image
RTFI deployment and installation options
The RTFI process
RTFI options menu
Supported firmware versions for storage nodes
Set up storage
Set up a cluster with storage nodes
Configure a storage node
Create a storage cluster
Log in to the Element software user interface
Add drives to the cluster
Set up a cluster with Fibre Channel nodes
Configure a Fibre Channel node
Create a new cluster with Fibre Channel nodes
Add Fibre Channel nodes to a cluster
Set up zones for Fibre Channel nodes
Create a volume access group for Fibre Channel clients
Determine which SolidFire components to install
Set up a management node
Configure Fully Qualified Domain Name web UI access
What's next?
Manage storage with Element software
Access the Element software user interface
Configure SolidFire system options after deployment
Change credentials in NetApp HCI and NetApp SolidFire
Change the Element software default SSL certificate
Change the IPMI password for nodes
Use basic options in the Element software UI
View API activity
Interface refresh rate impacted by cluster load
Icons in the Element interface
Provide feedback
Manage accounts
Work with accounts using CHAP
Manage cluster administrator user accounts
Manage LDAP
Manage your system
Enable multi-factor authentication
Set up multi-factor authentication
Additional information for Multi-factor authentication
Configure cluster settings
Enable and disable encryption for a cluster
Set the cluster full threshold
Enable and disable support access
Manage the Terms of Use banner
Set the Network Time Protocol
Configure Network Time Protocol servers for the cluster to query
Configure the cluster to listen for NTP broadcasts
Manage SNMP
SNMP details
Configure an SNMP requestor
Configure an SNMP USM user
Configure SNMP traps
View managed object data using management information base files
Manage drives
Drives details
Manage nodes
Add a node to a cluster
Node versioning and compatibility
Cluster capacity in a mixed node environment
View individual node details
View Fibre Channel ports details
Manage virtual networks
Add a virtual network
Enable virtual routing and forwarding
Edit a virtual network
Edit VRF VLANs
Delete a virtual network
Create a cluster supporting FIPS drives
Avoid mixing nodes for FIPS drives
Enable encryption at rest
Identify whether nodes are ready for the FIPS drives feature
Enable the FIPS drives feature
Check the FIPS drive status
Troubleshoot the FIPS drive feature
Enable FIPS 140-2 for HTTPS on your cluster
SSL ciphers
Get started with external key management
Set up external key management
Rekey software encryption at rest master key
Recover inaccessible or invalid authentication keys
External key management API Commands
Manage volumes and virtual volumes
Work with volumes
Manage Quality of Service policies
Manage volumes
Assign LUNs to Fibre Channel volumes
Apply a QoS policy to volumes
Remove the QoS policy association of a volume
Work with virtual volumes
Enable virtual volumes
View virtual volume details
Delete a virtual volume
Manage storage containers
Protocol endpoints
Protocol endpoints details
Bindings
Bindings details
Host details
Work with volume access groups and initiators
Create a volume access group
View individual access group details
Add volumes to an access group
Remove volumes from an access group
Create an initiator
Edit an initiator
Add a single initiator to a volume access group
Add multiple initiators to a volume access group
Remove initiators from an access group
Delete an access group
Delete an initiator
Protect your data
Use volume snapshots for data protection
Use individual volume snapshots for data protection
Create a volume snapshot
Edit snapshot retention
Delete a snapshot
Clone a volume from a snapshot
Roll back a volume to a snapshot
Back up a volume snapshot
Back up a volume snapshot to an Amazon S3 object store
Back up a volume snapshot to an OpenStack Swift object store
Back up a volume snapshot to a SolidFire cluster
Use group snapshots for data protection
Group snapshot details
Create a group snapshot
Edit group snapshots
Delete a group snapshot
Rol back volumes to a group snapshot
Edit members of group snapshot
Clone multiple volumes
Clone multiple volumes from a group snapshot
Schedule a snapshot
Snapshot schedule details
Create a snapshot schedule
Edit a snapshot schedule
Copy a snapshot schedule
Delete a snapshot schedule
Perform remote replication between clusters running NetApp Element software
Plan cluster and volume pairing for real-time replication
Pair clusters for replication
Pair clusters using MVIP or a pairing key
Pair clusters using MVIP
Pair clusters using a pairing key
Validate the cluster pair connection
Pair volumes
Create a target volume with read or write access
Pair volumes using a volume ID or pairing key
Pair volumes using a volume ID
Pair volumes using a pairing key
Assign a replication source and target to paired volumes
Validate volume replication
Delete a volume relationship after replication
Manage volume relationships
Pause replication
Change the mode of replication
Delete volume pairs
Delete a cluster pair
Cluster pair details
Volume pair details
Volume pairing messages
Volume pairing warnings
Use SnapMirror replication between Element and ONTAP clusters
SnapMirror overview
Enable SnapMirror on the cluster
Enable SnapMirror on the volume
Create a SnapMirror endpoint
Create a SnapMirror relationship
SnapMirror relationship actions
SnapMirror labels
Add SnapMirror labels to snapshots
Add SnapMirror labels to snapshot schedules
Disaster recovery using SnapMirror
Perform a failover from an Element cluster
Perform a failback to Element
SnapMirror failback scenarios
Perform a failback when source volume still exists
Perform a failback when source volume no longer exists
Perform a transfer or one-time migration from ONTAP to Element
Back up and restore volumes
Back up a volume to an Amazon S3 object store
Back up a volume to an OpenStack Swift object store
Back up a volume to a SolidFire storage cluster
Restore a volume from backup on an Amazon S3 object store
Restore a volume from backup on an OpenStack Swift object store
Restore a volume from backup on a SolidFire storage cluster
Configure custom protection domains
Replication between NetApp Element software and ONTAP
Overview
Workflow
Enable SnapMirror in Element software
Enable SnapMirror on the Element cluster
Enable SnapMirror on the Element source volume
Create a SnapMirror endpoint
Configure a replication relationship
Create a replication job schedule
Customize a replication policy
Create a custom replication policy
Define a rule for a policy
Create a replication relationship
Create a relationship from an Element source to an ONTAP destination
Create a relationship from an ONTAP source to an Element destination
Initialize a replication relationship
Serve data from a SnapMirror DR destination volume
Make the destination volume writeable
Configure the destination volume for data access
Reactivate the original source volume
Update a replication relationship manually
Resynchronize a replication relationship
Troubleshoot your system
View information about system events
Event types
View status of running tasks
View system alerts
Cluster fault codes
View node performance activity
View volume performance
Volume performance details
View iSCSI sessions
iSCSI session details
View Fibre Channel sessions
Fibre Channel session details
Troubleshoot drives
Remove failed drives from the cluster
Basic MDSS drive troubleshooting
Add MDSS drives
Remove MDSS drives
Troubleshoot nodes
Power down a cluster
Work with per-node utilities for storage nodes
Access per-node settings using the per-node UI
Network settings details from the per-node UI
Cluster settings details from the per-node UI
Run system tests using the per-node UI
Run system utilities using the per-node UI
Work with the management node
Understand cluster fullness levels
Manage and monitor storage with NetApp Hybrid Cloud Control
Add and manage storage clusters using NetApp Hybrid Cloud Control
Configure Fully Qualified Domain Name web UI access
Create and manage user accounts by using NetApp Hybrid Cloud Control
Create and manage volumes by using NetApp Hybrid Cloud Control
Create and manage volume access groups
Create and manage initiators
Create and manage volume QoS policies
Monitor your SolidFire system with NetApp Hybrid Cloud Control
Monitor storage resources on the Hybrid Cloud Control Dashboard
View your inventory on the Nodes page of NetApp Hybrid Cloud Control
Monitor volumes on your storage cluster with NetApp Hybrid Cloud Control
Collect logs for troubleshooting
Manage storage with Element API
About the Element software API
Request object members
Response object members
Request endpoints
API authentication
Asynchronous methods
Attributes
Common objects
account
authSessionInfo
bulkVolumeJob
binding (virtual volumes)
certificateDetails
cluster
clusterAdmin
clusterCapacity
clusterConfig
clusterInfo
clusterPair
clusterStats
clusterStructure
drive
driveStats
error
event
fault
fibreChannelPort
fipsErrorNodeReport
fipsNodeReport
fipsReport
groupSnapshot
hardwareInfo
host (virtual volumes)
idpConfigInfo
initiator
ISCSIAuthentication
keyProviderKmip
keyServerKmip
ldapConfiguration
loggingServer
network (bonded interfaces)
network (all interfaces)
network (Ethernet interfaces)
network (local interfaces)
network (SNMP)
networkInterface
networkInterfaceStats
node
nodeProtectionDomains
nodeStats
ontapVersionInfo
pendingActiveNode
pendingNode
protectionDomain
protectionDomainLevel
protectionDomainResiliency
protectionDomainTolerance
protectionSchemeResiliency
protectionSchemeTolerance
protocolEndpoint
QoS
QoSPolicy
remoteClusterSnapshotStatus
schedule
session (Fibre Channel)
session (iSCSI)
snapMirrorAggregate
snapMirrorClusterIdentity
snapMirrorEndpoint
snapMirrorJobScheduleCronInfo
snapMirrorLunInfo
snapMirrorNetworkInterface
snapMirrorNode
snapMirrorPolicy
snapMirrorPolicyRule
snapMirrorRelationship
snapMirrorVolume
snapMirrorVolumeInfo
snapMirrorVserver
snapMirrorVserverAggregateInfo
snapshot
snmpTrapRecipient
storageContainer
syncJob
task (virtual volumes)
usmUser
virtualNetwork
virtualVolume
volume
volumeAccessGroup
volumePair
volumeStats
Common methods
GetAPI
GetAsyncResult
GetCompleteStats
GetLimits
GetOrigin
GetRawStats
ListAsyncResults
Account API methods
AddAccount
GetAccountByID
GetAccountByName
GetAccountEfficiency
ListAccounts
ModifyAccount
RemoveAccount
Administrator API methods
AddClusterAdmin
GetCurrentClusterAdmin
GetLoginBanner
ListClusterAdmins
ModifyClusterAdmin
RemoveClusterAdmin
SetLoginBanner
Cluster API methods
AddNodes
ClearClusterFaults
CreateClusterInterfacePreference
DeleteClusterInterfacePreference
EnableFeature
GetClusterCapacity
GetClusterFullThreshold
GetClusterHardwareInfo
GetClusterInfo
GetClusterInterfacePreference
GetClusterMasterNodeID
GetClusterStats
GetClusterVersionInfo
GetFeatureStatus
GetLoginSessionInfo
GetNodeHardwareInfo
GetNodeStats
ListActiveNodes
ListAllNodes
ListClusterFaults
ListClusterInterfacePreferences
ListEvents
ListNodeStats
ListISCSISessions
ListServices
ListPendingNodes
ListPendingActiveNodes
ModifyClusterFullThreshold
ModifyClusterInterfacePreference
RemoveNodes
SetLoginSessionInfo
Shutdown
Cluster creation API Methods
CheckProposedCluster
CreateCluster
GetBootstrapConfig
Drive API methods
AddDrives
GetDriveHardwareInfo
GetDriveStats
ListDrives
ListDriveStats
RemoveDrives
SecureEraseDrives
Fibre Channel API methods
GetVolumeAccessGroupLunAssignments
ListFibreChannelPortInfo
ListFibreChannelSessions
ListNodeFibreChannelPortInfo
ModifyVolumeAccessGroupLunAssignments
Initiator API methods
CreateInitiators
DeleteInitiators
ListInitiators
ModifyInitiators
LDAP API methods
AddLdapClusterAdmin
EnableLdapAuthentication
DisableLdapAuthentication
GetLdapConfiguration
TestLdapAuthentication
Multi-factor authentication API methods
AddIdpClusterAdmin
CreateIdpConfiguration
DeleteAuthSession
DeleteAuthSessionsByClusterAdmin
DeleteAuthSessionsByUsername
DeleteIdpConfiguration
DisableIdpAuthentication
EnableIdpAuthentication
GetIdpAuthenticationState
ListActiveAuthSessions
ListIdpConfigurations
UpdateIdpConfiguration
Session authentication API methods
ListAuthSessionsByClusterAdmin
ListAuthSessionsByUsername
Node API methods
CheckPingOnVlan
CheckProposedNodeAdditions
CreateClusterSupportBundle
CreateSupportBundle
DeleteAllSupportBundles
DisableMaintenanceMode
DisableSsh
EnableMaintenanceMode
EnableSsh
GetClusterConfig
GetClusterState
GetConfig
GetDriveConfig
GetHardwareConfig
GetHardwareInfo
GetIpmiConfig
GetIpmiInfo
GetNetworkConfig
GetNetworkInterface
GetNodeActiveTlsCiphers
GetNodeFipsDrivesReport
GetNodeSSLCertificate
GetNodeSupportedTlsCiphers
GetPatchInfo
GetPendingOperation
GetSshInfo
ListDriveHardware
ListNetworkInterfaces
ListNetworkInterfaceStats
ListTests
ListUtilities
RemoveNodeSSLCertificate
ResetDrives
ResetNode
ResetNodeSupplementalTlsCiphers
RestartNetworking
RestartServices
SetClusterConfig
SetConfig
SetNetworkConfig
SetNodeSSLCertificate
SetNodeSupplementalTlsCiphers
Shutdown
TestConnectEnsemble
TestConnectMvip
TestConnectSvip
TestDrives
TestHardwareConfig
TestLocateCluster
TestLocalConnectivity
TestNetworkConfig
TestPing
TestRemoteConnectivity
Replication API methods
Cluster pairing order of operations
Volume pairing order of operations
Supported modes of replication for paired clusters
CompleteClusterPairing
CompleteVolumePairing
ListClusterPairs
ListActivePairedVolumes
ModifyVolumePair
RemoveClusterPair
RemoveVolumePair
StartClusterPairing
StartVolumePairing
Security API methods
AddKeyServerToProviderKmip
CreateKeyProviderKmip
CreateKeyServerKmip
CreatePublicPrivateKeyPair
DeleteKeyProviderKmip
DeleteKeyServerKmip
DisableEncryptionAtRest
EnableEncryptionAtRest
GetClientCertificateSignRequest
GetKeyProviderKmip
GetKeyServerKmip
GetSoftwareEncryptionatRestInfo
ListKeyProvidersKmip
ListKeyServersKmip
ModifyKeyServerKmip
RekeySoftwareEncryptionAtRestMasterKey
RemoveKeyServerFromProviderKmip
SignSshKeys
TestKeyProviderKmip
TestKeyServerKmip
SnapMirror API methods
AbortSnapMirrorRelationship
BreakSnapMirrorRelationship
BreakSnapMirrorVolume
CreateSnapMirrorEndpoint
CreateSnapMirrorEndpointUnmanaged
CreateSnapMirrorRelationship
CreateSnapMirrorVolume
DeleteSnapMirrorEndpoints
DeleteSnapMirrorRelationships
GetOntapVersionInfo
GetSnapMirrorClusterIdentity
InitializeSnapMirrorRelationship
ListSnapMirrorAggregates
ListSnapMirrorEndpoints
ListSnapMirrorLuns
ListSnapMirrorNetworkInterfaces
ListSnapMirrorNodes
ListSnapMirrorPolicies
ListSnapMirrorSchedules
ListSnapMirrorRelationships
ListSnapMirrorVolumes
ListSnapMirrorVservers
ModifySnapMirrorEndpoint
ModifySnapMirrorEndpoint (unmanaged)
ModifySnapMirrorRelationship
UpdateSnapMirrorRelationship
QuiesceSnapMirrorRelationship
ResumeSnapMirrorRelationship
ResyncSnapMirrorRelationship
System configuration API methods
DisableBmcColdReset
DisableClusterSsh
DisableSnmp
EnableBmcColdReset
EnableClusterSsh
EnableSnmp
GetBinAssignmentProperties
GetClusterSshInfo
GetClusterStructure
GetFipsReport
GetLldpConfig
GetLldpInfo
GetNodeFipsDrivesReport
GetNtpInfo
GetNvramInfo
GetProtectionDomainLayout
GetRemoteLoggingHosts
GetSnmpACL
GetSnmpInfo
GetSnmpState
GetSnmpTrapInfo
GetSSLCertificate
ListProtectionDomainLevels
RemoveSSLCertificate
ResetNetworkConfig
ResetSupplementalTlsCiphers
SetClusterStructure
SetLldpConfig
SetNtpInfo
SetProtectionDomainLayout
SetRemoteLoggingHosts
SetSnmpACL
SetSnmpInfo
SetSnmpTrapInfo
SetSSLCertificate
SnmpSendTestTraps
TestAddressAvailability
Multitenant networking API methods
Virtual network naming conventions
AddVirtualNetwork
ModifyVirtualNetwork
ListVirtualNetworks
RemoveVirtualNetwork
Volume API methods
CancelClone
CancelGroupClone
CloneMultipleVolumes
CloneVolume
CopyVolume
CreateQoSPolicy
CreateVolume
CreateBackupTarget
DeleteQoSPolicy
DeleteVolume
DeleteVolumes
GetBackupTarget
GetVolumeStats
GetDefaultQoS
GetQoSPolicy
GetVolumeCount
GetVolumeEfficiency
ListActiveVolumes
ListBackupTargets
ListBulkVolumeJobs
ListDeletedVolumes
ListQoSPolicies
ListSyncJobs
ListVolumeQoSHistograms
ListVolumes
ListVolumeStats
ListVolumesForAccount
ListVolumeStatsByAccount
ListVolumeStatsByVirtualVolume
ListVolumeStatsByVolume
ListVolumeStatsByVolumeAccessGroup
ModifyBackupTarget
ModifyQoSPolicy
ModifyVolume
ModifyVolumes
PurgeDeletedVolume
PurgeDeletedVolumes
RemoveBackupTarget
RestoreDeletedVolume
SetDefaultQoS
StartBulkVolumeRead
StartBulkVolumeWrite
UpdateBulkVolumeStatus
Volume access group API methods
AddInitiatorsToVolumeAccessGroup
AddVolumesToVolumeAccessGroup
CreateVolumeAccessGroup
DeleteVolumeAccessGroup
ListVolumeAccessGroups
RemoveVolumesFromVolumeAccessGroup
RemoveInitiatorsFromVolumeAccessGroup
ModifyVolumeAccessGroup
GetVolumeAccessGroupEfficiency
Volume snapshot API methods
Snapshots overview
CreateGroupSnapshot
CreateSchedule
CreateSnapshot
DeleteGroupSnapshot
DeleteSnapshot
GetSchedule
ListGroupSnapshots
ListSchedules
ListSnapshots
ModifyGroupSnapshot
ModifySchedule
ModifySnapshot
RollbackToGroupSnapshot
RollbackToSnapshot
Virtual volume API methods
CreateStorageContainer
DeleteStorageContainers
GetStorageContainerEfficiency
GetVirtualVolumeCount
ListProtocolEndpoints
ListStorageContainers
ListVirtualVolumeBindings
ListVirtualVolumeHosts
ListVirtualVolumes
ListVirtualVolumeTasks
ModifyStorageContainer
Access control
Response examples
GetConfig
GetClusterHardwareInfo
GetLldpInfo
GetNetworkConfig
GetNodeHardwareInfo (output for iSCSI)
GetNodeHardwareInfo (output for Fibre Channel nodes)
GetNvramInfo
ListActiveNodes
ListActiveVolumes
TestHardwareConfig
Manage storage with the Element Plug-in for vCenter Server
Monitor storage with NetApp SolidFire Active IQ
Work with the management node
Management node overview
Install or recover a management node
Install a management node
Create a NetApp HCC role in vCenter
Configure a storage Network Interface Controller (NIC)
Recover a management node
Access the management node
Change the management node default SSL certificate
Work with the management node UI
Management node UI overview
Configure alert monitoring
Modify and test the management node network, cluster, and system settings
Run system utilities from the management node
Work with the management node REST API
Management node REST API UI overview
Get authorization to use REST APIs
Enable Active IQ and NetApp monitoring
Configure NetApp Hybrid Cloud Control for multiple vCenters
Add a controller asset to the management node
Create and manage storage cluster assets
View or edit existing controller assets
Configure a proxy server
Verify management node OS and services versions
Getting logs from management services
Manage support connections
Accessing storage nodes using SSH for basic troubleshooting
Start a remote NetApp Support session
Manage SSH functionality on the management node
Upgrade your NetApp SolidFire all-flash storage system
Upgrade sequence overview
System upgrade procedures
Update management services
Run Element storage health checks prior to upgrading storage
Upgrade Element software
Upgrade storage firmware
Upgrade a management node
Upgrade the Element Plug-in for vCenter Server
Upgrade your vSphere components for a NetApp SolidFire storage system with the Element Plug-in for vCenter Server
Earlier versions
Legal notices