Skip to main content

Your first AFX storage system REST API call

Contributors dmp-netapp

You can issue a simple curl command to get started using the AFX REST API and confirm its availability.

About this task

AFX is one of three distinct ONTAP personalities. You can use a call to the REST API to determine the ONTAP personality of your cluster based on two fields included in the response.

Before you begin

In addition to having the curl utility available on your local workstation, you'll need the following:

  • IP address or FQDN of the AFX system cluster management LIF

  • ONTAP credentials for an account with authority to access the ONTAP REST API

Steps
  1. Issue the following command at the CLI of your local workstation:

    curl --request GET \
    "https://$FQDN_IP/api/cluster?fields=disaggregated,san_optimized" \
    --user username:password
  2. Based on the response, determine the ONTAP personality as follows:

    • If “disaggregated” is true and:

      • If “san_optimized” is false the personality is AFX

      • If “san_optimized” is true the personality is ASA r2

    • If “disaggregated” is false the personality is Unified ONTAP

Related information