---
name: "catalog_update"
section: "1"
platform: "linux"
package: "coop-computing-tools"
version: "1:7.14.5-1+b2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/catalog_update"
---

# catalog\_update(1)

send update to catalog server

## NAME

**catalog\_update** - send update to catalog server

## SYNOPSIS

FCcatalog\_update \[options\] \[name=value\] ..FT

## DESCRIPTION

The FCcatalog\_updateFT tool allows users to manually send an update to a catalog server via TCP or UDP.

## OPTIONS

- **-c,--catalog=*\<host\>***

  Send update to this catalog host.

- **-f,--file=*\<json-file\>***

   Send additional JSON attributes in this file.

- **-d,--debug=*\<flags\>***

   Enable debug flags.

- **-o,--debug-file=*\<file\>***

   Send debug output to this file.

- **-v *\<version\>***

   Show software version.

- **-h *\<help\>***

   Show all options.

The FCcatalog\_updateFT 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\_updateFT tool includes the following fields in the update:

- •

  FCtypeFT This describes the node type (default is "node").

- •

  FCversionFT This is the version of CCTools.

- •

  FCcpuFT This is CPU architecture of the machine.

- •

  FCopsysFT This is operating system of the machine.

- •

  FCopsysversionFT This is operating system version of the machine.

- •

  FCload1FT This is 1-minute load of the machine.

- •

  FCload5FT This is 5-minute load of the machine.

- •

  FCload15FT This is 15-minute load of the machine.

- •

  FCmemory\_totalFT This is total amount of memory on the machine

- •

  FCmemory\_availFT This is amount of available memory on the machine

- •

  FCcpusFT This is number of detected CPUs on the machine.

- •

  FCuptimeFT This how long the machine has been running.

- •

  FCownerFT This is user who sent the update.

  The field FCnameFT is intended to give a human-readable name to a service or application which accepts incoming connections at FCportFT.

## ENVIRONMENT VARIABLES

- •

  FCCATALOG\_HOSTFT Hostname of catalog server (same as FC-cFT).

## EXIT STATUS

On success, returns zero.  On failure, returns non-zero.

## EXAMPLES

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

```

```

-

  % cat \> test.json \<\< EOF {\
       "type" : "node",\
       "has\_java" : true,\
       "mode" : 3 } EOF % catalog\_update -c catalog.cse.nd.edu -f test.json

## COPYRIGHT

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

## SEE ALSO

- •

  **Cooperative Computing Tools Documentation**

- •

  **[catalog\_server(1)](/catalog_server/1.md)**  **[catalog\_update(1)](/catalog_update/1.md)**  **[catalog\_query(1)](/catalog_query/1.md)**  **[chirp\_status(1)](/chirp_status/1.md)**  **[work\_queue\_status(1)](/work_queue_status/1.md)**   **[deltadb\_query(1)](/deltadb_query/1.md)**