pstorage − tool for controlling and monitoring Parallels Cloud Storage clusters
pstorage [OPTIONS] [COMMAND [COMMAND OPTIONS]]
COMMAND := { make−mds | make−cs | rm−mds | rm−cs | top | ls | rm | *stat | get−event | put−event | get−attr | set−attr | file−info | get−config | set−config | revoke | mds−log−tail | discover | mnt−top | auth−node | load−license | view−license | update−license | make−report | advise−configuration | configure−cs | configure−mds | list−services | locate−disk | help }
pstorage(1) is a cluster control tool. This tool can be used to create and remove MDS/CS services, change cluster parameters, monitor global events, and the overall cluster health.
−c, −−cluster=CLUSTER_NAME
Name of the cluster to connect to (mandatory). A real cluster associated with the name is discovered using DNS or zeroconf (multicast). If the −c option is omitted, the PSTORAGE_NAME environment variable is used.
−q, −−silent
Run the command in silent mode.
−f, −−force
Force the operation.
−v, −−verbose
Increase verbosity.
−t, −−timeout=TIMEOUT
Timeout, in seconds, after which the operation is canceled.
pstorage(1) comes with a number of commands for controlling and monitoring different cluster components. Use the help command to get detailed information about a particular command.
make−mds
Create a MDS repository and configure the MDS daemon. See pstorage−make−mds(1) for more details.
make−cs
Create a CS repository and configure the CS daemon. See pstorage−make−cs(1) for more details.
rm−mds
Remove a metadata server from the cluster. See pstorage−rm−mds(1) for more details.
rm−cs
Remove a chunk server from the cluster. See pstorage−rm−cs(1) for more details.
top
Display a dynamic real−time cluster view. See pstorage−stat(1) for details.
stat
Print cluster statistics. See pstorage−stat(1) for details.
get−event
Query the cluster event log. See pstorage−eventlog(1) for more details.
put−event
Put an event to the cluster event log. See pstorage−eventlog(1) for more details.
get−attr
Print attributes of the specified file/directory. See pstorage−get−attr(1) for more details.
set−attr
Set attributes (e.g., the number of replicas) for the specified file/directory. See pstorage−set−attr(1) for more details.
file−info
Get the file allocation information.
get−config
Get global configuration settings. See pstorage−config(1) for more details.
set−config
Set global configuration settings. See pstorage−config(1) for more details.
revoke
Revoke lease(s) given the file path or the client ID. The command has 2 forms:
• revoke [−p] [−R] path − Revoke lease(s) given the cluster path. Use −p option in case the path is relative to the cluster root. Use −R option to revoke all leases recursively under the particular directory.
• revoke −I client_id − Revoke all leases issued to the particular client.
mds−log−tail
Retrieve the latest debug log messages.
discover
Discover clusters in the default or specified domain using available discovery methods (DNS, zeroconf, etc). More details on discovery can be found at pstorage−discovery(7).
mnt−top
Provide a dynamic real−time statistics for specified mount point.
auth−node
Authenticate this node in cluster if digest authentication in use. This command connects to master, asks password (read password from stdin if option −P specified), and store keys in /etc/pstorage/clusters/CLUSTER_NAME/auth_digest.key file if authentication passed. The −b option can be used to specify IP addresses of the active MDSs if autodiscovery by a cluster name does not work. To change the current password for an existing cluster use −−change−password option.
load−license
Load specified license. The license can be specified by key (−p), as file (−f) or via stdin (−i). Only PCSSTOR licenses are supported.
view−license
Print information about installed or license’s file (or product key) content. The following license statuses are recognized:
• VALID − License is valid and can be installed.
• EXPIRED − Expired license.
• INVALID − Invalid license, It has incorrect version, architecture, platform type, start time in future and etc. This license can’not be used.
• ACTIVE − License installed and used.
• GRACED − Limits of capacity or expiration date for this license exceeded and the graceperiod parameter is not zero.
update−license
Perform update for current license if possible.
ls
Print directory listing. For example the command pstorage −c CLUSTER_NAME ls −p / will print cluster’s root directory content. Use −p option in case the path is relative to the cluster root.
rm
Delete file or directory (which must be empty). Use −p option in case the path is relative to the cluster root.
make−report
Wrapper for pstorage−make−report(1).
advise−configuration
Advise storage configuration.
configure−cs
Change parameters of CS repository.
configure−mds
Change MDS repository parameters. See pstorage−configure−mds(1) for more details.
list−services
Print information about chunk and metadata servers on localhost.
locate−disk
Activate HDD indication using RAID HW LED or other means for a CS specified by id or local path. Remote control is not supported the moment.
help
Print usage for the specified command.
To learn more about a particular command, see its manual pages.
0
Success
Non−zero
Failure (syntax or usage error; configuration error; cluster failure; unexpected error).
Copyright © 2011−2013, Parallels, Inc. All rights reserved.
pstorage−make−cs(1), pstorage−make−mds(1), pstorage−stat(1), pstorage−set−attr(1), pstorage−eventlog(1), pstorage−overview(7), pstorage−discovery(7), pstorage−ssd(7), pstorage−make−report(1), pstorage−mount(1), pstorage−iscsi(7), pstorage−config(1), csd(1), mdsd(1), pstorage−hwflush−check(1), pstorage−config−files(7) pstorage−rm−cs(1) pstorage−rm−mds(1) pstorage−configure−mds(1) pstorage−configure−cs(1)