APIs in Category: cf | API version 1.5

cf-force-takeover cf-get-partner cf-giveback cf-negotiated-failover-disable cf-negotiated-failover-enable cf-negotiated-failover-status cf-service-disable cf-service-enable cf-status cf-takeover

NetApp Manage ONTAP

cf-force-takeover | [top]

> Forces one filer to take over its partner even though the filer detects an error that would otherwise prevent a takeover. For example, normally, if a detached or faulty ServerNet cable between the filers causes the filers' NVRAM contents to be unsynchronized, takeover is disabled. However, this will allow the filer to take over its partner despite the unsynchronized NVRAM contents. cf-force-takeover is dangerous and can lead to data corruption; in almost all cases, use cf-takeover instead.

> Input Name | Range | Type | Description
> disaster |  | boolean optional | When set to true, forces a filer to take over its partner in all cases where a force-takeover would. In addition it will force a takeover even if some partner mailbox disks are inaccessible. It can only be used when remotesyncmirror is licensed. This option is very dangerous. Not only can it cause data corruption, if not used carefully, it can also lead to a situation where both the filer and it's partner are operational (split brain). As such, it should only be used as a means of last resort when the takeover and force-takeover operations are unsuccessful in achieving a takeover. The operator must ensure that the partner filer does not become operational at any time while a filer is in a takeover mode initiated by the use of this operation. In conjunction with RAID mirroring, it can allow recovery from a disaster when the two filers in the cluster are located at two distant sites.

> Errno | Description
> EINTERNALERROR |  |

cf-get-partner | [top]

> Get the host name of the partner. If the name is unknown, It will return partner-unknown.

> Output Name | Range | Type | Description
> partner |  | string | Host name of the partner or partner-unknown, if the host name is not known.

> Errno | Description
> EINTERNALERROR |  |

cf-giveback | [top]

> Initiates a giveback of partner resources. Once the giveback is complete, the automatic takeover capability is disabled until the partner is rebooted. A giveback fails if outstanding CIFS sessions, active system dump processes, or other filer operations makes a giveback dangerous or disruptive.

> Input Name | Range | Type | Description
> force |  | boolean optional | When set to true, this allows a giveback to proceed even if there are outstanding CIFS sessions, active system dump processes, or other filer operations makes a giveback dangerous or disruptive as long as it would not result in data corruption or filer error.

> Errno | Description
> EINTERNALERROR |  |

cf-negotiated-failover-disable | [top]

> Disables negotiated failover. disk_shelf is the negotiated failover module currently supported.

> Input Name | Range | Type | Description
> module |  | string | Module currently supported is 'disk_shelf'.

> Errno | Description
> EINTERNALERROR |  |

cf-negotiated-failover-enable | [top]

> Enables negotiated failover. disk_shelf is the negotiated failover module currently supported.

> Input Name | Range | Type | Description
> module |  | string | Module currently supported is 'disk_shelf'.

> Errno | Description
> EINTERNALERROR |  |

cf-negotiated-failover-status | [top]

> Returns the status of the negotiated failover module. Negotiated failover is a general facility which supports negotiated failover on the basis of decisions made by various modules.

> Input Name | Range | Type | Description
> module |  | string | Module currently supported is 'disk_shelf'
> Output Name | Range | Type | Description
> is-enabled |  | boolean | True, if clusterfailover for this module is enabled, false otherwise.

> Errno | Description
> EINTERNALERROR |  |

cf-service-disable | [top]

> Disables the takeover capability of this filer in the cluster.

> Errno | Description
> EINTERNALERROR |  |

cf-service-enable | [top]

> Enables the takeover capability of this filer in the cluster. This spawns a process to enable the service

> Errno | Description
> EINTERNALERROR |  |

cf-status | [top]

> Get useful information about the status of the clustering service. If the monitor is not initialized, this returns an error.

> Output Name | Range | Type | Description
> current-time |  | integer | Current time on the filer
> is-enabled |  | boolean | True, if cluster failover is enabled, false otherwise.
> is-interconnect-up |  | boolean | True, if VIA Interconnect is up
> partner |  | string | Hostname of the partner. If the parner is unknown, returns an empty string.
> state |  | string optional | CONNECTED - Partner is available for takeover TAKEOVER SCHEDULED - Partner is down and takeover is scheduled TAKEOVER STARTED - Takeover process has begun TAKEOVER - Currently controlling partner's resources TAKEN OVER - Partner is controlling filer's resources GIVEBACK STARTED - In process of giving back resources ERROR - There is an error with the system WAITING - Waiting for a connection to partner Generally happens while partner is rebooting. Returns nothing if is-enabled == false.
> time-master-status |  | string optional | host is time "master" or "slave". If master, then other host syncs it's time with this one. If slave, then this host syncs it's time with the other. Nothing is returned if clustering is disabled.
> time-until-takeover |  | integer optional | if state == TAKEOVER SCHEDULED, this is the countdown time until state == TAKEOVER.

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

cf-takeover | [top]

> Initiates a takeover of the partner. Automatic giveback is enabled. Control will be returned to partner once it boots up.

> Input Name | Range | Type | Description
> force |  | boolean optional | This causes takeover to be immediately initiated. The taken over node, if up, does not get to shut things down in an orderly manner so the takeover of the resources takes longer. This is the type of takeover that is done during normal cluster operation when one of the nodes goes away (dies).

> Errno | Description
> EINTERNALERROR |  |