red hat openstack platform 13 · 9.28. baremetal node add trait 9.29. baremetal node adopt 9.30....

Red Hat OpenStack Platform 13

Command Line Interface Reference

Command-line clients for Red Hat OpenStack Platform

Last Updated: 2020-06-08

Red Hat OpenStack Platform 13 Command Line Interface Reference

Command-line clients for Red Hat OpenStack Platform

OpenStack Documentation [email protected]

OpenStack [email protected]

Legal Notice

Copyright © 2020 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 CLIENT

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-HISTORY SEARCH6.4. ALARM-HISTORY SHOW6.5. ALARM LIST6.6. ALARM SHOW6.7. ALARM STATE GET6.8. ALARM STATE SET6.9. ALARM UPDATE

22

23

353535363839

4242434444454748494950515254

565657585960

626263646566676870

7171

747576787981

8283

Table of Contents

1

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

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

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

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 CALL9.46. BAREMETAL NODE PASSTHRU LIST

8888

9090

929293939596979898

100101

103104106107107108109

111112113113115116116118119121121121122122124125125125127129130130131131

133134134135136


2

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

9.47. BAREMETAL NODE POWER OFF9.48. BAREMETAL NODE POWER ON9.49. BAREMETAL NODE PROVIDE9.50. BAREMETAL NODE REBOOT9.51. BAREMETAL NODE REBUILD9.52. BAREMETAL NODE REMOVE TRAIT9.53. BAREMETAL NODE SET9.54. BAREMETAL NODE SHOW9.55. BAREMETAL NODE TRAIT LIST9.56. BAREMETAL NODE UNDEPLOY9.57. BAREMETAL NODE UNSET9.58. BAREMETAL NODE VALIDATE9.59. BAREMETAL NODE VIF ATTACH9.60. BAREMETAL NODE VIF DETACH9.61. BAREMETAL NODE VIF LIST9.62. BAREMETAL PORT CREATE9.63. BAREMETAL PORT DELETE9.64. BAREMETAL PORT GROUP CREATE9.65. BAREMETAL PORT GROUP DELETE9.66. BAREMETAL PORT GROUP LIST9.67. BAREMETAL PORT GROUP SET9.68. BAREMETAL PORT GROUP SHOW9.69. BAREMETAL PORT GROUP UNSET9.70. BAREMETAL PORT LIST9.71. BAREMETAL PORT SET9.72. BAREMETAL PORT SHOW9.73. BAREMETAL PORT UNSET9.74. BAREMETAL VOLUME CONNECTOR CREATE9.75. BAREMETAL VOLUME CONNECTOR DELETE9.76. BAREMETAL VOLUME CONNECTOR LIST9.77. BAREMETAL VOLUME CONNECTOR SET9.78. BAREMETAL VOLUME CONNECTOR SHOW9.79. BAREMETAL VOLUME CONNECTOR UNSET9.80. BAREMETAL VOLUME TARGET CREATE9.81. BAREMETAL VOLUME TARGET DELETE9.82. BAREMETAL VOLUME TARGET LIST9.83. BAREMETAL VOLUME TARGET SET9.84. BAREMETAL VOLUME TARGET SHOW9.85. BAREMETAL VOLUME TARGET UNSET

CHAPTER 10. BGP10.1. BGP DRAGENT ADD SPEAKER10.2. BGP DRAGENT REMOVE SPEAKER10.3. BGP PEER CREATE10.4. BGP PEER DELETE10.5. BGP PEER LIST10.6. BGP PEER SET10.7. BGP PEER SHOW10.8. BGP SPEAKER ADD NETWORK10.9. BGP SPEAKER ADD PEER10.10. BGP SPEAKER CREATE10.11. BGP SPEAKER DELETE10.12. BGP SPEAKER LIST ADVERTISED ROUTES

137138138139139140140142144145146147149149150151

153154155156158159160161

163164166166168168170171172173174175177178179

181181181

182183184185185187187188190190

Table of Contents

3

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

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

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

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

10.13. BGP SPEAKER LIST10.14. BGP SPEAKER REMOVE NETWORK10.15. BGP SPEAKER REMOVE PEER10.16. BGP SPEAKER SET10.17. BGP SPEAKER SHOW DRAGENTS10.18. BGP SPEAKER SHOW

CHAPTER 11. BGPVPN11.1. BGPVPN CREATE11.2. BGPVPN DELETE11.3. BGPVPN LIST11.4. BGPVPN NETWORK ASSOCIATION CREATE11.5. BGPVPN NETWORK ASSOCIATION DELETE11.6. BGPVPN NETWORK ASSOCIATION LIST11.7. BGPVPN NETWORK ASSOCIATION SHOW11.8. BGPVPN PORT ASSOCIATION CREATE11.9. BGPVPN PORT ASSOCIATION DELETE11.10. BGPVPN PORT ASSOCIATION LIST11.11. BGPVPN PORT ASSOCIATION SET11.12. BGPVPN PORT ASSOCIATION SHOW11.13. BGPVPN PORT ASSOCIATION UNSET11.14. BGPVPN ROUTER ASSOCIATION CREATE11.15. BGPVPN ROUTER ASSOCIATION DELETE11.16. BGPVPN ROUTER ASSOCIATION LIST11.17. BGPVPN ROUTER ASSOCIATION SHOW11.18. BGPVPN SET11.19. BGPVPN SHOW11.20. BGPVPN UNSET

CHAPTER 12. CA12.1. CA GET12.2. CA LIST

CHAPTER 13. CATALOG13.1. CATALOG LIST13.2. CATALOG SHOW

CHAPTER 14. COE14.1. COE CA ROTATE14.2. COE CA SHOW14.3. COE CA SIGN14.4. COE CLUSTER CONFIG14.5. COE CLUSTER CREATE14.6. COE CLUSTER DELETE14.7. COE CLUSTER LIST14.8. COE CLUSTER SHOW14.9. COE CLUSTER TEMPLATE CREATE14.10. COE CLUSTER TEMPLATE DELETE14.11. COE CLUSTER TEMPLATE LIST14.12. COE CLUSTER TEMPLATE SHOW14.13. COE CLUSTER TEMPLATE UPDATE14.14. COE CLUSTER UPDATE14.15. COE QUOTAS CREATE14.16. COE QUOTAS DELETE

192193193194195196

198198199

200201

203204205207209209

211212213214216216218219

220222

224224225

227227228

230230230230231231

233233234236239239241242244244245


4

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

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

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

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

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

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

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

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

14.17. COE QUOTAS LIST14.18. COE QUOTAS SHOW14.19. COE QUOTAS UPDATE14.20. COE SERVICE LIST14.21. COE STATS LIST

