Module netapp_ontap.resources.ipspace
Copyright © 2019 NetApp Inc. All rights reserved.
Overview
An IPspace is an addressing domain within which each IP address is unique. The same address may appear in a different IPspace, but the matching addresses are considered to be distinct. SVMs and broadcast domains, and therefore IP interfaces and Ethernet ports, are associated with a single IPspace. This endpoint supports the following operations: GET (collection and instance), POST, PATCH, and DELETE.
Retrieving IPspace information
The IPspaces GET API retrieves all IPspaces configured in the cluster, including built-in and custom IPspaces, and specifically requested IPspaces.
Examples
Retrieving a list of the IPspaces in the cluster
The following example returns the requested list of IPspaces configured in the cluster.
# The API:
/api/network/ipspaces
# The call:
curl -X GET "https://<mgmt-ip>/api/network/ipspaces?fields=*" -H "accept: application/hal+json"
# The response:
{
"records": [
{
"uuid": "dcc7e79c-5acc-11e8-b9de-005056b42b32",
"name": "Default",
"_links": {
"self": {
"href": "/api/network/ipspaces/dcc7e79c-5acc-11e8-b9de-005056b42b32"
}
}
},
{
"uuid": "dfd3c1b2-5acc-11e8-b9de-005056b42b32",
"name": "Cluster",
"_links": {
"self": {
"href": "/api/network/ipspaces/dfd3c1b2-5acc-11e8-b9de-005056b42b32"
}
}
},
{
"uuid": "dedec1be-5aec-1eee-beee-0eee56be2b3e",
"name": "Ipspace1",
"_links": {
"self": {
"href": "/api/network/ipspaces/dedec1be-5aec-1eee-beee-0eee56be2b3e"
}
}
}
],
"num_records": 3,
"_links": {
"self": {
"href": "/api/network/ipspaces?fields=*"
}
}
}
Retrieving a specific IPspace in the cluster
The following example returns the specific IPspace requested. The system returns an error if there is no IPspace with the requested UUID.
# The API:
/api/network/ipspaces/{uuid}
# The call:
curl -X GET "https://<mgmt-ip>/api/network/ipspaces/dfd3c1b2-5acc-11e8-b9de-005056b42b32?fields=*" -H "accept: application/hal+json"
# The response:
{
"uuid": "dcc7e79c-5acc-11e8-b9de-005056b42b32",
"name": "Default",
"_links": {
"self": {
"href": "/api/network/ipspaces/dcc7e79c-5acc-11e8-b9de-005056b42b32"
}
}
}
Creating IPspaces
The network IPspaces POST API is used to create IPspaces.
Example
Creating an IPspace
The following output displays the record returned after the creation of an IPspace with the name "ipspace1".
# The API:
/api/network/ipspaces
# The call:
curl -X POST "https://<mgmt-ip>/api/network/ipspaces?return_records=true" -H "accept: application/hal+json" -d "{ \"name\": \"ipspace2\"}"
# The response:
{
"num_records": 1,
"records": [
{
"uuid": "4165655e-0528-11e9-bd68-005056bb046a",
"name": "ipspace2",
"_links": {
"self": {
"href": "/api/network/ipspaces/4165655e-0528-11e9-bd68-005056bb046a"
}
}
}
]
}
Updating IPspaces
The IPspaces PATCH API is used to modify attributes of the IPspace.
Example
Updating the name of an IPspace
The following PATCH request is used to update the name of the IPspace from "ipspace2" to "ipspace20".
# The API:
/api/network/ipspaces/{uuid}
# The call:
curl -X PATCH "https://<mgmt-ip>/api/network/ipspaces/4165655e-0528-11e9-bd68-005056bb046a" -H "accept: application/hal+json" -d "{ \"name\": \"ipspace20\"}"
Deleting IPspaces
The IPspaces DELETE API is used to delete an IPspace.
Example
Deleting an IPspace
The following DELETE request is used to delete an IPspace.
# The API:
/api/network/ipspaces/{uuid}
# The call:
curl -X DELETE "https://<mgmt-ip>/api/network/ipspaces/4165655e-0528-11e9-bd68-005056bb046a" -H "accept: application/hal+json" -H "Content-Type: application/json"
Classes
class Ipspace (*args, **kwargs)
-
Allows interaction with Ipspace 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 an IPspace object.
Related ONTAP commands
network ipspace 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 a collection of IPspaces for the entire cluster.
Related ONTAP commands
network ipspace 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 a collection of IPspaces for the entire cluster.
Related ONTAP commands
network ipspace 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. def patch_collection(body: dict, *args, connection: HostConnection = None, **kwargs) -> NetAppResponse
-
Updates an IPspace object.
Related ONTAP commands
network ipspace rename
Learn more
Patch all objects in a collection which match the given query.
All records on the host which match the query will be patched with the provided body.
Args
body
- A dictionary of name/value pairs to set on all matching members of the collection.
*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 patch 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
Methods
def delete(self, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse
-
Deletes an IPspace object.
Related ONTAP commands
network ipspace 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 information about a specific IPspace.
Related ONTAP commands
network ipspace 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 patch(self, hydrate: bool = False, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse
-
Updates an IPspace object.
Related ONTAP commands
network ipspace rename
Learn more
Send the difference in the object's state to the host as a modification request.
Calculates the difference in the object's state since the last time we interacted with the host and sends this in the request body.
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 def post(self, hydrate: bool = False, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse
-
Creates a new domain within which IP addresses are unique. SVMs, ports, and networks are scoped within a single IPspace.
Required properties
name
- Name of the ipspace to create.
Related ONTAP commands
network ipspace 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 IpspaceSchema (only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
-
The fields of the Ipspace object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.schema.BaseSchema
- marshmallow.base.SchemaABC
Class variables
var links
-
The links field of the ipspace.
var name
-
IPspace name
Example: ipspace1
var opts
var uuid
-
The UUID that uniquely identifies the IPspace.
Example: 1cd8a442-86d1-11e0-ae1c-123478563412