Module netapp_ontap.resources.fc_interface
Copyright © 2020 NetApp Inc. All rights reserved.
Overview
Fibre Channel (FC) interfaces are the logical endpoints for FC network connections to an SVM. An FC interface provides FC access to storage within the interface SVM using either Fibre Channel Protocol or NVMe over FC (NVMe/FC).
The Fibre Channel interface REST API allows you to create, delete, update, and discover FC interfaces, and obtain status information for FC interfaces.
An FC interface is created on an FC port which is located on a cluster node. The FC port must be specified to identify the location of the interface for a POST or PATCH request that relocates an interface. You can identify the port by supplying either the node and port names or the port UUID.
Examples
Creating an FC interface using the port node and name to identify the location
This example uses the return_records
query parameter to retrieve the newly created FC interface in the POST response.
from netapp_ontap import HostConnection
from netapp_ontap.resources import FcInterface
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
resource = FcInterface()
resource.svm.name = "svm1"
resource.name = "lif1"
resource.location.port.name = "0a"
resource.location.port.node.name = "node1"
resource.data_protocol = "fcp"
resource.post(hydrate=True)
print(resource)
FcInterface(
{
"_links": {
"self": {
"href": "/api/network/fc/interfaces/f6045b92-dec7-11e8-a733-005056bba0e0"
}
},
"location": {
"port": {
"_links": {
"self": {
"href": "/api/network/fc/ports/300c1ae3-db82-11e8-bd46-005056bba0e0"
}
},
"uuid": "300c1ae3-db82-11e8-bd46-005056bba0e0",
"node": {"name": "node1"},
"name": "0a",
},
"node": {
"_links": {
"self": {
"href": "/api/cluster/nodes/bafe9b9f-db81-11e8-bd46-005056bba0e0"
}
},
"uuid": "bafe9b9f-db81-11e8-bd46-005056bba0e0",
"name": "node1",
},
},
"enabled": True,
"data_protocol": "fcp",
"port_address": "9da2cb1",
"state": "down",
"uuid": "f6045b92-dec7-11e8-a733-005056bba0e0",
"wwpn": "20:04:00:50:56:bb:a0:e0",
"wwnn": "20:00:00:50:56:bb:a0:e0",
"svm": {
"_links": {
"self": {"href": "/api/svm/svms/cf300f5c-db83-11e8-bd46-005056bba0e0"}
},
"uuid": "cf300f5c-db83-11e8-bd46-005056bba0e0",
"name": "svm1",
},
"name": "lif1",
}
)
Creating an FC interface using the port UUID to identify the location
This example uses the return_records
query parameter to retrieve the newly created FC interface in the POST response.
from netapp_ontap import HostConnection
from netapp_ontap.resources import FcInterface
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
resource = FcInterface()
resource.svm.name = "svm3"
resource.name = "lif2"
resource.location.port.uuid = "24bb636a-db83-11e8-9a49-005056bb1ec6"
resource.data_protocol = "fc_nvme"
resource.post(hydrate=True)
print(resource)
FcInterface(
{
"_links": {
"self": {
"href": "/api/network/fc/interfaces/cdeb5591-dec9-11e8-a733-005056bba0e0"
}
},
"location": {
"port": {
"_links": {
"self": {
"href": "/api/network/fc/ports/24bb636a-db83-11e8-9a49-005056bb1ec6"
}
},
"uuid": "24bb636a-db83-11e8-9a49-005056bb1ec6",
"node": {"name": "node3"},
"name": "1b",
},
"node": {
"_links": {
"self": {
"href": "/api/cluster/nodes/e85aa147-db83-11e8-9a48-005056bb1ec6"
}
},
"uuid": "e85aa147-db83-11e8-9a48-005056bb1ec6",
"name": "node3",
},
},
"enabled": True,
"data_protocol": "fc_nvme",
"port_address": "612e202b",
"state": "down",
"uuid": "cdeb5591-dec9-11e8-a733-005056bba0e0",
"wwpn": "20:05:00:50:56:bb:a0:e0",
"wwnn": "20:02:00:50:56:bb:a0:e0",
"svm": {
"_links": {
"self": {"href": "/api/svm/svms/a5060466-dbab-11e8-bd46-005056bba0e0"}
},
"uuid": "a5060466-dbab-11e8-bd46-005056bba0e0",
"name": "svm3",
},
"name": "lif2",
}
)
Retrieving all properties for all FC interfaces
This example uses the fields
query parameter to retrieve all properties.
from netapp_ontap import HostConnection
from netapp_ontap.resources import FcInterface
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
print(list(FcInterface.get_collection(fields="*")))
[
FcInterface(
{
"_links": {
"self": {
"href": "/api/network/fc/interfaces/cdeb5591-dec9-11e8-a733-005056bba0e0"
}
},
"location": {
"port": {
"_links": {
"self": {
"href": "/api/network/fc/ports/24bb636a-db83-11e8-9a49-005056bb1ec6"
}
},
"uuid": "24bb636a-db83-11e8-9a49-005056bb1ec6",
"node": {"name": "node3"},
"name": "1b",
},
"node": {
"_links": {
"self": {
"href": "/api/cluster/nodes/e85aa147-db83-11e8-9a48-005056bb1ec6"
}
},
"uuid": "e85aa147-db83-11e8-9a48-005056bb1ec6",
"name": "node3",
},
},
"enabled": True,
"data_protocol": "fc_nvme",
"port_address": "612e202b",
"state": "down",
"uuid": "cdeb5591-dec9-11e8-a733-005056bba0e0",
"wwpn": "20:05:00:50:56:bb:a0:e0",
"wwnn": "20:02:00:50:56:bb:a0:e0",
"svm": {
"_links": {
"self": {
"href": "/api/svm/svms/a5060466-dbab-11e8-bd46-005056bba0e0"
}
},
"uuid": "a5060466-dbab-11e8-bd46-005056bba0e0",
"name": "svm3",
},
"name": "lif2",
}
),
FcInterface(
{
"_links": {
"self": {
"href": "/api/network/fc/interfaces/f6045b92-dec7-11e8-a733-005056bba0e0"
}
},
"location": {
"port": {
"_links": {
"self": {
"href": "/api/network/fc/ports/300c1ae3-db82-11e8-bd46-005056bba0e0"
}
},
"uuid": "300c1ae3-db82-11e8-bd46-005056bba0e0",
"node": {"name": "node1"},
"name": "0a",
},
"node": {
"_links": {
"self": {
"href": "/api/cluster/nodes/bafe9b9f-db81-11e8-bd46-005056bba0e0"
}
},
"uuid": "bafe9b9f-db81-11e8-bd46-005056bba0e0",
"name": "node1",
},
},
"enabled": True,
"data_protocol": "fcp",
"port_address": "9da2cb1",
"state": "down",
"uuid": "f6045b92-dec7-11e8-a733-005056bba0e0",
"wwpn": "20:04:00:50:56:bb:a0:e0",
"wwnn": "20:00:00:50:56:bb:a0:e0",
"svm": {
"_links": {
"self": {
"href": "/api/svm/svms/cf300f5c-db83-11e8-bd46-005056bba0e0"
}
},
"uuid": "cf300f5c-db83-11e8-bd46-005056bba0e0",
"name": "svm1",
},
"name": "lif1",
}
),
]
Retrieving a list of selected FC interfaces
This example uses property query parameters to retrieve FC interfaces configured for the FC Protocol that are set to up.
from netapp_ontap import HostConnection
from netapp_ontap.resources import FcInterface
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
print(list(FcInterface.get_collection(data_protocol="fcp", state="up")))
[
FcInterface(
{
"_links": {
"self": {
"href": "/api/network/fc/interfaces/f6045b92-dec7-11e8-a733-005056bba0e0"
}
},
"data_protocol": "fcp",
"state": "up",
"uuid": "f6045b92-dec7-11e8-a733-005056bba0e0",
"svm": {
"_links": {
"self": {
"href": "/api/svm/svms/cf300f5c-db83-11e8-bd46-005056bba0e0"
}
},
"uuid": "cf300f5c-db83-11e8-bd46-005056bba0e0",
"name": "svm1",
},
"name": "lif1",
}
)
]
Retrieving a specific FC interface
from netapp_ontap import HostConnection
from netapp_ontap.resources import FcInterface
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
resource = FcInterface(uuid="cdeb5591-dec9-11e8-a733-005056bba0e0")
resource.get()
print(resource)
FcInterface(
{
"_links": {
"self": {
"href": "/api/network/fc/interfaces/cdeb5591-dec9-11e8-a733-005056bba0e0"
}
},
"location": {
"port": {
"_links": {
"self": {
"href": "/api/network/fc/ports/24bb636a-db83-11e8-9a49-005056bb1ec6"
}
},
"uuid": "24bb636a-db83-11e8-9a49-005056bb1ec6",
"node": {"name": "node3"},
"name": "1b",
},
"node": {
"_links": {
"self": {
"href": "/api/cluster/nodes/e85aa147-db83-11e8-9a48-005056bb1ec6"
}
},
"uuid": "e85aa147-db83-11e8-9a48-005056bb1ec6",
"name": "node3",
},
},
"enabled": True,
"data_protocol": "fc_nvme",
"port_address": "612e202b",
"state": "down",
"uuid": "cdeb5591-dec9-11e8-a733-005056bba0e0",
"wwpn": "20:05:00:50:56:bb:a0:e0",
"wwnn": "20:02:00:50:56:bb:a0:e0",
"svm": {
"_links": {
"self": {"href": "/api/svm/svms/a5060466-dbab-11e8-bd46-005056bba0e0"}
},
"uuid": "a5060466-dbab-11e8-bd46-005056bba0e0",
"name": "svm3",
},
"name": "lif2",
}
)
Disabling an FC interface
When updating certain properties or deleting an FC interface, the interface must first be disabled using the following:
from netapp_ontap import HostConnection
from netapp_ontap.resources import FcInterface
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
resource = FcInterface(uuid="f6045b92-dec7-11e8-a733-005056bba0e0")
resource.enabled = False
resource.patch()
Moving an FC interface to a new node and port
To move an FC interface to another node or port, the destination FC port must be specified in a PATCH request. Either the port UUID or node and port names can be used to identify the port.
Note that only FC interfaces configured for the FC Protocol can be moved. FC interfaces configured for NVMe/FC cannot be moved. The interface must also be set to the disabled state before being moved.
from netapp_ontap import HostConnection
from netapp_ontap.resources import FcInterface
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
resource = FcInterface(uuid="f6045b92-dec7-11e8-a733-005056bba0e0")
resource.location.port.uuid = "a1dc7aa5-db83-11e8-9ef7-005056bbbbcc"
resource.patch()
Deleting an FC interface
The FC interface must be disabled before being deleted.
from netapp_ontap import HostConnection
from netapp_ontap.resources import FcInterface
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
resource = FcInterface(uuid="f6045b92-dec7-11e8-a733-005056bba0e0")
resource.delete()
Classes
class FcInterface (*args, **kwargs)
-
A Fibre Channel (FC) interface is the logical endpoint for FC network connections to an SVM. An FC interface provides FC access to storage within the interface SVM using either Fibre Channel Protocol or NVMe over Fibre Channel (NVMe/FC).
An FC interface is created on an FC port which is located on a cluster node. The FC port must be specified to identify the location of the interface for a POST or PATCH operation that relocates an interface. You can identify the port by supplying either the node and port names or the port UUID.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
-
Retrieves FC interfaces.
Related ONTAP commands
network interface show
vserver fcp interface show
Learn more
Fetch a count of all objects of this type from the host.
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 delete_collection(*args, body: typing.Union = None, connection: HostConnection = None, **kwargs) -> NetAppResponse
-
Deletes an FC interface.
Related ONTAP commands
network interface 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.
body
- The body of the delete request. This could be a Resource instance or a dictionary object.
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 FC interfaces.
Related ONTAP commands
network interface show
vserver fcp interface 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) -> typing.Iterable
-
Retrieves FC interfaces.
Related ONTAP commands
network interface show
vserver fcp interface 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, connection: HostConnection = None, **kwargs) -> NetAppResponse
-
Updates an FC interface.
Related ONTAP commands
network interface modify
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, body: typing.Union = None, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse
-
Deletes an FC interface.
Related ONTAP commands
network interface delete
Learn more
Send a deletion request to the host for this object.
Args
body
- The body of the delete request. This could be a Resource instance or a dictionary 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 async def fc_interface_create(links: dict = None, comment: str = None, data_protocol: str = None, enabled: bool = None, location: dict = None, name: str = None, port_address: str = None, state: str = None, svm: dict = None, uuid: str = None, wwnn: str = None, wwpn: str = None) -> netapp_ontap.resource_table.ResourceTable
-
Create an instance of a FcInterface resource
Args
links
comment
- A user configurable comment. Optional in POST; valid in PATCH. To clear a prior comment, set the property to an empty string in PATCH.
data_protocol
- The data protocol for which the FC interface is configured. Required in POST.
enabled
- The administrative state of the FC interface. The FC interface can be disabled to block all FC communication with the SVM through this interface. Optional in POST and PATCH; defaults to true (enabled) in POST.
location
name
- The name of the FC interface. Required in POST; optional in PATCH.
port_address
- The port address of the FC interface. Each FC port in an FC switched fabric has its own unique FC port address for routing purposes. The FC port address is assigned by a switch in the fabric when that port logs in to the fabric. This property refers to the address given by a switch to the FC interface when the SVM performs a port login (PLOGI).
This is useful for obtaining statistics and diagnostic information from FC switches.
This is a hexadecimal encoded numeric value. state
- The current operational state of the FC interface. The state is set to down if the interface is not enabled.
If the node hosting the port is down or unavailable, no state value is returned. svm
uuid
- The unique identifier of the FC interface. Required in the URL.
wwnn
- The world wide node name (WWNN) of the FC interface SVM. The WWNN is generated by ONTAP when Fibre Channel Protocol or the NVMe service is created for the FC interface SVM.
wwpn
- The world wide port name (WWPN) of the FC interface. The WWPN is generated by ONTAP when the FC interface is created.
async def fc_interface_delete(comment: str = None, data_protocol: str = None, enabled: bool = None, name: str = None, port_address: str = None, state: str = None, uuid: str = None, wwnn: str = None, wwpn: str = None)
-
Delete an instance of a FcInterface resource
Args
comment
- A user configurable comment. Optional in POST; valid in PATCH. To clear a prior comment, set the property to an empty string in PATCH.
data_protocol
- The data protocol for which the FC interface is configured. Required in POST.
enabled
- The administrative state of the FC interface. The FC interface can be disabled to block all FC communication with the SVM through this interface. Optional in POST and PATCH; defaults to true (enabled) in POST.
name
- The name of the FC interface. Required in POST; optional in PATCH.
port_address
- The port address of the FC interface. Each FC port in an FC switched fabric has its own unique FC port address for routing purposes. The FC port address is assigned by a switch in the fabric when that port logs in to the fabric. This property refers to the address given by a switch to the FC interface when the SVM performs a port login (PLOGI).
This is useful for obtaining statistics and diagnostic information from FC switches.
This is a hexadecimal encoded numeric value. state
- The current operational state of the FC interface. The state is set to down if the interface is not enabled.
If the node hosting the port is down or unavailable, no state value is returned. uuid
- The unique identifier of the FC interface. Required in the URL.
wwnn
- The world wide node name (WWNN) of the FC interface SVM. The WWNN is generated by ONTAP when Fibre Channel Protocol or the NVMe service is created for the FC interface SVM.
wwpn
- The world wide port name (WWPN) of the FC interface. The WWPN is generated by ONTAP when the FC interface is created.
async def fc_interface_modify(comment: str = None, query_comment: str = None, data_protocol: str = None, query_data_protocol: str = None, enabled: bool = None, query_enabled: bool = None, name: str = None, query_name: str = None, port_address: str = None, query_port_address: str = None, state: str = None, query_state: str = None, uuid: str = None, query_uuid: str = None, wwnn: str = None, query_wwnn: str = None, wwpn: str = None, query_wwpn: str = None) -> netapp_ontap.resource_table.ResourceTable
-
Modify an instance of a FcInterface resource
Args
comment
- A user configurable comment. Optional in POST; valid in PATCH. To clear a prior comment, set the property to an empty string in PATCH.
query_comment
- A user configurable comment. Optional in POST; valid in PATCH. To clear a prior comment, set the property to an empty string in PATCH.
data_protocol
- The data protocol for which the FC interface is configured. Required in POST.
query_data_protocol
- The data protocol for which the FC interface is configured. Required in POST.
enabled
- The administrative state of the FC interface. The FC interface can be disabled to block all FC communication with the SVM through this interface. Optional in POST and PATCH; defaults to true (enabled) in POST.
query_enabled
- The administrative state of the FC interface. The FC interface can be disabled to block all FC communication with the SVM through this interface. Optional in POST and PATCH; defaults to true (enabled) in POST.
name
- The name of the FC interface. Required in POST; optional in PATCH.
query_name
- The name of the FC interface. Required in POST; optional in PATCH.
port_address
- The port address of the FC interface. Each FC port in an FC switched fabric has its own unique FC port address for routing purposes. The FC port address is assigned by a switch in the fabric when that port logs in to the fabric. This property refers to the address given by a switch to the FC interface when the SVM performs a port login (PLOGI).
This is useful for obtaining statistics and diagnostic information from FC switches.
This is a hexadecimal encoded numeric value. query_port_address
- The port address of the FC interface. Each FC port in an FC switched fabric has its own unique FC port address for routing purposes. The FC port address is assigned by a switch in the fabric when that port logs in to the fabric. This property refers to the address given by a switch to the FC interface when the SVM performs a port login (PLOGI).
This is useful for obtaining statistics and diagnostic information from FC switches.
This is a hexadecimal encoded numeric value. state
- The current operational state of the FC interface. The state is set to down if the interface is not enabled.
If the node hosting the port is down or unavailable, no state value is returned. query_state
- The current operational state of the FC interface. The state is set to down if the interface is not enabled.
If the node hosting the port is down or unavailable, no state value is returned. uuid
- The unique identifier of the FC interface. Required in the URL.
query_uuid
- The unique identifier of the FC interface. Required in the URL.
wwnn
- The world wide node name (WWNN) of the FC interface SVM. The WWNN is generated by ONTAP when Fibre Channel Protocol or the NVMe service is created for the FC interface SVM.
query_wwnn
- The world wide node name (WWNN) of the FC interface SVM. The WWNN is generated by ONTAP when Fibre Channel Protocol or the NVMe service is created for the FC interface SVM.
wwpn
- The world wide port name (WWPN) of the FC interface. The WWPN is generated by ONTAP when the FC interface is created.
query_wwpn
- The world wide port name (WWPN) of the FC interface. The WWPN is generated by ONTAP when the FC interface is created.
def fc_interface_show(comment: cliche.arg_types.choices.Choices.define.
._Choices = None, data_protocol: cliche.arg_types.choices.Choices.define. ._Choices = None, enabled: cliche.arg_types.choices.Choices.define. ._Choices = None, name: cliche.arg_types.choices.Choices.define. ._Choices = None, port_address: cliche.arg_types.choices.Choices.define. ._Choices = None, state: cliche.arg_types.choices.Choices.define. ._Choices = None, uuid: cliche.arg_types.choices.Choices.define. ._Choices = None, wwnn: cliche.arg_types.choices.Choices.define. ._Choices = None, wwpn: cliche.arg_types.choices.Choices.define. ._Choices = None, fields: typing.List = None) -> netapp_ontap.resource_table.ResourceTable -
Fetch a list of FcInterface resources
Args
comment
- A user configurable comment. Optional in POST; valid in PATCH. To clear a prior comment, set the property to an empty string in PATCH.
data_protocol
- The data protocol for which the FC interface is configured. Required in POST.
enabled
- The administrative state of the FC interface. The FC interface can be disabled to block all FC communication with the SVM through this interface. Optional in POST and PATCH; defaults to true (enabled) in POST.
name
- The name of the FC interface. Required in POST; optional in PATCH.
port_address
- The port address of the FC interface. Each FC port in an FC switched fabric has its own unique FC port address for routing purposes. The FC port address is assigned by a switch in the fabric when that port logs in to the fabric. This property refers to the address given by a switch to the FC interface when the SVM performs a port login (PLOGI).
This is useful for obtaining statistics and diagnostic information from FC switches.
This is a hexadecimal encoded numeric value. state
- The current operational state of the FC interface. The state is set to down if the interface is not enabled.
If the node hosting the port is down or unavailable, no state value is returned. uuid
- The unique identifier of the FC interface. Required in the URL.
wwnn
- The world wide node name (WWNN) of the FC interface SVM. The WWNN is generated by ONTAP when Fibre Channel Protocol or the NVMe service is created for the FC interface SVM.
wwpn
- The world wide port name (WWPN) of the FC interface. The WWPN is generated by ONTAP when the FC interface is created.
def get(self, **kwargs) -> NetAppResponse
-
Retrieves an FC interface.
Related ONTAP commands
network interface show
vserver fcp interface 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 FC interface.
Related ONTAP commands
network interface modify
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 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 def post(self, hydrate: bool = False, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse
-
Creates an FC interface.
Required properties
svm.uuid
orsvm.name
- Existing SVM in which to create the FC interface.name
- Name of the FC interface.location.port.uuid
or bothlocation.port.name
andlocation.port.node.name
- FC port on which to create the FC interface.data_protocol
- Data protocol for the FC interface.
Default property values
If not specified in POST, the following default property values are assigned. *
enabled
- trueRelated ONTAP commands
network interface 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 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 FcInterfaceSchema (*, only: typing.Union = None, exclude: typing.Union = (), many: bool = False, context: typing.Dict = None, load_only: typing.Union = (), dump_only: typing.Union = (), partial: typing.Union = False, unknown: str = None)
-
The fields of the FcInterface object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.base.SchemaABC
Class variables
-
comment GET POST PATCH
-
A user configurable comment. Optional in POST; valid in PATCH. To clear a prior comment, set the property to an empty string in PATCH.
-
data_protocol GET POST
-
The data protocol for which the FC interface is configured. Required in POST.
Valid choices:
- fcp
- fc_nvme
-
enabled GET POST PATCH
-
The administrative state of the FC interface. The FC interface can be disabled to block all FC communication with the SVM through this interface. Optional in POST and PATCH; defaults to true (enabled) in POST.
-
links GET
-
The links field of the fc_interface.
-
location GET POST PATCH
-
The location field of the fc_interface.
-
name GET POST PATCH
-
The name of the FC interface. Required in POST; optional in PATCH.
Example: lif1
-
port_address GET
-
The port address of the FC interface. Each FC port in an FC switched fabric has its own unique FC port address for routing purposes. The FC port address is assigned by a switch in the fabric when that port logs in to the fabric. This property refers to the address given by a switch to the FC interface when the SVM performs a port login (PLOGI).
This is useful for obtaining statistics and diagnostic information from FC switches.
This is a hexadecimal encoded numeric value.Example: 5060F
-
state GET
-
The current operational state of the FC interface. The state is set to down if the interface is not enabled.
If the node hosting the port is down or unavailable, no state value is returned.Valid choices:
- up
- down
-
svm GET POST PATCH
-
The svm field of the fc_interface.
-
uuid GET
-
The unique identifier of the FC interface. Required in the URL.
Example: 1cd8a442-86d1-11e0-ae1c-123478563412
-
wwnn GET
-
The world wide node name (WWNN) of the FC interface SVM. The WWNN is generated by ONTAP when Fibre Channel Protocol or the NVMe service is created for the FC interface SVM.
Example: 20:00:00:50:56:b4:13:01
-
wwpn GET
-
The world wide port name (WWPN) of the FC interface. The WWPN is generated by ONTAP when the FC interface is created.
Example: 20:00:00:50:56:b4:13:a8