corosync-objctl(8)

corosync-objctl8

Configure objects in the object database

Usage

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

Overview

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

Releases

3 releases since Debian 6.0 (Squeeze); the text changed 2 times.

  1. 6.0
  2. 7
  3. 8

-b since Debian 7 (Wheezy).

Author

Angus Salkeld

From corosync 1.4.6-1.1 in Debian 8 (Jessie). Parsed by carta from the page's man source.