Configure Fully Qualified Domain Name web UI access

Contributors netapp-pcarriga netapp-amitha Download PDF of this page

NetApp HCI with Element 12.2 or later enables you to access storage cluster web interfaces using the Fully Qualified Domain Name (FQDN). If you want to use the FQDN to access web user interfaces such as the Element web UI, per-node UI, or management node UI, you must first add a storage cluster setting to identify the FQDN used by the cluster. This enables the cluster to properly redirect a login session and improves integration with external services such as key managers and identity providers for multi-factor authentication.

What you’ll need
  • This feature requires Element 12.2 or later.

  • Configuring this feature using NetApp Hybrid Cloud Control REST APIs requires management services 2.15 or later.

  • Configuring this feature using the NetApp Hybrid Cloud Control UI requires management services 2.19 or later.

  • To use REST APIs, you must have deployed a management node running version 11.5 or later.

  • You need fully qualified domain names for the management node and each storage cluster that resolve correctly to the management node IP address and each storage cluster IP address.

You can configure or remove FQDN web UI access using NetApp Hybrid Cloud Control and the REST API. You can also troubleshoot incorrectly configured FQDNs.

Configure FQDN web UI access using NetApp Hybrid Cloud Control

Steps
  1. Open a web browser and browse to the IP address of the management node:

    https://<ManagementNodeIP>
  2. Log in to NetApp Hybrid Cloud Control by providing the storage cluster administrator credentials.

  3. Select the menu icon at the top right of the page.

  4. Select Configure.

  5. In the Fully Qualified Domain Names pane, select Set Up.

  6. In the resulting window, enter the FQDNs for the management node and each storage cluster.

  7. Select Save.

    The Fully Qualified Domain Names pane lists each storage cluster with its associated MVIP and FQDN.

    Note Only connected storage clusters with the FQDN set are listed in the Fully Qualified Domain Names pane.

Configure FQDN web UI access using the REST API

Steps
  1. Ensure that the Element storage nodes and the management node have DNS configured correctly for the network environment so that FQDNs in the environment can be resolved. To set DNS, go to the per-node UI for storage nodes and to the management node, then select Network Settings > Management Network.

    1. Per-node UI for storage nodes: https://<storage_node_management_IP>:442

    2. Per-node UI for the management node: https://<management_node_IP>:442

  2. Change the storage cluster settings using the Element API.

    1. Access the Element API and create the following cluster interface preference using the CreateClusterInterfacePreference API method, and insert the cluster MVIP FQDN for the preference value:

      • Name: mvip_fqdn

      • Value: <Fully Qualified Domain Name for the Cluster MVIP>

        For example, the FQDN here is storagecluster.my.org:

        https://<Cluster_MVIP>/json-rpc/12.2?method=CreateClusterInterfacePreference&name=mvip_fqdn&value=storagecluster.my.org
  3. Change the management node settings using the REST API on the management node:

    1. Access the REST API UI for the management node by entering the management node IP address followed by /mnode/2/. For example:

      https://<management_node_IP>/mnode/2/
    2. Select Authorize or any lock icon and enter the Element cluster user name and password.

    3. Enter the client ID as mnode-client.

    4. Select Authorize to begin a session.

    5. Close the window.

    6. Select GET /settings.

    7. Select Try it out.

    8. Select Execute.

    9. Note whether or not the proxy is used as indicated in "use_proxy" by true or false.

    10. Select PUT /settings.

    11. Select Try it out.

    12. In the request body area, enter the management node FQDN as the value for the mnode_fqdn parameter. Also specify whether the proxy should be used (true or false from the previous step) for the use_proxy parameter.

      {
        "mnode_fqdn": "mnode.my.org",
        "use_proxy": false
      }
    13. Select Execute.

Remove FQDN web UI access using NetApp Hybrid Cloud Control

You can use this procedure to remove FQDN web access for the management node and the storage clusters.

Steps
  1. In the Fully Qualified Domain Names pane, select Edit.

  2. In the resulting window, delete the contents in the FQDN text field.

  3. Select Save.

    The window closes and the FQDN is no longer listed in the Fully Qualified Domain Names pane.

Remove FQDN web UI access using the REST API

Steps
  1. Change the storage cluster settings using the Element API.

    1. Access the Element API and delete the following cluster interface preference using the DeleteClusterInterfacePreference API method:

      • Name: mvip_fqdn

        For example:

        https://<Cluster_MVIP>/json-rpc/12.2?method=DeleteClusterInterfacePreference&name=mvip_fqdn
  2. Change the management node settings using the REST API on the management node:

    1. Access the REST API UI for the management node by entering the management node IP address followed by /mnode/2/. For example:

      https://<management_node_IP>/mnode/2/
    2. Select Authorize or any lock icon and enter the Element cluster user name and password.

    3. Enter the client ID as mnode-client.

    4. Select Authorize to begin a session.

    5. Close the window.

    6. Select PUT /settings.

    7. Select Try it out.

    8. In the request body area, do not enter a value for the mnode_fqdn parameter. Also specify whether the proxy should be used (true or false) for the use_proxy parameter.

      {
        "mnode_fqdn": "",
        "use_proxy": false
      }
    9. Select Execute.

Troubleshooting

If FQDNs are configured incorrectly, you might have problems accessing either the management node, a storage cluster, or both. Use the following information to help troubleshoot the issue.

Issue Cause Resolution
  • You get a browser error when attempting to access either the management node or the storage cluster using the FQDN.

  • You cannot log in to either the management node or the storage cluster using an IP address.

The management node FQDN and storage cluster FQDN are both incorrectly configured.

Use the REST API instructions on this page to remove the management node and storage cluster FQDN settings and configure them again.

  • You get a browser error when attempting to access the storage cluster FQDN.

  • You cannot log in to either the management node or the storage cluster using an IP address.

The management node FQDN is correctly configured, but the storage cluster FQDN is incorrectly configured.

Use the REST API instructions on this page to remove the storage cluster FQDN settings and configure them again.

  • You get a browser error when attempting to access the management node FQDN.

  • You can log in to the management node and storage cluster using an IP address.

The management node FQDN is incorrectly configured, but the storage cluster FQDN is correctly configured.

Log in to NetApp Hybrid Cloud Control to correct the management node FQDN settings in the UI, or use the REST API instructions on this page to correct the settings.

Find more information