Module netapp_ontap.resources.storage_port
Copyright © 2019 NetApp Inc. All rights reserved.
Retrieving storage port information
The storage port GET API retrieves all of the storage ports in the cluster.
Examples
1) Retrieve a list of storage ports from the cluster
The following example shows the response with a list of storage ports in the cluster:
# The API:
/api/storage/ports
# The call:
curl -X GET "https://<mgmt-ip>/api/storage/ports" -H "accept: application/hal+json"
# The response:
{
"records": [
{
"node": {
"uuid": "0530d6c1-8c6d-11e8-907f-00a0985a72ee",
"name": "node-1",
"_links": {
"self": {
"href": "/api/cluster/nodes/0530d6c1-8c6d-11e8-907f-00a0985a72ee"
}
}
},
"name": "0a",
"_links": {
"self": {
"href": "/api/storage/ports/0530d6c1-8c6d-11e8-907f-00a0985a72ee/0a"
}
}
},
{
"node": {
"uuid": "0530d6c1-8c6d-11e8-907f-00a0985a72ee",
"name": "node-1",
"_links": {
"self": {
"href": "/api/cluster/nodes/0530d6c1-8c6d-11e8-907f-00a0985a72ee"
}
}
},
"name": "0b",
"_links": {
"self": {
"href": "/api/storage/ports/0530d6c1-8c6d-11e8-907f-00a0985a72ee/0b"
}
}
},
{
"node": {
"uuid": "0530d6c1-8c6d-11e8-907f-00a0985a72ee",
"name": "node-1",
"_links": {
"self": {
"href": "/api/cluster/nodes/0530d6c1-8c6d-11e8-907f-00a0985a72ee"
}
}
},
"name": "0c",
"_links": {
"self": {
"href": "/api/storage/ports/0530d6c1-8c6d-11e8-907f-00a0985a72ee/0c"
}
}
},
{
"node": {
"uuid": "0530d6c1-8c6d-11e8-907f-00a0985a72ee",
"name": "node-1",
"_links": {
"self": {
"href": "/api/cluster/nodes/0530d6c1-8c6d-11e8-907f-00a0985a72ee"
}
}
},
"name": "0d",
"_links": {
"self": {
"href": "/api/storage/ports/0530d6c1-8c6d-11e8-907f-00a0985a72ee/0d"
}
}
},
{
"node": {
"uuid": "0530d6c1-8c6d-11e8-907f-00a0985a72ee",
"name": "node-1",
"_links": {
"self": {
"href": "/api/cluster/nodes/0530d6c1-8c6d-11e8-907f-00a0985a72ee"
}
}
},
"name": "0e",
"_links": {
"self": {
"href": "/api/storage/ports/0530d6c1-8c6d-11e8-907f-00a0985a72ee/0e"
}
}
},
{
"node": {
"uuid": "0530d6c1-8c6d-11e8-907f-00a0985a72ee",
"name": "node-1",
"_links": {
"self": {
"href": "/api/cluster/nodes/0530d6c1-8c6d-11e8-907f-00a0985a72ee"
}
}
},
"name": "0f",
"_links": {
"self": {
"href": "/api/storage/ports/0530d6c1-8c6d-11e8-907f-00a0985a72ee/0f"
}
}
},
{
"node": {
"uuid": "0530d6c1-8c6d-11e8-907f-00a0985a72ee",
"name": "node-1",
"_links": {
"self": {
"href": "/api/cluster/nodes/0530d6c1-8c6d-11e8-907f-00a0985a72ee"
}
}
},
"name": "0g",
"_links": {
"self": {
"href": "/api/storage/ports/0530d6c1-8c6d-11e8-907f-00a0985a72ee/0g"
}
}
},
],
"num_records": 7,
"_links": {
"self": {
"href": "/api/storage/ports"
}
}
}
2) Retrieve a specific storage port from the cluster
The following example shows the response of the requested storage port. If there is no storage port with the requested node uuid and name, an error is returned.
# The API:
/api/storage/ports/{node.uuid}/{name}
# The call:
curl -X GET "https://<mgmt-ip>/api/storage/ports/0530d6c1-8c6d-11e8-907f-00a0985a72ee/0a" -H "accept: application/hal+json"
# The response:
{
"node": {
"uuid": "0530d6c1-8c6d-11e8-907f-00a0985a72ee",
"name": "node-1",
"_links": {
"self": {
"href": "/api/cluster/nodes/0530d6c1-8c6d-11e8-907f-00a0985a72ee"
}
}
},
"name": "0a",
"description": "SAS Host Adapter 0a (PMC-Sierra PM8001 rev. C)",
"wwn": "500a098003633df0",
"speed": 6,
"cable": {
"part_number": "112-00429+A0",
"serial_number": "629230774",
"identifier": "500a0980066e2c01-500a098003633df0",
"length": "0.5m"
},
"state": "online",
"_links": {
"self": {
"href": "/api/storage/ports/0530d6c1-8c6d-11e8-907f-00a0985a72ee/0a"
}
}
}
Classes
class StoragePort (*args, **kwargs)
-
Allows interaction with StoragePort 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 find(*args, connection: HostConnection = None, **kwargs) -> Resource
-
Retrieves a collection of storage ports.
Related ONTAP commands
storage port 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 storage ports.
Related ONTAP commands
storage port 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 get(self, **kwargs) -> NetAppResponse
-
Retrieves a specific storage port.
Related ONTAP commands
storage port 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
Inherited members
class StoragePortSchema (only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
-
The fields of the StoragePort object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.schema.BaseSchema
- marshmallow.base.SchemaABC
Class variables
var board_name
-
The board_name field of the storage_port.
var cable
-
The cable field of the storage_port.
var description
-
The description field of the storage_port.
Example: SAS Host Adapter 2a (PMC-Sierra PM8072 rev. C)
var error
-
The error field of the storage_port.
var mac_address
-
The mac_address field of the storage_port.
var name
-
The name field of the storage_port.
Example: 2a
var node
-
The node field of the storage_port.
var opts
var part_number
-
The part_number field of the storage_port.
Example: 111-03801
var serial_number
-
The serial_number field of the storage_port.
Example: 7A2463CC45B
var speed
-
Operational port speed in Gbps
Example: 6.0
var state
-
The state field of the storage_port.
Valid choices:
- online
- offline
- error
var wwn
-
World Wide Name
Example: 50000d1703544b80