---
name: "corosync-objctl"
section: "8"
platform: "linux"
package: "corosync"
version: "1.4.6-1.1"
release: "Debian 8 (Jessie)"
platforms: ["linux"]
url: "https://new.carta.tech/corosync-objctl"
---

# corosync-objctl(8)

Configure objects in the Object Database

## NAME

corosync-objctl - Configure objects in the Object Database

## SYNOPSIS

**corosync-objctl \[-b\] \[-c\|-w\|-d\|-a\|-t-h\] \<OBJECT-SPEC\>...**

## DESCRIPTION

**corosync-objctl** is used to configure objects within the object database at runtime.

## OBJECT-SPEC

- There are two types of entities

  **Objects** and **Key=Value pairs**

- **Objects**

  Objects are container like entities that can hold other entities. They are specified as "objectA"."objectB". An example is logging.logger.

- **Key=Value pairs**

  These are the entities that actually hold values (read database "fields"). They are specified as object.key=value or just object.key if you are reading.

## OPTIONS

- **-c**

  Create a new object.

- **-d**

  Delete an existing object.

- **-w**

  Use this option when you want to write a new value to a key.

- **-a**

  Display all values currently available.

- **-t**

  Track changes to an object and it's children. As changes are made to the object they are printed out. this is kind of like a "tail -f" for the object database.

- **-h**

  Print basic usage.

- **-b**

  Display binary values in BASH backslash escape sequences format.

## EXAMPLES

- Print the objOne object (shouldn't exist yet).

  $ corosync-objctl objOne

- Create the objOne object.

  $ corosync-objctl -c objOne

- Print the objOne object (empty).

  $ corosync-objctl objOne\
   objOne

- Write two new keys to the objOne object.

  $ corosync-objctl -w objOne.max=3000 objOne.min=100

- Print the objOne object (with the two new keys).

  $ corosync-objctl objOne\
   objOne.min=100\
   objOne.max=3000

- Delete the objOne.min key

  $ corosync-objctl -d objOne.min=100

- Prove that is gone.

  $ corosync-objctl objOne\
   objOne.max=3000

- Delete the whole objOne object.

  $ corosync-objctl -d objOne

- Prove that is gone.

  $ corosync-objctl objOne

## SEE ALSO

[**confdb\_keys**(8)](/confdb_keys/8.md), [**confdb\_initialize**(3)](/confdb_initialize/3.md)

## AUTHOR

Angus Salkeld