|
APIs in Category: fcp |
Vserver API version 1.15 |
| fcp-initiator-get-iter | [top] |
List all initiators connected to FCP target LIFs.
Input Name Range Type Description desired-attributes fcp-adapter-initiators-info
optional
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned. max-records [1..100] integer
optional
The maximum number of records to return in this call. Default: 20 query fcp-adapter-initiators-info
optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the connected FCP initiator object. All connected FCP initiator objects matching this query up to 'max-records' will be returned. tag string
optional
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call. Output Name Range Type Description attributes-list fcp-adapter-initiators-info[]
optional
The list of attributes of connected FCP initiator objects. next-tag string
optional
Tag for the next call. Not present when there are no more connected FCP initiator objects to return. num-records [0..100] integer
The number of records returned in this call.
Errno Description EINTERNALERROR
| fcp-interface-get-iter | [top] |
Iterate over a list of FCP Target Logical Interfaces (LIF).
Input Name Range Type Description desired-attributes fcp-interface-info
optional
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned. max-records [1..100] integer
optional
The maximum number of records to return in this call. Default: 20 query fcp-interface-info
optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the FCP data LIF object. All FCP data LIF objects matching this query up to 'max-records' will be returned. tag string
optional
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call. Output Name Range Type Description attributes-list fcp-interface-info[]
optional
The list of attributes of FCP data LIF objects. next-tag string
optional
Tag for the next call. Not present when there are no more FCP data LIF objects to return. num-records [0..100] integer
The number of records returned in this call.
Errno Description EINTERNALERROR
| fcp-node-get-name | [top] |
Get the current FCP World Wide Node Name (WWNN). This WWNN name is in the form XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit. In Data ONTAP 7-Mode, this is the WWNN of the individual storage system. In "single_image" cfmode, the WWNN of the system and its high availability partner will be the same. In Data ONTAP Cluster-Mode, this is the WWNN of the Vserver FCP Service.
Output Name Range Type Description node-name string
Current FCP World Wide Node Name (WWNN).
Errno Description EINTERNALERROR EOPNOTSUPPORTED
License fcp
| fcp-node-set-name | [top] |
Set the current FCP World Wide Node Name (WWNN). This WWNN is in the form XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit. The supplied WWNN must also match the vendor's registered namespace unless the force argument is also supplied. In Data ONTAP 7-Mode, the registered namespace is "50:0a:80:8X:XX:XX:XX" and all Fibre Channel adapters must be offline. Changes will take place when the adapters are brought online. In Data ONTAP Cluster-Mode, the registered namespace is "2X:XX:00:a0:98:XX:XX:XX" and the FCP service must be offline. Changes will take place when the service is brought online.
Input Name Range Type Description force boolean
optional
If true, allow setting the WWNN to a value outside the vendor's registered namespace for the current mode. If false or not present, the request will fail unless the supplied WWNN is inside the correct namespace. node-name string
FCP World Wide Node Name.
Errno Description EINTERNALERROR EONTAPI_EINVAL EALREADYSTARTED EOPNOTSUPPORTED
License fcp
| fcp-port-name-get-iter | [top] |
Iterate over the list of valid Fibre Channel target port names on a Vserver's FCP LIFs.
Input Name Range Type Description desired-attributes fcp-port-name-info
optional
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned. max-records [1..100] integer
optional
The maximum number of records to return in this call. Default: 20 query fcp-port-name-info
optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the Fibre Channel target port name object. All Fibre Channel target port name objects matching this query up to 'max-records' will be returned. tag string
optional
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call. Output Name Range Type Description attributes-list fcp-port-name-info[]
optional
The list of attributes of Fibre Channel target port name objects. next-tag string
optional
Tag for the next call. Not present when there are no more Fibre Channel target port name objects to return. num-records [0..100] integer
The number of records returned in this call.
Errno Description EINTERNALERROR
| fcp-port-name-set | [top] |
Set a valid but unused port name on a Fibre Channel target interface.
Input Name Range Type Description fcp-adapter string
FCP target interface to set the WWPN on. In Data ONTAP 7-Mode, the name of a local adapter in standby single_image cfmode. In Data ONTAP Cluster-Mode, the name of an FCP data LIF in the vserver. port-name string
WWPN to be set on the interface. It has to be a valid and unused one.
Errno Description EOPNOTSUPPORTED EONTAPI_EINVAL EADAPTERNOTFOUND EADAPTERINVALIDTYPE EINTERNALERROR EALREADYSTARTED
License fcp
| fcp-service-create | [top] |
Create an FCP Service in a Vserver. Each Vserver requires an online FCP Service in order to serve data via the Fibre Channel protocol.
Input Name Range Type Description force-node-name boolean
optional
If true, allow setting the WWNN to a value outside NetApp's registered namespace. If false, the node-name must match the namespace 2X:XX:00:a0:98:XX:XX:XX. The default is false. node-name string
optional
The FCP World Wide Node Name (WWNN) for the FCP service. If not provided, one will be auto-generated. start boolean
optional
Determine the initial state of the FCP Service. If true, the service will be automatically started after creation completes. If false, the service will be left in the stopped state and the caller must subsequently call fcp-service-start to start the service. The default is true. Output Name Range Type Description node-name string
The world-wide node name (WWNN) of the FCP target in the Vserver.
Errno Description EINTERNALERROR
License FCP
| fcp-service-destroy | [top] |
Destroy the FCP Service in a Vserver.
Errno Description EOBJECTNOTFOUND EINTERNALERROR
License FCP
| fcp-service-get-iter | [top] |
Iterate over the list of FCP Services.
Input Name Range Type Description desired-attributes fcp-service-info
optional
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned. max-records [1..100] integer
optional
The maximum number of records to return in this call. Default: 20 query fcp-service-info
optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the FCP Service object. All FCP Service objects matching this query up to 'max-records' will be returned. tag string
optional
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call. Output Name Range Type Description attributes-list fcp-service-info[]
optional
The list of attributes of FCP Service objects. next-tag string
optional
Tag for the next call. Not present when there are no more FCP Service objects to return. num-records [0..100] integer
The number of records returned in this call.
Errno Description EINTERNALERROR
| fcp-service-start | [top] |
Starts FCP service. When FCP service is started, the adapters are brought online. Service will be avaliable once the call returns with success. The adapters however, may not be available immediately after the call, it may take up to a few seconds for the adapters to initialize.
Errno Description EINTERNALERROR EALREADYSTARTED VDISK_ERROR_CFMODE_MISMATCH VDISK_ERROR_PARTNER_NOT_REACHABLE EREVERTINPROGRESS VDISK_ERROR_PARTNER_WWNN_MISMATCH_FOR_SSI
License fcp
| fcp-service-status | [top] |
Get status of the FCP service, whether or not it is running.
Output Name Range Type Description is-available boolean
"true" if FCP service is running, "false" otherwise.
Errno Description EINTERNALERROR
License fcp
| fcp-service-stop | [top] |
Stops FCP service. When FCP service is stopped, the adapters are brought offline. Service will be unavaliable once the call returns with success.
Errno Description EINTERNALERROR ENOTSTARTED
License fcp
| fcp-wwpnalias-get-iter | [top] |
Iterate over the list of assigned World Wide Port Name (WWPN) aliases.
Input Name Range Type Description desired-attributes aliases-info
optional
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned. max-records [1..100] integer
optional
The maximum number of records to return in this call. Default: 20 query aliases-info
optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the WWPN aliases object. All WWPN aliases objects matching this query up to 'max-records' will be returned. tag string
optional
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call. Output Name Range Type Description attributes-list aliases-info[]
optional
The list of attributes of WWPN aliases objects. next-tag string
optional
Tag for the next call. Not present when there are no more WWPN aliases objects to return. num-records [0..100] integer
The number of records returned in this call.
Errno Description EINTERNALERROR
| fcp-wwpnalias-remove | [top] |
Remove an alias for a World Wide Port Name of an initiator. Either the alias or the wwpn argument must be provided.
Input Name Range Type Description alias string
optional
WWPN Alias to be removed. Either the alias or the wwpn argument must be provided. wwpn string
optional
WWPN for which all aliases are to be removed. Either the wwpn or the alias argument must be provided.
Errno Description EVDISK_ERROR_WWPN_ALIAS_NOT_FOUND EVDISK_ERROR_WWPN_NOT_FOUND EVDISK_ERROR_WWPN_ALIAS_REMOVE_INVALID_NUM_ARGS
License fcp
| fcp-wwpnalias-set | [top] |
Set an alias for a World Wide Port Name of an initiator that might login to the target.
Input Name Range Type Description alias string
Alias to be set for the given WWPN ("wwpn"); The alias can be 32-characters long and may contain: A-Z, a-z, 0-9, _,-,.,{,} and no spaces force boolean
optional
When set to true, the WWPN associated with the alias will be over-written. Default value is false. wwpn string
WWPN for which alias is being set
Errno Description EVDISK_ERROR_WWPN_ALIASES_TOO_MANY EVDISK_ERROR_WWPN_ALIAS_INVALID EVDISK_ERROR_NOT_VALID_FC_WWN EVDISK_ERROR_WWPN_ALIAS_ALREADY_SET
License fcp
| Element definition: aliases-info | [top] |
A list of WWPNs and their aliases generated according to the input - alias, WWPN or nothing.
Name Range Type Description aliases-alias string
The 32-character alias for a given FCP WWPN aliases-wwpn string
The FCP WWPN for which the alias is given vserver string
optional
Vserver containing the alias
| Element definition: fcp-adapter-initiators-info | [top] |
A list of initiators currently connected to the FC adapter or FCP data LIF.
Name Range Type Description adapter string
In Data ONTAP 7-Mode, the name of the physical FC adapter. In Data ONTAP Cluser-Mode, the name of the FCP data LIF. fcp-connected-initiators fcp-connected-initiator-info[]
Information about the connected initiators vserver string
optional
Vserver of the FCP LIF.
| Element definition: fcp-interface-info | [top] |
Information about a single FCP Logical Interface (LIF). When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Name Range Type Description current-node string
optional
Node currently hosting the LIF. Attributes: non-creatable, non-modifiable current-port string
optional
FC Adapter currently hosting the LIF. Attributes: non-creatable, non-modifiable interface-name string
optional
Name of the LIF. Attributes: key, required-for-create, non-modifiable node-name string
optional
World Wide Node Name (WWNN) of the LIF. All LIFs in a Vserver have the same WWNN as the Vserver's FCP service. Attributes: non-creatable, non-modifiable port-address string
optional
Host port address of LIF. Attributes: non-creatable, non-modifiable port-name string
optional
World Wide Port Name (WWPN) of the LIF. Attributes: non-creatable, non-modifiable relative-port-id integer
optional
The SCSI Relative Target Port Identifier of the LIF. Attributes: non-creatable, non-modifiable vserver string
optional
Vserver hosting the LIF. Attributes: key, non-creatable, non-modifiable
| Element definition: fcp-port-name-info | [top] |
Information for one valid local port name.
Name Range Type Description fcp-adapter string
optional
Only if this WWPN is being used by a Fibre Channel interface, the name of the interface is returned. In Data ONTAP 7-Mode, the name of a local adapter. In Data ONTAP Cluster-Mode, the name of an FCP data LIF. is-used boolean
This indicates whether this WWPN is being used by a Fibre Channel target interface. port-name string
A Fibre Channel WWPN in the form XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit. vserver string
Vserver containing this port name
| Element definition: fcp-service-info | [top] |
FCP target service configuration. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Name Range Type Description is-available boolean
optional
true if the FCP Service is running, false otherwise. Attributes: non-creatable, non-modifiable node-name string
optional
The world-wide node name (WWNN) of the FCP target in the Vserver. Attributes: optional-for-create, modifiable vserver string
optional
Vserver hosting the FCP service. Attributes: key, non-creatable, non-modifiable
| Element definition: fcp-connected-initiator-info | [top] |
Information about an initiator connected to an FC adapter.
Name Range Type Description initiator-group-list initiator-group-list-info[]
List of initiator groups this initiator belongs to. node-name string
World Wide Node Name (WWNN) of initiator. port-address [0..2^32-1] integer
Fibre Channel host address it is connected to. port-name string
World Wide Port Name (WWPN) of the initiator. portname-alias-list portname-alias-name[]
List of aliases for the WWPN.
| Element definition: initiator-group-list-info | [top] |
Initiator group this initiator belogs to.
Name Range Type Description initiator-group-name string
Name of initiator group.
| Element definition: portname-alias-name | [top] |
Aliases for this WWPN
Name Range Type Description portname-alias string
Alias for the WWPN