APIs in Category: ic | API version 1.13

ic-config-show ic-get-error-stats ic-get-perf-stats ic-zero-error-stats

NetApp Manage ONTAP

ic-config-show | [top]

> Print HA Interconnect configuration information.

> Output Name | Range | Type | Description
> ic-config-details |  | ic-config-details | HA Interconnect configuration information.

> Errno | Description
> EINTERNALERROR |  |
> ENOPARTNERIFC |  |

ic-get-error-stats | [top]

> Get Interconnect and nvram related statistics and device specific counters

> Input Name | Range | Type | Description
> verbose |  | boolean optional | If set to true the output is detailed.
> Output Name | Range | Type | Description
> active-logical-link |  | integer optional | The current logical link Possilbe values: 0, 1, 2 Range : [0..2^32-1]
> nvram-hardware-error-stats |  | ic-counter[] optional | List of nvram hardware error counters
> nvram-hardware-perf-stats |  | ic-counter[] optional | List of nvram hardware performance counters
> nvram-per-port-counters |  | nvram-per-port-counters-info[] optional | Port counters list for all available ports
> nvram-software-counters |  | ic-counter[] optional | List of basic nvram counters
> peer-connect-stats |  | ic-counter[] | List of basic Rendezvous counters
> per-link-parameters |  | per-link-parameters-info[] optional | Link Parameters list for all available ports
> sfo-connection-state |  | string | Connection state with peer. Possible value: "not connected", "waiting for connected", "waiting for not connected", "connected", "waiting for teardown", "unknown".
> sfo-nic-used |  | integer | The interconnect adapter in use Range : [0..2^32-1]

> Errno | Description
> EINTERNALERROR |  |

ic-get-perf-stats | [top]

> Get Interconnect related performance statistics

> Output Name | Range | Type | Description
> ic-perf-details |  | ic-counter[] | List of Basic IC performance counters
> virtual-interface-socket-stats |  | virtual-interface-socket-stat-info[] | Virtual Interface socket statistics

> Errno | Description
> EINTERNALERROR |  |

ic-zero-error-stats | [top]

> Zeroes out the interconnect error stats

> Errno | Description
> EINTERNALERROR |  |

Element definition: ic-config-details | [top]

> Details on HA configuration

> Name | Range | Type | Description
> ic-rlib-if |  | ic-rlib-if-info[] optional | Interface configuration info for rlib (RDMA, Remote Direct Memory Access library) interconnects.
> ic-system-id |  | ic-system-id-info[] | Per node information.
> interconnect-type |  | string | The type of HA interconnect present. Possible value: "iwarp", "infiniband".
> interface-config |  | interface-config-info[] optional | Interface configuration info only for interfaces used by iWarp.

Element definition: ic-counter | [top]

> IC counters

> Name | Range | Type | Description
> counter-name |  | string | Name of the counter
> counter-value |  | integer | Value of the counter Range : [0..2^64-1]

Element definition: nvram-per-port-counters-info | [top]

> List of port counters for an nvram port

> Name | Range | Type | Description
> counter-list |  | ic-counter[] optional | list of counters for a port.
> port-number |  | integer | Numerical Id of the port. Range : [0..2^32-1]

Element definition: per-link-parameters-info | [top]

> Per link parameters

> Name | Range | Type | Description
> link-number |  | integer | The link id. Range : [0..2^32-1]
> link-state |  | string | State of the link Possible values: "up", "down"
> num-mad-received |  | integer | Number of Management Datagram (MAD) packets received Range : [0..2^32-1]
> num-mad-sent |  | integer | Number of Management Datagram (MAD) packets sent Range : [0..2^32-1]
> num-recv-desc |  | integer | Number of receive descriptors posted Range : [0..2^32-1]
> port-mtu |  | integer | Port Max Transfer Unit Range : [0..2^32-1]
> port-state |  | string | Port state Possible values: "port down", "port initialize", "port armed", "port active"

Element definition: virtual-interface-socket-stat-info | [top]

> Per channel Virtual Interface socket statistics

> Name | Range | Type | Description
> channel-number |  | integer | The channel for which the statistics are being reported Possible values: 0, 1. Range : [0..2^32-1]
> per-channel-counters |  | ic-counter[] | Per channel Virtual Interface socket counters.

Element definition: ic-counter | [top]

> IC counters

> Name | Range | Type | Description
> counter-name |  | string | Name of the counter
> counter-value |  | integer | Value of the counter Range : [0..2^64-1]

Element definition: ic-rlib-if-info | [top]

> Interface information for each rlib interface.

