Module netapp_ontap.resources.storage_port
Copyright © 2023 NetApp Inc. All rights reserved.
This file has been automatically generated based on the ONTAP REST API documentation.
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:
from netapp_ontap import HostConnection
from netapp_ontap.resources import StoragePort
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
print(list(StoragePort.get_collection()))
[
StoragePort(
{
"name": "0a",
"node": {
"name": "node-1",
"_links": {
"self": {
"href": "/api/cluster/nodes/0530d6c1-8c6d-11e8-907f-00a0985a72ee"
}
},
"uuid": "0530d6c1-8c6d-11e8-907f-00a0985a72ee",
},
}
),
StoragePort(
{
"name": "0b",
"node": {
"name": "node-1",
"_links": {
"self": {
"href": "/api/cluster/nodes/0530d6c1-8c6d-11e8-907f-00a0985a72ee"
}
},
"uuid": "0530d6c1-8c6d-11e8-907f-00a0985a72ee",
},
}
),
StoragePort(
{
"name": "0c",
"node": {
"name": "node-1",
"_links": {
"self": {
"href": "/api/cluster/nodes/0530d6c1-8c6d-11e8-907f-00a0985a72ee"
}
},
"uuid": "0530d6c1-8c6d-11e8-907f-00a0985a72ee",
},
}
),
StoragePort(
{
"name": "0d",
"node": {
"name": "node-1",
"_links": {
"self": {
"href": "/api/cluster/nodes/0530d6c1-8c6d-11e8-907f-00a0985a72ee"
}
},
"uuid": "0530d6c1-8c6d-11e8-907f-00a0985a72ee",
},
}
),
StoragePort(
{
"name": "0e",
"node": {
"name": "node-1",
"_links": {
"self": {
"href": "/api/cluster/nodes/0530d6c1-8c6d-11e8-907f-00a0985a72ee"
}
},
"uuid": "0530d6c1-8c6d-11e8-907f-00a0985a72ee",
},
}
),
StoragePort(
{
"name": "0f",
"node": {
"name": "node-1",
"_links": {
"self": {
"href": "/api/cluster/nodes/0530d6c1-8c6d-11e8-907f-00a0985a72ee"
}
},
"uuid": "0530d6c1-8c6d-11e8-907f-00a0985a72ee",
},
}
),
StoragePort(
{
"name": "0g",
"node": {
"name": "node-1",
"_links": {
"self": {
"href": "/api/cluster/nodes/0530d6c1-8c6d-11e8-907f-00a0985a72ee"
}
},
"uuid": "0530d6c1-8c6d-11e8-907f-00a0985a72ee",
},
}
),
]
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.
from netapp_ontap import HostConnection
from netapp_ontap.resources import StoragePort
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
resource = StoragePort(
name="0a", **{"node.uuid": "0530d6c1-8c6d-11e8-907f-00a0985a72ee"}
)
resource.get()
print(resource)
StoragePort(
{
"speed": 6.0,
"name": "0a",
"state": "online",
"firmware_version": "01.12.09.00",
"enabled": True,
"description": "SAS Host Adapter 0a (PMC-Sierra PM8001 rev. C)",
"redundant": True,
"in_use": True,
"cable": {
"identifier": "500a0980066e2c01-500a098003633df0",
"part_number": "112-00429+A0",
"serial_number": "629230774",
"length": "0.5m",
},
"node": {
"name": "node-1",
"_links": {
"self": {
"href": "/api/cluster/nodes/0530d6c1-8c6d-11e8-907f-00a0985a72ee"
}
},
"uuid": "0530d6c1-8c6d-11e8-907f-00a0985a72ee",
},
"wwn": "500a098003633df0",
"type": "sas",
}
)
Updating a storage port
The storage port PATCH API modifies the port mode for storage/network use and allows the port to be enabled/disabled.
Examples
1) Using an Ethernet port for storage
The following example sets an Ethernet port mode for storage use:
from netapp_ontap import HostConnection
from netapp_ontap.resources import StoragePort
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
resource = StoragePort(
name="e3a", **{"node.uuid": "0530d6c1-8c6d-11e8-907f-00a0985a72ee"}
)
resource.mode = "storage"
resource.patch()
2) Disabling a storage port
The following example disables an unused storage port:
from netapp_ontap import HostConnection
from netapp_ontap.resources import StoragePort
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
resource = StoragePort(
name="e3a", **{"node.uuid": "0530d6c1-8c6d-11e8-907f-00a0985a72ee"}
)
resource.enabled = False
resource.patch()
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 count_collection (*args, connection: HostConnection = None, **kwargs) -> int
-
Returns a count of all StoragePort resources that match the provided query
This calls GET on the object to determine the number of records. It is more efficient than calling get_collection() because it will not construct any objects. Query parameters can be passed in as kwargs to determine a count of objects that match some filtered criteria.
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 count 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. These query parameters can affect the count. A return_records query param will be ignored.
Returns
On success, returns an integer count of the objects of this type. On failure, returns -1.
Raises
NetAppRestError
: If the API call returned a status code >= 400, or if there is no connection available to use either passed in or on the library. 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, None will be returned. 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 or None if no matches were found.Raises
NetAppRestError
: If the API call returned more than 1 matching resource. def get_collection (*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> Iterable[Resource]
-
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.
This is a lazy fetch, making API calls only as necessary when the result of this call is iterated over. For instance, if max_records is set to 5, then iterating over the collection causes an API call to be sent to the server once for every 5 records. If the client stops iterating before getting to the 6th record, then no additional API calls are made.
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. This would be not be raised when get_collection() is called, but rather when the result is iterated. def patch_collection (body: dict, *args, records: Iterable[_ForwardRef('StoragePort')] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse
-
Updates a storage port.
Related ONTAP commands
storage port modify
storage port enable
storage port disable
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. The body argument will be ignored if records is provided.
*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.
records
- Can be provided in place of a query. If so, this list of objects will be patched on the host.
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.
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 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 def patch (self, hydrate: bool = False, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse
-
Updates a storage port.
Related ONTAP commands
storage port modify
storage port enable
storage port disable
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.
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 normally be sent as query parameters to the host. If any of these pairs are parameters that are sent as formdata then only parameters of that type will be accepted and all others will be discarded.
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: Union[Sequence[str], Set[str]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Dict = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: str = None)
-
The fields of the StoragePort object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.base.SchemaABC
Class variables
-
board_name: str GET
-
The board_name field of the storage_port.
-
cable: ShelfPortsCable GET
-
The cable field of the storage_port.
-
description: str GET
-
The description field of the storage_port.
Example: SAS Host Adapter 2a (PMC-Sierra PM8072 rev. C)
-
enabled: bool GET POST PATCH
-
The enabled field of the storage_port.
-
error: StoragePortError GET
-
The error field of the storage_port.
-
firmware_version: str GET
-
The firmware_version field of the storage_port.
Example: 03.08.09.00
-
force: bool PATCH
-
The force field of the storage_port.
-
in_use: bool GET
-
Specifies whether any devices are connected through this port
-
mac_address: str GET
-
The mac_address field of the storage_port.
-
mode: str GET POST PATCH
-
Operational mode of a non-dedicated Ethernet port
Valid choices:
- network
- storage
-
name: str GET
-
The name field of the storage_port.
Example: 2a
-
node: Node GET POST PATCH
-
The node field of the storage_port.
-
part_number: str GET
-
The part_number field of the storage_port.
Example: 111-03801
-
redundant: bool GET
-
Specifies whether all devices connected through this port have a redundant path from another port
-
serial_number: str GET
-
The serial_number field of the storage_port.
Example: 7A2463CC45B
-
speed: float GET
-
Operational port speed in Gbps
Example: 6.0
-
state: str GET
-
The state field of the storage_port.
Valid choices:
- online
- offline
- error
-
type: str GET
-
The type field of the storage_port.
Valid choices:
- sas
- fc
- enet
-
wwn: str GET
-
World Wide Name
Example: 50000d1703544b80
-
wwpn: str GET
-
World Wide Port Name