Module netapp_ontap.resources.wwpn_alias
Copyright © 2019 NetApp Inc. All rights reserved.
Overview
A world wide port name (WWPN) is a unique 64-bit identifier for a Fibre Channel (FC) initiator. It is displayed as a 16-character hexadecimal value. SAN administrators may find it easier to identify FC initiators using an alias, especially in larger SANs.
The WWPN alias REST API allows you to create, delete, and discover aliases for WWPNs.
Multiple aliases can be created for a WWPN, but you cannot use the same alias for multiple WWPNs.
An alias can consist of up to 32 characters. Valid characters are:
- A through Z
- a through z
- numbers 0 through 9
- hyphen ("-")
- underscore ("_")
- left and right braces ("{", "}")
- period (".")
Examples
Creating a WWPN alias
# The API:
POST /api/network/fc/wwpn-aliases
# The call:
curl -X POST "https://<mgmt-ip>/api/network/fc/wwpn-aliases" -H "accept: application/json" -d '{ "svm": { "name": "svm1" }, "wwpn": "50:0a:09:82:b4:30:25:05", "alias": "alias3" }'
Retrieving all of the properties of all the WWPN aliases
The fields
query parameter is used to request that all properties be returned.
# The API:
GET /api/network/fc/wwpn-aliases
# The call:
curl -X GET "https://<mgmt-ip>/api/network/fc/wwpn-aliases?fields=*" -H "accept: application/hal+json"
# The response:
{
"records": [
{
"svm": {
"uuid": "68589d3d-7efa-11e8-9eed-005056b43025",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/68589d3d-7efa-11e8-9eed-005056b43025"
}
}
},
"alias": "alias1",
"wwpn": "20:00:00:50:56:b4:30:25",
"_links": {
"self": {
"href": "/api/network/fc/wwpn-aliases/68589d3d-7efa-11e8-9eed-005056b43025/alias1"
}
}
},
{
"svm": {
"uuid": "68589d3d-7efa-11e8-9eed-005056b43025",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/68589d3d-7efa-11e8-9eed-005056b43025"
}
}
},
"alias": "alias2",
"wwpn": "50:0a:09:82:b4:30:25:00",
"_links": {
"self": {
"href": "/api/network/fc/wwpn-aliases/68589d3d-7efa-11e8-9eed-005056b43025/alias2"
}
}
}
],
"num_records": 2,
"_links": {
"self": {
"href": "/api/network/fc/wwpn-aliases"
}
}
}
Retrieving all WWPN aliases with the alias "alias1"
The alias
query parameter is used to specify a query for the value "alias1".
# The API:
GET /api/network/fc/wwpn-aliases
# The call:
curl -X GET "https://<mgmt-ip>/api/network/fc/wwpn-aliases?alias=alias1" -H "accept: application/hal+json"
# The response:
{
"records": [
{
"svm": {
"uuid": "68589d3d-7efa-11e8-9eed-005056b43025",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/68589d3d-7efa-11e8-9eed-005056b43025"
}
}
},
"alias": "alias1",
"wwpn": "20:00:00:50:56:b4:30:25",
"_links": {
"self": {
"href": "/api/network/fc/wwpn-aliases/68589d3d-7efa-11e8-9eed-005056b43025/alias1"
}
}
}
],
"num_records": 1,
"_links": {
"self": {
"href": "/api/network/fc/wwpn-aliases?alias=alias1"
}
}
}
Retrieving a specific WWPN alias
The alias to be returned is identified by the UUID of its SVM and the alias name.
# The API:
GET /api/network/fc/wwpn-aliases/{svm.uuid}/{alias}
# The call:
curl -X GET "https://<mgmt-ip>/api/network/fc/wwpn-aliases/68589d3d-7efa-11e8-9eed-005056b43025/alias2" -H "accept: application/hal+json"
# The response:
{
"records": [
{
"svm": {
"uuid": "68589d3d-7efa-11e8-9eed-005056b43025",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/68589d3d-7efa-11e8-9eed-005056b43025"
}
}
},
"alias": "alias2",
"wwpn": "50:0a:09:82:b4:30:25:00",
"_links": {
"self": {
"href": "/api/network/fc/wwpn-aliases/68589d3d-7efa-11e8-9eed-005056b43025/alias1"
}
}
}
],
"num_records": 1,
"_links": {
"self": {
"href": "/api/network/fc/wwpn-aliases?alias=alias1"
}
}
}
Deleting a WWPN alias
The alias to delete is identified by the UUID of its SVM and the alias name.
# The API:
DELETE /api/network/fc/wwpn-aliases/{svm.uuid}/{alias}
# The call:
curl -X DELETE "https://<mgmt-ip>/api/network/fc/wwpn-aliases/68589d3d-7efa-11e8-9eed-005056b43025/alias2" -H "accept: application/hal+json"
Classes
class WwpnAlias (*args, **kwargs)
-
A Fibre Channel (FC) world wide port name (WWPN) alias. A WWPN is a unique 64-bit identifier for an FC initiator. It is displayed as a 16-character hexadecimal value. SAN administrators may find it easier to identify FC initiators using an alias, especially in larger SANs.
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 FC WWPN alias.
Related ONTAP commands
vserver fcp wwpn-alias remove
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 FC WWPN aliases.
Related ONTAP commands
vserver fcp wwpn-alias 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 FC WWPN aliases.
Related ONTAP commands
vserver fcp wwpn-alias 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 delete(self, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse
-
Deletes an FC WWPN alias.
Related ONTAP commands
vserver fcp wwpn-alias remove
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 FC WWPN alias.
Related ONTAP commands
vserver fcp wwpn-alias 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 post(self, hydrate: bool = False, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse
-
Creates an FC WWPN alias.
Required properties
svm.uuid
orsvm.name
- Existing SVM in which to create the FC alias.alias
- Name of the FC alias.wwpn
- FC WWPN for which to create the alias.
Related ONTAP commands
vserver fcp wwpn-alias set
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 WwpnAliasSchema (only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
-
The fields of the WwpnAlias object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.schema.BaseSchema
- marshmallow.base.SchemaABC
Class variables
var alias
-
The FC WWPN alias. Required in POST.
Example: host1
var links
-
The links field of the wwpn_alias.
var opts
var svm
-
The svm field of the wwpn_alias.
var wwpn
-
The FC initiator WWPN. Required in POST.
Example: 2f:a0:00:a0:98:0b:56:13