-
Notifications
You must be signed in to change notification settings - Fork 48
rozo.1
adrenaline edited this page Jan 6, 2014
·
17 revisions
ROZO(1) User Manuals ROZO(1)
NAME
rozo - rozofs management tool
SYNOPSIS
rozo [-d] topic [options] command [options]
rozo -h | --help [topic [action]]
rozo -V | --version
DESCRIPTION
rozo manages a rozofs(7) platform.
General options:
-d, --debug
set debugging on.
-h, --help
display help and exit.
-V, --version
display version information and exit.
AGENT TOPIC
rozo agent status | start | stop | restart
status
rozo agent status
Get rozo agent status for this node.
start
rozo agent start [-p | --pacemaker [resource] ] [-l | --listener [listener...] ]
Start a rozo agent with the given listener list.
-p, --pacemaker [resource]
Use this cluster resource name when exportd(8) is managed thru pacemaker
(default: exportd_rozofs).
-l, --listener [listener...]
List of listener. Must be a subset of {exportd,storaged,rozofsmount}.
stop
rozo agent stop
Stop rozo agent for this node.
restart
rozo agent restart [-p | --pacemaker [resource] ] [-l | --listener [listener...] ]
Stop any running rozo agent then start it with the given listener list.
-p, --pacemaker [resource]
Use this cluster resource name when exportd(8) is managed thru pacemaker
(default: exportd_rozofs).
-l, --listener [listener...]
List of listener. Must be a subset of {exportd,storaged,rozofsmount}.
LAYOUT TOPIC
rozo layout get | set -E | --exportd host
get
rozo layout get -E | --exportd host
Get the storage layout for this platform, see exportd(8),rozofs(7). The layout value
should be 0, 1 or 2.
-E, --exportd host
A running exportd hostname.
set
rozo layout set layout -E | --exportd host
Set the protection configuration for this platform according to the given layout,
see exportd(8), rozofs(7). The layout value must be 0, 1 or 2.
-E, --exportd host
A running exportd hostname.
NODE TOPIC
rozo node list | status | config | start | stop [-r | --roles role...] -E |
--exportd host
list
rozo node list [-r | --roles role...] -E | --exportd host
Display the list of nodes managed by this platform. Nodes are specified with their
roles.
-E, --exportd host
A running exportd hostname.
-r | --roles role...
List of roles. Must be a subset of {exportd,storaged,rozofsmount}. Only nodes
with these roles will be listed. If not set all nodes with all roles will be
displayed.
status
rozo node status [-r | --roles role...] [-n | --nodes node...] -E | --exportd host
Display the list of node managed by this platform. Check the status of nodes and
their associated RozoFS components. Nodes and roles can be set to filter the output.
If none is specified, everything is displayed.
-E, --exportd host
A running exportd hostname.
-r | --roles role...
List of roles. Must be a subset of {exportd,storaged,rozofsmount}. Only nodes
with these roles will be listed. If not set all nodes with all roles will be
displayed.
-n | --nodes node...
List of node hostnames to be displayed. If not set all nodes of the platform
will be displayed.
config
rozo node config [-r | --roles role...] [-n | --nodes node...] -E | --exportd host
Display the list of nodes managed by this platform. Check the status of nodes and
their associated RozoFS components. Nodes and roles can be set to filter the output.
If none is specified, everything is displayed.
-E, --exportd host
A running exportd hostname.
-r | --roles role...
List of roles. Must be a subset of {exportd,storaged,rozofsmount}. Only nodes
with these roles will be listed. If not set all nodes with all roles will be
displayed.
-n | --nodes node...
List of node hostnames to be displayed. If not set all nodes of the platform
will be displayed.
start
rozo node start [-r | --roles role...] [-n | --nodes node...] -E | --exportd host
Start node services.
-E, --exportd host
A running exportd hostname.
-r, --roles role...
List of roles. Must be a subset of {exportd,storaged,rozofsmount}. Only nodes
with these roles will be listed. If not set all nodes with all roles will be
displayed.
-n, --nodes node(s),...
List of node hostnames to be started. If not set all nodes of the platform
will be started.
stop
rozo node stop [-r |--roles role...] [-n | --nodes node...] -E | --exportd host
Stop node services.
-E, --exportd host
A running exportd hostname. -r, --roles role... List of roles. Must be a
subset of {exportd,storaged,rozofsmount}. Only nodes with these roles will be
listed. If not set all nodes with all roles will be displayed.
-n, --nodes node...
List of node hostnames to be stopped. If not set all nodes of the platform
will be stopped.
VOLUME TOPIC
rozo volume list | stat | get | expand | remove -E | --exportd host
list
rozo volume list -E | --exportd host
Display the list of the volumes managed by this platform. Volumes contain clusters
which contain storages.
-E, --exportd host
A running exportd hostname.
stat
rozo volume stat -E | --exportd host
Display statistics about the volumes managed by this platform.
-E, --exportd host
A running exportd hostname.
get
rozo volume get vid... -E | --exportd host
Display statistics about the volume according to the given vid(s).
-E, --exportd host
A running exportd hostname.
expand
rozo volume expand [-v | --vid vid...] node... -E | --exportd host
Expand a volume relying on the given list of storage node hostnames.
-E, --exportd host
A running exportd hostname.
-v, --vid vid...
List of the vid of the volumes to expand. If not set a new volume will be
created.
remove
rozo volume remove -v | --vid vid... -E | --exportd host
Remove a volume according to the given vid list from this platform. Volume can be
removed only if no export is defined on it.
-E, --exportd host
A running exportd hostname.
-v, --vid vid...
List of the vid of the volumes to remove.
EXPORT TOPIC
rozo export list | create | update | remove | get | mount | umount -E | --exportd
host
list
rozo export list -E | --exportd host
Display the list of the exports managed by this platform.
-E, --exportd host
A running exportd hostname.
create
rozo export create vid -E | --exportd host [-n | --name name] [-p | --passwd pass‐
word] [-s | --squota squota] [-a | --hquota hquota]
Export a new filesytem on the given volume by vid.
-E, --exportd host
A running exportd hostname.
-n, --name name
The name to give to the new export. If not set a name will be generated
(export_x).
-p, --passwd passwd
Password to set.
-s, --squota squota
Soft quota to set. (value [K | M | G])
-a, --hquota hquota
Hard quota to set. (value [K | M | G])
update
rozo export update eid -E | --exportd host [-c | --current password] [-p | --passwd
password] [-s | --squota squota] [-a | --hquota hquota]
Update an export according to eid.
-E, --exportd host
A running exportd hostname.
-c, --current passwd
Current password (needed with -p).
-p, --passwd passwd
Password to set.
-s, --squota squota
Soft quota to set. (value [K | M | G])
-a, --hquota hquota
Hard quota to set. (value [K | M | G])
remove
rozo export remove [-f | --force] eid... -E | --exportd host
Remove an export according to eid... Only empty exports will be removed.
-E, --exportd host
A running exportd hostname.
-f, --force
Force removing non empty exports.
mount
rozo export mount -E | --exportd host [-n | --node node...] [-e | --eids eid...] [-o
| --options options...]
Mount export(s) identified by eid... on nodes.
-E, --exportd host
A running exportd hostname.
-n, --nodes node...
List of node hostnames to mount on. If not set exports will be mount on each
node.
-e, --eids eid...
List of export(s) identified by eid... to mount.
-o, --options options...
List of mount option(s) to use.
umount
rozo export umount -E | --exportd host [-n | --node node...] [-e | --eids eid...]
Umount export(s) identified by eid... on nodes.
-E, --exportd node
A running exportd hostname.
-n, --nodes node...
List of node hostnames to umount from. If not set exports will be umount from
each node.
-e, --eids eid...
List of export(s) identified by eid... to umount.
STORAGE TOPIC
rozo storage list | get | add | remove -E | --exportd host
list
rozo storage list -E | --exportd host
Display the list of the storage interface listeners.
-E, --exportd host
A running exportd hostname.
get
rozo storage get node... -E | --exportd host
Get the interface listeners for the given storage node hostnames.
-E, --exportd host
A running exportd hostname.
add
rozo storage add -n | --nodes node... -i | --interface interface -p | --port port -E
| --exportd host
Add an interface listener according to the given interface and
port to the storaged host.
-E, --exportd host
A running exportd hostname.
-n, --nodes node...
The list of running storaged nodes to add the new listener.
-i, --interface interface
Interface to set.
-p, --port port
Port to set.
remove
rozo storage remove -n | --nodes node... -i | --interface interface -p | --port port
-E | --exportd host
Remove an interface listener to the storaged node list according to the given inter‐
face and port.
-E, --exportd host
A running exportd hostname.
-n, --nodes node...
The list of running storaged nodes to add the new listener.
-i, --interface interface
Interface to set.
-p, --port port
Port to set.
REPORTING BUGS
Report bugs to <[email protected]>.
COPYRIGHT
Copyright (c) 2013 Fizians SAS. <http://www.fizians.com>
Rozofs is free software; you can redistribute it and/or modify it under the terms of
the GNU General Public License as published by the Free Software Foundation, version
2.
Rozofs is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this
program. If not, see <http://www.gnu.org/licenses/>.
AUTHOR
Fizians <http://www.fizians.org>
SEE ALSO
rozofs(7), exportd(8), storaged(8) rozofsmount(8)
Rozofs DECEMBER 2013 ROZO(1)