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

ucm-adapter-list-info 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. 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.

NetApp Manage ONTAP

ucm-adapter-list-info | [top]

> Report configuration for all available adapters under Unified Connect Management (UCM) framework.

> Input Name | Range | Type | Description
> adapter-name |  | string optional | Slot name of adapter (e.g 0e). If no adapter is specified, information is returned for all adapters.
> Output Name | Range | Type | Description
> uc-adapters |  | uc-adapter-info[] optional | List of UC adapters. Nothing will be returned if no adapter is available.

> Errno | Description
> EONTAPI_EINVAL |  |
> EINTERNALERROR |  |
> EADAPTERNOTFOUND |  |
> EOPNOTSUPPORTED |  |

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 | 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 | Modify the mode of the adapter. Possible values: "fc" - change mode to "Fibre Channel" "cna" - change mode to "CNA"

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

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.
> 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 administrative 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]