Statistics
| Branch: | Tag: | Revision:

one / share / man / oneflow.1 @ f3d57119

History | View | Annotate | Download (3.6 KB)

1
.\" generated with Ronn/v0.7.3
2
.\" http://github.com/rtomayko/ronn/tree/0.7.3
3
.
4
.TH "ONEFLOW" "1" "August 2015" "" "oneflow(1) -- Manage oneFlow Services"
5
.
6
.SH "NAME"
7
\fBoneflow\fR \- Manage oneFlow Services
8
.
9
.SH "SYNOPSIS"
10
\fBoneflow\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
11
.
12
.SH "OPTIONS"
13
.
14
.nf
15

    
16
 \-j, \-\-json                Print the resource in JSON
17
 \-t, \-\-top                 Top for the command
18
 \-d, \-\-delay x             Sets the delay in seconds for top command
19
 \-f, \-\-force               Force the new cardinality even if it is outside
20
                           the limits
21
 \-p, \-\-period x            Seconds between each group of actions
22
 \-n, \-\-number x            Number of VMs to apply the action to each period
23
 \-s, \-\-server url          Service endpoint
24
 \-u, \-\-username name       User name
25
 \-p, \-\-password pass       User password
26
 \-V, \-\-version             Show version and copyright information
27
 \-h, \-\-help                Show this message
28
.
29
.fi
30
.
31
.SH "COMMANDS"
32
.
33
.IP "\(bu" 4
34
list List the available services valid options: json
35
.
36
.IP "\(bu" 4
37
show \fIservice_id\fR Show detailed information of a given service valid options: json
38
.
39
.IP "\(bu" 4
40
top [\fIservice_id\fR] Top the services or the extended information of the target service if a id is specified valid options: json, top, delay
41
.
42
.IP "\(bu" 4
43
delete \fIrange|service_id_list\fR Delete a given service
44
.
45
.IP "\(bu" 4
46
shutdown \fIrange|service_id_list\fR Shutdown a service\. From RUNNING or WARNING shuts down the Service
47
.
48
.IP "\(bu" 4
49
recover \fIrange|service_id_list\fR Recover a failed service, cleaning the failed VMs\. From FAILED_DEPLOYING continues deploying the Service From FAILED_SCALING continues scaling the Service From FAILED_UNDEPLOYING continues shutting down the Service From COOLDOWN the Service is set to running ignoring the cooldown duration From WARNING failed VMs are deleted, and new VMs are instantiated
50
.
51
.IP "\(bu" 4
52
scale \fIservice_id\fR \fIrole_name\fR \fIcardinality\fR Scale a role to the given cardinality valid options: force
53
.
54
.IP "\(bu" 4
55
chgrp \fIrange|service_id_list\fR \fIgroupid\fR Changes the service group
56
.
57
.IP "\(bu" 4
58
chown \fIrange|service_id_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the service owner and group
59
.
60
.IP "\(bu" 4
61
chmod \fIrange|service_id_list\fR \fIoctet\fR Changes the service permissions
62
.
63
.IP "\(bu" 4
64
action \fIservice_id\fR \fIrole_name\fR \fIvm_action\fR Perform an action on all the Virtual Machines of a given role\. Actions supported: shutdown,shutdown\-hard,undeploy,undeploy\-hard,hold,release,stop,suspend,resume,delete,delete\-recreate,reboot,reboot\-hard,poweroff,poweroff\-hard,snapshot\-create valid options: period, number
65
.
66
.IP "" 0
67
.
68
.SH "ARGUMENT FORMATS"
69
.
70
.IP "\(bu" 4
71
file Path to a file
72
.
73
.IP "\(bu" 4
74
range List of id\'s in the form 1,8\.\.15
75
.
76
.IP "\(bu" 4
77
text String
78
.
79
.IP "\(bu" 4
80
groupid OpenNebula GROUP name or id
81
.
82
.IP "\(bu" 4
83
userid OpenNebula USER name or id
84
.
85
.IP "\(bu" 4
86
service_id OpenNebula SERVICE name or id
87
.
88
.IP "\(bu" 4
89
service_id_list Comma\-separated list of OpenNebula SERVICE names or ids
90
.
91
.IP "\(bu" 4
92
vm_action Actions supported: shutdown, shutdown\-hard, undeploy, undeploy\-hard, hold, release, stop, suspend, resume, delete, delete\-recreate, reboot, reboot\-hard, poweroff, poweroff\-hard, snapshot\-create
93
.
94
.IP "" 0
95
.
96
.SH "LICENSE"
97
OpenNebula 4\.13\.80 Copyright 2002\-2015, OpenNebula Project (OpenNebula\.org), C12G Labs
98
.
99
.P
100
Licensed under the Apache License, Version 2\.0 (the "License"); you may not use this file except in compliance with the License\. You may obtain a copy of the License at http://www\.apache\.org/licenses/LICENSE\-2\.0