NetApp Manage ONTAP

APIs in Category: ucm | Cluster-Mode API version 1.21

ucm-adapter-get ucm-adapter-get-iter ucm-adapter-modify | UCM provides a management framework to manage configurations of all Fibre Channel (FC) adapters and Converged Network Adapters (CNA) under Data ONTAP. Some adapters with dual operational modes can be configured into either FC or CNA modes. When configured as a CNA, the adapter can concurrently support Ethernet and Fibre Channel over Ethernet (FCoE). When configured as an FC adapter, the adapter only supports native FC. Not all adapters support both modes. Under FC or FCoE, UCM supports two different functions or FC-4 types: initiator, or target (Fiber Channel Virtual Interface). The initiator type can be used for FC storage loops, FC TapeSAN, and OPR functionality. The target type can be used for SAN attach (FCP/Blocks access) functionality. To modify the configuration of an adapter, use the ucm-adapter-modify API.

ucm-adapter-get | [top]

> Get the attributes of the UC Adapter.

> Input Name | Range | Type | Description
> adapter-name |  | string | Adapter
> desired-attributes |  | uc-adapter-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.
> node-name |  | node-name | Node
> Output Name | Range | Type | Description
> attributes |  | uc-adapter-info | The attributes of the UC Adapter.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

ucm-adapter-get-iter | [top]

> Iterate over a list of UC Adapter objects.

> Input Name | Range | Type | Description
> desired-attributes |  | uc-adapter-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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | uc-adapter-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the UC Adapter object. All UC Adapter 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 |  | uc-adapter-info[] optional | The list of attributes of UC Adapter objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more UC Adapter objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

ucm-adapter-modify | [top]

> Modify configuration of an adapter under the Unified Connect Management (UCM) framework, including the mode and/or the FC-4 type.

> Input Name | Range | Type | Description
> adapter-name |  | string | Slot name of adapter (e.g 0e)
> fc4-type |  | ucm-type optional | Modify the FC-4 type of the adapter. Possible values: "initiator" - change FC-4 type to Initiator "target" - change FC-4 type to Target
> mode |  | ucm-mode optional | Modify the mode of the adapter. Possible values: "fc" - change mode to "Fibre Channel" "cna" - change mode to "CNA"
> node-name |  | node-name optional | The name of the node where the adapter is installed. This is only needed in Cluster-Mode.

> Errno | Description
> EONTAPI_EINVAL |  |
> EINTERNALERROR |  |
> EADAPTERNOTFOUND |  |
> EADAPTERINVALIDTYPE |  |
> ENODENOTFOUND |  |

Element definition: node-name | [top]

> The node's name

> [none]

Element definition: uc-adapter-info | [top]

> Information for one adapter.

> Name | Range | Type | Description
> adapter-name |  | string | The slot name of the adapter (e.g. 0e)
> fc4-type |  | ucm-type | The current FC-4 type of this adapter.
> mode |  | ucm-mode | The current mode of this adapter.
> node-name |  | node-name optional | The name of the node where the adapter is installed. This is only reported in Clustered ONTAP.
> pending-fc4-type |  | ucm-type optional | This is the pending change that has been made to the FC4-type on this adapter, but a controller reboot has not been performed for the change to take effect. A controller reboot is required for any pending changes to take effect. This will not be reported if there is no pending change on this adapter See fc4-type element for possible values.
> pending-mode |  | ucm-mode optional | This is the pending change that has been made to the mode on this adapter, but a controller reboot has not been performed for the change to take effect. A controller reboot is required for any pending changes to take effect. This will not be reported if there is no pending change on this adapter. See the mode element for possible values.
> status |  | string | The status of this adapter. Possible values: "online" "offline" "unsupported"
> supported-fc4-type-for-cna-mode |  | ucm-type[] optional | Return a list of supported FC-4 types for the adapter if configured in cna mode.
> supported-fc4-type-for-fc-mode |  | ucm-type[] optional | Return a list of supported FC-4 types for the adapter if configured in fc mode.
> supported-mode |  | ucm-mode[] | Return a list of supported modes for the specified adapter.

Element definition: ucm-mode | [top]

> The operational mode of the adapter. Possible values: "fc" - Fibre Channel, "cna" - Converged Network Adapter

> [none]

Element definition: ucm-type | [top]

> The FC-4 type of the adapter. Possible values: "initiator" - Initiator mode, "target" - Target mode

> [none]

Element definition: node-name | [top]

> The node's name

> [none]