Callback Functions

Certain objects support some or all of the Callback functions listed below.

Callback Functions allow you to install new callbacks on supported objects by simply doing, for example

>>> Node('democluster').onShutdown.new(...)

rather than having to do

>>> Cluster().callbacks.new(..., event='shutdown', node='democluster', ...)
Callback events can be Global or Local:
  • Global events trigger callbacks on all Nodes on which the callback is installed
  • Local events trigger callbacks on only the nodes on which the events occured

Description

class arcapix.fs.gpfs.callbackable.callbackable
onAfmFilesetExpired

Returns a Callbacks collection, the members of which will be triggered when the contents of a fileset expire. (Global Event)

Supported on: Cluster, Nodeclass, Node, Fileset

onAfmFilesetUnexpired

Returns a Callbacks collection, the members of which will be triggered when the contents of a fileset become unexpired. (Global Event)

Supported on: Cluster, Nodeclass, Node, Fileset

onNodeJoin

Returns a Callbacks collection, the members of which will be triggered when one or more nodes join the cluster. (Global Event)

Supported on: Cluster, Nodeclass, Node

onNodeLeave

Returns a Callbacks collection, the members of which will be triggered when one or more nodes leave the cluster. (Global Event)

Supported on: Cluster, Nodeclass, Node

onQuorumReached

Returns a Callbacks collection, the members of which will be triggered when a quorum has been established in the GPFS cluster. This event is triggered only on the elected cluster manager node, not on all the nodes in the cluster. (Global Event)

Supported on: Cluster, Nodeclass, Node

onQuorumLoss

Returns a Callbacks collection, the members of which will be triggered when a quorum has been lost in the GPFS cluster. (Global Event)

Supported on: Cluster, Nodeclass, Node

onQuorumNodeJoin

Returns a Callbacks collection, the members of which will be triggered when one or more quorum nodes join the cluster. (Global Event)

Supported on: Cluster, Nodeclass, Node

onQuorumNodeLeave

Returns a Callbacks collection, the members of which will be triggered when one or more quorum nodes leave the cluster. (Global Event)

Supported on: Cluster, Nodeclass, Node

onClusterManagerTakeover

Returns a Callbacks collection, the members of which will be triggered when a new cluster manager node has been elected. (Global Event)

Supported on: Cluster, Nodeclass, Node

onAfmHomeConnected

Returns a Callbacks collection, the members of which will be triggered when a gateway node connects to the home NFS server of the fileset that it is serving. (Local Event)

Supported on: Cluster, Nodeclass, Node

onAfmHomeDisconnected

Returns a Callbacks collection, the members of which will be triggered when a gateway node gets disconnected from the home NFS server of the fileset that it is serving. (Local Event)

Supported on: Cluster, Nodeclass, Node

onAfmManualResyncComplete

Returns a Callbacks collection, the members of which will be triggered when a manual resync is completed. (Local Event)

Supported on: Cluster, Nodeclass, Node, Filesystem, Fileset

onAfmPrepopEnd

Returns a Callbacks collection, the members of which will be triggered when all the files specified by a prefetch operation have been cached successfully. (Local Event)

Supported on: Cluster, Nodeclass, Node, Fileset

onAfmRecoveryStart

Returns a Callbacks collection, the members of which will be triggered when AFM recovery starts. (Local Event)

Supported on: Cluster, Nodeclass, Node

onAfmRecoveryEnd

Returns a Callbacks collection, the members of which will be triggered when AFM recovery ends. (Local Event)

Supported on: Cluster, Nodeclass, Node

onDeadlockDetected

Returns a Callbacks collection, the members of which will be triggered when a node detects a potential deadlock. (Local Event)

Supported on: Cluster, Nodeclass, Node

onDeadlockOverload

Returns a Callbacks collection, the members of which will be triggered when a cluster is overloaded on the node detecting the overload condition. (Local Event)

Supported on: Cluster, Nodeclass, Node

onDiskFailure

Returns a Callbacks collection, the members of which will be triggered on the file system manager node when the disk status in the files system changes to down. (Local Event)

Supported on: Cluster, Nodeclass, Node, Filesystem

