NetApp ONTAP Network icon

NetApp ONTAP Network

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

Actions26

Route → Create

AI-generated

Summary

Create a new network route on a specified ONTAP cluster and Storage Virtual Machine (SVM) by defining its destination network, gateway IP address, and optional metric.

Inputs

  • Cluster Host (required) — The hostname or IP address of the ONTAP cluster management LIF to connect to.
  • Port — HTTPS port number for the ONTAP REST API (default is 443).
  • SVM (required) — The Storage Virtual Machine (SVM) by name under which the route will be created.
  • Destination (required) — The destination network in CIDR notation (e.g., 0.0.0.0/0) for the new route.
  • Gateway (required) — The gateway IP address for the route.
  • Metric — Optional numeric metric for the route (default is 20).
  • Options — Optional additional settings such as a comma-separated list of fields to include in the response.

Output shape

a JSON object containing the created route details or job status if asynchronous

If the route creation operation triggers an asynchronous job, the node polls until completion and returns the final job status along with the route details.

Examples

Example 1: Create a default route through gateway 192.168.1.1 on SVM named 'svm1' for ONTAP cluster at 10.0.0.1

Set Cluster Host to '10.0.0.1', SVM to 'svm1', Destination to '0.0.0.0/0', Gateway to '192.168.1.1', and use default metric 20.

Links

Discussion