Menu Search

SYNOPSIS

qdmanage [OPTIONS] OPERATION [ARGUMENTS]

DESCRIPTION

An AMQP management client for use with qdrouterd. Sends AMQP management operations requests and prints the response in JSON format. This is a generic AMQP management tool and can be used with any standard AMQP managed endpoint, not just with qdrouter.

OPTIONS

-h, --help : show this help message and exit

--version : Print version and exit.

--type=TYPE : Type of entity to operate on.

--name=NAME : Name of entity to operate on.

--identity=ID : Identity of entity to operate on.

--indent=INDENT : Pretty-printing indent. -1 means don’t pretty-print

--stdin : Read attributes as JSON map or list of maps from

--body=BODY : JSON value to use as body of a non-standard operation

--properties=PROPERTIES : JSON map to use as properties for a non-standard operation call.

Connection Options

-b URL, --bus=URL : URL of the messaging bus to connect to (default

-r ROUTER-ID, --router=ROUTER-ID : Router to be queried

-t SECS, --timeout=SECS : Maximum time to wait for connection in seconds (default 5)

--ssl-certificate=CERT : Client SSL certificate (PEM Format)

--ssl-key=KEY : Client SSL private key (PEM Format)

--ssl-trustfile=TRUSTED-CA-DB : Trusted Certificate Authority Database file (PEM Format)

--ssl-password=PASSWORD : Certificate password, will be prompted if not specifed.

--ssl-password-file=SSL-PASSWORD-FILE : Certificate password, will be prompted if not specifed.

--sasl-mechanisms=SASL-MECHANISMS : Allowed sasl mechanisms to be supplied during the sasl handshake.

--sasl-username=SASL-USERNAME : User name for SASL plain authentication

--sasl-password=SASL-PASSWORD : Password for SASL plain authentication

--sasl-password-file=SASL-PASSWORD-FILE : Password for SASL plain authentication

--ssl-disable-peer-name-verify : Disables SSL peer name verification. WARNING - This option is insecure and must not be used in production environments

OPERATIONS

query [ATTR…]

Print attributes for multiple entities. Prints all entities by default, use --type, --name or --identity options to restrict which entities are printed. Prints the attributes named in the ATTR list, or all attributes if none are listed.

create [ATTR=VALUE…]

Create a new entity with the specified attributes. With the --stdin option, read attributes from stdin. This can be a JSON map of attributes to create a single entity, or a JSON list of maps to create multiple entities.

read

Print all the attributes of a single entity, specified by the --name or --identity options.

update [ATTR=VALUE…]

Update the attributes of an existing entity. If an ATTR name is listed with no =VALUE, that attribute will be deleted from the entity. With the --stdin option, read attributes from stdin. This can be a JSON map of attributes to update a single entity, or a JSON list of maps to update multiple entities.

delete

Delete an entity specified by the --name or --identity options.

get-types [TYPE]

List entity types with their base types. With no arguments list all types.

get-operations [TYPE]

List entity types with their operations. With no arguments list all types.

get-attributes [TYPE]

List entity types with their attributes. With no arguments list all types.

get-annotations [TYPE]

List entity types with their annotations. With no arguments list all types.

get-mgmt-nodes

List all other known management nodes connected to this one.

get-json-schema [INDENT]

Get the router schema in JSON format. Optional integer indent for formatted output.

get-log [INDENT]

Get recent log entries from the router.

FILES

/usr/local/share/doc/qpid-dispatch/qdrouter.json

Management schema for qdrouterd.

/usr/local/share/doc/qpid-dispatch/qdrouter.json.readme.txt

Explanation of the management schema.

EXAMPLES

Show the logging configuration
qdmanage query --type=log
Enable debug and higher log messages by default:
qdmanage update name=log/DEFAULT enable=debug+
Enable trace log messages only for the MESSAGE module and direct MESSAGE logs to the file "test.log"
qdmanage update name=log/MESSAGE enable=trace output=test.log
Set MESSAGE logging back to the default
qdmanage update name=log/MESSAGE enable=default
Disable MESSAGE logging
qdmanage update name=log/MESSAGE enable=none

SEE ALSO

qdrouterd(8), qdstat(8), qdrouterd.conf(5)