Module netapp_ontap.resources.network_route
Copyright © 2019 NetApp Inc. All rights reserved.
Overview
This endpoint supports the following operations: GET (collection and instance), POST, and DELETE.
Retrieving network routes
The IP routes GET API retrieves and displays relevant information pertaining to the routes configured in the cluster. The API retrieves the list of all routes configured in the cluster, or a specific route. The fields that are returned in the response will differ with the configuration.
Examples
Retrieving all routes in the cluster
The following output shows the list of all routes configured in a cluster.
# The API:
/api/network/ip/routes
# The call:
curl -X GET "https://<mgmt-ip>/api/network/ip/routes?fields=*" -H "accept: application/hal+json"
# The response:
{
"records": [
{
"uuid": "5fdffb0b-62f8-11e8-853d-005056b4c971",
"ipspace": {
"uuid": "84f4beb2-616c-11e8-a4df-005056b4c971",
"name": "Default",
"_links": {
"self": {
"href": "/api/network/ipspaces/84f4beb2-616c-11e8-a4df-005056b4c971"
}
}
},
"svm": {
"uuid": "3243312c-62f8-11e8-853d-005056b4c971",
"name": "vs1",
"_links": {
"self": {
"href": "/api/svm/svms/3243312c-62f8-11e8-853d-005056b4c971"
}
}
},
"scope": "svm",
"destination": {
"address": "10.4.3.14",
"netmask": "18",
"family": "ipv4"
},
"gateway": "10.4.3.1",
"_links": {
"self": {
"href": "/api/network/ip/routes/5fdffb0b-62f8-11e8-853d-005056b4c971"
}
}
},
{
"uuid": "84c128d2-62f9-11e8-853d-005056b4c971",
"ipspace": {
"uuid": "cc71aadc-62f7-11e8-853d-005056b4c971",
"name": "ips1",
"_links": {
"self": {
"href": "/api/network/ipspaces/cc71aadc-62f7-11e8-853d-005056b4c971"
}
}
},
"scope": "cluster",
"destination": {
"address": "::",
"netmask": "0",
"family": "ipv6"
},
"gateway": "fd20:8b1e:b255:814e::1",
"_links": {
"self": {
"href": "/api/network/ip/routes/84c128d2-62f9-11e8-853d-005056b4c971"
}
}
},
{
"uuid": "8cc72bcd-616c-11e8-a4df-005056b4c971",
"ipspace": {
"uuid": "84f4beb2-616c-11e8-a4df-005056b4c971",
"name": "Default",
"_links": {
"self": {
"href": "/api/network/ipspaces/84f4beb2-616c-11e8-a4df-005056b4c971"
}
}
},
"scope": "cluster",
"destination": {
"address": "0.0.0.0",
"netmask": "0",
"family": "ipv4"
},
"gateway": "10.224.64.1",
"_links": {
"self": {
"href": "/api/network/ip/routes/8cc72bcd-616c-11e8-a4df-005056b4c971"
}
}
},
{
"uuid": "d63b6eee-62f9-11e8-853d-005056b4c971",
"ipspace": {
"uuid": "84f4beb2-616c-11e8-a4df-005056b4c971",
"name": "Default",
"_links": {
"self": {
"href": "/api/network/ipspaces/84f4beb2-616c-11e8-a4df-005056b4c971"
}
}
},
"svm": {
"uuid": "3243312c-62f8-11e8-853d-005056b4c971",
"name": "vs1",
"_links": {
"self": {
"href": "/api/svm/svms/3243312c-62f8-11e8-853d-005056b4c971"
}
}
},
"scope": "svm",
"destination": {
"address": "fd20:8b1e:b255:814e::",
"netmask": "64",
"family": "ipv6"
},
"gateway": "fd20:8b1e:b255:814e::1",
"_links": {
"self": {
"href": "/api/network/ip/routes/d63b6eee-62f9-11e8-853d-005056b4c971"
}
}
}
],
"num_records": 4,
"_links": {
"self": {
"href": "/api/network/ip/routes?fields=*"
}
}
}
Retrieving a specific cluster-scoped route
The following output shows the returned response when a specific cluster-scoped route is requested. The system returns an error if there is no route with the requested UUID. SVM information is not returned for cluster-scoped routes.
# The API:
/api/network/ip/routes/{uuid}
# The call:
curl -X GET "https://<mgmt-ip>/api/network/ip/routes/84c128d2-62f9-11e8-853d-005056b4c971?fields=*" -H "accept: application/hal+json"
# The response:
{
"uuid": "84c128d2-62f9-11e8-853d-005056b4c971",
"ipspace": {
"uuid": "cc71aadc-62f7-11e8-853d-005056b4c971",
"name": "ips1",
"_links": {
"self": {
"href": "/api/network/ipspaces/cc71aadc-62f7-11e8-853d-005056b4c971"
}
}
},
"scope": "cluster",
"destination": {
"address": "::",
"netmask": "0",
"family": "ipv6"
},
"gateway": "fd20:8b1e:b255:814e::1",
"_links": {
"self": {
"href": "/api/network/ip/routes/84c128d2-62f9-11e8-853d-005056b4c971"
}
}
}
Retrieving a specific SVM-scoped route
The following output shows the returned response when a specific SVM-scoped route is requested. The system returns an error if there is no route with the requested UUID. The SVM object is only included for SVM-scoped routes.
# The API:
/api/network/ip/routes
# The call:
curl -X GET "https://<mgmt-ip>/api/network/ip/routes/d63b6eee-62f9-11e8-853d-005056b4c971?fields=*" -H "accept: application/hal+json"
# The response:
{
"uuid": "d63b6eee-62f9-11e8-853d-005056b4c971",
"ipspace": {
"uuid": "84f4beb2-616c-11e8-a4df-005056b4c971",
"name": "Default",
"_links": {
"self": {
"href": "/api/network/ipspaces/84f4beb2-616c-11e8-a4df-005056b4c971"
}
}
},
"svm": {
"uuid": "3243312c-62f8-11e8-853d-005056b4c971",
"name": "vs1",
"_links": {
"self": {
"href": "/api/svm/svms/3243312c-62f8-11e8-853d-005056b4c971"
}
}
},
"scope": "svm",
"destination": {
"address": "fd20:8b1e:b255:814e::",
"netmask": "64",
"family": "ipv6"
},
"gateway": "fd20:8b1e:b255:814e::1",
"_links": {
"self": {
"href": "/api/network/ip/routes/d63b6eee-62f9-11e8-853d-005056b4c971"
}
}
}
Creating network routes
The POST API is used to create an SVM-scoped route by specifying the associated SVM, or a cluster-scoped route by specifying the associated IPspace.
Examples
Creating a cluster-scoped route
IPspace is required to create a cluster-scoped route. If the IPspace is not specified, the route will be created in the Default IPspace. The default destination will be set to "0.0.0.0/0" for IPv4 gateway addresses or "::/0" for IPv6 gateway addresses.
# The API:
/api/network/ip/routes
# The call:
curl -X POST "https://<mgmt-ip>/api/network/ip/routes?return_records=true" -H "accept: application/json" -d '{ "ipspace": { "name":"ips1" }, "gateway": "10.10.10.1"}'
# The response:
{
"num_records": 1,
"records": [
{
"uuid": "ae583c9e-9ac7-11e8-8bc9-005056bbd531",
"ipspace": {
"name": "ips1"
},
"gateway": "10.10.10.1"
}
]
}
Creating an SVM-scoped route
To create an SVM-scoped route, the associated SVM can be identified by either its UUID or name.
# The API:
/api/network/ip/routes
# The call:
curl -X POST "https://<mgmt-ip>/api/network/ip/routes?return_records=true" -H "accept: application/json" -d '{ "svm": { "name":"vs0" }, "gateway": "10.10.10.1"}'
# The response:
{
"num_records": 1,
"records": [
{
"uuid": "38805a91-9ac9-11e8-8bc9-005056bbd531",
"svm": {
"name": "vs0"
},
"gateway": "10.10.10.1"
}
]
}
Deleting network routes
The DELETE API can remove a specific route identified by its UUID.
Example
Deleting a specific route
# The API:
/api/network/ip/routes
# The call:
curl -X DELETE "https://<mgmt-ip>/api/network/ip/routes/38805a91-9ac9-11e8-8bc9-005056bbd531"
Classes
class NetworkRoute (*args, **kwargs)
-
Allows interaction with NetworkRoute objects on the host
Initialize the instance of the resource.
Any keyword arguments are set on the instance as properties. For example, if the class was named 'MyResource', then this statement would be true:
MyResource(name='foo').name == 'foo'
Args
*args
- Each positional argument represents a parent key as used in the URL of the object. That is, each value will be used to fill in a segment of the URL which refers to some parent object. The order of these arguments must match the order they are specified in the URL, from left to right.
**kwargs
- each entry will have its key set as an attribute name on the instance and its value will be the value of that attribute.
Ancestors
Static methods
def delete_collection(*args, connection: HostConnection = None, **kwargs) -> NetAppResponse
-
Deletes a specific IP route.
Related ONTAP commands
network route delete
Learn more
Delete all objects in a collection which match the given query.
All records on the host which match the query will be deleted.
Args
*args
- Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to delete the collection of bars for a particular foo, the foo.name value should be passed.
connection
- The
HostConnection
object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context. **kwargs
- Any key/value pairs passed will be sent as query parameters to the host. Only resources matching this query will be patched.
Returns
A
NetAppResponse
object containing the details of the HTTP response.Raises
NetAppRestError
: If the API call returned a status code >= 400 def find(*args, connection: HostConnection = None, **kwargs) -> Resource
-
Retrieves the collection of IP routes.
Related ONTAP commands
network route show
Learn more
Find an instance of an object on the host given a query.
The host will be queried with the provided key/value pairs to find a matching resource. If 0 are found or if more than 1 is found, an error will be raised or returned. If there is exactly 1 matching record, then it will be returned.
Args
*args
- Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to find a bar for a particular foo, the foo.name value should be passed.
connection
- The
HostConnection
object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context. **kwargs
- Any key/value pairs passed will be sent as query parameters to the host.
Returns
A
Resource
object containing the details of the object.Raises
NetAppRestError
: If the API call did not return exactly 1 matching resource. def get_collection(*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> typing.Iterable
-
Retrieves the collection of IP routes.
Related ONTAP commands
network route show
Learn more
Fetch a list of all objects of this type from the host.
Args
*args
- Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the collection of bars for a particular foo, the foo.name value should be passed.
connection
- The
HostConnection
object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context. max_records
- The maximum number of records to return per call
**kwargs
- Any key/value pairs passed will be sent as query parameters to the host.
Returns
A list of
Resource
objectsRaises
NetAppRestError
: If there is no connection available to use either passed in or on the library.
Methods
def delete(self, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse
-
Deletes a specific IP route.
Related ONTAP commands
network route delete
Learn more
Send a deletion request to the host for this object.
Args
poll
- If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval
- If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout
- If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
**kwargs
- Any key/value pairs passed will be sent as query parameters to the host.
Returns
A
NetAppResponse
object containing the details of the HTTP response.Raises
NetAppRestError
: If the API call returned a status code >= 400 def get(self, **kwargs) -> NetAppResponse
-
Retrieves the details of a specific IP route.
Related ONTAP commands
network route show
Learn more
Fetch the details of the object from the host.
Requires the keys to be set (if any). After returning, new or changed properties from the host will be set on the instance.
Returns
A
NetAppResponse
object containing the details of the HTTP response.Raises
NetAppRestError
: If the API call returned a status code >= 400 def post(self, hydrate: bool = False, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse
-
Creates a cluster-scoped or SVM-scoped static route.
Required properties
gateway
- IP address to route packets to.- SVM-scoped routes
svm.name
orsvm.uuid
- SVM that route is applied to.- cluster-scoped routes
- There are no additional required fields for cluster-scoped routes.
Default property values
If not specified in POST, the following default property values are assigned: *
destination
- 0.0.0.0/0 for IPv4 or ::/0 for IPv6. *ipspace.name
* Default for cluster-scoped routes. * Name of the SVM's IPspace for SVM-scoped routes.Related ONTAP commands
network route create
Learn more
Send this object to the host as a creation request.
Args
hydrate
- If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of the object.
poll
- If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval
- If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout
- If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
**kwargs
- Any key/value pairs passed will be sent as query parameters to the host.
Returns
A
NetAppResponse
object containing the details of the HTTP response.Raises
NetAppRestError
: If the API call returned a status code >= 400
Inherited members
class NetworkRouteSchema (only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
-
The fields of the NetworkRoute object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.schema.BaseSchema
- marshmallow.base.SchemaABC
Class variables
var destination
-
The destination field of the network_route.
var gateway
-
The IP address of the gateway router leading to the destination.
Example: 10.1.1.1
var ipspace
-
The ipspace field of the network_route.
var links
-
The links field of the network_route.
var opts
var scope
-
The scope field of the network_route.
var svm
-
The svm field of the network_route.
var uuid
-
The UUID that uniquely identifies the route.
Example: 1cd8a442-86d1-11e0-ae1c-123478563412