'\" t
.\"     Title: ocf_heartbeat_SysInfo
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 12/17/2020
.\"    Manual: OCF resource agents
.\"    Source: resource-agents UNKNOWN
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_SYSINF" "7" "12/17/2020" "resource-agents UNKNOWN" "OCF resource agents"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocf_heartbeat_SysInfo \- Records various node attributes in the CIB
.SH "SYNOPSIS"
.HP \w'\fBSysInfo\fR\ 'u
\fBSysInfo\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
This is a SysInfo Resource Agent\&. It records (in the CIB) various attributes of a node Sample Linux output: arch: i686 os: Linux\-2\&.4\&.26\-gentoo\-r14 free_swap: 1999 cpu_info: Intel(R) Celeron(R) CPU 2\&.40GHz cpu_speed: 4771\&.02 cpu_cores: 1 cpu_load: 0\&.00 ram_total: 513 ram_free: 117 root_free: 2\&.4
.PP
Sample Darwin output: arch: i386 os: Darwin\-8\&.6\&.2 cpu_info: Intel Core Duo cpu_speed: 2\&.16 cpu_cores: 2 cpu_load: 0\&.18 ram_total: 2016 ram_free: 787 root_free: 13
.PP
Units: free_swap: Mb ram_*: Mb root_free: Gb cpu_speed (Linux): bogomips cpu_speed (Darwin): Ghz
.PP
.SH "SUPPORTED PARAMETERS"
.PP
\fBpidfile\fR
.RS 4
PID file
.sp
(optional, string, default "/run/resource\-agents/SysInfo\-RESOURCE_ID")
.RE
.PP
\fBdelay\fR
.RS 4
Interval to allow values to stabilize
.sp
(optional, string, default "0s")
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 20s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 20s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 20s\&. Suggested interval: 60s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 20s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a SysInfo resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_SysInfo ocf:heartbeat:SysInfo \e
  op monitor timeout="20s" interval="60s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a SysInfo resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_SysInfo ocf:heartbeat:SysInfo \e
  op monitor timeout="20s" interval="60s" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\m[blue]\fB\%http://clusterlabs.org/\fR\m[]
.SH "AUTHOR"
.PP
\fBClusterLabs contributors (see the resource agent source for information about individual authors)\fR