JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle® ZFS Storage Appliance Administration Guide
Oracle Technology Network
Print View
search filter icon
search icon

Document Information

Using This Documentation

Chapter 1 Oracle ZFS Storage Appliance Overview

Chapter 2 Status

Chapter 3 Initial Configuration

Chapter 4 Network Configuration

Chapter 5 Storage Configuration

Chapter 6 Storage Area Network Configuration

Chapter 7 User Configuration

Chapter 8 Setting ZFSSA Preferences

Chapter 9 Alert Configuration

Chapter 10 Cluster Configuration

Chapter 11 ZFSSA Services

Available Services

Data Services

Directory Services

Service Settings

Remote Access Services

Security Services

Minimum Needed Ports

Configuring Services Using the BUI

Viewing a Specific Service Screen

Viewing a Specific Service Screen

Enabling a Service

Disabling a Service

Defining Properties

Viewing Service Logs

Configuring Services Using the CLI

Selecting a Service

Viewing a Service's State

Enabling a Service

Disabling a Service

Setting Properties

Viewing Service Help



Kerberos Realms

Service Logs

NFS Analytics

NFS BUI and CLI Properties

Sharing a Filesystem over NFS

iSCSI Service

iSCSI Service Properties

iSCSI Service Authentication

iSCSI Service Authorization

iSCSI Service Targets and Initiators

iSCSI Troubleshooting

SMB Service

SMB Service Properties

SMB Share Properties

NFS/SMB Interoperability

SMB DFS Namespaces

SMB Microsoft Stand-alone DFS Namespace Management Tools Support Matrix

Example: Manipulating DFS Namespaces

SMB Autohome Service

Adding SMB Autohome Rules

SMB Local Groups

Adding a User to an SMB Local Group

SMB Local Accounts

SMB MMC Integration

SMB Event Viewer

SMB Share Management

SMB Users, Groups, and Connections

Listing SMB Services

Configuring SMB Using the BUI

Initial Configuration

Active Directory Configuration

Project and Share Configuration

SMB Data Service Configuration

FTP Service

FTP Properties

FTP General Settings

FTP Security Settings

FTP Logs

Configuring FTP Using the BUI

Allowing FTP Access to a share

HTTP Service

HTTP Properties

HTTP Authentication and Access Control


Configuring HTTP

Allowing HTTP access to a share

NDMP Service

NDMP Local vs. Remote Configurations

NDMP Backup Formats and Types

NDMP Back up with

NDMP Back up with

NDMP Incremental backups

NDMP Properties


Remote Replication

Shadow Migration

Shadow Migration Properties

SFTP Service

SFTP Properties



Configuring SFTP

Allowing SFTP access to a share

Configuring SFTP Services for Remote Access

SRP Service

TFTP Service

TFTP Properties

Configuring TFTP

Allowing TFTP access to a share

Virus Scan Service

Virus Scan Properties

Virus Scan File Extensions

Scanning Engines

Virus Scan Logs

Configuring Virus Scan

Configuring virus scanning for a share

NIS Service

NIS Properties

NIS Logs

Configuring NIS

Adding an appliance administrator from NIS

LDAP Service

LDAP Properties

LDAP Custom Mappings


Configuring LDAP

Adding an appliance administrator

Active Directory

Active Directory Properties

Active Directory Join Domain

Active Directory Join Workgroup

Active Directory Domains and Workgroups

Active Directory LDAP Signing

Active Directory Windows Server 2012 Support

Active Directory Windows Server 2008 Support

Active Directory Windows Server 2008 Support Section A: Kerberos issue (KB951191)

Active Directory Windows Server 2008 Support Section B: NTLMv2 issue (KB957441)

Active Directory Windows Server 2008 Support Section C: Note on NTLMv2

Configuring Active Directory Using the BUI

Joining a Domain

Joining a Workgroup

Configuring Active Directory Using the CLI

Example - Configuring Active Directory Using the CLI