CHAPTER 15. COMMAND15.1. COMMAND LIST

CHAPTER 16. COMPLETE.ADOC16.1. COMPLETE

CHAPTER 17. COMPUTE17.1. COMPUTE AGENT CREATE17.2. COMPUTE AGENT DELETE17.3. COMPUTE AGENT LIST17.4. COMPUTE AGENT SET17.5. COMPUTE SERVICE DELETE17.6. COMPUTE SERVICE LIST17.7. COMPUTE SERVICE SET

CHAPTER 18. CONFIGURATION18.1. CONFIGURATION SHOW

CHAPTER 19. CONSISTENCY19.1. CONSISTENCY GROUP ADD VOLUME19.2. CONSISTENCY GROUP CREATE19.3. CONSISTENCY GROUP DELETE19.4. CONSISTENCY GROUP LIST19.5. CONSISTENCY GROUP REMOVE VOLUME19.6. CONSISTENCY GROUP SET19.7. CONSISTENCY GROUP SHOW19.8. CONSISTENCY GROUP SNAPSHOT CREATE19.9. CONSISTENCY GROUP SNAPSHOT DELETE19.10. CONSISTENCY GROUP SNAPSHOT LIST19.11. CONSISTENCY GROUP SNAPSHOT SHOW

CHAPTER 20. CONSOLE20.1. CONSOLE LOG SHOW20.2. CONSOLE URL SHOW

CHAPTER 21. CONTAINER21.1. CONTAINER CREATE21.2. CONTAINER DELETE21.3. CONTAINER LIST21.4. CONTAINER SAVE21.5. CONTAINER SET21.6. CONTAINER SHOW21.7. CONTAINER UNSET

CHAPTER 22. CRON22.1. CRON TRIGGER CREATE22.2. CRON TRIGGER DELETE22.3. CRON TRIGGER LIST22.4. CRON TRIGGER SHOW

245246246247248

249249

251251

252252253254255255256257

259259

261261261

263263265265266267269269271

273273273

276276277278279280280282

283283284285286

Table of Contents

5

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

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

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

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

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

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

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

CHAPTER 23. DATASTORE23.1. DATASTORE LIST23.2. DATASTORE SHOW23.3. DATASTORE VERSION LIST23.4. DATASTORE VERSION SHOW

CHAPTER 24. DNS24.1. DNS QUOTA LIST24.2. DNS QUOTA RESET24.3. DNS QUOTA SET24.4. DNS SERVICE LIST24.5. DNS SERVICE SHOW

CHAPTER 25. EC225.1. EC2 CREDENTIALS CREATE25.2. EC2 CREDENTIALS DELETE25.3. EC2 CREDENTIALS LIST25.4. EC2 CREDENTIALS SHOW

CHAPTER 26. ENDPOINT26.1. ENDPOINT CREATE26.2. ENDPOINT DELETE26.3. ENDPOINT LIST26.4. ENDPOINT SHOW

CHAPTER 27. EVENT27.1. EVENT TRIGGER CREATE27.2. EVENT TRIGGER DELETE27.3. EVENT TRIGGER LIST27.4. EVENT TRIGGER SHOW

CHAPTER 28. EXTENSION28.1. EXTENSION LIST28.2. EXTENSION SHOW

CHAPTER 29. FIREWALL29.1. FIREWALL GROUP CREATE29.2. FIREWALL GROUP DELETE29.3. FIREWALL GROUP LIST29.4. FIREWALL GROUP POLICY ADD RULE29.5. FIREWALL GROUP POLICY CREATE29.6. FIREWALL GROUP POLICY DELETE29.7. FIREWALL GROUP POLICY LIST29.8. FIREWALL GROUP POLICY REMOVE RULE29.9. FIREWALL GROUP POLICY SET29.10. FIREWALL GROUP POLICY SHOW29.11. FIREWALL GROUP POLICY UNSET29.12. FIREWALL GROUP RULE CREATE29.13. FIREWALL GROUP RULE DELETE29.14. FIREWALL GROUP RULE LIST29.15. FIREWALL GROUP RULE SET29.16. FIREWALL GROUP RULE SHOW29.17. FIREWALL GROUP RULE UNSET29.18. FIREWALL GROUP SET29.19. FIREWALL GROUP SHOW

288288289290292

294294295295297299

301301302302304

306306307308309

311311312313314

316316317

320320322322324324326327328329330331332335335337338340341

342


6

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

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

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

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

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

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

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

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

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

29.20. FIREWALL GROUP UNSET

CHAPTER 30. FLAVOR30.1. FLAVOR CREATE30.2. FLAVOR DELETE30.3. FLAVOR LIST30.4. FLAVOR SET30.5. FLAVOR SHOW30.6. FLAVOR UNSET

CHAPTER 31. FLOATING31.1. FLOATING IP CREATE31.2. FLOATING IP DELETE31.3. FLOATING IP LIST31.4. FLOATING IP POOL LIST31.5. FLOATING IP SET31.6. FLOATING IP SHOW31.7. FLOATING IP UNSET

CHAPTER 32. HELP.ADOC32.1. HELP

CHAPTER 33. HOST33.1. HOST LIST33.2. HOST SET33.3. HOST SHOW

CHAPTER 34. HYPERVISOR34.1. HYPERVISOR LIST34.2. HYPERVISOR SHOW34.3. HYPERVISOR STATS SHOW

CHAPTER 35. IMAGE35.1. IMAGE ADD PROJECT35.2. IMAGE CREATE35.3. IMAGE DELETE35.4. IMAGE LIST35.5. IMAGE REMOVE PROJECT35.6. IMAGE SAVE35.7. IMAGE SET35.8. IMAGE SHOW35.9. IMAGE UNSET

CHAPTER 36. IP36.1. IP AVAILABILITY LIST36.2. IP AVAILABILITY SHOW

CHAPTER 37. KEYPAIR37.1. KEYPAIR CREATE37.2. KEYPAIR DELETE37.3. KEYPAIR LIST37.4. KEYPAIR SHOW

CHAPTER 38. LIMITS38.1. LIMITS SHOW

343

345345347347349349351

352352353354356357358359

361361

362362363363

366366367368

370370371

374374376376377379380

382382383

385385386386388

390390

Table of Contents

7

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

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

CHAPTER 39. LOADBALANCER39.1. LOADBALANCER AMPHORA LIST39.2. LOADBALANCER AMPHORA SHOW39.3. LOADBALANCER CREATE39.4. LOADBALANCER DELETE39.5. LOADBALANCER FAILOVER39.6. LOADBALANCER HEALTHMONITOR CREATE39.7. LOADBALANCER HEALTHMONITOR DELETE39.8. LOADBALANCER HEALTHMONITOR LIST39.9. LOADBALANCER HEALTHMONITOR SET39.10. LOADBALANCER HEALTHMONITOR SHOW39.11. LOADBALANCER L7POLICY CREATE39.12. LOADBALANCER L7POLICY DELETE39.13. LOADBALANCER L7POLICY LIST39.14. LOADBALANCER L7POLICY SET39.15. LOADBALANCER L7POLICY SHOW39.16. LOADBALANCER L7RULE CREATE39.17. LOADBALANCER L7RULE DELETE39.18. LOADBALANCER L7RULE LIST39.19. LOADBALANCER L7RULE SET39.20. LOADBALANCER L7RULE SHOW39.21. LOADBALANCER LIST39.22. LOADBALANCER LISTENER CREATE39.23. LOADBALANCER LISTENER DELETE39.24. LOADBALANCER LISTENER LIST39.25. LOADBALANCER LISTENER SET39.26. LOADBALANCER LISTENER SHOW39.27. LOADBALANCER LISTENER STATS SHOW39.28. LOADBALANCER MEMBER CREATE39.29. LOADBALANCER MEMBER DELETE39.30. LOADBALANCER MEMBER LIST39.31. LOADBALANCER MEMBER SET39.32. LOADBALANCER MEMBER SHOW39.33. LOADBALANCER POOL CREATE39.34. LOADBALANCER POOL DELETE39.35. LOADBALANCER POOL LIST39.36. LOADBALANCER POOL SET39.37. LOADBALANCER POOL SHOW39.38. LOADBALANCER QUOTA DEFAULTS SHOW39.39. LOADBALANCER QUOTA LIST39.40. LOADBALANCER QUOTA RESET39.41. LOADBALANCER QUOTA SET39.42. LOADBALANCER QUOTA SHOW39.43. LOADBALANCER SET39.44. LOADBALANCER SHOW39.45. LOADBALANCER STATS SHOW

CHAPTER 40. MESSAGING40.1. MESSAGING CLAIM CREATE40.2. MESSAGING CLAIM QUERY40.3. MESSAGING CLAIM RELEASE40.4. MESSAGING CLAIM RENEW40.5. MESSAGING FLAVOR CREATE

392392393395396397397400400401402404406406407408410411

412413414416417419

420421422424425427428429430431

433434435436437438440440442443444445

448448449451451

453


8

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

40.6. MESSAGING FLAVOR DELETE40.7. MESSAGING FLAVOR LIST40.8. MESSAGING FLAVOR SHOW40.9. MESSAGING FLAVOR UPDATE40.10. MESSAGING HEALTH40.11. MESSAGING HOMEDOC40.12. MESSAGING MESSAGE LIST40.13. MESSAGING MESSAGE POST40.14. MESSAGING PING40.15. MESSAGING POOL CREATE40.16. MESSAGING POOL DELETE40.17. MESSAGING POOL LIST40.18. MESSAGING POOL SHOW40.19. MESSAGING POOL UPDATE40.20. MESSAGING QUEUE CREATE40.21. MESSAGING QUEUE DELETE40.22. MESSAGING QUEUE GET METADATA40.23. MESSAGING QUEUE LIST40.24. MESSAGING QUEUE PURGE40.25. MESSAGING QUEUE SET METADATA40.26. MESSAGING QUEUE SIGNED URL40.27. MESSAGING QUEUE STATS40.28. MESSAGING SUBSCRIPTION CREATE40.29. MESSAGING SUBSCRIPTION DELETE40.30. MESSAGING SUBSCRIPTION LIST40.31. MESSAGING SUBSCRIPTION SHOW40.32. MESSAGING SUBSCRIPTION UPDATE

CHAPTER 41. METRIC41.1. METRIC AGGREGATES41.2. METRIC ARCHIVE-POLICY CREATE41.3. METRIC ARCHIVE-POLICY DELETE41.4. METRIC ARCHIVE-POLICY LIST41.5. METRIC ARCHIVE-POLICY-RULE CREATE41.6. METRIC ARCHIVE-POLICY-RULE DELETE41.7. METRIC ARCHIVE-POLICY-RULE LIST41.8. METRIC ARCHIVE-POLICY-RULE SHOW41.9. METRIC ARCHIVE-POLICY SHOW41.10. METRIC ARCHIVE-POLICY UPDATE41.11. METRIC BENCHMARK MEASURES ADD41.12. METRIC BENCHMARK MEASURES SHOW41.13. METRIC BENCHMARK METRIC CREATE41.14. METRIC BENCHMARK METRIC SHOW41.15. METRIC CAPABILITIES LIST41.16. METRIC CREATE41.17. METRIC DELETE41.18. METRIC LIST41.19. METRIC MEASURES ADD41.20. METRIC MEASURES AGGREGATION41.21. METRIC MEASURES BATCH-METRICS41.22. METRIC MEASURES BATCH-RESOURCES-METRICS41.23. METRIC MEASURES SHOW41.24. METRIC METRIC CREATE

454455456457459459459461

462463465465467468469471471

473474474475476478479480481

483

485485487488489490491

492493494496497499501

503504505507507509509512512513515

Table of Contents

9

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

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

41.25. METRIC METRIC DELETE41.26. METRIC METRIC LIST41.27. METRIC METRIC SHOW41.28. METRIC RESOURCE BATCH DELETE41.29. METRIC RESOURCE CREATE41.30. METRIC RESOURCE DELETE41.31. METRIC RESOURCE HISTORY41.32. METRIC RESOURCE LIST41.33. METRIC RESOURCE SEARCH41.34. METRIC RESOURCE SHOW41.35. METRIC RESOURCE-TYPE CREATE41.36. METRIC RESOURCE-TYPE DELETE41.37. METRIC RESOURCE-TYPE LIST41.38. METRIC RESOURCE-TYPE SHOW41.39. METRIC RESOURCE-TYPE UPDATE41.40. METRIC RESOURCE UPDATE41.41. METRIC SERVER VERSION41.42. METRIC SHOW41.43. METRIC STATUS

CHAPTER 42. MODULE42.1. MODULE LIST

CHAPTER 43. NETWORK43.1. NETWORK AGENT ADD NETWORK43.2. NETWORK AGENT ADD ROUTER43.3. NETWORK AGENT DELETE43.4. NETWORK AGENT LIST43.5. NETWORK AGENT REMOVE NETWORK43.6. NETWORK AGENT REMOVE ROUTER43.7. NETWORK AGENT SET43.8. NETWORK AGENT SHOW43.9. NETWORK AUTO ALLOCATED TOPOLOGY CREATE43.10. NETWORK AUTO ALLOCATED TOPOLOGY DELETE43.11. NETWORK CREATE43.12. NETWORK DELETE43.13. NETWORK FLAVOR ADD PROFILE43.14. NETWORK FLAVOR CREATE43.15. NETWORK FLAVOR DELETE43.16. NETWORK FLAVOR LIST43.17. NETWORK FLAVOR PROFILE CREATE43.18. NETWORK FLAVOR PROFILE DELETE43.19. NETWORK FLAVOR PROFILE LIST43.20. NETWORK FLAVOR PROFILE SET43.21. NETWORK FLAVOR PROFILE SHOW43.22. NETWORK FLAVOR REMOVE PROFILE43.23. NETWORK FLAVOR SET43.24. NETWORK FLAVOR SHOW43.25. NETWORK LIST43.26. NETWORK LOG CREATE43.27. NETWORK LOG DELETE43.28. NETWORK LOG LIST43.29. NETWORK LOG SET

516517518

520521

523523525526528530531532533534536538539540

542542

544544544545545547547548548550551

552555555555557558559561561562563565565566567570571

572573


10

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

43.30. NETWORK LOG SHOW43.31. NETWORK LOGGABLE RESOURCES LIST43.32. NETWORK METER CREATE43.33. NETWORK METER DELETE43.34. NETWORK METER LIST43.35. NETWORK METER RULE CREATE43.36. NETWORK METER RULE DELETE43.37. NETWORK METER RULE LIST43.38. NETWORK METER RULE SHOW43.39. NETWORK METER SHOW43.40. NETWORK QOS POLICY CREATE43.41. NETWORK QOS POLICY DELETE43.42. NETWORK QOS POLICY LIST43.43. NETWORK QOS POLICY SET43.44. NETWORK QOS POLICY SHOW43.45. NETWORK QOS RULE CREATE43.46. NETWORK QOS RULE DELETE43.47. NETWORK QOS RULE LIST43.48. NETWORK QOS RULE SET43.49. NETWORK QOS RULE SHOW43.50. NETWORK QOS RULE TYPE LIST43.51. NETWORK QOS RULE TYPE SHOW43.52. NETWORK RBAC CREATE43.53. NETWORK RBAC DELETE43.54. NETWORK RBAC LIST43.55. NETWORK RBAC SET43.56. NETWORK RBAC SHOW43.57. NETWORK SEGMENT CREATE43.58. NETWORK SEGMENT DELETE43.59. NETWORK SEGMENT LIST43.60. NETWORK SEGMENT SET43.61. NETWORK SEGMENT SHOW43.62. NETWORK SERVICE PROVIDER LIST43.63. NETWORK SET43.64. NETWORK SHOW43.65. NETWORK SUBPORT LIST43.66. NETWORK TRUNK CREATE43.67. NETWORK TRUNK DELETE43.68. NETWORK TRUNK LIST43.69. NETWORK TRUNK SET43.70. NETWORK TRUNK SHOW43.71. NETWORK TRUNK UNSET43.72. NETWORK UNSET

CHAPTER 44. OBJECT44.1. OBJECT CREATE44.2. OBJECT DELETE44.3. OBJECT LIST44.4. OBJECT SAVE44.5. OBJECT SET44.6. OBJECT SHOW44.7. OBJECT STORE ACCOUNT SET44.8. OBJECT STORE ACCOUNT SHOW

574575577578579580582582583585586588588590591592594594596597598599601

603603605605607608609610611

612613615616618619

620621622623624

625625626627628629629631631

Table of Contents

11

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

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

44.9. OBJECT STORE ACCOUNT UNSET44.10. OBJECT UNSET

CHAPTER 45. ORCHESTRATION45.1. ORCHESTRATION BUILD INFO45.2. ORCHESTRATION RESOURCE TYPE LIST45.3. ORCHESTRATION RESOURCE TYPE SHOW45.4. ORCHESTRATION SERVICE LIST45.5. ORCHESTRATION TEMPLATE FUNCTION LIST45.6. ORCHESTRATION TEMPLATE VALIDATE45.7. ORCHESTRATION TEMPLATE VERSION LIST

CHAPTER 46. OVERCLOUD46.1. OVERCLOUD CEPH-UPGRADE RUN46.2. OVERCLOUD CONFIG DOWNLOAD46.3. OVERCLOUD CONTAINER IMAGE BUILD46.4. OVERCLOUD CONTAINER IMAGE PREPARE46.5. OVERCLOUD CONTAINER IMAGE TAG DISCOVER46.6. OVERCLOUD CONTAINER IMAGE UPLOAD46.7. OVERCLOUD CREDENTIALS46.8. OVERCLOUD DELETE46.9. OVERCLOUD DEPLOY46.10. OVERCLOUD EXECUTE46.11. OVERCLOUD FAILURES46.12. OVERCLOUD FFWD-UPGRADE CONVERGE46.13. OVERCLOUD FFWD-UPGRADE PREPARE46.14. OVERCLOUD FFWD-UPGRADE RUN46.15. OVERCLOUD GENERATE FENCING46.16. OVERCLOUD IMAGE BUILD46.17. OVERCLOUD IMAGE UPLOAD46.18. OVERCLOUD NETENV VALIDATE46.19. OVERCLOUD NODE CONFIGURE46.20. OVERCLOUD NODE DELETE46.21. OVERCLOUD NODE DISCOVER46.22. OVERCLOUD NODE IMPORT46.23. OVERCLOUD NODE INTROSPECT46.24. OVERCLOUD NODE PROVIDE46.25. OVERCLOUD PARAMETERS SET46.26. OVERCLOUD PLAN CREATE46.27. OVERCLOUD PLAN DELETE46.28. OVERCLOUD PLAN DEPLOY46.29. OVERCLOUD PLAN EXPORT46.30. OVERCLOUD PLAN LIST46.31. OVERCLOUD PROFILES LIST46.32. OVERCLOUD PROFILES MATCH46.33. OVERCLOUD RAID CREATE46.34. OVERCLOUD ROLE LIST46.35. OVERCLOUD ROLE SHOW46.36. OVERCLOUD ROLES GENERATE46.37. OVERCLOUD STATUS46.38. OVERCLOUD SUPPORT REPORT COLLECT46.39. OVERCLOUD UPDATE CONVERGE46.40. OVERCLOUD UPDATE PREPARE

632633

634634635636638639641

642

644644648649649651652652653653657658658663667668669670670671672673674674675675676677677678678680682682683683684685685686690


12

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

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

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

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

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

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

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

46.41. OVERCLOUD UPDATE RUN46.42. OVERCLOUD UPGRADE CONVERGE46.43. OVERCLOUD UPGRADE PREPARE46.44. OVERCLOUD UPGRADE RUN

CHAPTER 47. PORT47.1. PORT CREATE47.2. PORT DELETE47.3. PORT LIST47.4. PORT SET47.5. PORT SHOW47.6. PORT UNSET

CHAPTER 48. PROJECT48.1. PROJECT CREATE48.2. PROJECT DELETE48.3. PROJECT LIST48.4. PROJECT PURGE48.5. PROJECT SET48.6. PROJECT SHOW48.7. PROJECT UNSET

CHAPTER 49. PTR49.1. PTR RECORD LIST49.2. PTR RECORD SET49.3. PTR RECORD SHOW49.4. PTR RECORD UNSET

CHAPTER 50. QUOTA50.1. QUOTA LIST50.2. QUOTA SET50.3. QUOTA SHOW

CHAPTER 51. RECORDSET51.1. RECORDSET CREATE51.2. RECORDSET DELETE51.3. RECORDSET LIST51.4. RECORDSET SET51.5. RECORDSET SHOW

CHAPTER 52. RESOURCE52.1. RESOURCE MEMBER CREATE52.2. RESOURCE MEMBER DELETE52.3. RESOURCE MEMBER LIST52.4. RESOURCE MEMBER SHOW52.5. RESOURCE MEMBER UPDATE

CHAPTER 53. ROLE53.1. ROLE ADD53.2. ROLE ASSIGNMENT LIST53.3. ROLE CREATE53.4. ROLE DELETE53.5. ROLE LIST53.6. ROLE REMOVE53.7. ROLE SHOW

695696700705

707707709710712714716

718718719

720721

722722724

725725726728729

731731732734

737737738740742744

746746747748749751

753753754756757757759759

Table of Contents

13

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

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

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

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

CHAPTER 54. ROUTER54.1. ROUTER ADD PORT54.2. ROUTER ADD SUBNET54.3. ROUTER CREATE54.4. ROUTER DELETE54.5. ROUTER LIST54.6. ROUTER REMOVE PORT54.7. ROUTER REMOVE SUBNET54.8. ROUTER SET54.9. ROUTER SHOW54.10. ROUTER UNSET

CHAPTER 55. SECRET55.1. SECRET CONTAINER CREATE55.2. SECRET CONTAINER DELETE55.3. SECRET CONTAINER GET55.4. SECRET CONTAINER LIST55.5. SECRET DELETE55.6. SECRET GET55.7. SECRET LIST55.8. SECRET ORDER CREATE55.9. SECRET ORDER DELETE55.10. SECRET ORDER GET55.11. SECRET ORDER LIST55.12. SECRET STORE55.13. SECRET UPDATE

CHAPTER 56. SECURITY56.1. SECURITY GROUP CREATE56.2. SECURITY GROUP DELETE56.3. SECURITY GROUP LIST56.4. SECURITY GROUP RULE CREATE56.5. SECURITY GROUP RULE DELETE56.6. SECURITY GROUP RULE LIST56.7. SECURITY GROUP RULE SHOW56.8. SECURITY GROUP SET56.9. SECURITY GROUP SHOW

CHAPTER 57. SERVER57.1. SERVER ADD FIXED IP57.2. SERVER ADD FLOATING IP57.3. SERVER ADD NETWORK57.4. SERVER ADD PORT57.5. SERVER ADD SECURITY GROUP57.6. SERVER ADD VOLUME57.7. SERVER BACKUP CREATE57.8. SERVER CREATE57.9. SERVER DELETE57.10. SERVER DUMP CREATE57.11. SERVER EVENT LIST57.12. SERVER EVENT SHOW57.13. SERVER GROUP CREATE57.14. SERVER GROUP DELETE57.15. SERVER GROUP LIST

761761761762764764766766767768770

771771

772772774775776777779781782783784786

787787788789790792793794796796

799799799800800801801802803806807807809810812812


14

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

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

57.16. SERVER GROUP SHOW57.17. SERVER IMAGE CREATE57.18. SERVER LIST57.19. SERVER LOCK57.20. SERVER MIGRATE57.21. SERVER PAUSE57.22. SERVER REBOOT57.23. SERVER REBUILD57.24. SERVER REMOVE FIXED IP57.25. SERVER REMOVE FLOATING IP57.26. SERVER REMOVE NETWORK57.27. SERVER REMOVE PORT57.28. SERVER REMOVE SECURITY GROUP57.29. SERVER REMOVE VOLUME57.30. SERVER RESCUE57.31. SERVER RESIZE57.32. SERVER RESTORE57.33. SERVER RESUME57.34. SERVER SET57.35. SERVER SHELVE57.36. SERVER SHOW57.37. SERVER SSH57.38. SERVER START57.39. SERVER STOP57.40. SERVER SUSPEND57.41. SERVER UNLOCK57.42. SERVER UNPAUSE57.43. SERVER UNRESCUE57.44. SERVER UNSET57.45. SERVER UNSHELVE

CHAPTER 58. SERVICE58.1. SERVICE CREATE58.2. SERVICE DELETE58.3. SERVICE LIST58.4. SERVICE SHOW

CHAPTER 59. SFC59.1. SFC FLOW CLASSIFIER CREATE59.2. SFC FLOW CLASSIFIER DELETE59.3. SFC FLOW CLASSIFIER LIST59.4. SFC FLOW CLASSIFIER SET59.5. SFC FLOW CLASSIFIER SHOW59.6. SFC PORT CHAIN CREATE59.7. SFC PORT CHAIN DELETE59.8. SFC PORT CHAIN LIST59.9. SFC PORT CHAIN SET59.10. SFC PORT CHAIN SHOW59.11. SFC PORT CHAIN UNSET59.12. SFC PORT PAIR CREATE59.13. SFC PORT PAIR DELETE59.14. SFC PORT PAIR GROUP CREATE59.15. SFC PORT PAIR GROUP DELETE

813815816818819

820820821822823823824824825825826827827827828828830831831832832832833833834

835835836836838

840840842842843844845847847849850851852853854856

Table of Contents

15

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

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

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

59.16. SFC PORT PAIR GROUP LIST59.17. SFC PORT PAIR GROUP SET59.18. SFC PORT PAIR GROUP SHOW59.19. SFC PORT PAIR GROUP UNSET59.20. SFC PORT PAIR LIST59.21. SFC PORT PAIR SET59.22. SFC PORT PAIR SHOW59.23. SFC SERVICE GRAPH CREATE59.24. SFC SERVICE GRAPH DELETE59.25. SFC SERVICE GRAPH LIST59.26. SFC SERVICE GRAPH SET59.27. SFC SERVICE GRAPH SHOW

CHAPTER 60. SNAPSHOT60.1. SNAPSHOT CREATE60.2. SNAPSHOT DELETE60.3. SNAPSHOT LIST60.4. SNAPSHOT SET60.5. SNAPSHOT SHOW60.6. SNAPSHOT UNSET

CHAPTER 61. SOFTWARE61.1. SOFTWARE CONFIG CREATE61.2. SOFTWARE CONFIG DELETE61.3. SOFTWARE CONFIG LIST61.4. SOFTWARE CONFIG SHOW61.5. SOFTWARE DEPLOYMENT CREATE61.6. SOFTWARE DEPLOYMENT DELETE61.7. SOFTWARE DEPLOYMENT LIST61.8. SOFTWARE DEPLOYMENT METADATA SHOW61.9. SOFTWARE DEPLOYMENT OUTPUT SHOW61.10. SOFTWARE DEPLOYMENT SHOW

CHAPTER 62. STACK62.1. STACK ABANDON62.2. STACK ADOPT62.3. STACK CANCEL62.4. STACK CHECK62.5. STACK CREATE62.6. STACK DELETE62.7. STACK ENVIRONMENT SHOW62.8. STACK EVENT LIST62.9. STACK EVENT SHOW62.10. STACK EXPORT62.11. STACK FAILURES LIST62.12. STACK FILE LIST62.13. STACK HOOK CLEAR62.14. STACK HOOK POLL62.15. STACK LIST62.16. STACK OUTPUT LIST62.17. STACK OUTPUT SHOW62.18. STACK RESOURCE LIST62.19. STACK RESOURCE MARK UNHEALTHY62.20. STACK RESOURCE METADATA

856857858859860861

862863865865866867

869869870871872873874

875875876877878879881

882883884884

887887888890891

892894895896898900901901

903903905907908910911

912


16

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

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

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

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

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

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

62.21. STACK RESOURCE SHOW62.22. STACK RESOURCE SIGNAL62.23. STACK RESUME62.24. STACK SHOW62.25. STACK SNAPSHOT CREATE62.26. STACK SNAPSHOT DELETE62.27. STACK SNAPSHOT LIST62.28. STACK SNAPSHOT RESTORE62.29. STACK SNAPSHOT SHOW62.30. STACK SUSPEND62.31. STACK TEMPLATE SHOW62.32. STACK UPDATE

CHAPTER 63. SUBNET63.1. SUBNET CREATE63.2. SUBNET DELETE63.3. SUBNET LIST63.4. SUBNET POOL CREATE63.5. SUBNET POOL DELETE63.6. SUBNET POOL LIST63.7. SUBNET POOL SET63.8. SUBNET POOL SHOW63.9. SUBNET POOL UNSET63.10. SUBNET SET63.11. SUBNET SHOW63.12. SUBNET UNSET

CHAPTER 64. TASK64.1. TASK EXECUTION LIST64.2. TASK EXECUTION PUBLISHED SHOW64.3. TASK EXECUTION RERUN64.4. TASK EXECUTION RESULT SHOW64.5. TASK EXECUTION SHOW

CHAPTER 65. TLD65.1. TLD CREATE65.2. TLD DELETE65.3. TLD LIST65.4. TLD SET65.5. TLD SHOW

CHAPTER 66. TOKEN66.1. TOKEN ISSUE66.2. TOKEN REVOKE

CHAPTER 67. TSIGKEY67.1. TSIGKEY CREATE67.2. TSIGKEY DELETE67.3. TSIGKEY LIST67.4. TSIGKEY SET67.5. TSIGKEY SHOW

CHAPTER 68. UNDERCLOUD68.1. UNDERCLOUD BACKUP68.2. UNDERCLOUD DEPLOY

913915915917918919

920921922923925926

929929932932934937937939941

942942944945

947947948949950950

953953954955956958

960960961

962962963964965967

970970970

Table of Contents

17

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

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

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

68.3. UNDERCLOUD INSTALL68.4. UNDERCLOUD UPGRADE

CHAPTER 69. USAGE69.1. USAGE LIST69.2. USAGE SHOW

CHAPTER 70. USER70.1. USER CREATE70.2. USER DELETE70.3. USER LIST70.4. USER ROLE LIST70.5. USER SET70.6. USER SHOW

CHAPTER 71. VOLUME71.1. VOLUME BACKUP CREATE71.2. VOLUME BACKUP DELETE71.3. VOLUME BACKUP LIST71.4. VOLUME BACKUP RESTORE71.5. VOLUME BACKUP SET71.6. VOLUME BACKUP SHOW71.7. VOLUME CREATE71.8. VOLUME DELETE71.9. VOLUME HOST FAILOVER71.10. VOLUME HOST SET71.11. VOLUME LIST71.12. VOLUME MIGRATE71.13. VOLUME QOS ASSOCIATE71.14. VOLUME QOS CREATE71.15. VOLUME QOS DELETE71.16. VOLUME QOS DISASSOCIATE71.17. VOLUME QOS LIST71.18. VOLUME QOS SET71.19. VOLUME QOS SHOW71.20. VOLUME QOS UNSET71.21. VOLUME SERVICE LIST71.22. VOLUME SERVICE SET71.23. VOLUME SET71.24. VOLUME SHOW71.25. VOLUME SNAPSHOT CREATE71.26. VOLUME SNAPSHOT DELETE71.27. VOLUME SNAPSHOT LIST71.28. VOLUME SNAPSHOT SET71.29. VOLUME SNAPSHOT SHOW71.30. VOLUME SNAPSHOT UNSET71.31. VOLUME TRANSFER REQUEST ACCEPT71.32. VOLUME TRANSFER REQUEST CREATE71.33. VOLUME TRANSFER REQUEST DELETE71.34. VOLUME TRANSFER REQUEST LIST71.35. VOLUME TRANSFER REQUEST SHOW71.36. VOLUME TYPE CREATE71.37. VOLUME TYPE DELETE71.38. VOLUME TYPE LIST

971972

973973974

976976977978979981981

98398398498598698898899099299399399499699699799899999910011001

100310031005100510071008100910101012101310141015101610181018

10201021

10231024


18

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

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

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

71.39. VOLUME TYPE SET71.40. VOLUME TYPE SHOW71.41. VOLUME TYPE UNSET71.42. VOLUME UNSET

CHAPTER 72. WORKBOOK72.1. WORKBOOK CREATE72.2. WORKBOOK DEFINITION SHOW72.3. WORKBOOK DELETE72.4. WORKBOOK LIST72.5. WORKBOOK SHOW72.6. WORKBOOK UPDATE72.7. WORKBOOK VALIDATE

