Add ZFS Storage Appliance

You can add ZFS Storage Appliance entities using the Add Entity UI or using the cloud agent command line interface (omcli) with the appropriate JSON files.

Step 1: Decide how you want to add the ZFS Storage Appliance.

You can add ZFS Storage Appliance entities using one of two ways:

  • Add them from UI
  • Use the agent's omcli add_entity command with the appropriate JSON files

Adding Entities from the UI

  1. From the Management Cloud main menu, select Administration, Discovery, and then Add Entity. The Add Entity page displays.
  2. Select the ZFS Storage Appliance Entity Type.
  3. Enter the following UI properties.
    ZFS Storage Appliance UI Fields
    • Entity Name: Name of this entity displayed in the Oracle Management Cloud console.
    • ZFFSA IP Address: IP address of the ZFS storage appliance with REST API.
    • ZFFSA Port: Port of the storage appliance REST API.
    • Trust Any Server Certificate: False is recommended. You must import the storage server SSL certificate into the selected could agent before discovery. If you choose True instead, discovery will occur even for an untrusted or expired certificate.
    • Cloud Agent: Cloud agent monitoring the host where the ZFS Storage Appliance is installed.

    Monitoring Credentials (ZFFSA Credentials)

    • Username: Storage appliance username.
    • Password: Storage appliance password.

See Add Entities from the Console for detailed instructions on using the Add Entity UI.

Using omcli and the Appropriate JSON Files

  1. Download and extract the required JSON file(s) from the master JSON zip file. See the table below for the specific JSON files you'll need.
  2. Edit the file(s) and specify the requisite properties shown below.
    ZFS Storage Appliance JSON Files and Properties

    Definition File: omc_oracle_zfs_storage_appliance_sample.json

    • omc_zfssa_hostname: ONLY IP of the ZFS Storage Appliance (if you use hostname/fully qualified domain name, you will trigger a REST fetchlet problem with certificate validation: ( handshake alert: unrecognized_name ))
    • omc_zfssa_port: Port to use for REST API communication with ZFS Storage Appliance storage
    • omc_ssl_trust_server_cert: Flag indicating whether to trust self-signed certificates.

    Credential File: omc_oracle_zfs_storage_appliance_sample_creds.json

    • Alias: Alias (username/login name) to be used for the ZFS Storage Appliance REST API
    • Password: Password for the ZFS Storage Appliance REST API alias.
  3. Add the entity using omcli.
    omcli add_entity agent DEFINITION_FILE [-credential_file CREDENTIAL_FILE [-encryption_method_gpg]] 
  4. Verify the status of the newly added entity.
    omcli status_entity agent DEFINITION_FILE

See step 4. Adding Entities to Your Service of Add Entities Using JSON Files for more information.

Step 3: (Optional but recommended) Set up alerts.

To enable lights-out monitoring, you can set up alert rules to generate alerts and send notifications if your entities have performance issues.

See Set Up Alert Rules and Set Up Alert Thresholds and Notifications.


If you run into any issues regarding discovery or monitoring of ZFS Storage Appliance, see the following: