qdmanage(8)

1QDMANAGE(8)                                                        QDMANAGE(8)
2
3
4

NAME

6       qdmanage - management client to control or query qdrouterd(8)
7

SYNOPSIS

9       qdmanage [OPTIONS] OPERATION [ARGUMENTS]
10

DESCRIPTION

12       An AMQP management client for use with the Dispatch router daemon
13       (qdrouterd). Sends AMQP management operations requests and prints the
14       response in JSON format. This is a generic AMQP management tool and can
15       be used with any AMQP endpoint that follows the AMQP Management
16       specification, not just with qdrouterd.
17

OPTIONS

19       -h, --help : show this help message and exit
20
21       --version : show program’s version number and exit
22
23       -v, --verbose : Show maximum detail
24
25       -r ROUTER-ID, --router ROUTER-ID : Router to be queried
26
27       -d EDGE-ROUTER-ID, --edge-router EDGE-ROUTER-ID : Edge Router to be
28       queried
29
30       --type TYPE : Type of entity to operate on.
31
32       --name NAME : Name of entity to operate on.
33
34       --identity ID : Identity of entity to operate on.
35
36       --indent INDENT : Pretty-printing indent. -1 means don’t pretty-print
37
38       --stdin : Read attributes as JSON map or list of maps from
39
40       --body BODY : JSON value to use as body of a non-standard operation
41
42       --properties PROPERTIES : JSON map to use as properties for a
43       non-standard operation call.
44
45       -b URL, --bus URL : URL of the messaging bus to connect to default
46       0.0.0.0
47
48       -t SECS, --timeout SECS : Maximum time to wait for connection in
49       seconds default 5
50
51       --ssl-certificate CERT : Client SSL certificate (PEM Format)
52
53       --ssl-key KEY : Client SSL private key (PEM Format)
54
55       --ssl-trustfile TRUSTED-CA-DB : Trusted Certificate Authority Database
56       file (PEM Format)
57
58       --ssl-password PASSWORD : Certificate password, will be prompted if not
59       specifed.
60
61       --ssl-password-file SSL-PASSWORD-FILE : Certificate password, will be
62       prompted if not specifed.
63
64       --sasl-mechanisms SASL-MECHANISMS : Allowed sasl mechanisms to be
65       supplied during the sasl handshake.
66
67       --sasl-username SASL-USERNAME : User name for SASL plain authentication
68
69       --sasl-password SASL-PASSWORD : Password for SASL plain authentication
70
71       --sasl-password-file SASL-PASSWORD-FILE : Password for SASL plain
72       authentication
73
74       --ssl-disable-peer-name-verify : Disables SSL peer name verification.
75       WARNING - This option is insecure and must not be used in production
76       environments
77

OPERATIONS

79       query [ATTR...]
80           Print attributes for multiple entities. Prints all entities by
81           default, use --type, --name or --identity options to restrict which
82           entities are printed. Prints the attributes named in the ATTR list,
83           or all attributes if none are listed.
84
85       create [ATTR=VALUE...]
86           Create a new entity with the specified attributes. With the --stdin
87           option, read attributes from stdin. This can be a JSON map of
88           attributes to create a single entity, or a JSON list of maps to
89           create multiple entities.
90
91       read
92           Print all of the attributes of a single entity, specified by the
93           --name or --identity options.
94
95       update [ATTR=VALUE...]
96           Update the attributes of an existing entity. If an ATTR name is
97           listed with no =VALUE, that attribute will be deleted from the
98           entity. With the --stdin option, read attributes from stdin. This
99           can be a JSON map of attributes to update a single entity, or a
100           JSON list of maps to update multiple entities.
101
102       delete
103           Delete an entity specified by the --name or --identity options.
104
105       get-types [TYPE]
106           List entity types with their base types. With no arguments, list
107           all types.
108
109       get-operations [TYPE]
110           List entity types with their operations. With no arguments, list
111           all types.
112
113       get-attributes [TYPE]
114           List entity types with their attributes. With no arguments, list
115           all types.
116
117       get-annotations [TYPE]
118           List entity types with their annotations. With no arguments, list
119           all types.
120
121       get-mgmt-nodes
122           List all other known management nodes connected to this one.
123
124       get-json-schema [INDENT]
125           Get the router schema in JSON format. Optional integer indent for
126           formatted output.
127
128       get-log [INDENT]
129           Get recent log entries from the router.
130

FILES

132       /usr//usr/share/doc/qpid-dispatch/qdrouter.json
133           Management schema for qdrouterd.
134
135       /usr//usr/share/doc/qpid-dispatch/qdrouter.json.readme.txt
136           Explanation of the management schema.
137

EXAMPLES

139       Show the logging configuration:.
140
141           qdmanage query --type=log
142
143       Enable debug and higher log messages by default:.
144
145           qdmanage update name=log/DEFAULT enable=debug+
146
147       Enable trace log messages only for the MESSAGE module, and direct
148       MESSAGE logs to the file test.log:.
149
150           qdmanage update name=log/MESSAGE enable=trace output=test.log
151
152       Set MESSAGE logging back to the default:.
153
154           qdmanage update name=log/MESSAGE enable=default
155
156       Disable MESSAGE logging:.
157
158           qdmanage update name=log/MESSAGE enable=none
159
160