Cibadmin (8) Linux Manual Page

Pacemaker – Part of the Pacemaker cluster resource manager

Synopsis

cibadmin command [options] [data]

Description

cibadmin – Provides direct access to the cluster configuration.

Allows the configuration, or sections of it, to be queried, modified, replaced and deleted.

Where necessary, XML data will be obtained using the -X, -x, or -p options.

Options

-?, –help: This text
-$, –version: Version information
-V, –verbose: Increase debug output

Commands:

-u, –upgrade: Upgrade the configuration to the latest syntax
-Q, –query: Query the contents of the CIB
-E, –erase: Erase the contents of the whole CIB
-B, –bump: Increase the CIB’s epoch value by 1
-C, –create: Create an object in the CIB. Will fail if the object already exists.
-M, –modify: Find the object somewhere in the CIB’s XML tree and update it. Fails if the object does not exist unless -c is specified
-P, –patch: Supply an update in the form of an xml diff (See also: crm_diff)
-R, –replace: Recursively replace an object in the CIB
-D, –delete: Delete the first object matching the supplied criteria, Eg. <op id="rsc1_op1" name="monitor"/>; The tagname and all attributes must match in order for the element to be deleted
-d, –delete-all: When used with –xpath, remove all matching objects in the configuration instead of just the first one
-a, –empty: Output an empty CIB
-5, –md5-sum: Calculate the on-disk CIB digest
-6, –md5-sum-versioned: Calculate an on-the-wire versioned CIB digest

Additional options:

-f, –force
-t, –timeout=value: Time (in seconds) to wait before declaring the operation failed
-U, –user=value: Run the command with permissions of the named user (valid only for the root and hacluster accounts)
-s, –sync-call: Wait for call to complete before returning
-l, –local: Command takes effect locally. Should only be used for queries
-c, –allow-create: (Advanced) Allow the target of a –modify,-M operation to be created if they do not exist
-n, –no-children: (Advanced) When querying an object, do not return include its children in the result

Data:

-X, –xml-text=value: Retrieve XML from the supplied string
-x, –xml-file=value: Retrieve XML from the named file
-p, –xml-pipe Retrieve XML from stdin
-o, –scope=value: Limit the scope of the operation to a specific section of the CIB.; Valid values are: nodes, resources, constraints, crm_config, rsc_defaults, op_defaults, status
-A, –xpath=value: A valid XPath to use instead of –scope,-o
-e, –node-path: When performing XPath queries, return the address of any matches found.; Eg: /cib/configuration/resources/master[@id=’ms_RH1_SCS’]/primitive[@id=’prm_RH1_SCS’]
-N, –node=value: (Advanced) Send command to the specified host

Examples

Query the configuration from the local node:

# cibadmin –query –local

Query just the cluster options configuration:

# cibadmin –query –scope crm_config

Query all 'target-role' settings:


# cibadmin --query --xpath "//nvpair[@name='target-role']"
Remove all 'is-managed' settings:


# cibadmin --delete-all --xpath "//nvpair[@name='is-managed']"

Remove the resource named ‘old’:

# cibadmin –delete –xml-text ‘<primitive id="old"/>’

Remove all resources from the configuration:

# cibadmin –replace –scope resources –xml-text ‘<resources/>’

Replace the complete configuration with the contents of $HOME/pacemaker.xml:

# cibadmin –replace –xml-file $HOME/pacemaker.xml

Replace the constraints section of the configuration with the contents of $HOME/constraints.xml:

# cibadmin –replace –scope constraints –xml-file $HOME/constraints.xml

Increase the configuration version to prevent old configurations from being loaded accidentally:

# cibadmin –modify –xml-text ‘<cib admin_epoch="admin_epoch++"/>’

Edit the configuration with your favorite $EDITOR:

# cibadmin –query > $HOME/local.xml

# $EDITOR $HOME/local.xml

# cibadmin –replace –xml-file $HOME/local.xml

Author

Written by Andrew Beekhof

Reporting Bugs

Report bugs to pacemaker [at] oss.clusterlabs.org

cibadmin (8) Linux Manual Page