| 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
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
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}.
EXPORTD TOPIC¶
rozo exportd layout | option -E | --exportd host...
layout get¶
rozo exportd layout get -E | --exportd host...
- Get the storage layout for this platform, see exportd(8),rozofs(7).
- -E, --exportd host...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
layout set¶
rozo exportd 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...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
option list¶
rozo exportd option list -E | --exportd host
- Display all exportd options and theirs values for the exportd host.
- -E, --exportd host...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
option get¶
rozo exportd option get option -E | --exportd host
- Get the value for a specific option name from the exportd host.
- -E, --exportd host...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
option set¶
rozo exportd option set option value -E | --exportd host
- Set a value for a specific option name for the exportd host.
- -E, --exportd host...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
NODE TOPIC¶
rozo node list | status | config | start | stop | rebuild [-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...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
- -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...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
- -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...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
- -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...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
- -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 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...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
- -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...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
stat¶
rozo volume stat -E | --exportd host...
- Display statistics about the volumes managed by this platform.
- -E, --exportd host...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
get¶
rozo volume get vid... -E | --exportd host...
- Display statistics about the volume according to the given vid(s).
- -E, --exportd host...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
expand¶
rozo volume expand [-v | --vid vid] [-l | --layout layout] [-t | --total device-total] [-m | --mapper device-mapper] [-r | --redundancy device-redundancy] node... -E | --exportd host...
- Expand a volume relying on the given list of storage node hostnames.
- -E, --exportd host...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
- -v, --vid vid
- vid of the volume to expand. If not set a new volume will be created.
- -l, --layout layout
- Specific layout to use. If not set the default layout or the layout of the already defined volume will be used.
- -t, --total device-total
- Specific total number of devices to use for each storage. If not set the default value is 1.
- -m, --mapper device-mapper
- Specific number of device mapper to use for each storage. If not set the default value is 1.
- -r, --redundancy device-redundancy
- Specific number of device redundancy to use for each storage. If not set the default value is 1.
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...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
- -v, --vid vid...
- List of the vid of the volumes to remove.
EXPORT TOPIC¶
rozo export get | create | update | remove -E | --exportd host...
get¶
rozo export get [-e | --eids eid...] -E | --exportd host
- Display the list of export(s) configuration managed by this platform. If option -e | --eids eid... is not specified, all export(s) configuration are displayed.
- -e, --eids eid...
- List of export(s) identified by eid... to display. If not set all export(s) configuration are displayed.
- -E, --exportd host...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
create¶
rozo export create vid -E | --exportd host... [-n | --name name] [-s | --squota squota] [-a | --hquota hquota]
- Export a new filesystem on the given volume by vid.
- -E, --exportd host...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
- -n, --name name
- The name to give to the new export. If not set a name will be generated (export_x).
- -s, --squota squota
- Soft quota to set. (value [K | M | G | T])
- -a, --hquota hquota
- Hard quota to set. (value [K | M | G | T])
update¶
rozo export update eid -E | --exportd host... [-s | --squota squota] [-a | --hquota hquota]
- Update an export according to eid.
- -E, --exportd host...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
- -s, --squota squota
- Soft quota to set. (value [K | M | G | T])
- -a, --hquota hquota
- Hard quota to set. (value [K | M | G | T])
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...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
- -f, --force
- Force removing non empty exports.
MOUNT TOPIC¶
rozo mount create | remove -E | --exportd host...
create¶
rozo mount create -E | --exportd host... [-n | --nodes node...] [-i | --eids eid...] | [-e | --exports export_name...] [-m | --mountpoints mountpoint...] [-o | --options options...]
- Mount export(s) identified by eid... or export_name on nodes.
- -E, --exportd host...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
- -n, --nodes node...
- List of node hostnames to mount on. If not set exports will be mount on each node.
- -i, --eids eid...
- List of export(s) identified by eid... to mount.
- -e, --exports export_name...
- List of export(s) identified by export_name... to mount.
- -m, --mountpoints mountpoint...
- List of mountpoint(s) to use for mount export(s).
- -o, --options options...
- List of mount option(s) to use.
remove¶
rozo mount remove -E | --exportd host... [-n | --nodes node...] [-i | --eids eid...] | [-e | --exports export_name...] | [-m | --mountpoints mountpoint...]
- Unmount export(s) identified by eid..., export_name..., or mountpoint... on nodes.
- -E, --exportd host...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
- -n, --nodes node...
- List of node hostnames to unmount from. If not set exports will be umount from each node.
- -i, --eids eid...
- List of export(s) identified by eid... to unmount.
- -e, --exports export_name...
- List of export(s) identified by export_name... to unmount.
- -m, --mountpoints mountpoint...
- List of mountpoint(s) to unmount.
STORAGED TOPIC¶
rozo storaged listen | option | rebuild -E | --exportd host...
listen get¶
rozo storaged listen get [-n | --nodes node...] -E | --exportd host...
- Display interface listeners for the storaged nodes.
- -n, --nodes node...
- List of storaged nodes hostnames to query. If not set all storaged nodes are queried.
- -E, --exportd host...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
listen add¶
rozo storaged listen add node... -i | --interface interface -p | --port port -E | --exportd host...
- Add an interface listener according to the given interface and port to the storaged node hostname.
- -i, --interface interface
- Interface to set.
- -p, --port port
- Port to set.
- -E, --exportd host...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
listen remove¶
rozo storaged listen remove node... -i | --interface interface -p | --port port -E | --exportd host...
- Remove an interface listener to the storaged node list according to the given interface and port.
- -E, --exportd host...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
- -i, --interface interface
- Interface to set.
- -p, --port port
- Port to set.
option list¶
rozo storaged option list [-n | --nodes node...] -E | --exportd host
- Display all storaged options and theirs values for the storaged nodes.
- -n, --nodes node...
- List of storaged nodes hostnames to query. If not set all storaged nodes are queried.
- -E, --exportd host...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
option get¶
rozo storaged option get option [-n | --nodes node...] -E | --exportd host
- Get the value for a specific option name from the storaged nodes.
- -n, --nodes node...
- List of storaged nodes hostnames to query. If not set all storaged nodes are queried.
- -E, --exportd host...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
option set¶
rozo storaged option set option value [-n | --nodes node...] -E | --exportd host
- Set a value for a specific option name for the storaged nodes.
- -n, --nodes node...
- List of storaged nodes hostnames to set. If not set all storaged nodes are set.
- -E, --exportd host...
- List of running exportd hostname(s). When securing the exportd thanks to a virtual IP address only the VIP address is declared and when no VIP is used, the list of "physical" IP addresses of each host securing the exportd must be given.
ENVIRONMENT VARIABLE¶
- ROZO_EXPORT_HOSTNAME
- Specify default exportd hostname(s) (option: -E | --exportd) using this environment variable . If not set, exportd hostname(s) must be specified with -E | --exportd option.
REPORTING BUGS¶
Report bugs to <bugs@fizians.org>.
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)
| October 2016 | RozoFS |