onFilesetLimitExceeded

Returns a Callbacks collection, the members of which will be triggered when the file system manager detects that a fileset quota has been exceeded. (Local event)

Note

GPFS recommends using the softQuotaExceeded event instead.

Supported on: Cluster, Nodeclass, Node, Fileset

onLowDiskSpace

Returns a Callbacks collection, the members of which will be triggered when the file system manager detects that disk space is running below the low threshold that is specified in the current policy rule. (Local Event)

Note

This event is triggered every two minutes until the condition is solved.

Supported on: Cluster, Nodeclass, Node, Pool

onMmProtocolTraceFileChange

Returns a Callbacks collection, the members of which will be triggered on each CES node to check for required tracing tasks when the trace file is changed within the CCR. Allows traces to be started, stopped, and monitored across a cluster. (Local Event)

Supported on: Cluster, Nodeclass, Node

onNoDiskSpace

Returns a Callbacks collection, the members of which will be triggered when the file system encounters a disk that ran out of space. (Local event)

Note

This event is triggered every two minutes until the condition is solved.

Supported on: Cluster, Nodeclass, Node, Fileset, Pool

onPreMount

Returns a Callbacks collection, the members of which will be triggered when a file system is about to be mounted. (Local Event)

Supported on: Cluster, Nodeclass, Node, Filesystem

onPreUnmount

Returns a Callbacks collection, the members of which will be triggered when a file system is about to be unmounted. (Local Event)

Supported on: Cluster, Nodeclass, Node, Filesystem

onMount

Returns a Callbacks collection, the members of which will be triggered when a file system is mounted successfully. (Local Event)

Supported on: Cluster, Nodeclass, Node, Filesystem

onUnmount

Returns a Callbacks collection, the members of which will be triggered when a file system is unmounted successfully. (Local Event)

Supported on: Cluster, Nodeclass, Node, Filesystem

onPreShutdown

Returns a Callbacks collection, the members of which will be triggered when GPFS detects a failure and is about to shut down. (Local Event)

Supported on: Cluster, Nodeclass, Node

onPreStartup

Returns a Callbacks collection, the members of which will be triggered after the GPFS daemon completes its internal initialization and joins the cluster, but before the node runs recovery for any VFS mount points that were already mounted, and before the node starts accepting user initiated sessions. (Local Event)

Supported on: Cluster, Nodeclass, Node

onSendRequestToNodes

Returns a Callbacks collection, the members of which will be triggered when a node sends a request for collecting expel-related debug data to some nodes. (Local Event)

Supported on: Cluster, Nodeclass, Node

onShutdown

Returns a Callbacks collection, the members of which will be triggered when GPFS completes the shutdown. (Local Event)

Supported on: Cluster, Nodeclass, Node

onSnapshotCreated

Returns a Callbacks collection, the members of which will be triggered after a snapshot is created, and run before the file system is resumed. (Local Event)

Supported on: Cluster, Nodeclass, Node, Filesystem, Fileset

onSoftQuotaExceeded

Returns a Callbacks collection, the members of which will be triggered when the file system manager detects that a soft quota limit (for either files or blocks) has been exceeded. (Local Event)

Supported on: Cluster, Nodeclass, Node, Filesystem, Fileset

onStartup

Returns a Callbacks collection, the members of which will be triggered after a successful GPFS startup and when the node is ready for user initiated sessions. (Local Event)

Supported on: Cluster, Nodeclass, Node

onTiebreakerCheck

Returns a Callbacks collection, the members of which will be triggered when a quorum node detects loss of network connectivity but before GPFS runs the algorithm that decides if the node will remain in the cluster. This event is generated only in configurations that use quorum nodes with tiebreaker disks. (Local Event)

Supported on: Cluster, Nodeclass, Node

onUsageUnderSoftQuota

Returns a Callbacks collection, the members of which will be triggered when the file system manager detects that quota usage has dropped below soft limits and grace time is reset. (Local Event)

Supported on: Cluster, Nodeclass, Node, Filesystem, Fileset

callbacks

Returns a collection of the callbacks that are installed on this object

Return type:Callbacks