CHAPTER 73. WORKFLOW73.1. WORKFLOW CREATE73.2. WORKFLOW DEFINITION SHOW73.3. WORKFLOW DELETE73.4. WORKFLOW ENGINE SERVICE LIST73.5. WORKFLOW ENV CREATE73.6. WORKFLOW ENV DELETE73.7. WORKFLOW ENV LIST73.8. WORKFLOW ENV SHOW73.9. WORKFLOW ENV UPDATE73.10. WORKFLOW EXECUTION CREATE73.11. WORKFLOW EXECUTION DELETE73.12. WORKFLOW EXECUTION INPUT SHOW73.13. WORKFLOW EXECUTION LIST73.14. WORKFLOW EXECUTION OUTPUT SHOW73.15. WORKFLOW EXECUTION SHOW73.16. WORKFLOW EXECUTION UPDATE73.17. WORKFLOW LIST73.18. WORKFLOW SHOW73.19. WORKFLOW UPDATE73.20. WORKFLOW VALIDATE

CHAPTER 74. ZONE74.1. ZONE ABANDON74.2. ZONE AXFR74.3. ZONE BLACKLIST CREATE74.4. ZONE BLACKLIST DELETE74.5. ZONE BLACKLIST LIST74.6. ZONE BLACKLIST SET74.7. ZONE BLACKLIST SHOW74.8. ZONE CREATE74.9. ZONE DELETE74.10. ZONE EXPORT CREATE74.11. ZONE EXPORT DELETE74.12. ZONE EXPORT LIST74.13. ZONE EXPORT SHOW74.14. ZONE EXPORT SHOWFILE74.15. ZONE IMPORT CREATE74.16. ZONE IMPORT DELETE74.17. ZONE IMPORT LIST

1025102610281028

10301030103110311032103310341036

103810381039104010401041

104310431044104610471049104910501051

105210531055105610571059

106110611061106210631064106510671068107010721073107410751077107810801080

Table of Contents

19

74.18. ZONE IMPORT SHOW74.19. ZONE LIST74.20. ZONE SET74.21. ZONE SHOW74.22. ZONE TRANSFER ACCEPT LIST74.23. ZONE TRANSFER ACCEPT REQUEST74.24. ZONE TRANSFER ACCEPT SHOW74.25. ZONE TRANSFER REQUEST CREATE74.26. ZONE TRANSFER REQUEST DELETE74.27. ZONE TRANSFER REQUEST LIST74.28. ZONE TRANSFER REQUEST SET74.29. ZONE TRANSFER REQUEST SHOW

1082108310851087108810901091

10931094109510971098


20

Table of Contents

21

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


22

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 . :leveloffset: +1

Command-line interface to the OpenStack APIs

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 ] [--os-queues-api-version ] [--os-tripleoclient-api-version ] [--os-key-manager-api-version ] [--os-loadbalancer-api-version ] [--os-metrics-api-version ] [--os-workflow-api-version ] [--os-baremetal-api-version ] [--os-dns-api-version ] [--os-alarming-api-version ] [--os-orchestration-api-version ] [--os-data-processing-api-version ] [--os-data-processing-url OS_DATA_PROCESSING_URL] [--os-container-infra-api-version ] [--inspector-api-version INSPECTOR_API_VERSION] [--inspector-url INSPECTOR_URL] [--os-database-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 ] [--os-code ] [--os-application-credential-name ]


23

[--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 ]

Table 1.1. Optional Arguments

Value Summary

--inspector-url INSPECTOR_URL Inspector url, defaults to localhost (env:INSPECTOR_URL).

--os-cacert Ca certificate bundle file (env: os_cacert)

--os-baremetal-api-version Bare metal api version, default="latest" (themaximum version supported by both the client andthe server). (Env: OS_BAREMETAL_API_VERSION)

--inspector-api-version INSPECTOR_API_VERSION Inspector api version, only 1 is supported now (env:INSPECTOR_VERSION).

--os-redirect-uri With v3oidcauthcode: openid connect redirect url(env: OS_REDIRECT_URI)

--os-cloud Cloud name in clouds.yaml (env: os_cloud)


24

--os-container-infra-api-version

Container-infra api version, default=1 (env:OS_CONTAINER_INFRA_API_VERSION)

--os-alarming-api-version Queues api version, default=2 (env:OS_ALARMING_API_VERSION)

--os-user-id With v2password: user id to login with withv3password: User ID With noauth: User ID Withv3totp: User ID With aodh-noauth: User ID Withgnocchi-noauth: User ID With password: User id Withv3applicationcredential: User ID (Env: OS_USER_ID)

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

--os-project-name With v3adfspassword: project name to scope to withv3password: Project name to scope to With v3token:Project name to scope to With v3oidcauthcode:Project name to scope to With v3samlpassword:Project name to scope to With v1password: Swiftaccount to use With v3totp: Project name to scopeto With v3tokenlessauth: Project name to scope toWith v3oidcclientcredentials: Project name to scopeto With password: Project name to scope to Withv3oidcaccesstoken: Project name to scope to Withv3oidcpassword: Project name to scope to Withtoken: Project name to scope to Withv3applicationcredential: Project name to scope to(Env: OS_PROJECT_NAME)

--os-trust-id With v2token: trust id with v3adfspassword: trust idWith v2password: Trust ID With v3password: Trust IDWith v3token: Trust ID With v3oidcauthcode: Trust IDWith v3samlpassword: Trust ID With v3totp: Trust IDWith v3oidcclientcredentials: Trust ID With password:Trust ID With v3oidcaccesstoken: Trust ID Withv3oidcpassword: Trust ID With token: Trust ID Withv3applicationcredential: Trust ID (Env:OS_TRUST_ID)

--os-identity-api-version Identity api version, default=3 (env:OS_IDENTITY_API_VERSION)

--os-remote-project-name Project name when authenticating to a serviceprovider if using Keystone-to-Keystone federation.

--verify Verify server certificate (default)

Value Summary


25

--os-remote-project-domain-id

Domain id of the project when authenticating to aservice provider if using Keystone-to-Keystonefederation.

--os-system-scope With v3adfspassword: scope for system operationswith v3password: Scope for system operations Withv3token: Scope for system operations Withv3oidcauthcode: Scope for system operations Withv3samlpassword: Scope for system operations Withv3totp: Scope for system operations Withv3oidcclientcredentials: Scope for system operationsWith password: Scope for system operations Withv3oidcaccesstoken: Scope for system operationsWith v3oidcpassword: Scope for system operationsWith token: Scope for system operations Withv3applicationcredential: Scope for system operations(Env: OS_SYSTEM_SCOPE)

