.TH "catalog_update" 1 "" "CCTools 8.0.0 DEVELOPMENT" "Cooperative Computing Tools"

.SH NAME
.LP
\fBcatalog_update\fP - send update to catalog server

.SH SYNOPSIS
.LP
\FC\fBcatalog_update [options] [name=value] ..\fP\FT

.SH DESCRIPTION
.LP

.PP
The \FCcatalog_update\FT tool allows users to manually send an update to a
catalog server via a short UDP packet.

.SH OPTIONS
.LP

.LP
.TP
\fB-c\fP, \fB-\-catalog\fP=\fI<host>\fP
.
Send update to this catalog host.
.TP
\fB-f\fP, \fB-\-file\fP=\fI<json-file>\fP
.
 Send additional JSON attributes in this file.
.TP
\fB-d\fP, \fB-\-debug\fP=\fI<flags>\fP
.
 Enable debug flags.
.TP
\fB-o\fP, \fB-\-debug-file\fP=\fI<file>\fP
.
 Send debug output to this file.
.TP
.BI \ -v \ <version>
.
 Show software version.
.TP
.BI \ -h \ <help>
.
 Show all options.

.PP
The \FCcatalog_update\FT tool sends a custom message to the catalog
server in the from of a JSON object with various properties describing
the host.  By default, the \FCcatalog_update\FT tool includes the following
fields in the update:


.IP \(bu 4
\FC\fBtype\fP\FT This describes the node type (default is "node").
.IP \(bu 4
\FC\fBversion\fP\FT This is the version of CCTools.
.IP \(bu 4
\FC\fBcpu\fP\FT This is CPU architecture of the machine.
.IP \(bu 4
\FC\fBopsys\fP\FT This is operating system of the machine.
.IP \(bu 4
\FC\fBopsysversion\fP\FT This is operating system version of the machine.
.IP \(bu 4
\FC\fBload1\fP\FT This is 1-minute load of the machine.
.IP \(bu 4
\FC\fBload5\fP\FT This is 5-minute load of the machine.
.IP \(bu 4
\FC\fBload15\fP\FT This is 15-minute load of the machine.
.IP \(bu 4
\FC\fBmemory_total\fP\FT This is total amount of memory on the machine
.IP \(bu 4
\FC\fBmemory_avail\fP\FT This is amount of available memory on the machine
.IP \(bu 4
\FC\fBcpus\fP\FT This is number of detected CPUs on the machine.
.IP \(bu 4
\FC\fBuptime\fP\FT This how long the machine has been running.
.IP \(bu 4
\FC\fBowner\fP\FT This is user who sent the update.



The field \FCname\FT is intended to give a human-readable name to a service or
application which accepts incoming connections at \FCport\FT.


.SH ENVIRONMENT VARIABLES
.LP


.IP \(bu 4
\FC\fBCATALOG_HOST\fP\FT Hostname of catalog server (same as \FC-c\FT).


.SH EXIT STATUS
.LP
On success, returns zero.  On failure, returns non-zero.

.SH EXAMPLES
.LP
.PP

The following example sends an update to the catalog server located at
\FCcatalog.cse.nd.edu\FT with three custom fields.

.fam C
.nf
.nh
.IP "" 8
% cat > test.json << EOF
{
    "type" : "node",
    "has_java" : true,
    "mode" : 3
}
EOF
% catalog_update -c catalog.cse.nd.edu -f test.json
.fi
.hy
.fam
.P

.SH COPYRIGHT
.LP
The Cooperative Computing Tools are Copyright (C) 2005-2019 The University of Notre Dame.  This software is distributed under the GNU General Public License.  See the file COPYING for details.

.SH SEE ALSO
.LP

.IP \(bu 4
\fBCooperative Computing Tools Documentation\fP
.IP \(bu 4
\fBcatalog_server(1)\fP  \fBcatalog_update(1)\fP  \fBcatalog_query(1)\fP  \fBchirp_status(1)\fP  \fBwork_queue_status(1)\fP   \fBdeltadb_query(1)\fP