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 standard AMQP managed endpoint, not just with
16       qdrouterd.
17

OPTIONS

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

OPERATIONS

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

FILES

127       /usr//usr/share/doc/qpid-dispatch/qdrouter.json
128           Management schema for qdrouterd.
129
130       /usr//usr/share/doc/qpid-dispatch/qdrouter.json.readme.txt
131           Explanation of the management schema.
132

EXAMPLES

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