Module netapp_ontap.resources.port
Copyright © 2019 NetApp Inc. All rights reserved.
Overview
A port is a physical or virtual Ethernet network device. Physical ports may be combined into Link Aggregation Groups (LAGs or ifgrps), or divided into Virtual LANs (VLANs).
The GET (collection), GET (instance) and PATCH APIs are available for all port types. The POST and DELETE APIs are available for "lag" (ifgrp) and "vlan" port types.
Retrieving network port information
The network ports GET API retrieves and displays relevant information pertaining to the ports configured in the cluster. The API retrieves the list of all ports configured in the cluster, or specifically requested ports. The fields returned in the response vary for different ports and configurations.
Examples
Retrieving all ports in the cluster
The following output displays the UUID, name, and port type for all ports configured in a 2-node cluster. The port types are physical, vlan, and lag (ifgrp).
# The API:
/api/network/ethernet/ports
# The call:
curl -X GET "https://<mgmt-ip>/api/network/ethernet/ports?fields=uuid,name,type" -H "accept: application/hal+json"
# The response:
{
"records": [
{
"uuid": "2d2c90c0-f70d-11e8-b145-005056bb5b8e",
"name": "e0a",
"type": "physical",
"_links": {
"self": {
"href": "/api/network/ethernet/ports/2d2c90c0-f70d-11e8-b145-005056bb5b8e"
}
}
},
{
"uuid": "2d3004da-f70d-11e8-b145-005056bb5b8e",
"name": "e0b",
"type": "physical",
"_links": {
"self": {
"href": "/api/network/ethernet/ports/2d3004da-f70d-11e8-b145-005056bb5b8e"
}
}
},
{
"uuid": "2d34a2cb-f70d-11e8-b145-005056bb5b8e",
"name": "e0c",
"type": "physical",
"_links": {
"self": {
"href": "/api/network/ethernet/ports/2d34a2cb-f70d-11e8-b145-005056bb5b8e"
}
}
},
{
"uuid": "2d37189f-f70d-11e8-b145-005056bb5b8e",
"name": "e0d",
"type": "physical",
"_links": {
"self": {
"href": "/api/network/ethernet/ports/2d37189f-f70d-11e8-b145-005056bb5b8e"
}
}
},
{
"uuid": "35de5d8b-f70d-11e8-abdf-005056bb7fc8",
"name": "e0a",
"type": "physical",
"_links": {
"self": {
"href": "/api/network/ethernet/ports/35de5d8b-f70d-11e8-abdf-005056bb7fc8"
}
}
},
{
"uuid": "35de78cc-f70d-11e8-abdf-005056bb7fc8",
"name": "e0b",
"type": "physical",
"_links": {
"self": {
"href": "/api/network/ethernet/ports/35de78cc-f70d-11e8-abdf-005056bb7fc8"
}
}
},
{
"uuid": "35dead3c-f70d-11e8-abdf-005056bb7fc8",
"name": "e0c",
"type": "physical",
"_links": {
"self": {
"href": "/api/network/ethernet/ports/35dead3c-f70d-11e8-abdf-005056bb7fc8"
}
}
},
{
"uuid": "35deda90-f70d-11e8-abdf-005056bb7fc8",
"name": "e0d",
"type": "physical",
"_links": {
"self": {
"href": "/api/network/ethernet/ports/35deda90-f70d-11e8-abdf-005056bb7fc8"
}
}
},
{
"uuid": "42e25145-f97d-11e8-ade9-005056bb7fc8",
"name": "e0c-100",
"type": "vlan",
"_links": {
"self": {
"href": "/api/network/ethernet/ports/42e25145-f97d-11e8-ade9-005056bb7fc8"
}
}
},
{
"uuid": "569e0abd-f97d-11e8-ade9-005056bb7fc8",
"name": "a0a",
"type": "lag",
"_links": {
"self": {
"href": "/api/network/ethernet/ports/569e0abd-f97d-11e8-ade9-005056bb7fc8"
}
}
}
],
"num_records": 10,
"_links": {
"self": {
"href": "/api/network/ethernet/ports?fields=uuid,name,type"
}
}
}
Retrieving a specific physical port
The following output displays the response when a specific physical port is requested. The system returns an error when there is no port with the requested UUID. Also, the speed field is set only if the state of the port is up.
# The API:
/api/network/ethernet/ports/{uuid}
# The call:
curl -X GET "https://<mgmt-ip>/api/network/ethernet/ports/2d37189f-f70d-11e8-b145-005056bb5b8e?fields=*" -H "accept: application/hal+json"
# The response:
{
"uuid": "2d37189f-f70d-11e8-b145-005056bb5b8e",
"name": "e0d",
"mac_address": "00:50:56:bb:62:2d",
"type": "physical",
"node": {
"uuid": "faa56898-f70c-11e8-b145-005056bb5b8e",
"name": "user-cluster-01",
"_links": {
"self": {
"href": "/api/cluster/nodes/faa56898-f70c-11e8-b145-005056bb5b8e"
}
}
},
"broadcast_domain": {
"uuid": "36434bec-f70d-11e8-b145-005056bb5b8e",
"name": "Default",
"ipspace": {
"name": "Default"
},
"_links": {
"self": {
"href": "/api/network/ethernet/broadcast-domains/36434bec-f70d-11e8-b145-005056bb5b8e"
}
}
},
"enabled": true,
"state": "up",
"mtu": 1500,
"speed": "1000",
"_links": {
"self": {
"href": "/api/network/ethernet/ports/2d37189f-f70d-11e8-b145-005056bb5b8e"
}
}
}
Retrieving a specific VLAN port
The following output displays the response when a specific VLAN port is requested. The system returns an error when there is no port with the requested UUID. Also, the speed field is set only if the state of the port is up.
# The API:
/api/network/ethernet/ports/{uuid}
# The call:
curl -X GET "https://<mgmt-ip>/api/network/ethernet/ports/42e25145-f97d-11e8-ade9-005056bb7fc8?fields=*" -H "accept: application/hal+json"
# The response:
{
"uuid": "42e25145-f97d-11e8-ade9-005056bb7fc8",
"name": "e0e-100",
"mac_address": "00:50:56:bb:52:2f",
"type": "vlan",
"node": {
"uuid": "6042cf47-f70c-11e8-abdf-005056bb7fc8",
"name": "user-cluster-02",
"_links": {
"self": {
"href": "/api/cluster/nodes/6042cf47-f70c-11e8-abdf-005056bb7fc8"
}
}
},
"enabled": true,
"state": "up",
"mtu": 1500,
"speed": "1000",
"vlan": {
"tag": 100,
"base_port": {
"uuid": "35deff03-f70d-11e8-abdf-005056bb7fc8",
"name": "e0e",
"node": {
"name": "user-cluster-02"
},
"_links": {
"self": {
"href": "/api/network/ethernet/ports/35deff03-f70d-11e8-abdf-005056bb7fc8"
}
}
}
},
"_links": {
"self": {
"href": "/api/network/ethernet/ports/42e25145-f97d-11e8-ade9-005056bb7fc8"
}
}
}
Retrieving a specific LAG port
The following output displays the response when a specific LAG port is requested. The system returns an error when there is no port with the requested UUID. Also, the speed and lag.active_ports fields are set only if the state of the port is up.
# The API:
/api/network/ethernet/ports/{uuid}
# The call:
curl -X GET "https://<mgmt-ip>/api/network/ethernet/ports/569e0abd-f97d-11e8-ade9-005056bb7fc8?fields=*" -H "accept: application/hal+json"
# The response:
{
"uuid": "569e0abd-f97d-11e8-ade9-005056bb7fc8",
"name": "a0a",
"mac_address": "02:50:56:bb:7f:c8",
"type": "lag",
"node": {
"uuid": "6042cf47-f70c-11e8-abdf-005056bb7fc8",
"name": "user-cluster-02",
"_links": {
"self": {
"href": "/api/cluster/nodes/6042cf47-f70c-11e8-abdf-005056bb7fc8"
}
}
},
"enabled": true,
"state": "up",
"mtu": 1500,
"speed": "1000",
"lag": {
"mode": "singlemode",
"distribution_policy": "mac",
"member_ports": [
{
"uuid": "35df318d-f70d-11e8-abdf-005056bb7fc8",
"name": "e0f",
"node": {
"name": "user-cluster-02"
},
"_links": {
"self": {
"href": "/api/network/ethernet/ports/35df318d-f70d-11e8-abdf-005056bb7fc8"
}
}
},
{
"uuid": "35df5bad-f70d-11e8-abdf-005056bb7fc8",
"name": "e0g",
"node": {
"name": "user-cluster-02"
},
"_links": {
"self": {
"href": "/api/network/ethernet/ports/35df5bad-f70d-11e8-abdf-005056bb7fc8"
}
}
},
{
"uuid": "35df9926-f70d-11e8-abdf-005056bb7fc8",
"name": "e0h",
"node": {
"name": "user-cluster-02"
},
"_links": {
"self": {
"href": "/api/network/ethernet/ports/35df9926-f70d-11e8-abdf-005056bb7fc8"
}
}
}
],
"active_ports": [
{
"uuid": "35df318d-f70d-11e8-abdf-005056bb7fc8",
"name": "e0f",
"_links": {
"self": {
"href": "/api/network/ethernet/ports/35df318d-f70d-11e8-abdf-005056bb7fc8"
}
}
}
]
},
"_links": {
"self": {
"href": "/api/network/ethernet/ports/569e0abd-f97d-11e8-ade9-005056bb7fc8"
}
}
}
Retrieving all LAG (ifgrp) ports in the cluster
This command retrieves all LAG ports in the cluster (that is, all ports with type=LAG). The example shows how to filter a GET collection based on type.
# The API:
/api/network/ethernet/ports
# The call:
curl -X GET "https://<mgmt-ip>/api/network/ethernet/ports?type=lag&node.name=user-cluster-01&fields=name,enabled,speed,mtu" -H "accept: application/hal+json"
# The response:
{
"records": [
{
"uuid": "0c226db0-4b63-11e9-8113-005056bbe040",
"name": "a0b",
"type": "lag",
"node": {
"name": "user-cluster-01"
},
"enabled": true,
"mtu": 1500,
"speed": "1000",
"_links": {
"self": {
"href": "/api/network/ethernet/ports/0c226db0-4b63-11e9-8113-005056bbe040"
}
}
},
{
"uuid": "d3a84153-4b3f-11e9-a00d-005056bbe040",
"name": "a0a",
"type": "lag",
"node": {
"name": "user-cluster-01"
},
"enabled": true,
"mtu": 1500,
"speed": "1000",
"_links": {
"self": {
"href": "/api/network/ethernet/ports/d3a84153-4b3f-11e9-a00d-005056bbe040"
}
}
}
],
"num_records": 2,
"_links": {
"self": {
"href": "/api/network/ethernet/ports?fields=name,enabled,speed,mtu&type=lag&node.name=user-cluster-01"
}
}
}
Creating VLAN and LAG ports
The network ports POST API is used to create VLAN and LAG ports.
Examples
Creating a VLAN port
The following output displays the record returned after the creation of a VLAN port on "e0e" and VLAN tag "100". Also, the VLAN port is added to the "Default" broadcast domain in the "Default" IPspace.
# The API:
/api/network/ethernet/ports
# The call:
curl -X POST "https://<mgmt-ip>/api/network/ethernet/ports?return_records=true" -H "accept: application/hal+json" -H "Content-Type: application/json" -d "{ \"type\": \"vlan\", \"node\": { \"name\": \"user-cluster-01\" }, \"broadcast_domain\": { \"name\": \"Default\", \"ipspace\": { \"name\": \"Default \" } }, \"enabled\": true, \"vlan\": { \"tag\": 100, \"base_port\": { \"name\": \"e0e\", \"node\": { \"name\": \"user-cluster-01\" } } }}"
# The response:
{
"num_records": 1,
"records": [
{
"uuid": "88b2f682-fa42-11e8-a6d7-005056bb5b8e",
"type": "vlan",
"node": {
"uuid": "faa56898-f70c-11e8-b145-005056bb5b8e",
"name": "user-cluster-01",
"_links": {
"self": {
"href": "/api/cluster/nodes/faa56898-f70c-11e8-b145-005056bb5b8e"
}
}
},
"broadcast_domain": {
"uuid": "36434bec-f70d-11e8-b145-005056bb5b8e",
"name": "Default",
"ipspace": {
"name": "Default"
},
"_links": {
"self": {
"href": "/api/network/ethernet/broadcast-domains/36434bec-f70d-11e8-b145-005056bb5b8e"
}
}
},
"enabled": true,
"vlan": {
"tag": 100,
"base_port": {
"uuid": "2d39df72-f70d-11e8-b145-005056bb5b8e",
"name": "e0e",
"node": {
"name": "user-cluster-01"
},
"_links": {
"self": {
"href": "/api/network/ethernet/ports/2d39df72-f70d-11e8-b145-005056bb5b8e"
}
}
}
},
"_links": {
"self": {
"href": "/api/network/ethernet/ports/88b2f682-fa42-11e8-a6d7-005056bb5b8e"
}
}
}
]
}
Creating a LAG (ifgrp) port
The following output displays the record returned after the creation of a LAG port with "e0f", "e0g" and "e0h" as member ports.
# The API:
/api/network/ethernet/ports
# The call:
curl -X POST "https://<mgmt-ip>/api/network/ethernet/ports?return_records=true" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"type\": \"lag\", \"node\": { \"name\": \"user-cluster-01\" }, \"broadcast_domain\": { \"name\": \"Default\", \"ipspace\": { \"name\": \"Default\" } }, \"enabled\": true, \"lag\": { \"mode\": \"singlemode\", \"distribution_policy\": \"mac\", \"member_ports\": [ { \"name\": \"e0f\", \"node\": { \"name\": \"user-cluster-01\" } }, { \"name\": \"e0g\", \"node\": { \"name\": \"user-cluster-01\" }}, { \"name\": \"e0h\", \"node\": { \"name\": \"user-cluster-01\" } } ] } }" -u admin:netapp1! -k
# The response:
{
"num_records": 1,
"records": [
{
"uuid": "1807772a-fa4d-11e8-a6d7-005056bb5b8e",
"type": "lag",
"node": {
"uuid": "faa56898-f70c-11e8-b145-005056bb5b8e",
"name": "user-cluster-01"
},
"broadcast_domain": {
"uuid": "36434bec-f70d-11e8-b145-005056bb5b8e",
"name": "Default",
"ipspace": {
"name": "Default"
}
},
"enabled": true,
"lag": {
"mode": "singlemode",
"distribution_policy": "mac",
"member_ports": [
{
"uuid": "2d3c9adc-f70d-11e8-b145-005056bb5b8e",
"name": "e0f",
"node": {
"name": "user-cluster-01"
}
},
{
"uuid": "2d40b097-f70d-11e8-b145-005056bb5b8e",
"name": "e0g",
"node": {
"name": "user-cluster-01"
}
},
{
"uuid": "2d46d01e-f70d-11e8-b145-005056bb5b8e",
"name": "e0h",
"node": {
"name": "user-cluster-01"
}
}
]
}
}
]
}
Updating ports
The network ports PATCH API is used to modify attributes of ports.
Examples
Updating the broadcast domain of a port
The following PATCH request removes the port from the current broadcast domain and adds it to the specified broadcast domain.
# The API:
/api/network/ethernet/ports/{uuid}
# The call:
curl -X PATCH "https://<mgmt-ip>/api/network/ethernet/ports/6867efaf-d702-11e8-994f-005056bbc994" -H "accept: application/hal+json" -H "Content-Type: application/json" -d "{ \"broadcast_domain\": { \"name\": \"Default\", \"ipspace\": { \"name\": \"Default\" }}}"
Updating the admin status of a port
The following PATCH request brings the specified port down.
# The API:
/api/network/ethernet/ports/{uuid}
# The call:
curl -X PATCH "https://<mgmt-ip>/api/network/ethernet/ports/51d3ab39-d86d-11e8-aca6-005056bbc994" -H "accept: application/hal+json" -H "Content-Type: application/json" -d "{ \"enabled\": \"false\" }"
Deleting ports
The network ports DELETE API is used to delete VLAN and LAG ports in the cluster. Note that physical ports cannot be deleted. Deleting a port also removes the port from the broadcast domain.
Example
Deleting a VLAN port
The network ports DELETE API is used to delete a VLAN port.
# The API:
/api/network/ethernet/ports/{uuid}
# The call:
curl -X DELETE "https://<mgmt-ip>/api/network/ethernet/ports/6867efaf-d702-11e8-994f-005056bbc994" -H "accept: application/hal+json" -H "Content-Type: application/json"
Classes
class Port (*args, **kwargs)
-
Allows interaction with Port 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 delete_collection(*args, connection: HostConnection = None, **kwargs) -> NetAppResponse
-
Deletes a VLAN or LAG (ifgrp).
Related ONTAP commands
network port ifgrp delete
network port vlan 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 a collection of ports (physical, VLAN and LAG) for an entire cluster.
Related ONTAP commands
network port show
network port ifgrp show
network port vlan 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 ports (physical, VLAN and LAG) for an entire cluster.
Related ONTAP commands
network port show
network port ifgrp show
network port vlan 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 a port.
Related ONTAP commands
network port broadcast-domain add-ports
network port broadcast-domain remove-ports
network port ifgrp modify
network port modify
network port vlan 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, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse
-
Deletes a VLAN or LAG (ifgrp).
Related ONTAP commands
network port ifgrp delete
network port vlan 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 the details of a physical port, VLAN, or LAG.
Related ONTAP commands
network port show
network port ifgrp show
network port vlan 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 a port.
Related ONTAP commands
network port broadcast-domain add-ports
network port broadcast-domain remove-ports
network port ifgrp modify
network port modify
network port vlan 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 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 a new VLAN (such as node1:e0a-100) or LAG (ifgrp, such as node2:a0a).
Required properties
node
- Node the port will be created on.broadcast_domain
- Broadcast domain the port is associated with.type
- Defines if a VLAN or LAG will be created:- VLAN
vlan.base_port
- Physical port or LAG the VLAN will be created on.vlan.tag
- Tag used to identify VLAN on the base port.
- LAG
lag.mode
- Policy for the LAG that will be created.lag.distribution_policy
- Indicates how the packets are distributed between ports.lag.member_ports
- Set of ports the LAG consists of.
Related ONTAP commands
network port ifgrp create
network port vlan 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 PortSchema (only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
-
The fields of the Port object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.schema.BaseSchema
- marshmallow.base.SchemaABC
Class variables
var broadcast_domain
-
The broadcast_domain field of the port.
var enabled
-
The enabled field of the port.
var lag
-
The lag field of the port.
var links
-
The links field of the port.
var mac_address
-
The mac_address field of the port.
Example: 01:02:03:04:05:06
var mtu
-
MTU of the port in bytes. Set by broadcast domain.
Example: 1500
var name
-
Portname, such as e0a, e1b-100 (VLAN on ethernet), a0c (LAG/ifgrp), a0d-200 (vlan on LAG/ifgrp)
Example: e1b
var node
-
The node field of the port.
var opts
var speed
-
Link speed in Mbps
Example: 1000
var state
-
Operational state of the port.
Valid choices:
- up
- down
var type
-
Type of physical or virtual port
Valid choices:
- vlan
- physical
- lag
var uuid
-
Port UUID
Example: 1cd8a442-86d1-11e0-ae1c-123478563412
var vlan
-
The vlan field of the port.