Identity Mapping Service

Identity Mapping Properties

Identity Mapping Rule-based Mapping

Identity Mapping Directory-based Mapping

Identity Mapping IDMU

Identity Mapping Rules

Deny Mappings

Mapping Rule Directional Symbols

Identity Mapping Mappings

Identity Mapping Logs

Identity Mapping Best Practices

Identity Mapping Concepts

Identity Mapping Case Sensitivity

Mapping Persistence

Identity Mapping Domain-Wide Rules

Ephemeral Mapping

Identity Mapping Examples

Configuring Identity Mapping

Configuring Identity Mapping

Viewing or Flushing Mappings

DNS Service

DNS Properties

Configuring DNS

DNS Logs

Active Directory and DNS

Non-DNS Resolution

DNS-Less Operation

Dynamic Routing Service

RIP and RIPng Dynamic Routing Protocols

Dynamic Routing Logs

IPMP Service

IPMP Properties


NTP Service

NTP Properties

NTP Validation

NTP Authentication


NTP Tips

Configuring NTP Using the BUI

BUI Clock Synchronization

Configuring NTP Using the CLI

Phone Home Service

Oracle Single Sign-On Account

Phone Home Properties

Phone Home Web Proxy

Registering the Appliance

Registering the Appliance Using the BUI

Registering the Appliance Using the CLI

Changing Account Information

Phone Home Status

Phone Home State

Phone Home Logs



Service Tags

Service Tag Properties

SMTP Service

SMTP Properties


SNMP Service

SNMP Properties




Confinguring SNMP

Configuring SNMP to Serve Appliance Status

Configuring SNMP to Send Traps

Syslog Service

Syslog Properties

Classic Syslog: RFC 3164

Updated Syslog: RFC 5424

SYSLOG Message Format

SYSLOG Alert Message Format

Receiver Configuration Examples

Configuring a Solaris Receiver

Configuring a Linux Receiver

System Identity

System Identity Properties

System Identity Logs

SSH Service

SSH Properties

SSH Logs

Configuring SSH

Disabling root SSH access

Chapter 12 Shares, Projects, and Schema

Chapter 13 Replication

Chapter 14 Shadow Migration

Chapter 15 CLI Scripting

Chapter 16 Maintenance Workflows

Chapter 17 Integration


NDMP Backup Formats and Types

The NDMP protocol does not specify a backup data format. The appliance supports three backup types corresponding to different implementations and on-tape formats. DMAs can select a backup type using the following values for the NDMP environment variable "TYPE":

Table 11-18  NDMP Backup Formats and Types
Backup type
File-based for filesystems only. Supports file history and direct access recovery (DAR).
File-based for filesystems only. Supports file history and direct access recovery (DAR).
Share-based for both filesystems and volumes. Does not support file history or direct access recovery (DAR), but may be faster for some datasets. Only supported with NDMPv4.

There is no standard NDMP data stream format, so backup streams generated on the appliance can only be restored on 7000-series appliances running compatible software. Future versions of appliance software can generally restore streams backed up from older versions of the software, but the reverse is not necessarily true. For example, the "zfs" backup type is new in 2010.Q3 and systems running 2010.Q1 or earlier cannot restore backup streams created using type "zfs" under 2010.Q3.

NDMP Back up with "dump" and "tar"

When backing up with "dump" and "tar" backup types, administrators specify the data to backup by a filesystem path, called the backup path. For example, if the administrator configures a backup of /export/home, then the share mounted at that path will be backed up. Similarly, if a backup stream is restored to /export/code, then that's the path where files will be restored, even if they were backed up from another path.

Only paths which are mountpoints of existing shares or contained within existing shares may be specified for backup. If the backup path matches a share's mountpoint, only that share is backed up. Otherwise the path must be contained within a share, in which case only the portion of that share under that path is backed up. In both cases, other shares mounted inside the specified share under the backup path will not be backed up; these shares must be specified separately for backup.