> Name | Range | Type | Description
> interface-ip |  | string | Interface IP Address.
> interface-name |  | string | Name of the interface.

Element definition: ic-system-id-info | [top]

> Per node information.

> Name | Range | Type | Description
> is-connection-initiator |  | boolean | If set to true, the node is the server node with the larger sysid.
> node |  | string | Whether local or partner node.
> system-id |  | integer | System ID of the node. Range : [0..2^64-1]

Element definition: interface-config-info | [top]

> Configuration for one interface.

> Name | Range | Type | Description
> aliases |  | ip-address-info[] optional | List of interface IP aliases.
> flowcontrol |  | string optional | Specifies the flow control type. Possible values: {none | receive | send | full} The meaning of these values is: "none" (no flow control), "receive" (only receive flow control frames), "send" (only send flow control frames), and "full" (send and receive flow control frames). If the flowcontrol option is not specified, the default value is interface-dependent. Fiber Interfaces: If the interface detects that the link partner auto-negotiates, then the operational flow control setting is negotiated (and the configured or default setting for flow control is ignored). Not all interfaces have a flowcontrol (e.g. loopback does not)
> interface-name |  | string | Name of the interface.
> ipspace-name |  | string | Name of ipspace that the interface belongs to.
> is-enabled |  | boolean | Administrative status. (TRUE: interface is administratively up).
> is-nfo-enabled |  | boolean | TRUE: network failover is configured for this interface.
> is-trusted |  | boolean | TRUE: interface is trusted.
> is-wins-enabled |  | boolean | TRUE: interface is advertised to the WINS server.
> mac-address |  | string optional | Interface mac address. Not provided for "lo" or "vh" interfaces.
> mediatype |  | string optional | Specifies the Ethernet media type used. Possible values: {tp | tp-fd | 100tx | 100tx-fd | 1000fx | 10g-sr | auto} 10/100, 100/1000, and 10/100/1000 Mbps Copper Interfaces: The acceptable types (which vary from card to card) are "tp" (Half-duplex 10BaseT RJ-45 twisted-pair), "tp-fd" (Full duplex 10Base-T RJ-45 twisted-pair), "100tx" (Half-duplex 100Base-T RJ-45 twisted-pair), "100tx-fd" (Full duplex 100Base-T RJ-45 twisted-pair), and "auto" (Auto RJ-45 twisted-pair). The default media type is set to "tp" or to "auto" where applicable. 1000 Mbps Fiber Interfaces: The Gigabit Ethernet Controllers only support the mediatype "auto". The Gigabit Ethernet Controllers only support full-duplex. 10G bps Fiber Interfaces: The 10G TOE/Ethernet Controllers support the mediatype "10g-sr" and "auto". The interface does not do auto-negotiatition, it only supports 10Gb speed, full duplex. Not all interfaces have a mediatype (e.g. loopback does not)
> mtusize |  | integer | Maximum Transfer Unit (MTU) of an interface. Range: 296-9196
> partner |  | string optional | Name of CFO partner interface that will failover to this interface.
> primary-address |  | ip-address-info optional | The primary address for this interface

Element definition: ip-address-info | [top]

> A configured IP Address

> Name | Range | Type | Description
> addr-family |  | string | Address family. Possible values: {af-inet6 | af-inet}.
> address |  | ip-address-or-hostname | IP address.
> broadcast |  | ip-address optional | broadcast address. Default if not specified is computed from IP address and netmask. Not used for IPV6. Must be consistent with netmask.
> creator |  | string | Entity responsible for creation of address. Possible values: "filer" if created by d-blade. "vserver: " if created by n-blade with cluster-wide scope.
> netmask |  | netmask optional |
> prefixlen |  | integer optional | address prefix length. Specifies the number of bits of the address starting at the most significant bit. Can be used for both IPV4 and IPV6. (for IPV4 it is equivalent to netmask). Range: IPV4: 1-32. Default is classful. Range: IPV6: 1-128. Default is 64.

Element definition: ip-address | [top]

> One ip address, in dotted-decimal format (for example, "192.168.11.12").

> [none]

Element definition: ip-address-or-hostname | [top]

> IP address string. For example, 198.18.100.12, or "`hostname`-e0c" (backquoted hostname is allowed) or "toaster" (assuming toaster resolves to an IP address)

> [none]

Element definition: netmask | [top]

> netmask. Possible values: dotted decimal or hex integer (range: 0x1 .. 0xffffffff) Default if not specified is classful: Class A address - 255.0.0.0 or 0xff000000 Class B address - 255.255.0.0 or 0xffff0000 Class C address - 255.255.255.0 or 0xffffff00

> [none]