Module netapp_ontap.resources.iscsi_service
Copyright © 2019 NetApp Inc. All rights reserved.
Overview
An iSCSI service defines the properties of the iSCSI target for an SVM. There can be at most one iSCSI service for an SVM. An SVM's iSCSI service must be created before iSCSI initiators can log in to the SVM.
The iSCSI service REST API allows you to create, update, delete, and discover iSCSI services for SVMs.
Examples
Creating an iSCSI service for an SVM
The simplest way to create an iSCSI service is to specify only the SVM, either by name or UUID. By default, the new iSCSI service is enabled and uses the SVM name as its target alias.
In this example, the return_records
query parameter is used to retrieve the new iSCSI service object in the REST response.
# The API:
POST /api/protocols/san/iscsi/services
# The call:
curl -X POST 'https://<mgmt-ip>/api/protocols/san/iscsi/services?return_records=true' -H 'accept: application/hal+json' -d '{ "svm": { "name": "svm1" } }'
# The response:
{
"num_records": 1,
"records": [
{
"svm": {
"uuid": "19d04b8e-94d7-11e8-8370-005056b48fd2",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/19d04b8e-94d7-11e8-8370-005056b48fd2"
}
}
},
"enabled": true,
"target": {
"name": "iqn.1992-08.com.netapp:sn.19d04b8e94d711e88370005056b48fd2:vs.4",
"alias": "svm1"
},
"_links": {
"self": {
"href": "/api/protocols/san/iscsi/services/19d04b8e-94d7-11e8-8370-005056b48fd2"
}
}
}
]
}
Retrieving the iSCSI services for all SVMs in the cluster
# The API:
GET /api/protocols/san/iscsi/services
# The call:
curl -X GET 'https://<mgmt-ip>/api/protocols/san/iscsi/services' -H 'accept: application/hal+json'
# The response:
{
"records": [
{
"svm": {
"uuid": "19d04b8e-94d7-11e8-8370-005056b48fd2",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/19d04b8e-94d7-11e8-8370-005056b48fd2"
}
}
},
"_links": {
"self": {
"href": "/api/protocols/san/iscsi/services/19d04b8e-94d7-11e8-8370-005056b48fd2"
}
}
},
{
"svm": {
"uuid": "25f617cf-94d7-11e8-8370-005056b48fd2",
"name": "svm2",
"_links": {
"self": {
"href": "/api/svm/svms/25f617cf-94d7-11e8-8370-005056b48fd2"
}
}
},
"_links": {
"self": {
"href": "/api/protocols/san/iscsi/services/25f617cf-94d7-11e8-8370-005056b48fd2"
}
}
}
],
"num_records": 2,
"_links": {
"self": {
"href": "/api/protocols/san/iscsi/services"
}
}
}
Retrieving details for a specific iSCSI service
The iSCSI service is identified by the UUID of its SVM.
# The API:
GET /api/protocols/san/iscsi/services/{svm.uuid}
# The call:
curl -X GET 'https://<mgmt-ip>/api/protocols/san/iscsi/services/19d04b8e-94d7-11e8-8370-005056b48fd2' -H 'accept: application/hal+json'
# The response:
{
"svm": {
"uuid": "19d04b8e-94d7-11e8-8370-005056b48fd2",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/19d04b8e-94d7-11e8-8370-005056b48fd2"
}
}
},
"enabled": true,
"target": {
"name": "iqn.1992-08.com.netapp:sn.19d04b8e94d711e88370005056b48fd2:vs.4",
"alias": "svm1"
},
"_links": {
"self": {
"href": "/api/protocols/san/iscsi/services/19d04b8e-94d7-11e8-8370-005056b48fd2"
}
}
}
Disabling an iSCSI service
Disabling an iSCSI service shuts down all active iSCSI sessions for the SVM and prevents the creation of new iSCSI sessions.
The iSCSI service to update is identified by the UUID of its SVM.
# The API:
PATCH /api/protocols/san/iscsi/services/{svm.uuid}
# The call:
curl -X PATCH 'https://<mgmt-ip>/api/protocols/san/iscsi/services/19d04b8e-94d7-11e8-8370-005056b48fd2' -H 'accept: application/hal+json' -d '{ "enabled": "false" }'
You can retrieve the iSCSI service to confirm the change.
In this example, the fields
query parameter is used to limit the response to the enabled
property and iSCSI service identifiers.
# The API:
GET /api/protocols/san/iscsi/services/{svm.uuid}
# The call:
curl -X GET 'https://<mgmt-ip>/api/protocols/san/iscsi/services/19d04b8e-94d7-11e8-8370-005056b48fd2?fields=enabled' -H 'accept: application/hal+json'
# The response:
{
"svm": {
"uuid": "19d04b8e-94d7-11e8-8370-005056b48fd2",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/19d04b8e-94d7-11e8-8370-005056b48fd2"
}
}
},
"enabled": false,
"_links": {
"self": {
"href": "/api/protocols/san/iscsi/services/19d04b8e-94d7-11e8-8370-005056b48fd2"
}
}
}
Deleting an iSCSI service
The iSCSI service must be disabled before it can be deleted.
The iSCSI service to be deleted is identified by the UUID of its SVM.
# The API:
DELETE /api/protocols/san/iscsi/services/{svm.uuid}
# The call:
curl -X DELETE 'https://<mgmt-ip>/api/protocols/san/iscsi/services/19d04b8e-94d7-11e8-8370-005056b48fd2' -H 'accept: application/hal+json'
Classes
class IscsiService (*args, **kwargs)
-
An iSCSI service defines the properties of the iSCSI target for an SVM. There can be at most one iSCSI service for an SVM. An SVM's iSCSI service must be created before iSCSI initiators can log in to the SVM.
An iSCSI service is identified by the UUID of its SVM.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 iSCSI service. An iSCSI service must be disabled before it can be deleted.
Related ONTAP commands
vserver iscsi 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 iSCSI services.
Related ONTAP commands
vserver iscsi 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 iSCSI services.
Related ONTAP commands
vserver iscsi 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 iSCSI service.
Related ONTAP commands
vserver iscsi modify
vserver iscsi start
vserver iscsi stop
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 iSCSI service. An iSCSI service must be disabled before it can be deleted.
Related ONTAP commands
vserver iscsi 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 iSCSI service.
Related ONTAP commands
vserver iscsi 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 iSCSI service.
Related ONTAP commands
vserver iscsi modify
vserver iscsi start
vserver iscsi stop
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 an iSCSI service.
Required properties
svm.uuid
orsvm.name
- Existing SVM in which to create the iSCSI service.
Related ONTAP commands
vserver iscsi 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 IscsiServiceSchema (only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
-
The fields of the IscsiService object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.schema.BaseSchema
- marshmallow.base.SchemaABC
Class variables
var enabled
-
The administrative state of the iSCSI service. The iSCSI service can be disabled to block all iSCSI connectivity to the SVM.
Optional in POST and PATCH. The default setting is true (enabled) in POST. var links
-
The links field of the iscsi_service.
var opts
var svm
-
The svm field of the iscsi_service.
var target
-
The target field of the iscsi_service.