client/doc/source/man/escalator.rst

   1 ==============================
   2 :program:`escalator` CLI man page
   3 ==============================
   4
   5 .. program:: escalator
   6 .. highlight:: bash
   7
   8 SYNOPSIS
   9 ========
  10
  11 :program:`escalator` [options] <command> [command-options]
  12
  13 :program:`escalator help`
  14
  15 :program:`escalator help` <command>
  16
  17
  18 DESCRIPTION
  19 ===========
  20
  21 The :program:`escalator` command line utility interacts with OpenStack Images
  22 Service (escalator).
  23
  24 In order to use the CLI, you must provide your OpenStack username, password,
  25 project (historically called tenant), and auth endpoint. You can use
  26 configuration options :option:`--os-username`, :option:`--os-password`,
  27 :option:`--os-tenant-id`, and :option:`--os-auth-url` or set corresponding
  28 environment variables::
  29
  30     export OS_USERNAME=user
  31     export OS_PASSWORD=pass
  32     export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b
  33     export OS_AUTH_URL=http://auth.example.com:5000/v2.0
  34
  35 The command line tool will attempt to reauthenticate using provided
  36 credentials for every request. You can override this behavior by manually
  37 supplying an auth token using :option:`--os-image-url` and
  38 :option:`--os-auth-token` or by setting corresponding environment variables::
  39
  40     export OS_IMAGE_URL=http://escalator.example.org:9292/
  41     export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155
  42
  43
  44 You can select an API version to use by :option:`--os-image-api-version`
  45 option or by setting corresponding environment variable::
  46
  47     export OS_IMAGE_API_VERSION=2
  48
  49 OPTIONS
  50 =======
  51
  52 To get a list of available commands and options run::
  53
  54     escalator help
  55
  56 To get usage and options of a command::
  57
  58     escalator help <command>
  59
  60
  61 EXAMPLES
  62 ========
  63
  64 Get information about image-create command::
  65
  66     escalator help image-create
  67
  68 See available images::
  69
  70     escalator image-list
  71
  72 Create new image::
  73
  74     escalator image-create --name foo --disk-format=qcow2 \
  75                         --container-format=bare --is-public=True \
  76                         --copy-from http://somewhere.net/foo.img
  77
  78 Describe a specific image::
  79
  80     escalator image-show foo
  81
  82
  83 BUGS
  84 ====
  85
  86 escalator client is hosted in Launchpad so you can view current bugs at
  87 https://bugs.launchpad.net/python-escalatorclient/.