NetApp ONTAP Network icon

NetApp ONTAP Network

Manage NetApp ONTAP network interfaces, ports, broadcast domains, and routing

Actions26

IP Interface → Get

AI-generated

Summary

Retrieve detailed information about a specific NetApp ONTAP IP interface (LIF) identified by UUID or name within a cluster.

Inputs

  • Cluster Host (required) — The hostname or IP address of the ONTAP cluster management LIF.
  • Port — HTTPS port for the ONTAP REST API; defaults to 443.
  • IP Interface (required) — Identifier of the IP interface to retrieve, specified either by UUID or by name.
  • Options — Optional parameters; currently supports 'Fields' to specify a comma-separated list of fields to include in the output (use '*' for all fields).

Output shape

a single record object representing the detailed properties of the specified IP interface.

Returns the full IP interface details as returned by the ONTAP REST API. The 'Fields' option can limit which fields are included in the response. If the interface is specified by name, the node resolves it to its UUID before fetching details. Errors are thrown if the interface cannot be found.

Examples

Example 1: Get IP interface details by UUID

Specify 'Cluster Host' as 'cluster.example.com', 'IP Interface' mode as 'UUID' with the interface UUID value, optionally set 'Fields' to '*' to fetch all fields.

Example 2: Get IP interface details by name

Specify 'Cluster Host' as 'cluster.example.com', 'IP Interface' mode as 'Name' with the interface name value; node resolves the UUID internally before retrieving details.

Links

Discussion