Module netapp_ontap.resources.nvme_subsystem_map
Copyright © 2019 NetApp Inc. All rights reserved.
Overview
An NVMe subsystem map is an association of an NVMe namespace with an NVMe subsystem. When an NVMe namespace is mapped to an NVMe subsystem, the NVMe subsystem's hosts are granted access to the NVMe namespace. The relationship between an NVMe subsystem and an NVMe namespace is one subsystem to many namespaces.
The NVMe subsystem map REST API allows you to create, delete and discover NVMe subsystem maps.
Examples
Creating an NVMe subsystem map
# The API:
POST /api/protocols/nvme/subsystem-maps
# The call:
curl -X POST 'https://<mgmt-ip>/api/protocols/nvme/subsystem-maps' -H 'accept: application/hal+json' -d '{ "svm": { "name": "svm1" }, "subsystem": { "name": "subsystem1" }, "namespace": { "name": "/vol/vol1/namespace1" } }'
Retrieving all of the NVMe subsystem maps
# The API:
GET /api/protocols/nvme/subsystem-maps
# The call:
curl -X GET 'https://<mgmt-ip>/api/protocols/nvme/subsystem-maps' -H 'accept: application/hal+json'
# The response:
{
"records": [
{
"svm": {
"uuid": "0e91b214-fe40-11e8-91a0-005056a79967",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/0e91b214-fe40-11e8-91a0-005056a79967"
}
}
},
"subsystem": {
"uuid": "580a6b1e-fe43-11e8-91a0-005056a79967",
"name": "subsystem1",
"_links": {
"self": {
"href": "/api/protocols/nvme/subsystems/580a6b1e-fe43-11e8-91a0-005056a79967"
}
}
},
"namespace": {
"uuid": "3ccdedc6-2519-4206-bc1f-b0f4adab6f89",
"name": "/vol/vol1/namespace1",
"_links": {
"self": {
"href": "/api/storage/namespaces/3ccdedc6-2519-4206-bc1f-b0f4adab6f89"
}
}
},
"_links": {
"self": {
"href": "/api/protocols/nvme/subsystem-maps/580a6b1e-fe43-11e8-91a0-005056a79967/3ccdedc6-2519-4206-bc1f-b0f4adab6f89"
}
}
}
],
"num_records": 1,
"_links": {
"self": {
"href": "/api/protocols/nvme/subsystem-maps"
}
}
}
Retrieving a specific NVMe subsystem map
The NVMe subsystem map is identified by the UUID of the NVMe subsystem followed by the UUID of the NVMe namespace.
# The API:
GET /api/protocols/nvme/subsystem-maps/{subsystem.uuid}/{namespace.uuid}
# The call:
curl -X GET 'https://<mgmt-ip>/api/protocols/nvme/subsystem-maps/580a6b1e-fe43-11e8-91a0-005056a79967/3ccdedc6-2519-4206-bc1f-b0f4adab6f89' -H 'accept: application/hal+json'
# The response:
{
"svm": {
"uuid": "0e91b214-fe40-11e8-91a0-005056a79967",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/0e91b214-fe40-11e8-91a0-005056a79967"
}
}
},
"subsystem": {
"uuid": "580a6b1e-fe43-11e8-91a0-005056a79967",
"name": "subsystem1",
"_links": {
"self": {
"href": "/api/protocols/nvme/subsystems/580a6b1e-fe43-11e8-91a0-005056a79967"
}
}
},
"namespace": {
"uuid": "3ccdedc6-2519-4206-bc1f-b0f4adab6f89",
"name": "/vol/vol1/namespace1",
"node": {
"name": "node1",
"uuid": "012b4508-67d6-4788-8c2d-801f254ce976",
"_links": {
"self": {
"href": "/api/cluster/nodes/012b4508-67d6-4788-8c2d-801f254ce976"
}
}
}
"_links": {
"self": {
"href": "/api/storage/namespaces/3ccdedc6-2519-4206-bc1f-b0f4adab6f89"
}
}
},
"nsid": "00000001h",
"_links": {
"self": {
"href": "/api/protocols/nvme/subsystem-maps/580a6b1e-fe43-11e8-91a0-005056a79967/3ccdedc6-2519-4206-bc1f-b0f4adab6f89"
}
}
}
Deleting an NVMe subsystem map
# The API:
DELETE /api/protocols/nvme/subsystem-maps/{subsystem.uuid}/{namespace.uuid}
# The call:
curl -X DELETE 'https://<mgmt-ip>/api/protocols/nvme/subsystem-maps/580a6b1e-fe43-11e8-91a0-005056a79967/3ccdedc6-2519-4206-bc1f-b0f4adab6f89' -H 'accept: application/hal+json'
Classes
class NvmeSubsystemMap (*args, **kwargs)
-
An NVMe subsystem map is an association of an NVMe namespace with an NVMe subsystem. When an NVMe namespace is mapped to an NVMe subsystem, the NVMe subsystem's hosts are granted access to the NVMe namespace. The relationship between an NVMe subsystem and an NVMe namespace is one subsystem to many namespaces.
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 NVMe subsystem map.
Related ONTAP commands
vserver nvme subsystem map 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 NVMe subsystem maps.
Expensive properties
There is an added cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the
fields
query parameter. SeeDOC Requesting specific fields
to learn more. *anagrpid
Related ONTAP commands
vserver nvme subsystem map 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 NVMe subsystem maps.
Expensive properties
There is an added cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the
fields
query parameter. SeeDOC Requesting specific fields
to learn more. *anagrpid
Related ONTAP commands
vserver nvme subsystem map 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 an NVMe subsystem map.
Related ONTAP commands
vserver nvme subsystem map 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 an NVMe subsystem map.
Expensive properties
There is an added cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the
fields
query parameter. SeeDOC Requesting specific fields
to learn more. *anagrpid
Related ONTAP commands
vserver nvme subsystem map 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 an NVMe subsystem map.
Required properties
svm.uuid
orsvm.name
- Existing SVM in which to create the NVMe subsystem map.namespace.uuid
ornamespace.name
- Existing NVMe namespace to map to the specified NVme subsystem.subsystem.uuid
orsubsystem.name
- Existing NVMe subsystem to map to the specified NVMe namespace.
Related ONTAP commands
vserver nvme subsystem map 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 NvmeSubsystemMapSchema (only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
-
The fields of the NvmeSubsystemMap object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.schema.BaseSchema
- marshmallow.base.SchemaABC
Class variables
var anagrpid
-
The Asymmetric Namespace Access Group ID (ANAGRPID) of the NVMe namespace.
The format for an ANAGRPID is 8 hexadecimal digits (zero-filled) followed by a lower case "h".
There is an added cost to retrieving this property's value. It is not populated for either a collection GET or an instance GET unless it is explicitly requested using thefields
query parameter. SeeDOC Requesting specific fields
to learn more.Example: 00103050h
var links
-
The links field of the nvme_subsystem_map.
var namespace
-
The namespace field of the nvme_subsystem_map.
var nsid
-
The NVMe namespace identifier. This is an identifier used by an NVMe controller to provide access to the NVMe namespace.
The format for an NVMe namespace identifier is 8 hexadecimal digits (zero-filled) followed by a lower case "h".Example: 00000001h
var opts
var subsystem
-
The subsystem field of the nvme_subsystem_map.
var svm
-
The svm field of the nvme_subsystem_map.