1303
Red Hat OpenStack Platform 13 Command Line Interface Reference Command-line clients for Red Hat OpenStack Platform Last Updated: 2019-06-25

Red Hat OpenStack Platform 13...Command Line Interface Reference Command-line clients for Red Hat OpenStack Platform Last Updated: 2019-06-25 ... C A T R B R MET L 11.1. BAREMETAL

  • Upload
    others

  • View
    46

  • Download
    0

Embed Size (px)

Citation preview

  • Red Hat OpenStack Platform 13

    Command Line Interface Reference

    Command-line clients for Red Hat OpenStack Platform

    Last Updated: 2019-06-25

  • Red Hat OpenStack Platform 13 Command Line Interface Reference

    Command-line clients for Red Hat OpenStack Platform

    OpenStack Documentation [email protected]

  • Legal Notice

    Copyright © 2019 Red Hat, Inc.

    The text of and illustrations in this document are licensed by Red Hat under a Creative CommonsAttribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA isavailable athttp://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you mustprovide the URL for the original version.

    Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert,Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

    Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift,Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United Statesand other countries.

    Linux ® is the registered trademark of Linus Torvalds in the United States and other countries.

    Java ® is a registered trademark of Oracle and/or its affiliates.

    XFS ® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United Statesand/or other countries.

    MySQL ® is a registered trademark of MySQL AB in the United States, the European Union andother countries.

    Node.js ® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by theofficial Joyent Node.js open source or commercial project.

    The OpenStack ® Word Mark and OpenStack logo are either registered trademarks/service marksor trademarks/service marks of the OpenStack Foundation, in the United States and othercountries and are used with the OpenStack Foundation's permission. We are not affiliated with,endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

    All other trademarks are the property of their respective owners.

    Abstract

    A reference to the commands available to the unified OpenStack command-line client.

  • . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    Table of Contents

    PREFACE

    CHAPTER 1. THE OPENSTACK CLIENT1.1. OPENSTACK

    CHAPTER 2. ACL2.1. ACL DELETE2.2. ACL GET2.3. ACL SUBMIT2.4. ACL USER ADD2.5. ACL USER REMOVE

    CHAPTER 3. ACTION3.1. ACTION DEFINITION CREATE3.2. ACTION DEFINITION DEFINITION SHOW3.3. ACTION DEFINITION DELETE3.4. ACTION DEFINITION LIST3.5. ACTION DEFINITION SHOW3.6. ACTION DEFINITION UPDATE3.7. ACTION EXECUTION DELETE3.8. ACTION EXECUTION INPUT SHOW3.9. ACTION EXECUTION LIST3.10. ACTION EXECUTION OUTPUT SHOW3.11. ACTION EXECUTION RUN3.12. ACTION EXECUTION SHOW3.13. ACTION EXECUTION UPDATE

    CHAPTER 4. ADDRESS4.1. ADDRESS SCOPE CREATE4.2. ADDRESS SCOPE DELETE4.3. ADDRESS SCOPE LIST4.4. ADDRESS SCOPE SET4.5. ADDRESS SCOPE SHOW

    CHAPTER 5. AGGREGATE5.1. AGGREGATE ADD HOST5.2. AGGREGATE CREATE5.3. AGGREGATE DELETE5.4. AGGREGATE LIST5.5. AGGREGATE REMOVE HOST5.6. AGGREGATE SET5.7. AGGREGATE SHOW5.8. AGGREGATE UNSET

    CHAPTER 6. ALARM6.1. ALARM CREATE6.2. ALARM DELETE6.3. ALARM LIST6.4. ALARM SHOW6.5. ALARM STATE GET6.6. ALARM STATE SET6.7. ALARM UPDATE6.8. ALARM HISTORY SEARCH

    24

    2525

    3838383941

    43

    4545464747485051525254545657

    606061

    626364

    666667686970727274

    757578798082838589

    Table of Contents

    1

  • . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    6.9. ALARM HISTORY SHOW

    CHAPTER 7. ALARMING7.1. ALARMING CAPABILITIES LIST

    CHAPTER 8. AVAILABILITY8.1. AVAILABILITY ZONE LIST

    CHAPTER 9. BAREMETAL9.1. BAREMETAL CHASSIS CREATE9.2. BAREMETAL CHASSIS DELETE9.3. BAREMETAL CHASSIS LIST9.4. BAREMETAL CHASSIS SET9.5. BAREMETAL CHASSIS SHOW9.6. BAREMETAL CHASSIS UNSET9.7. BAREMETAL CREATE9.8. BAREMETAL DRIVER LIST9.9. BAREMETAL DRIVER PASSTHRU CALL9.10. BAREMETAL DRIVER PASSTHRU LIST9.11. BAREMETAL DRIVER PROPERTY LIST9.12. BAREMETAL DRIVER RAID PROPERTY LIST9.13. BAREMETAL DRIVER SHOW9.14. BAREMETAL INTROSPECTION ABORT9.15. BAREMETAL INTROSPECTION DATA SAVE9.16. BAREMETAL INTROSPECTION INTERFACE LIST9.17. BAREMETAL INTROSPECTION INTERFACE SHOW9.18. BAREMETAL INTROSPECTION LIST9.19. BAREMETAL INTROSPECTION REPROCESS9.20. BAREMETAL INTROSPECTION RULE DELETE9.21. BAREMETAL INTROSPECTION RULE IMPORT9.22. BAREMETAL INTROSPECTION RULE LIST9.23. BAREMETAL INTROSPECTION RULE PURGE9.24. BAREMETAL INTROSPECTION RULE SHOW9.25. BAREMETAL INTROSPECTION START9.26. BAREMETAL INTROSPECTION STATUS9.27. BAREMETAL NODE ABORT9.28. BAREMETAL NODE ADD TRAIT9.29. BAREMETAL NODE ADOPT9.30. BAREMETAL NODE BOOT DEVICE SET9.31. BAREMETAL NODE BOOT DEVICE SHOW9.32. BAREMETAL NODE CLEAN9.33. BAREMETAL NODE CONSOLE DISABLE9.34. BAREMETAL NODE CONSOLE ENABLE9.35. BAREMETAL NODE CONSOLE SHOW9.36. BAREMETAL NODE CREATE9.37. BAREMETAL NODE DELETE9.38. BAREMETAL NODE DEPLOY9.39. BAREMETAL NODE INJECT NMI9.40. BAREMETAL NODE INSPECT9.41. BAREMETAL NODE LIST9.42. BAREMETAL NODE MAINTENANCE SET9.43. BAREMETAL NODE MAINTENANCE UNSET9.44. BAREMETAL NODE MANAGE9.45. BAREMETAL NODE PASSTHRU CALL

    90

    9393

    9595

    97979898

    100101102103103105106108109

    111112113113115116118118119

    120121122123125126127127128128130131131131

    133136136137137138140141141

    142

    Red Hat OpenStack Platform 13 Command Line Interface Reference

    2

  • . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    9.46. BAREMETAL NODE PASSTHRU LIST9.47. BAREMETAL NODE POWER OFF9.48. BAREMETAL NODE POWER ON9.49. BAREMETAL NODE PROVIDE9.50. BAREMETAL NODE REBOOT

    CHAPTER 10. CA10.1. CA GET

    CHAPTER 11. BAREMETAL11.1. BAREMETAL NODE REBUILD11.2. BAREMETAL NODE REMOVE TRAIT11.3. BAREMETAL NODE SET11.4. BAREMETAL NODE SHOW11.5. BAREMETAL NODE TRAIT LIST11.6. BAREMETAL NODE UNDEPLOY11.7. BAREMETAL NODE UNSET11.8. BAREMETAL NODE VALIDATE11.9. BAREMETAL NODE VIF ATTACH11.10. BAREMETAL NODE VIF DETACH11.11. BAREMETAL NODE VIF LIST11.12. BAREMETAL PORT CREATE11.13. BAREMETAL PORT DELETE11.14. BAREMETAL PORT GROUP CREATE11.15. BAREMETAL PORT GROUP DELETE11.16. BAREMETAL PORT GROUP LIST11.17. BAREMETAL PORT GROUP SET11.18. BAREMETAL PORT GROUP SHOW11.19. BAREMETAL PORT GROUP UNSET11.20. BAREMETAL PORT LIST11.21. BAREMETAL PORT SET11.22. BAREMETAL PORT SHOW11.23. BAREMETAL PORT UNSET11.24. BAREMETAL VOLUME CONNECTOR CREATE11.25. BAREMETAL VOLUME CONNECTOR DELETE11.26. BAREMETAL VOLUME CONNECTOR LIST11.27. BAREMETAL VOLUME CONNECTOR SET11.28. BAREMETAL VOLUME CONNECTOR SHOW11.29. BAREMETAL VOLUME CONNECTOR UNSET11.30. BAREMETAL VOLUME TARGET CREATE11.31. BAREMETAL VOLUME TARGET DELETE11.32. BAREMETAL VOLUME TARGET LIST11.33. BAREMETAL VOLUME TARGET SET11.34. BAREMETAL VOLUME TARGET SHOW11.35. BAREMETAL VOLUME TARGET UNSET

    CHAPTER 12. BGP12.1. BGP DRAGENT ADD SPEAKER12.2. BGP DRAGENT REMOVE SPEAKER12.3. BGP PEER CREATE12.4. BGP PEER DELETE12.5. BGP PEER LIST12.6. BGP PEER SET12.7. BGP PEER SHOW

    142144145145146

    147147

    149149149150152153155155157159159160161

    163164166166168169171171

    173174176177178179181

    182183184185186188189190

    192192192193194195196197

    Table of Contents

    3

  • . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    12.8. BGP SPEAKER ADD NETWORK12.9. BGP SPEAKER ADD PEER12.10. BGP SPEAKER CREATE12.11. BGP SPEAKER DELETE12.12. BGP SPEAKER LIST12.13. BGP SPEAKER LIST ADVERTISED ROUTES12.14. BGP SPEAKER REMOVE NETWORK12.15. BGP SPEAKER REMOVE PEER12.16. BGP SPEAKER SET12.17. BGP SPEAKER SHOW12.18. BGP SPEAKER SHOW DRAGENTS

    CHAPTER 13. BGPVPN13.1. BGPVPN CREATE13.2. BGPVPN DELETE13.3. BGPVPN LIST13.4. BGPVPN NETWORK ASSOCIATION CREATE13.5. BGPVPN NETWORK ASSOCIATION DELETE13.6. BGPVPN NETWORK ASSOCIATION LIST13.7. BGPVPN NETWORK ASSOCIATION SHOW13.8. BGPVPN PORT ASSOCIATION CREATE13.9. BGPVPN PORT ASSOCIATION DELETE13.10. BGPVPN PORT ASSOCIATION LIST13.11. BGPVPN PORT ASSOCIATION SET13.12. BGPVPN PORT ASSOCIATION SHOW13.13. BGPVPN PORT ASSOCIATION UNSET13.14. BGPVPN ROUTER ASSOCIATION CREATE13.15. BGPVPN ROUTER ASSOCIATION DELETE13.16. BGPVPN ROUTER ASSOCIATION LIST13.17. BGPVPN ROUTER ASSOCIATION SHOW13.18. BGPVPN SET13.19. BGPVPN SHOW13.20. BGPVPN UNSET

    CHAPTER 14. CA14.1. CA LIST

    CHAPTER 15. CATALOG15.1. CATALOG LIST15.2. CATALOG SHOW

    CHAPTER 16. COE16.1. COE CA ROTATE16.2. COE CA SHOW16.3. COE CA SIGN16.4. COE CLUSTER CONFIG16.5. COE CLUSTER CREATE16.6. COE CLUSTER DELETE16.7. COE CLUSTER LIST16.8. COE CLUSTER SHOW16.9. COE CLUSTER TEMPLATE CREATE16.10. COE CLUSTER TEMPLATE DELETE16.11. COE CLUSTER TEMPLATE LIST16.12. COE CLUSTER TEMPLATE SHOW

    198199199201

    202203205205206207208

    210210211212214215216217219221221

    223224225226228229230232233234

    236236

    238238239

    241241241242242243244244246247250251

    252

    Red Hat OpenStack Platform 13 Command Line Interface Reference

    4

  • . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    16.13. COE CLUSTER TEMPLATE UPDATE16.14. COE CLUSTER UPDATE16.15. COE QUOTAS CREATE16.16. COE QUOTAS DELETE16.17. COE QUOTAS LIST16.18. COE QUOTAS SHOW16.19. COE QUOTAS UPDATE16.20. COE SERVICE LIST16.21. COE STATS LIST

    CHAPTER 17. COMMAND17.1. COMMAND LIST

    CHAPTER 18. COMPLETE.ADOC18.1. COMPLETE

    CHAPTER 19. COMPUTE19.1. COMPUTE AGENT CREATE19.2. COMPUTE AGENT DELETE19.3. COMPUTE AGENT LIST19.4. COMPUTE AGENT SET19.5. COMPUTE SERVICE DELETE19.6. COMPUTE SERVICE LIST19.7. COMPUTE SERVICE SET

    CHAPTER 20. CONFIGURATION20.1. CONFIGURATION SHOW

    CHAPTER 21. CONSISTENCY21.1. CONSISTENCY GROUP ADD VOLUME21.2. CONSISTENCY GROUP CREATE21.3. CONSISTENCY GROUP DELETE21.4. CONSISTENCY GROUP LIST21.5. CONSISTENCY GROUP REMOVE VOLUME21.6. CONSISTENCY GROUP SET21.7. CONSISTENCY GROUP SHOW21.8. CONSISTENCY GROUP SNAPSHOT CREATE21.9. CONSISTENCY GROUP SNAPSHOT DELETE21.10. CONSISTENCY GROUP SNAPSHOT LIST21.11. CONSISTENCY GROUP SNAPSHOT SHOW

    CHAPTER 22. CONSOLE22.1. CONSOLE LOG SHOW22.2. CONSOLE URL SHOW

    CHAPTER 23. CONTAINER23.1. CONTAINER CREATE23.2. CONTAINER DELETE23.3. CONTAINER LIST23.4. CONTAINER SAVE23.5. CONTAINER SET23.6. CONTAINER SHOW23.7. CONTAINER UNSET

    CHAPTER 24. CRON

    254255256256257258258258260

    261261

    263263

    264264265266267267268269

    271271

    273273273275275277277278279281281283

    285285285

    288288289290291292292293

    295

    Table of Contents

    5

  • . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    24.1. CRON TRIGGER CREATE24.2. CRON TRIGGER DELETE24.3. CRON TRIGGER LIST24.4. CRON TRIGGER SHOW

    CHAPTER 25. DATABASE25.1. DATABASE BACKUP CREATE25.2. DATABASE BACKUP DELETE25.3. DATABASE BACKUP LIST25.4. DATABASE BACKUP LIST INSTANCE25.5. DATABASE BACKUP SHOW25.6. DATABASE CLUSTER CREATE25.7. DATABASE CLUSTER DELETE25.8. DATABASE CLUSTER FORCE DELETE25.9. DATABASE CLUSTER LIST25.10. DATABASE CLUSTER LIST INSTANCES25.11. DATABASE CLUSTER RESET STATUS25.12. DATABASE CLUSTER SHOW25.13. DATABASE CLUSTER UPGRADE25.14. DATABASE CONFIGURATION ATTACH25.15. DATABASE CONFIGURATION CREATE25.16. DATABASE CONFIGURATION DELETE25.17. DATABASE CONFIGURATION DETACH25.18. DATABASE CONFIGURATION LIST25.19. DATABASE CONFIGURATION PARAMETER LIST25.20. DATABASE CONFIGURATION PARAMETER SHOW25.21. DATABASE CONFIGURATION SHOW25.22. DATABASE DB CREATE25.23. DATABASE DB DELETE25.24. DATABASE DB LIST25.25. DATABASE FLAVOR LIST25.26. DATABASE FLAVOR SHOW25.27. DATABASE INSTANCE CREATE25.28. DATABASE INSTANCE DELETE25.29. DATABASE INSTANCE FORCE DELETE25.30. DATABASE INSTANCE LIST25.31. DATABASE INSTANCE RESET STATUS25.32. DATABASE INSTANCE RESIZE FLAVOR25.33. DATABASE INSTANCE RESIZE VOLUME25.34. DATABASE INSTANCE RESTART25.35. DATABASE INSTANCE SHOW25.36. DATABASE INSTANCE UPGRADE25.37. DATABASE LIMIT LIST25.38. DATABASE LOG ENABLE25.39. DATABASE QUOTA SHOW25.40. DATABASE QUOTA UPDATE25.41. DATABASE ROOT DISABLE25.42. DATABASE ROOT ENABLE25.43. DATABASE ROOT SHOW25.44. DATABASE USER CREATE25.45. DATABASE USER DELETE25.46. DATABASE USER GRANT ACCESS25.47. DATABASE USER LIST

    295296297298

    300300301302303305306308309309

    311312313314314315317317317319321

    322324324325326328329332332333334335335336336338338339341

    342344344346347348348349

    Red Hat OpenStack Platform 13 Command Line Interface Reference

    6

  • . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    25.48. DATABASE USER REVOKE ACCESS25.49. DATABASE USER SHOW25.50. DATABASE USER SHOW ACCESS25.51. DATABASE USER UPDATE ATTRIBUTES

    CHAPTER 26. DATAPROCESSING26.1. DATAPROCESSING CLUSTER CREATE26.2. DATAPROCESSING CLUSTER DELETE26.3. DATAPROCESSING CLUSTER LIST26.4. DATAPROCESSING CLUSTER SCALE26.5. DATAPROCESSING CLUSTER SHOW26.6. DATAPROCESSING JOB LIST26.7. DATAPROCESSING CLUSTER TEMPLATE CREATE26.8. DATAPROCESSING CLUSTER TEMPLATE DELETE26.9. DATAPROCESSING CLUSTER TEMPLATE EXPORT26.10. DATAPROCESSING CLUSTER TEMPLATE IMPORT26.11. DATAPROCESSING CLUSTER TEMPLATE LIST26.12. DATAPROCESSING CLUSTER TEMPLATE SHOW26.13. DATAPROCESSING CLUSTER TEMPLATE UPDATE26.14. DATAPROCESSING CLUSTER UPDATE26.15. DATAPROCESSING CLUSTER VERIFICATION26.16. DATAPROCESSING DATA SOURCE CREATE26.17. DATAPROCESSING DATA SOURCE DELETE26.18. DATAPROCESSING DATA SOURCE LIST26.19. DATAPROCESSING DATA SOURCE SHOW26.20. DATAPROCESSING DATA SOURCE UPDATE26.21. DATAPROCESSING IMAGE LIST26.22. DATAPROCESSING IMAGE REGISTER26.23. DATAPROCESSING IMAGE SHOW26.24. DATAPROCESSING IMAGE TAGS ADD26.25. DATAPROCESSING IMAGE TAGS REMOVE26.26. DATAPROCESSING IMAGE TAGS SET26.27. DATAPROCESSING IMAGE UNREGISTER26.28. DATAPROCESSING JOB BINARY CREATE26.29. DATAPROCESSING JOB BINARY DELETE26.30. DATAPROCESSING JOB BINARY DOWNLOAD26.31. DATAPROCESSING JOB BINARY LIST26.32. DATAPROCESSING JOB BINARY SHOW26.33. DATAPROCESSING JOB BINARY UPDATE26.34. DATAPROCESSING JOB DELETE26.35. DATAPROCESSING JOB EXECUTE26.36. DATAPROCESSING JOB SHOW26.37. DATAPROCESSING JOB TEMPLATE CREATE26.38. DATAPROCESSING JOB TEMPLATE DELETE26.39. DATAPROCESSING JOB TEMPLATE LIST26.40. DATAPROCESSING JOB TEMPLATE SHOW26.41. DATAPROCESSING JOB TEMPLATE UPDATE26.42. DATAPROCESSING JOB TYPE CONFIGS GET26.43. DATAPROCESSING JOB TYPE LIST26.44. DATAPROCESSING JOB UPDATE26.45. DATAPROCESSING NODE GROUP TEMPLATE CREATE26.46. DATAPROCESSING NODE GROUP TEMPLATE DELETE26.47. DATAPROCESSING NODE GROUP TEMPLATE EXPORT

    350351352354

    356356358358360361

    363364366367368369371372374376378380380382383385387388390391

    393394395397397398399401

    403403405407409409

    411412414414416418421421

    Table of Contents

    7

  • . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    26.48. DATAPROCESSING NODE GROUP TEMPLATE IMPORT26.49. DATAPROCESSING NODE GROUP TEMPLATE LIST26.50. DATAPROCESSING NODE GROUP TEMPLATE SHOW26.51. DATAPROCESSING NODE GROUP TEMPLATE UPDATE26.52. DATAPROCESSING PLUGIN CONFIGS GET26.53. DATAPROCESSING PLUGIN LIST26.54. DATAPROCESSING PLUGIN SHOW26.55. DATAPROCESSING PLUGIN UPDATE

    CHAPTER 27. DATASTORE27.1. DATASTORE LIST27.2. DATASTORE SHOW27.3. DATASTORE VERSION LIST27.4. DATASTORE VERSION SHOW

    CHAPTER 28. DNS28.1. DNS QUOTA LIST28.2. DNS QUOTA RESET28.3. DNS QUOTA SET28.4. DNS SERVICE LIST28.5. DNS SERVICE SHOW

    CHAPTER 29. EC229.1. EC2 CREDENTIALS CREATE29.2. EC2 CREDENTIALS DELETE29.3. EC2 CREDENTIALS LIST29.4. EC2 CREDENTIALS SHOW

    CHAPTER 30. ENDPOINT30.1. ENDPOINT CREATE30.2. ENDPOINT DELETE30.3. ENDPOINT LIST30.4. ENDPOINT SHOW

    CHAPTER 31. EVENT31.1. EVENT TRIGGER CREATE31.2. EVENT TRIGGER DELETE31.3. EVENT TRIGGER LIST31.4. EVENT TRIGGER SHOW

    CHAPTER 32. EXTENSION32.1. EXTENSION LIST32.2. EXTENSION SHOW

    CHAPTER 33. FIREWALL33.1. FIREWALL GROUP CREATE33.2. FIREWALL GROUP DELETE33.3. FIREWALL GROUP LIST33.4. FIREWALL GROUP POLICY ADD RULE33.5. FIREWALL GROUP POLICY CREATE33.6. FIREWALL GROUP POLICY DELETE33.7. FIREWALL GROUP POLICY LIST33.8. FIREWALL GROUP POLICY REMOVE RULE33.9. FIREWALL GROUP POLICY SET33.10. FIREWALL GROUP POLICY SHOW

    422424425427430431

    433434

    436436437438440

    442442443444446447

    450450451451

    453

    455455456457458

    460460461

    462463

    465465466

    468468470470472473475475477477478

    Red Hat OpenStack Platform 13 Command Line Interface Reference

    8

  • . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    33.11. FIREWALL GROUP POLICY UNSET33.12. FIREWALL GROUP RULE CREATE33.13. FIREWALL GROUP RULE DELETE33.14. FIREWALL GROUP RULE LIST33.15. FIREWALL GROUP RULE SET33.16. FIREWALL GROUP RULE SHOW33.17. FIREWALL GROUP RULE UNSET33.18. FIREWALL GROUP SET33.19. FIREWALL GROUP SHOW33.20. FIREWALL GROUP UNSET

    CHAPTER 34. FLAVOR34.1. FLAVOR CREATE34.2. FLAVOR DELETE34.3. FLAVOR LIST34.4. FLAVOR SET34.5. FLAVOR SHOW34.6. FLAVOR UNSET

    CHAPTER 35. FLOATING35.1. FLOATING IP CREATE35.2. FLOATING IP DELETE35.3. FLOATING IP LIST35.4. FLOATING IP POOL LIST35.5. FLOATING IP SET35.6. FLOATING IP SHOW35.7. FLOATING IP UNSET

    CHAPTER 36. HELP.ADOC36.1. HELP

    CHAPTER 37. HOST37.1. HOST LIST37.2. HOST SET37.3. HOST SHOW

    CHAPTER 38. HYPERVISOR38.1. HYPERVISOR LIST38.2. HYPERVISOR SHOW38.3. HYPERVISOR STATS SHOW

    CHAPTER 39. IMAGE39.1. IMAGE ADD PROJECT39.2. IMAGE CREATE39.3. IMAGE DELETE39.4. IMAGE LIST39.5. IMAGE REMOVE PROJECT39.6. IMAGE SAVE39.7. IMAGE SET39.8. IMAGE SHOW39.9. IMAGE UNSET

    CHAPTER 40. IP40.1. IP AVAILABILITY LIST40.2. IP AVAILABILITY SHOW

    480481

    483484485487488489491

    492

    494494496496498498500

    501501

    502503505506507508

    510510

    511511512513

    515515516517

    519519

    520523523525525526528529

    531531532

    Table of Contents

    9

  • . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    CHAPTER 41. KEYPAIR41.1. KEYPAIR CREATE41.2. KEYPAIR DELETE41.3. KEYPAIR LIST41.4. KEYPAIR SHOW

    CHAPTER 42. LIMITS42.1. LIMITS SHOW

    CHAPTER 43. LOADBALANCER43.1. LOADBALANCER AMPHORA LIST43.2. LOADBALANCER AMPHORA SHOW43.3. LOADBALANCER CREATE43.4. LOADBALANCER DELETE43.5. LOADBALANCER FAILOVER43.6. LOADBALANCER HEALTHMONITOR CREATE43.7. LOADBALANCER HEALTHMONITOR DELETE43.8. LOADBALANCER HEALTHMONITOR LIST43.9. LOADBALANCER HEALTHMONITOR SET43.10. LOADBALANCER HEALTHMONITOR SHOW43.11. LOADBALANCER L7POLICY CREATE43.12. LOADBALANCER L7POLICY DELETE43.13. LOADBALANCER L7POLICY LIST43.14. LOADBALANCER L7POLICY SET43.15. LOADBALANCER L7POLICY SHOW43.16. LOADBALANCER L7RULE CREATE43.17. LOADBALANCER L7RULE DELETE43.18. LOADBALANCER L7RULE LIST43.19. LOADBALANCER L7RULE SET43.20. LOADBALANCER L7RULE SHOW43.21. LOADBALANCER LIST43.22. LOADBALANCER LISTENER CREATE43.23. LOADBALANCER LISTENER DELETE43.24. LOADBALANCER LISTENER LIST43.25. LOADBALANCER LISTENER SET43.26. LOADBALANCER LISTENER SHOW43.27. LOADBALANCER LISTENER STATS SHOW43.28. LOADBALANCER MEMBER CREATE43.29. LOADBALANCER MEMBER DELETE43.30. LOADBALANCER MEMBER LIST43.31. LOADBALANCER MEMBER SET43.32. LOADBALANCER MEMBER SHOW43.33. LOADBALANCER POOL CREATE43.34. LOADBALANCER POOL DELETE43.35. LOADBALANCER POOL LIST43.36. LOADBALANCER POOL SET43.37. LOADBALANCER POOL SHOW43.38. LOADBALANCER QUOTA DEFAULTS SHOW43.39. LOADBALANCER QUOTA LIST43.40. LOADBALANCER QUOTA RESET43.41. LOADBALANCER QUOTA SET43.42. LOADBALANCER QUOTA SHOW43.43. LOADBALANCER SET

    534534535535537

    539539

    541541542544545546546549549551

    552553555556557558559561562563564566567569570571

    573574575577578579580582584584585586588589590591592594

    Red Hat OpenStack Platform 13 Command Line Interface Reference

    10

  • . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    43.44. LOADBALANCER SHOW43.45. LOADBALANCER STATS SHOW

    CHAPTER 44. MESSAGING44.1. MESSAGING CLAIM CREATE44.2. MESSAGING CLAIM QUERY44.3. MESSAGING CLAIM RELEASE44.4. MESSAGING CLAIM RENEW44.5. MESSAGING FLAVOR CREATE44.6. MESSAGING FLAVOR DELETE44.7. MESSAGING FLAVOR LIST44.8. MESSAGING FLAVOR SHOW44.9. MESSAGING FLAVOR UPDATE44.10. MESSAGING HEALTH44.11. MESSAGING HOMEDOC44.12. MESSAGING MESSAGE LIST44.13. MESSAGING MESSAGE POST44.14. MESSAGING PING44.15. MESSAGING POOL CREATE44.16. MESSAGING POOL DELETE44.17. MESSAGING POOL LIST44.18. MESSAGING POOL SHOW44.19. MESSAGING POOL UPDATE44.20. MESSAGING QUEUE CREATE44.21. MESSAGING QUEUE DELETE44.22. MESSAGING QUEUE GET METADATA44.23. MESSAGING QUEUE LIST44.24. MESSAGING QUEUE PURGE44.25. MESSAGING QUEUE SET METADATA44.26. MESSAGING QUEUE SIGNED URL44.27. MESSAGING QUEUE STATS44.28. MESSAGING SUBSCRIPTION CREATE44.29. MESSAGING SUBSCRIPTION DELETE44.30. MESSAGING SUBSCRIPTION LIST44.31. MESSAGING SUBSCRIPTION SHOW44.32. MESSAGING SUBSCRIPTION UPDATE

    CHAPTER 45. METRIC45.1. METRIC AGGREGATES45.2. METRIC ARCHIVE POLICY CREATE45.3. METRIC ARCHIVE POLICY DELETE45.4. METRIC ARCHIVE POLICY LIST45.5. METRIC ARCHIVE POLICY SHOW45.6. METRIC ARCHIVE POLICY UPDATE45.7. METRIC ARCHIVE POLICY RULE CREATE45.8. METRIC ARCHIVE POLICY RULE DELETE45.9. METRIC ARCHIVE POLICY RULE LIST45.10. METRIC ARCHIVE POLICY RULE SHOW45.11. METRIC BENCHMARK MEASURES ADD45.12. METRIC BENCHMARK MEASURES SHOW45.13. METRIC BENCHMARK METRIC CREATE45.14. METRIC BENCHMARK METRIC SHOW45.15. METRIC CAPABILITIES LIST

    595596

    598598599601601

    603604605606608609609610612612613615615617618

    620621622623625625626627629630631

    632634

    636636638639640641

    642644645646647649651

    653654656

    Table of Contents

    11

  • . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    45.16. METRIC CREATE45.17. METRIC DELETE45.18. METRIC LIST45.19. METRIC MEASURES ADD45.20. METRIC MEASURES AGGREGATION45.21. METRIC MEASURES BATCH METRICS45.22. METRIC MEASURES BATCH RESOURCES METRICS45.23. METRIC MEASURES SHOW45.24. METRIC METRIC CREATE45.25. METRIC METRIC DELETE45.26. METRIC METRIC LIST45.27. METRIC METRIC SHOW45.28. METRIC RESOURCE BATCH DELETE45.29. METRIC RESOURCE CREATE45.30. METRIC RESOURCE DELETE45.31. METRIC RESOURCE HISTORY45.32. METRIC RESOURCE LIST45.33. METRIC RESOURCE SEARCH45.34. METRIC RESOURCE SHOW45.35. METRIC RESOURCE UPDATE45.36. METRIC RESOURCE TYPE CREATE45.37. METRIC RESOURCE TYPE DELETE45.38. METRIC RESOURCE TYPE LIST45.39. METRIC RESOURCE TYPE SHOW45.40. METRIC RESOURCE TYPE UPDATE45.41. METRIC SERVER VERSION45.42. METRIC SHOW45.43. METRIC STATUS

    CHAPTER 46. MODULE46.1. MODULE LIST

    CHAPTER 47. NETWORK47.1. NETWORK AGENT ADD NETWORK47.2. NETWORK AGENT ADD ROUTER47.3. NETWORK AGENT DELETE47.4. NETWORK AGENT LIST47.5. NETWORK AGENT REMOVE NETWORK47.6. NETWORK AGENT REMOVE ROUTER47.7. NETWORK AGENT SET47.8. NETWORK AGENT SHOW47.9. NETWORK AUTO ALLOCATED TOPOLOGY CREATE47.10. NETWORK AUTO ALLOCATED TOPOLOGY DELETE47.11. NETWORK CREATE47.12. NETWORK DELETE47.13. NETWORK FLAVOR ADD PROFILE47.14. NETWORK FLAVOR CREATE47.15. NETWORK FLAVOR DELETE47.16. NETWORK FLAVOR LIST47.17. NETWORK FLAVOR PROFILE CREATE47.18. NETWORK FLAVOR PROFILE DELETE47.19. NETWORK FLAVOR PROFILE LIST47.20. NETWORK FLAVOR PROFILE SET

    657658659660661

    663664664666668668670671

    673674675677678680682684685685687688690691

    692

    694694

    696696696697697699699700700702703704707707708709710711

    713713715

    Red Hat OpenStack Platform 13 Command Line Interface Reference

    12

  • 47.21. NETWORK FLAVOR PROFILE SHOW47.22. NETWORK FLAVOR REMOVE PROFILE47.23. NETWORK FLAVOR SET47.24. NETWORK FLAVOR SHOW47.25. NETWORK LIST47.26. NETWORK LOG CREATE47.27. NETWORK LOG DELETE47.28. NETWORK LOG LIST47.29. NETWORK LOG SET47.30. NETWORK LOG SHOW47.31. NETWORK LOGGABLE RESOURCES LIST47.32. NETWORK METER CREATE47.33. NETWORK METER DELETE47.34. NETWORK METER LIST47.35. NETWORK METER RULE CREATE47.36. NETWORK METER RULE DELETE47.37. NETWORK METER RULE LIST47.38. NETWORK METER RULE SHOW47.39. NETWORK METER SHOW47.40. NETWORK QOS POLICY CREATE47.41. NETWORK QOS POLICY DELETE47.42. NETWORK QOS POLICY LIST47.43. NETWORK QOS POLICY SET47.44. NETWORK QOS POLICY SHOW47.45. NETWORK QOS RULE CREATE47.46. NETWORK QOS RULE DELETE47.47. NETWORK QOS RULE LIST47.48. NETWORK QOS RULE SET47.49. NETWORK QOS RULE SHOW47.50. NETWORK QOS RULE TYPE LIST47.51. NETWORK QOS RULE TYPE SHOW47.52. NETWORK RBAC CREATE47.53. NETWORK RBAC DELETE47.54. NETWORK RBAC LIST47.55. NETWORK RBAC SET47.56. NETWORK RBAC SHOW47.57. NETWORK SEGMENT CREATE47.58. NETWORK SEGMENT DELETE47.59. NETWORK SEGMENT LIST47.60. NETWORK SEGMENT SET47.61. NETWORK SEGMENT SHOW47.62. NETWORK SERVICE PROVIDER LIST47.63. NETWORK SET47.64. NETWORK SHOW47.65. NETWORK SUBPORT LIST47.66. NETWORK TRUNK CREATE47.67. NETWORK TRUNK DELETE47.68. NETWORK TRUNK LIST47.69. NETWORK TRUNK SET47.70. NETWORK TRUNK SHOW47.71. NETWORK TRUNK UNSET47.72. NETWORK UNSET

    715717717718719722724724726726728729731731732734735736737738740741742743744746747748749750752753755755757757759760761762763764765767769770772772773774776776

    Table of Contents

    13

  • . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    CHAPTER 48. OBJECT48.1. OBJECT CREATE48.2. OBJECT DELETE48.3. OBJECT LIST48.4. OBJECT SAVE48.5. OBJECT SET48.6. OBJECT SHOW48.7. OBJECT STORE ACCOUNT SET48.8. OBJECT STORE ACCOUNT SHOW48.9. OBJECT STORE ACCOUNT UNSET48.10. OBJECT UNSET

    CHAPTER 49. ORCHESTRATION49.1. ORCHESTRATION BUILD INFO49.2. ORCHESTRATION RESOURCE TYPE LIST49.3. ORCHESTRATION RESOURCE TYPE SHOW49.4. ORCHESTRATION SERVICE LIST49.5. ORCHESTRATION TEMPLATE FUNCTION LIST49.6. ORCHESTRATION TEMPLATE VALIDATE49.7. ORCHESTRATION TEMPLATE VERSION LIST

    CHAPTER 50. OVERCLOUD50.1. OVERCLOUD CEPH UPGRADE RUN50.2. OVERCLOUD CONFIG DOWNLOAD50.3. OVERCLOUD CONTAINER IMAGE BUILD50.4. OVERCLOUD CONTAINER IMAGE PREPARE50.5. OVERCLOUD CONTAINER IMAGE TAG DISCOVER50.6. OVERCLOUD CONTAINER IMAGE UPLOAD50.7. OVERCLOUD CREDENTIALS50.8. OVERCLOUD DELETE50.9. OVERCLOUD DEPLOY50.10. OVERCLOUD EXECUTE50.11. OVERCLOUD FAILURES50.12. OVERCLOUD FFWD UPGRADE CONVERGE50.13. OVERCLOUD FFWD UPGRADE PREPARE50.14. OVERCLOUD FFWD UPGRADE RUN50.15. OVERCLOUD GENERATE FENCING50.16. OVERCLOUD IMAGE BUILD50.17. OVERCLOUD IMAGE UPLOAD50.18. OVERCLOUD NETENV VALIDATE50.19. OVERCLOUD NODE CONFIGURE50.20. OVERCLOUD NODE DELETE50.21. OVERCLOUD NODE DISCOVER50.22. OVERCLOUD NODE IMPORT50.23. OVERCLOUD NODE INTROSPECT50.24. OVERCLOUD NODE PROVIDE50.25. OVERCLOUD PARAMETERS SET50.26. OVERCLOUD PLAN CREATE50.27. OVERCLOUD PLAN DELETE50.28. OVERCLOUD PLAN DEPLOY50.29. OVERCLOUD PLAN EXPORT50.30. OVERCLOUD PLAN LIST50.31. OVERCLOUD PROFILES LIST

    778778779780781782782784784785786

    787787788789791792794795

    798798802803803806806807807808812812813817822823824824825826827828828829830831831832832833834835

    Red Hat OpenStack Platform 13 Command Line Interface Reference

    14

  • . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    50.32. OVERCLOUD PROFILES MATCH50.33. OVERCLOUD RAID CREATE50.34. OVERCLOUD ROLE LIST50.35. OVERCLOUD ROLE SHOW50.36. OVERCLOUD ROLES GENERATE50.37. OVERCLOUD STATUS50.38. OVERCLOUD SUPPORT REPORT COLLECT50.39. OVERCLOUD UPDATE CONVERGE50.40. OVERCLOUD UPDATE PREPARE50.41. OVERCLOUD UPDATE RUN50.42. OVERCLOUD UPGRADE CONVERGE50.43. OVERCLOUD UPGRADE PREPARE50.44. OVERCLOUD UPGRADE RUN

    CHAPTER 51. PORT51.1. PORT CREATE51.2. PORT DELETE51.3. PORT LIST51.4. PORT SET51.5. PORT SHOW51.6. PORT UNSET

    CHAPTER 52. PROJECT52.1. PROJECT CREATE52.2. PROJECT DELETE52.3. PROJECT LIST52.4. PROJECT PURGE52.5. PROJECT SET52.6. PROJECT SHOW52.7. PROJECT UNSET

    CHAPTER 53. PTR53.1. PTR RECORD LIST53.2. PTR RECORD SET53.3. PTR RECORD SHOW53.4. PTR RECORD UNSET

    CHAPTER 54. QUOTA54.1. QUOTA LIST54.2. QUOTA SET54.3. QUOTA SHOW

    CHAPTER 55. RECORDSET55.1. RECORDSET CREATE55.2. RECORDSET DELETE55.3. RECORDSET LIST55.4. RECORDSET SET55.5. RECORDSET SHOW

    CHAPTER 56. RESOURCE56.1. RESOURCE MEMBER CREATE56.2. RESOURCE MEMBER DELETE56.3. RESOURCE MEMBER LIST56.4. RESOURCE MEMBER SHOW56.5. RESOURCE MEMBER UPDATE

    837838839839840841841

    842847851852857861

    864864867867869872873

    875875876877878879879881

    882882883885887

    888888889891

    894894895897899901

    903903904905906908

    Table of Contents

    15

  • . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    CHAPTER 57. ROLE57.1. ROLE ADD57.2. ROLE ASSIGNMENT LIST57.3. ROLE CREATE57.4. ROLE DELETE57.5. ROLE LIST57.6. ROLE REMOVE57.7. ROLE SHOW

    CHAPTER 58. ROUTER58.1. ROUTER ADD PORT58.2. ROUTER ADD SUBNET58.3. ROUTER CREATE58.4. ROUTER DELETE58.5. ROUTER LIST58.6. ROUTER REMOVE PORT58.7. ROUTER REMOVE SUBNET58.8. ROUTER SET58.9. ROUTER SHOW58.10. ROUTER UNSET

    CHAPTER 59. SECRET59.1. SECRET CONTAINER CREATE59.2. SECRET CONTAINER DELETE59.3. SECRET CONTAINER GET59.4. SECRET CONTAINER LIST59.5. SECRET DELETE59.6. SECRET GET59.7. SECRET LIST59.8. SECRET ORDER CREATE59.9. SECRET ORDER DELETE59.10. SECRET ORDER GET59.11. SECRET ORDER LIST59.12. SECRET STORE59.13. SECRET UPDATE

    CHAPTER 60. SECURITY60.1. SECURITY GROUP CREATE60.2. SECURITY GROUP DELETE60.3. SECURITY GROUP LIST60.4. SECURITY GROUP RULE CREATE60.5. SECURITY GROUP RULE DELETE60.6. SECURITY GROUP RULE LIST60.7. SECURITY GROUP RULE SHOW60.8. SECURITY GROUP SET60.9. SECURITY GROUP SHOW

    CHAPTER 61. SERVER61.1. SERVER ADD FIXED IP61.2. SERVER ADD FLOATING IP61.3. SERVER ADD NETWORK61.4. SERVER ADD PORT61.5. SERVER ADD SECURITY GROUP61.6. SERVER ADD VOLUME

    910910911

    913914914916916

    918918918919921921

    923924924926927

    928928929929931

    932933935936938939940942944

    945945946947948950951952954954

    956956956957957958958

    Red Hat OpenStack Platform 13 Command Line Interface Reference

    16

  • . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    61.7. SERVER BACKUP CREATE61.8. SERVER CREATE61.9. SERVER DELETE61.10. SERVER DUMP CREATE61.11. SERVER EVENT LIST61.12. SERVER EVENT SHOW61.13. SERVER GROUP CREATE61.14. SERVER GROUP DELETE61.15. SERVER GROUP LIST61.16. SERVER GROUP SHOW61.17. SERVER IMAGE CREATE61.18. SERVER LIST61.19. SERVER LOCK61.20. SERVER MIGRATE61.21. SERVER PAUSE61.22. SERVER REBOOT61.23. SERVER REBUILD61.24. SERVER REMOVE FIXED IP61.25. SERVER REMOVE FLOATING IP61.26. SERVER REMOVE NETWORK61.27. SERVER REMOVE PORT61.28. SERVER REMOVE SECURITY GROUP61.29. SERVER REMOVE VOLUME61.30. SERVER RESCUE61.31. SERVER RESIZE61.32. SERVER RESTORE61.33. SERVER RESUME61.34. SERVER SET61.35. SERVER SHELVE61.36. SERVER SHOW61.37. SERVER SSH61.38. SERVER START61.39. SERVER STOP61.40. SERVER SUSPEND61.41. SERVER UNLOCK61.42. SERVER UNPAUSE61.43. SERVER UNRESCUE61.44. SERVER UNSET61.45. SERVER UNSHELVE

    CHAPTER 62. SERVICE62.1. SERVICE CREATE62.2. SERVICE DELETE62.3. SERVICE LIST62.4. SERVICE SHOW

    CHAPTER 63. SFC63.1. SFC FLOW CLASSIFIER CREATE63.2. SFC FLOW CLASSIFIER DELETE63.3. SFC FLOW CLASSIFIER LIST63.4. SFC FLOW CLASSIFIER SET63.5. SFC FLOW CLASSIFIER SHOW63.6. SFC PORT CHAIN CREATE

    959960964964965966968969969971972973976976977978978980980981981

    982982983983984984985986986987988989989990990990991991

    993993994995996

    998998

    10001000100210021004

    Table of Contents

    17

  • . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    63.7. SFC PORT CHAIN DELETE63.8. SFC PORT CHAIN LIST63.9. SFC PORT CHAIN SET63.10. SFC PORT CHAIN SHOW63.11. SFC PORT CHAIN UNSET63.12. SFC PORT PAIR CREATE63.13. SFC PORT PAIR DELETE63.14. SFC PORT PAIR GROUP CREATE63.15. SFC PORT PAIR GROUP DELETE63.16. SFC PORT PAIR GROUP LIST63.17. SFC PORT PAIR GROUP SET63.18. SFC PORT PAIR GROUP SHOW63.19. SFC PORT PAIR GROUP UNSET63.20. SFC PORT PAIR LIST63.21. SFC PORT PAIR SET63.22. SFC PORT PAIR SHOW63.23. SFC SERVICE GRAPH CREATE63.24. SFC SERVICE GRAPH DELETE63.25. SFC SERVICE GRAPH LIST63.26. SFC SERVICE GRAPH SET63.27. SFC SERVICE GRAPH SHOW

    CHAPTER 64. SNAPSHOT64.1. SNAPSHOT CREATE64.2. SNAPSHOT DELETE64.3. SNAPSHOT LIST64.4. SNAPSHOT SET64.5. SNAPSHOT SHOW64.6. SNAPSHOT UNSET

    CHAPTER 65. SOFTWARE65.1. SOFTWARE CONFIG CREATE65.2. SOFTWARE CONFIG DELETE65.3. SOFTWARE CONFIG LIST65.4. SOFTWARE CONFIG SHOW65.5. SOFTWARE DEPLOYMENT CREATE65.6. SOFTWARE DEPLOYMENT DELETE65.7. SOFTWARE DEPLOYMENT LIST65.8. SOFTWARE DEPLOYMENT METADATA SHOW65.9. SOFTWARE DEPLOYMENT OUTPUT SHOW65.10. SOFTWARE DEPLOYMENT SHOW

    CHAPTER 66. STACK66.1. STACK ABANDON66.2. STACK ADOPT66.3. STACK CANCEL66.4. STACK CHECK66.5. STACK CREATE66.6. STACK DELETE66.7. STACK ENVIRONMENT SHOW66.8. STACK EVENT LIST66.9. STACK EVENT SHOW66.10. STACK EXPORT66.11. STACK FAILURES LIST

    10051006100710081009101010121012101410151016101710181019

    10201021

    10221024102410251026

    1028102810291030103110321033

    10351035103610371038103910421042104310441045

    10471047104810501051

    1053105510561057105910611062

    Red Hat OpenStack Platform 13 Command Line Interface Reference

    18

  • . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    66.12. STACK FILE LIST66.13. STACK HOOK CLEAR66.14. STACK HOOK POLL66.15. STACK LIST66.16. STACK OUTPUT LIST66.17. STACK OUTPUT SHOW66.18. STACK RESOURCE LIST66.19. STACK RESOURCE MARK UNHEALTHY66.20. STACK RESOURCE METADATA66.21. STACK RESOURCE SHOW66.22. STACK RESOURCE SIGNAL66.23. STACK RESUME66.24. STACK SHOW66.25. STACK SNAPSHOT CREATE66.26. STACK SNAPSHOT DELETE66.27. STACK SNAPSHOT LIST66.28. STACK SNAPSHOT RESTORE66.29. STACK SNAPSHOT SHOW66.30. STACK SUSPEND66.31. STACK TEMPLATE SHOW66.32. STACK UPDATE

    CHAPTER 67. SUBNET67.1. SUBNET CREATE67.2. SUBNET DELETE67.3. SUBNET LIST67.4. SUBNET POOL CREATE67.5. SUBNET POOL DELETE67.6. SUBNET POOL LIST67.7. SUBNET POOL SET67.8. SUBNET POOL SHOW

    CHAPTER 68. TLD68.1. TLD SET

    CHAPTER 69. SUBNET69.1. SUBNET POOL UNSET69.2. SUBNET SET69.3. SUBNET SHOW69.4. SUBNET UNSET

    CHAPTER 70. TASK70.1. TASK EXECUTION LIST70.2. TASK EXECUTION PUBLISHED SHOW70.3. TASK EXECUTION RERUN70.4. TASK EXECUTION RESULT SHOW70.5. TASK EXECUTION SHOW

    CHAPTER 71. TLD71.1. TLD CREATE71.2. TLD DELETE71.3. TLD LIST71.4. TLD SHOW

    CHAPTER 72. TOKEN

    1062106410651066106810701071

    10731073107510761077107810801081108210831084108510871088

    109210921095109510981100110011031104

    11061106

    11081108110811101111

    111311131114111511161117

    11191119

    112011211122

    1125

    Table of Contents

    19

  • . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    72.1. TOKEN ISSUE72.2. TOKEN REVOKE

    CHAPTER 73. TSIGKEY73.1. TSIGKEY CREATE73.2. TSIGKEY DELETE73.3. TSIGKEY LIST73.4. TSIGKEY SET73.5. TSIGKEY SHOW

    CHAPTER 74. UNDERCLOUD74.1. UNDERCLOUD BACKUP74.2. UNDERCLOUD DEPLOY74.3. UNDERCLOUD INSTALL74.4. UNDERCLOUD UPGRADE

    CHAPTER 75. USAGE75.1. USAGE LIST75.2. USAGE SHOW

    CHAPTER 76. USER76.1. USER CREATE76.2. USER DELETE76.3. USER LIST76.4. USER ROLE LIST76.5. USER SET76.6. USER SHOW

    CHAPTER 77. VOLUME77.1. VOLUME BACKUP CREATE77.2. VOLUME BACKUP DELETE77.3. VOLUME BACKUP LIST77.4. VOLUME BACKUP RESTORE77.5. VOLUME BACKUP SET77.6. VOLUME BACKUP SHOW77.7. VOLUME CREATE77.8. VOLUME DELETE77.9. VOLUME HOST FAILOVER77.10. VOLUME HOST SET77.11. VOLUME LIST77.12. VOLUME MIGRATE77.13. VOLUME QOS ASSOCIATE77.14. VOLUME QOS CREATE77.15. VOLUME QOS DELETE77.16. VOLUME QOS DISASSOCIATE77.17. VOLUME QOS LIST77.18. VOLUME QOS SET77.19. VOLUME QOS SHOW77.20. VOLUME QOS UNSET77.21. VOLUME SERVICE LIST77.22. VOLUME SERVICE SET77.23. VOLUME SET77.24. VOLUME SHOW77.25. VOLUME SNAPSHOT CREATE

    11251126

    112711271128112911311132

    11351135113511361137

    113811381139

    11411141

    11421143114411451146

    11481148114911501151

    115311531155115711581158115911611161

    11621163116411641166116611671168116911701171

    1173

    Red Hat OpenStack Platform 13 Command Line Interface Reference

    20

  • . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    77.26. VOLUME SNAPSHOT DELETE77.27. VOLUME SNAPSHOT LIST77.28. VOLUME SNAPSHOT SET77.29. VOLUME SNAPSHOT SHOW77.30. VOLUME SNAPSHOT UNSET77.31. VOLUME TRANSFER REQUEST ACCEPT77.32. VOLUME TRANSFER REQUEST CREATE77.33. VOLUME TRANSFER REQUEST DELETE77.34. VOLUME TRANSFER REQUEST LIST77.35. VOLUME TRANSFER REQUEST SHOW77.36. VOLUME TYPE CREATE77.37. VOLUME TYPE DELETE77.38. VOLUME TYPE LIST77.39. VOLUME TYPE SET77.40. VOLUME TYPE SHOW77.41. VOLUME TYPE UNSET77.42. VOLUME UNSET

    CHAPTER 78. VPN78.1. VPN ENDPOINT GROUP CREATE78.2. VPN ENDPOINT GROUP DELETE78.3. VPN ENDPOINT GROUP LIST78.4. VPN ENDPOINT GROUP SET78.5. VPN ENDPOINT GROUP SHOW78.6. VPN IKE POLICY CREATE78.7. VPN IKE POLICY DELETE78.8. VPN IKE POLICY LIST78.9. VPN IKE POLICY SET78.10. VPN IKE POLICY SHOW78.11. VPN IPSEC POLICY CREATE78.12. VPN IPSEC POLICY DELETE78.13. VPN IPSEC POLICY LIST78.14. VPN IPSEC POLICY SET78.15. VPN IPSEC POLICY SHOW78.16. VPN IPSEC SITE CONNECTION CREATE78.17. VPN IPSEC SITE CONNECTION DELETE78.18. VPN IPSEC SITE CONNECTION LIST78.19. VPN IPSEC SITE CONNECTION SET78.20. VPN IPSEC SITE CONNECTION SHOW78.21. VPN SERVICE CREATE78.22. VPN SERVICE DELETE78.23. VPN SERVICE LIST78.24. VPN SERVICE SET78.25. VPN SERVICE SHOW

    CHAPTER 79. WORKBOOK79.1. WORKBOOK CREATE79.2. WORKBOOK DEFINITION SHOW79.3. WORKBOOK DELETE79.4. WORKBOOK LIST79.5. WORKBOOK SHOW79.6. WORKBOOK UPDATE79.7. WORKBOOK VALIDATE

    1174117511771178117911801181

    11821183118411861188118811901191

    11921193

    119511951196119711981199

    120012021203120412051206120812091210121112131215121612171219

    12201222122312241225

    12271227122812281229123012321233

    Table of Contents

    21

  • . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

    CHAPTER 80. WORKFLOW80.1. WORKFLOW CREATE80.2. WORKFLOW DEFINITION SHOW80.3. WORKFLOW DELETE80.4. WORKFLOW ENGINE SERVICE LIST80.5. WORKFLOW ENV CREATE80.6. WORKFLOW ENV DELETE80.7. WORKFLOW ENV LIST80.8. WORKFLOW ENV SHOW80.9. WORKFLOW ENV UPDATE80.10. WORKFLOW EXECUTION CREATE80.11. WORKFLOW EXECUTION DELETE80.12. WORKFLOW EXECUTION INPUT SHOW80.13. WORKFLOW EXECUTION LIST80.14. WORKFLOW EXECUTION OUTPUT SHOW80.15. WORKFLOW EXECUTION SHOW80.16. WORKFLOW EXECUTION UPDATE80.17. WORKFLOW LIST80.18. WORKFLOW SHOW80.19. WORKFLOW UPDATE80.20. WORKFLOW VALIDATE

    CHAPTER 81. ZONE81.1. ZONE ABANDON81.2. ZONE AXFR81.3. ZONE BLACKLIST CREATE81.4. ZONE BLACKLIST DELETE81.5. ZONE BLACKLIST LIST81.6. ZONE BLACKLIST SET81.7. ZONE BLACKLIST SHOW81.8. ZONE CREATE81.9. ZONE DELETE81.10. ZONE EXPORT CREATE81.11. ZONE EXPORT DELETE81.12. ZONE EXPORT LIST81.13. ZONE EXPORT SHOW81.14. ZONE EXPORT SHOWFILE81.15. ZONE IMPORT CREATE81.16. ZONE IMPORT DELETE81.17. ZONE IMPORT LIST81.18. ZONE IMPORT SHOW81.19. ZONE LIST81.20. ZONE SET81.21. ZONE SHOW81.22. ZONE TRANSFER ACCEPT LIST81.23. ZONE TRANSFER ACCEPT REQUEST81.24. ZONE TRANSFER ACCEPT SHOW81.25. ZONE TRANSFER REQUEST CREATE81.26. ZONE TRANSFER REQUEST DELETE81.27. ZONE TRANSFER REQUEST LIST81.28. ZONE TRANSFER REQUEST SET81.29. ZONE TRANSFER REQUEST SHOW

    123512351236123712371238124012401242124312441246124612471249124912501252125312551256

    125912591259126012611262126412651267126912701272127212741275127712781279128012821284128512871289129012921293129412961297

    Red Hat OpenStack Platform 13 Command Line Interface Reference

    22

  • Table of Contents

    23

  • PREFACEA reference to the commands available to the unified OpenStack command-line client.

    Red Hat OpenStack Platform 13 Command Line Interface Reference

    24

  • CHAPTER 1. THE OPENSTACK CLIENTThe openstack client is a common OpenStack command-line interface (CLI). This chapter documentsthe main options for openstack version 3.14.3.

    1.1. OPENSTACK

    Usage:

    openstack [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]

    [--os-cloud ] [--os-region-name ] [--os-cacert ] [--os-cert ] [--os-key ] [--verify | --insecure] [--os-default-domain ] [--os-interface ] [--os-service-provider ] [--os-remote-project-name | --os-remote-project-id ] [--os-remote-project-domain-name | --os-remote-project-domain-id ] [--timing] [--os-beta-command] [--os-profile hmac-key] [--os-compute-api-version ] [--os-network-api-version ] [--os-image-api-version ] [--os-volume-api-version ] [--os-identity-api-version ] [--os-object-api-version ] [--inspector-api-version INSPECTOR_API_VERSION] [--inspector-url INSPECTOR_URL] [--os-queues-api-version ] [--os-baremetal-api-version ] [--os-orchestration-api-version ] [--os-workflow-api-version ] [--os-tripleoclient-api-version ] [--os-dns-api-version ] [--os-database-api-version ] [--os-alarming-api-version ] [--os-key-manager-api-version ] [--os-loadbalancer-api-version ] [--os-container-infra-api-version ] [--os-data-processing-api-version ] [--os-data-processing-url OS_DATA_PROCESSING_URL] [--os-metrics-api-version ] [--os-auth-type ] [--os-project-domain-id ] [--os-protocol ] [--os-project-name ] [--os-trust-id ] [--os-consumer-key ] [--os-domain-name ] [--os-access-secret ] [--os-user-domain-id ] [--os-access-token-type ]

    CHAPTER 1. THE OPENSTACK CLIENT

    25

  • [--os-code ] [--os-application-credential-name ] [--os-identity-provider-url ] [--os-aodh-endpoint ] [--os-service-provider-endpoint ] [--os-access-token ] [--os-domain-id ] [--os-user-domain-name ] [--os-openid-scope ] [--os-user-id ] [--os-application-credential-secret ] [--os-identity-provider ] [--os-username ] [--os-auth-url ] [--os-client-secret ] [--os-access-token-endpoint ] [--os-default-domain-id ] [--os-discovery-endpoint ] [--os-client-id ] [--os-default-domain-name ] [--os-project-domain-name ] [--os-service-provider-entity-id ] [--os-access-key ] [--os-password ] [--os-redirect-uri ] [--os-endpoint ] [--os-roles ] [--os-url ] [--os-consumer-secret ] [--os-token ] [--os-application-credential-id ] [--os-passcode ] [--os-system-scope ] [--os-project-id ] [--os-user ]

    Command-line interface to the OpenStack APIs

    Table 1.1. Optional Arguments

    Value Summary

    --version Show program’s version number and exit

    -v, --verbose Increase verbosity of output. can be repeated.

    -q, --quiet Suppress output except warnings and errors.

    --log-file LOG_FILE Specify a file to log output. disabled by default.

    -h, --help Show help message and exit.

    --debug Show tracebacks on errors.

    --os-cloud Cloud name in clouds.yaml (Env: OS_CLOUD)

    Red Hat OpenStack Platform 13 Command Line Interface Reference

    26

  • --os-region-name Authentication region name (Env:OS_REGION_NAME)

    --os-cacert CA certificate bundle file (Env: OS_CACERT)

    --os-cert Client certificate bundle file (Env: OS_CERT)

    --os-key Client certificate key file (env: os_key)

    --verify Verify server certificate (default)

    --insecure Disable server certificate verification

    --os-default-domain Default domain ID, default=default. (Env:OS_DEFAULT_DOMAIN)

    --os-interface Select an interface type. Valid interface types:[admin, public, internal]. (Env: OS_INTERFACE)

    --os-service-pro