~ubuntu-branches/ubuntu/trusty/cinder/trusty

cinder-manage controls cloud computing instances by managing cinder users, cinder projects, cinder roles, shell selection, vpn connections, and floating IP address configuration. More information about OpenStack Cinder is at http://cinder.openstack.org.

OPTIONS

=======

The standard pattern for executing a cinder-manage command is:

``cinder-manage <category> <command> [<args>]``

For example, to obtain a list of all projects:

``cinder-manage project list``

Run without arguments to see a list of available command categories:

``cinder-manage``

Categories are user, project, role, shell, vpn, and floating. Detailed descriptions are below.

You can also run with a category argument such as user to see a list of all commands in that category:

``cinder-manage user``

These sections describe the available categories and arguments for cinder-manage.

Cinder Db

~~~~~~~

``cinder-manage db version``

Print the current database version.

``cinder-manage db sync``

Sync the database up to the most recent version. This is the standard way to create the db as well.

Cinder User

~~~~~~~~~

``cinder-manage user admin <username>``

Create an admin user with the name <username>.

``cinder-manage user create <username>``

Create a normal user with the name <username>.

``cinder-manage user delete <username>``

Delete the user with the name <username>.

``cinder-manage user exports <username>``

Outputs a list of access key and secret keys for user to the screen

``cinder-manage user list``

Outputs a list of all the user names to the screen.

``cinder-manage user modify <accesskey> <secretkey> <admin?T/F>``

Updates the indicated user keys, indicating with T or F if the user is an admin user. Leave any argument blank if you do not want to update it.

Cinder Project

~~~~~~~~~~~~

``cinder-manage project add <projectname>``

Add a cinder project with the name <projectname> to the database.

``cinder-manage project create <projectname>``

Create a new cinder project with the name <projectname> (you still need to do cinder-manage project add <projectname> to add it to the database).

``cinder-manage project delete <projectname>``

Delete a cinder project with the name <projectname>.

``cinder-manage project environment <projectname> <username>``

100

Exports environment variables for the named project to a file named cinderrc.

101

102

``cinder-manage project list``

103

104

Outputs a list of all the projects to the screen.

105

106

``cinder-manage project quota <projectname>``

107

108

Outputs the size and specs of the project's instances including gigabytes, instances, floating IPs, volumes, and cores.

109

110

``cinder-manage project remove <projectname>``

111

112

Deletes the project with the name <projectname>.

113

114

``cinder-manage project zipfile``

115

116

Compresses all related files for a created project into a zip file cinder.zip.

117

118

Cinder Role

119

~~~~~~~~~

120

121

``cinder-manage role add <username> <rolename> <(optional) projectname>``

122

123

Add a user to either a global or project-based role with the indicated <rolename> assigned to the named user. Role names can be one of the following five roles: cloudadmin, itsec, sysadmin, netadmin, developer. If you add the project name as the last argument then the role is assigned just for that project, otherwise the user is assigned the named role for all projects.

124

125

``cinder-manage role has <username> <projectname>``

126

Checks the user or project and responds with True if the user has a global role with a particular project.

127

128

``cinder-manage role remove <username> <rolename>``

129

Remove the indicated role from the user.

130

131

Cinder Logs

132

~~~~~~~~~

133

134

``cinder-manage logs errors``

135

136

Displays cinder errors from log files.

137

138

``cinder-manage logs syslog <number>``

139

140

Displays cinder alerts from syslog.

141

142

Cinder Shell

143

~~~~~~~~~~

144

145

``cinder-manage shell bpython``

146

147

Starts a new bpython shell.

148

149

``cinder-manage shell ipython``

150

151

Starts a new ipython shell.

152

153

``cinder-manage shell python``

154

155

Starts a new python shell.

156

157

``cinder-manage shell run``

158

159

Starts a new shell using python.

160

161

``cinder-manage shell script <path/scriptname>``

162

163

Runs the named script from the specified path with flags set.

164

165

Cinder VPN

166

~~~~~~~~

167

168

``cinder-manage vpn list``

169

170

Displays a list of projects, their IP prot numbers, and what state they're in.

171

172

``cinder-manage vpn run <projectname>``

173

174

Starts the VPN for the named project.

175

176

``cinder-manage vpn spawn``

177

178

Runs all VPNs.

179

180

Cinder Floating IPs

181

~~~~~~~~~~~~~~~~~

182

183

``cinder-manage floating create <ip_range> [--pool <pool>] [--interface <interface>]``

184

185

Creates floating IP addresses for the given range, optionally specifying

186

a floating pool and a network interface.

187

188

``cinder-manage floating delete <ip_range>``

189

190

Deletes floating IP addresses in the range given.

191

192

``cinder-manage floating list``

193

194

Displays a list of all floating IP addresses.

195

196

Cinder Flavor

197

~~~~~~~~~~~

198

199

``cinder-manage flavor list``

200

201

Outputs a list of all active flavors to the screen.

202

203

``cinder-manage flavor list --all``

204

205

Outputs a list of all flavors (active and inactive) to the screen.

206

207

``cinder-manage flavor create <name> <memory> <vCPU> <local_storage> <flavorID> <(optional) swap> <(optional) RXTX Quota> <(optional) RXTX Cap>``

208

209

creates a flavor with the following positional arguments:

210

* memory (expressed in megabytes)

211

* vcpu(s) (integer)

212

* local storage (expressed in gigabytes)

213

* flavorid (unique integer)

214

* swap space (expressed in megabytes, defaults to zero, optional)

215

* RXTX quotas (expressed in gigabytes, defaults to zero, optional)

216

* RXTX cap (expressed in gigabytes, defaults to zero, optional)

217

218

``cinder-manage flavor delete <name>``

219

220

Delete the flavor with the name <name>. This marks the flavor as inactive and cannot be launched. However, the record stays in the database for archival and billing purposes.

221

222

``cinder-manage flavor delete <name> --purge``

223

224

Purges the flavor with the name <name>. This removes this flavor from the database.

225

226

Cinder Instance_type

227

~~~~~~~~~~~~~~~~~~

228

229

The instance_type command is provided as an alias for the flavor command. All the same subcommands and arguments from cinder-manage flavor can be used.

230

231

Cinder Images

232

~~~~~~~~~~~

233

234

``cinder-manage image image_register <path> <owner>``

235

236

Registers an image with the image service.

237

238

``cinder-manage image kernel_register <path> <owner>``

239

240

Registers a kernel with the image service.

241

242

``cinder-manage image ramdisk_register <path> <owner>``

243

244

Registers a ramdisk with the image service.

245

246

``cinder-manage image all_register <image_path> <kernel_path> <ramdisk_path> <owner>``

247

248

Registers an image kernel and ramdisk with the image service.

249

250

``cinder-manage image convert <directory>``

251

252

Converts all images in directory from the old (Bexar) format to the new format.

253

254

Cinder VM

255

~~~~~~~~~~~

256

257

``cinder-manage vm list [host]``

258

Show a list of all instances. Accepts optional hostname (to show only instances on specific host).

259

260

``cinder-manage live-migration <ec2_id> <destination host name>``

261

Live migrate instance from current host to destination host. Requires instance id (which comes from euca-describe-instance) and destination host name (which can be found from cinder-manage service list).

262

263

264

FILES

265

========

266

267

The cinder-manage.conf file contains configuration information in the form of python-gflags.

268

269