Snapshots - If the backup path specifies a live filesystem (e.g., /export/code) or a path contained within a live filesystem (e.g., /export/code/src), the appliance immediately takes a new snapshot and backs up the given path from that snapshot. When the backup completes, the snapshot is destroyed. If the backup path specifies a snapshot (e.g., /export/code/.zfs/snapshot/mysnap), no new snapshot is created and the system backs up from the specified snapshot.

Share metadata - To simplify backup and restore of complex share configurations, "dump" and "tar" backups include share metadata for projects and shares associated with the backup path. This metadata describes the share configuration on the appliance, including protocol sharing properties, quota properties, and other properties configured on the Shares screen. This is not to be confused with filesystem metadata like directory structure and file permissions, which is also backed up and restored with NDMP.

For example, if you back up /export/proj, the share metadata for all shares whose mountpoints start with /export/proj will be backed up, as well as the share metadata for their parent projects. Similarly, if you back up /export/someshare/somedir, and a share is mounted at /export/someshare, that share and its project's share metadata will be backed up.

When restoring, if the destination of the restore path is not contained inside an existing share, projects and shares in the backup stream will be recreated as needed with their original properties as stored in the backup. For example, if you back up /export/foo, which contains project proj1 and shares share1 and share2, and then destroy the project and restore from the backup, then these two shares and the project will be recreated with their backed-up properties as part of the restore operation.

During a restore, if a project exists that would have been automatically recreated, the existing project is used and no new project is automatically created. If a share exists that would have been automatically recreated, and if its mountpoint matches what the appliance expects based on the original backup path and the destination of the restore, then the existing share is used and no new share is automatically created. Otherwise, a new share is automatically created from the metadata in the backup. If a share with the same name already exists (but has a different mountpoint), then the newly created share will be given a unique name starting with "ndmp-" and with the correct mountpoint.

It is recommended that you either restore a stream whose datasets no longer exist on the appliance, allowing the appliance to recreate datasets as specified in the backup stream, or precreate a destination share for restores. Either of these practices avoids surprising results related to the automatic share creation described above.

NDMP Back up with "zfs"

When backing up with type "zfs", administrators specify the data to backup by its canonical name on the appliance. This can be found underneath the name of the share in the BUI:

Figure 11-8  NDMP Share Name

image:NDMP Share Name

or in the CLI as the value of the canonical_name property. Canonical names do not begin with a leading '/', but when configuring the backup path the canonical name must be prefixed with '/'.

Both projects and shares can be specified for backup using type "zfs". If the canonical name is specified as-is, then a new snapshot is created and used for the backup. A specific snapshot can be specified for backup using the '@snapshot' suffix, in which case no new snapshot is created and the specified snapshot is backed up. For example:

Table 11-19  Canonical Names and Shares Backed Up
Canonical name
Shares backed up
New snapshot of the local project called "default" and all of its shares.
Named snapshot "yesterday" of local project "default", and all of its shares having snapshot "yesterday".
New snapshot of share "code" in local project "default". "code" could be a filesystem or volume.
Named snapshot "yesterday" of share "code" in local project "default". "code" could be a filesystem or volume.

Because level-based incremental backups using the "zfs" backup type require a base snapshot from the previous incremental, the default behavior for level backups for which a new snapshot is created is to keep the new snapshot so that it can be used for subsequent incremental backups. If the DMA indicates that the backup will not be used for subsequent incremental backups by setting UPDATE=n, the newly created snapshot is destroyed after the backup. Existing user snapshots are never destroyed after a backup. See "Incremental backups" below for details.

Share metadata - Share metadata (i.e., share configuration) is always included in "zfs" backups. When restoring a full backup with type "zfs", the destination project or share must not already exist. It will be recreated from the metadata in the backup stream. When restoring an incremental backup with type "zfs", the destination project or share must already exist. Its properties will be updated from the metadata in the backup stream. See "Incremental backups" below for details.