--os-auth-type Select an authentication type. available types:v2token, v3adfspassword, admin_token, v2password,v3password, noauth, v3token, v3oauth1,v3oidcauthcode, v3samlpassword, token_endpoint,v1password, v3totp, aodh-noauth, v3tokenlessauth,v3oidcclientcredentials, gnocchi-basic, gnocchi-noauth, password, none, v3oidcaccesstoken,v3oidcpassword, token, v3applicationcredential.Default: selected based on --os-username/--os-token (Env: OS_AUTH_TYPE)

--os-remote-project-domain-name

Domain name of the project when authenticating to aservice provider if using Keystone-to-Keystonefederation.

Value Summary


26

--os-project-domain-name

With v3adfspassword: domain name containingproject With v3password: Domain name containingproject With v3token: Domain name containingproject With v3oidcauthcode: Domain namecontaining project With v3samlpassword: Domainname containing project With v3totp: Domain namecontaining project With v3tokenlessauth: Domainname containing project Withv3oidcclientcredentials: Domain name containingproject With password: Domain name containingproject With v3oidcaccesstoken: Domain namecontaining project With v3oidcpassword: Domainname containing project With token: Domain namecontaining project With v3applicationcredential:Domain name containing project (Env:OS_PROJECT_DOMAIN_NAME)

--os-endpoint With admin_token: the endpoint that will always beused With noauth: Cinder endpoint With gnocchi-basic: Gnocchi endpoint With gnocchi-noauth:Gnocchi endpoint With none: The endpoint that willalways be used (Env: OS_ENDPOINT)

--os-default-domain-name

With password: optional domain name to use with v3api and v2 parameters. It will be used for both theuser and project domain in v3 and ignored in v2authentication. With token: Optional domain name touse with v3 API and v2 parameters. It will be used forboth the user and project domain in v3 and ignored inv2 authentication. (Env:OS_DEFAULT_DOMAIN_NAME)

--os-aodh-endpoint With aodh-noauth: aodh endpoint (env:OS_AODH_ENDPOINT)

--os-roles With aodh-noauth: roles with gnocchi-noauth: roles(Env: OS_ROLES)

--os-application-credential-name

With v3applicationcredential: application credentialname (Env:OS_APPLICATION_CREDENTIAL_NAME)

--os-dns-api-version Dns api version, default=2 (env: os_dns_api_version)

--os-key-manager-api-version

Barbican api version, default=1 (env:OS_KEY_MANAGER_API_VERSION)

--os-data-processing-api-version

Data processing api version, default=1.1 (env:OS_DATA_PROCESSING_API_VERSION)

Value Summary


27

--os-service-provider-entity-id

With v3adfspassword: service provider’s saml entityid (Env: OS_SERVICE_PROVIDER_ENTITY_ID)

--os-access-secret With v3oauth1: oauth access secret (env:OS_ACCESS_SECRET)

--os-beta-command Enable beta commands which are subject to change

--os-orchestration-api-version

Orchestration api version, default=1 (env:OS_ORCHESTRATION_API_VERSION)

--os-service-provider-endpoint

With v3adfspassword: service provider’s endpoint(env: OS_SERVICE_PROVIDER_ENDPOINT)

--timing Print api call timing info

--os-tripleoclient-api-version

Tripleo client api version, default=1 (env:OS_TRIPLEOCLIENT_API_VERSION)

--os-loadbalancer-api-version

Osc plugin api version, default=2.0 (env:OS_LOADBALANCER_API_VERSION)

--os-protocol With v3adfspassword: protocol for federated pluginWith v3oidcauthcode: Protocol for federated pluginWith v3samlpassword: Protocol for federated pluginWith v3oidcclientcredentials: Protocol for federatedplugin With v3oidcaccesstoken: Protocol forfederated plugin With v3oidcpassword: Protocol forfederated plugin (Env: OS_PROTOCOL)

--os-auth-url With v2token: authentication url withv3adfspassword: Authentication URL Withv2password: Authentication URL With v3password:Authentication URL With v3token: AuthenticationURL With v3oauth1: Authentication URL Withv3oidcauthcode: Authentication URL Withv3samlpassword: Authentication URL Withv1password: Authentication URL With v3totp:Authentication URL With v3tokenlessauth:Authentication URL With v3oidcclientcredentials:Authentication URL With password: AuthenticationURL With v3oidcaccesstoken: Authentication URLWith v3oidcpassword: Authentication URL Withtoken: Authentication URL Withv3applicationcredential: Authentication URL (Env:OS_AUTH_URL)

--os-user With gnocchi-basic: user (env: os_user)

Value Summary


28

--os-client-secret With v3oidcauthcode: oauth 2.0 client secret withv3oidcclientcredentials: OAuth 2.0 Client SecretWith v3oidcpassword: OAuth 2.0 Client Secret (Env:OS_CLIENT_SECRET)

--os-project-domain-id With v3adfspassword: domain id containing projectwith v3password: Domain ID containing project Withv3token: Domain ID containing project Withv3oidcauthcode: Domain ID containing project Withv3samlpassword: Domain ID containing project Withv3totp: Domain ID containing project Withv3tokenlessauth: Domain ID containing project Withv3oidcclientcredentials: Domain ID containing projectWith password: Domain ID containing project Withv3oidcaccesstoken: Domain ID containing projectWith v3oidcpassword: Domain ID containing projectWith token: Domain ID containing project Withv3applicationcredential: Domain ID containingproject (Env: OS_PROJECT_DOMAIN_ID)

--insecure Disable server certificate verification

--os-network-api-version Network api version, default=2.0 (env:OS_NETWORK_API_VERSION)

--os-password With v3adfspassword: password with v2password:Password to use With v3password: User’s passwordWith v3samlpassword: Password With v1password:Password to use With password: User’s passwordWith v3oidcpassword: Password (Env:OS_PASSWORD)

--os-cert Client certificate bundle file (env: os_cert)

--os-code With v3oidcauthcode: oauth 2.0 authorization code(Env: OS_CODE)

--os-consumer-secret With v3oauth1: oauth consumer secret (env:OS_CONSUMER_SECRET)

--os-compute-api-version Compute api version, default=2.1 (env:OS_COMPUTE_API_VERSION)

Value Summary


29

--os-default-domain-id With password: optional domain id to use with v3 andv2 parameters. It will be used for both the user andproject domain in v3 and ignored in v2authentication. With token: Optional domain ID touse with v3 and v2 parameters. It will be used forboth the user and project domain in v3 and ignored inv2 authentication. (Env: OS_DEFAULT_DOMAIN_ID)

--os-access-token With v3oidcaccesstoken: oauth 2.0 access token(env: OS_ACCESS_TOKEN)

--os-region-n

red hat openstack platform 13 · 9.28. baremetal node add trait 9.29. baremetal node adopt 9.30....

Documents