|
657 | 657 | "subcommands": [ |
658 | 658 | { |
659 | 659 | "name": "create", |
660 | | - "about": "Create a new support bundle", |
| 660 | + "about": "Create support bundle", |
661 | 661 | "args": [ |
662 | 662 | { |
663 | 663 | "long": "json-body", |
|
680 | 680 | }, |
681 | 681 | { |
682 | 682 | "name": "delete", |
683 | | - "about": "Delete an existing support bundle", |
| 683 | + "about": "Delete support bundle", |
684 | 684 | "long_about": "May also be used to cancel a support bundle which is currently being collected, or to remove metadata for a support bundle that has failed.", |
685 | 685 | "args": [ |
686 | 686 | { |
|
764 | 764 | }, |
765 | 765 | { |
766 | 766 | "name": "update", |
767 | | - "about": "Update a support bundle", |
| 767 | + "about": "Update support bundle", |
768 | 768 | "args": [ |
769 | 769 | { |
770 | 770 | "long": "bundle-id", |
|
818 | 818 | "subcommands": [ |
819 | 819 | { |
820 | 820 | "name": "create", |
821 | | - "about": "Create new system-wide x.509 certificate", |
| 821 | + "about": "Create system-wide x.509 certificate", |
822 | 822 | "long_about": "This certificate is automatically used by the Oxide Control plane to serve external connections.", |
823 | 823 | "args": [ |
824 | 824 | { |
|
2149 | 2149 | "subcommands": [ |
2150 | 2150 | { |
2151 | 2151 | "name": "attach", |
2152 | | - "about": "Attach an external subnet to an instance", |
| 2152 | + "about": "Attach external subnet to instance", |
2153 | 2153 | "args": [ |
2154 | 2154 | { |
2155 | 2155 | "long": "external-subnet", |
|
2180 | 2180 | }, |
2181 | 2181 | { |
2182 | 2182 | "name": "create", |
2183 | | - "about": "Create an external subnet", |
| 2183 | + "about": "Create external subnet", |
2184 | 2184 | "args": [ |
2185 | 2185 | { |
2186 | 2186 | "long": "description" |
|
2209 | 2209 | }, |
2210 | 2210 | { |
2211 | 2211 | "name": "delete", |
2212 | | - "about": "Delete an external subnet", |
| 2212 | + "about": "Delete external subnet", |
2213 | 2213 | "args": [ |
2214 | 2214 | { |
2215 | 2215 | "long": "external-subnet", |
|
2228 | 2228 | }, |
2229 | 2229 | { |
2230 | 2230 | "name": "detach", |
2231 | | - "about": "Detach an external subnet from an instance", |
| 2231 | + "about": "Detach external subnet from instance", |
2232 | 2232 | "args": [ |
2233 | 2233 | { |
2234 | 2234 | "long": "external-subnet", |
|
2247 | 2247 | }, |
2248 | 2248 | { |
2249 | 2249 | "name": "list", |
2250 | | - "about": "List external subnets in a project", |
| 2250 | + "about": "List external subnets", |
2251 | 2251 | "args": [ |
2252 | 2252 | { |
2253 | 2253 | "long": "limit", |
|
2274 | 2274 | }, |
2275 | 2275 | { |
2276 | 2276 | "name": "update", |
2277 | | - "about": "Update an external subnet", |
| 2277 | + "about": "Update external subnet", |
2278 | 2278 | "args": [ |
2279 | 2279 | { |
2280 | 2280 | "long": "description" |
|
2307 | 2307 | }, |
2308 | 2308 | { |
2309 | 2309 | "name": "view", |
2310 | | - "about": "Fetch an external subnet", |
| 2310 | + "about": "Fetch external subnet", |
2311 | 2311 | "args": [ |
2312 | 2312 | { |
2313 | 2313 | "long": "external-subnet", |
|
2377 | 2377 | }, |
2378 | 2378 | { |
2379 | 2379 | "name": "create", |
2380 | | - "about": "Create a floating IP", |
| 2380 | + "about": "Create floating IP", |
2381 | 2381 | "long_about": "A specific IP address can be reserved, or an IP can be auto-allocated from a specific pool or the silo's default pool.", |
2382 | 2382 | "args": [ |
2383 | 2383 | { |
|
5049 | 5049 | "subcommands": [ |
5050 | 5050 | { |
5051 | 5051 | "name": "list", |
5052 | | - "about": "Lists resource quotas for all silos", |
| 5052 | + "about": "List resource quotas for all silos", |
5053 | 5053 | "args": [ |
5054 | 5054 | { |
5055 | 5055 | "long": "limit", |
|
5595 | 5595 | }, |
5596 | 5596 | { |
5597 | 5597 | "name": "status", |
5598 | | - "about": "Retrieve the rack cluster membership status", |
| 5598 | + "about": "Fetch rack cluster membership status", |
5599 | 5599 | "long_about": "Returns the status for the most recent change, or a specific version if one is specified.", |
5600 | 5600 | "args": [ |
5601 | 5601 | { |
|
5862 | 5862 | "help": "A rack id to use when selecting switch ports." |
5863 | 5863 | }, |
5864 | 5864 | { |
5865 | | - "long": "switch-location", |
5866 | | - "help": "A switch location to use when selecting switch ports." |
| 5865 | + "long": "switch-slot", |
| 5866 | + "values": [ |
| 5867 | + "switch0", |
| 5868 | + "switch1" |
| 5869 | + ], |
| 5870 | + "help": "The slot of the switch within the rack to use when selecting switch ports." |
5867 | 5871 | } |
5868 | 5872 | ] |
5869 | 5873 | }, |
|
5885 | 5889 | "help": "A rack id to use when selecting switch ports." |
5886 | 5890 | }, |
5887 | 5891 | { |
5888 | | - "long": "switch-location", |
5889 | | - "help": "A switch location to use when selecting switch ports." |
| 5892 | + "long": "switch-slot", |
| 5893 | + "values": [ |
| 5894 | + "switch0", |
| 5895 | + "switch1" |
| 5896 | + ], |
| 5897 | + "help": "The slot of the switch within the rack to use when selecting switch ports." |
5890 | 5898 | } |
5891 | 5899 | ] |
5892 | 5900 | }, |
|
5944 | 5952 | "help": "A rack id to use when selecting switch ports." |
5945 | 5953 | }, |
5946 | 5954 | { |
5947 | | - "long": "switch-location", |
5948 | | - "help": "A switch location to use when selecting switch ports." |
| 5955 | + "long": "switch-slot", |
| 5956 | + "values": [ |
| 5957 | + "switch0", |
| 5958 | + "switch1" |
| 5959 | + ], |
| 5960 | + "help": "The slot of the switch within the rack to use when selecting switch ports." |
5949 | 5961 | } |
5950 | 5962 | ] |
5951 | 5963 | } |
|
6329 | 6341 | "help": "Address of the remote peer to disable a BFD session for." |
6330 | 6342 | }, |
6331 | 6343 | { |
6332 | | - "long": "switch", |
6333 | | - "help": "The switch to enable this session on. Must be `switch0` or `switch1`." |
| 6344 | + "long": "switch-slot", |
| 6345 | + "values": [ |
| 6346 | + "switch0", |
| 6347 | + "switch1" |
| 6348 | + ], |
| 6349 | + "help": "The slot of the switch within the rack to disable this session on." |
6334 | 6350 | } |
6335 | 6351 | ] |
6336 | 6352 | }, |
|
6376 | 6392 | "help": "The minimum interval, in microseconds, between received BFD Control packets that this system requires" |
6377 | 6393 | }, |
6378 | 6394 | { |
6379 | | - "long": "switch", |
6380 | | - "help": "The switch to enable this session on. Must be `switch0` or `switch1`." |
| 6395 | + "long": "switch-slot", |
| 6396 | + "values": [ |
| 6397 | + "switch0", |
| 6398 | + "switch1" |
| 6399 | + ], |
| 6400 | + "help": "The slot of the switch within the rack to enable this session on." |
6381 | 6401 | } |
6382 | 6402 | ] |
6383 | 6403 | }, |
|
6620 | 6640 | "subcommands": [ |
6621 | 6641 | { |
6622 | 6642 | "name": "create", |
6623 | | - "about": "Create new BGP configuration", |
| 6643 | + "about": "Create BGP configuration", |
6624 | 6644 | "args": [ |
6625 | 6645 | { |
6626 | 6646 | "long": "asn", |
|
7844 | 7864 | "subcommands": [ |
7845 | 7865 | { |
7846 | 7866 | "name": "neighbors", |
7847 | | - "about": "Fetch the LLDP neighbors seen on a switch port", |
| 7867 | + "about": "Fetch LLDP neighbors for switch port", |
7848 | 7868 | "args": [ |
7849 | 7869 | { |
7850 | 7870 | "long": "limit", |
|
7870 | 7890 | ] |
7871 | 7891 | }, |
7872 | 7892 | { |
7873 | | - "long": "switch-location", |
7874 | | - "help": "A switch location to use when selecting switch ports." |
| 7893 | + "long": "switch-slot", |
| 7894 | + "values": [ |
| 7895 | + "switch0", |
| 7896 | + "switch1" |
| 7897 | + ], |
| 7898 | + "help": "The slot of the switch within the rack to use when selecting switch ports." |
7875 | 7899 | } |
7876 | 7900 | ] |
7877 | 7901 | }, |
7878 | 7902 | { |
7879 | 7903 | "name": "update", |
7880 | | - "about": "Update the LLDP configuration for a switch port", |
| 7904 | + "about": "Update LLDP configuration for switch port", |
7881 | 7905 | "args": [ |
7882 | 7906 | { |
7883 | 7907 | "long": "chassis-id", |
|
7929 | 7953 | "help": "A rack id to use when selecting switch ports." |
7930 | 7954 | }, |
7931 | 7955 | { |
7932 | | - "long": "switch-location", |
7933 | | - "help": "A switch location to use when selecting switch ports." |
| 7956 | + "long": "switch-slot", |
| 7957 | + "values": [ |
| 7958 | + "switch0", |
| 7959 | + "switch1" |
| 7960 | + ], |
| 7961 | + "help": "The slot of the switch within the rack to use when selecting switch ports." |
7934 | 7962 | }, |
7935 | 7963 | { |
7936 | 7964 | "long": "system-description", |
|
7944 | 7972 | }, |
7945 | 7973 | { |
7946 | 7974 | "name": "view", |
7947 | | - "about": "Fetch the LLDP configuration for a switch port", |
| 7975 | + "about": "Fetch LLDP configuration for switch port", |
7948 | 7976 | "args": [ |
7949 | 7977 | { |
7950 | 7978 | "long": "port", |
|
7960 | 7988 | "help": "A rack id to use when selecting switch ports." |
7961 | 7989 | }, |
7962 | 7990 | { |
7963 | | - "long": "switch-location", |
7964 | | - "help": "A switch location to use when selecting switch ports." |
| 7991 | + "long": "switch-slot", |
| 7992 | + "values": [ |
| 7993 | + "switch0", |
| 7994 | + "switch1" |
| 7995 | + ], |
| 7996 | + "help": "The slot of the switch within the rack to use when selecting switch ports." |
7965 | 7997 | } |
7966 | 7998 | ] |
7967 | 7999 | } |
|
8019 | 8051 | "help": "The rack containing the switch this loopback address will be configured on." |
8020 | 8052 | }, |
8021 | 8053 | { |
8022 | | - "long": "switch-location", |
8023 | | - "help": "The location of the switch within the rack this loopback address will be configured on." |
| 8054 | + "long": "switch-slot", |
| 8055 | + "values": [ |
| 8056 | + "switch0", |
| 8057 | + "switch1" |
| 8058 | + ], |
| 8059 | + "help": "The slot of the switch within the rack this loopback address will be configured on." |
8024 | 8060 | } |
8025 | 8061 | ] |
8026 | 8062 | }, |
|
8046 | 8082 | "help": "The IP address and subnet mask to use when selecting the loopback address." |
8047 | 8083 | }, |
8048 | 8084 | { |
8049 | | - "long": "switch-location", |
8050 | | - "help": "The switch location to use when selecting the loopback address." |
| 8085 | + "long": "switch-slot", |
| 8086 | + "values": [ |
| 8087 | + "switch0", |
| 8088 | + "switch1" |
| 8089 | + ], |
| 8090 | + "help": "The slot of the switch within the rack to use when selecting the loopback address." |
8051 | 8091 | } |
8052 | 8092 | ] |
8053 | 8093 | }, |
|
8759 | 8799 | "subcommands": [ |
8760 | 8800 | { |
8761 | 8801 | "name": "recovery-finish", |
8762 | | - "about": "Instructs the system that a system recovery operation (\"mupdate\") was", |
8763 | | - "long_about": "completed using the software in the specified release\n\nThe system recovery operation is used to bypass the control plane to deploy known-working software when the control plane itself is not functioning or otherwise unable to update itself. When the control plane detects this, it stops making any changes to deployed software to avoid reverting the recovery itself. This operation puts the control plane back in charge of determining what software should be deployed, instructing it that the specified software (which is also what's currently running) is what's supposed to be deployed.\n\nIf the provided version does not match what's currently running, the control plane will continue to avoid changing deployed software until this operation is invoked with the correct version.\n\nThis endpoint should only be called at the direction of Oxide support.", |
| 8802 | + "about": "Clear system recovery status", |
| 8803 | + "long_about": "Instructs the system that a system recovery operation (\"mupdate\") was completed using the software in the specified release.\n\nThe system recovery operation is used to bypass the control plane to deploy known-working software when the control plane itself is not functioning or otherwise unable to update itself. When the control plane detects this, it stops making any changes to deployed software to avoid reverting the recovery itself. This operation puts the control plane back in charge of determining what software should be deployed, instructing it that the specified software (which is also what's currently running) is what's supposed to be deployed.\n\nIf the provided version does not match what's currently running, the control plane will continue to avoid changing deployed software until this operation is invoked with the correct version.\n\nThis endpoint should only be called at the direction of Oxide support.", |
8764 | 8804 | "args": [ |
8765 | 8805 | { |
8766 | 8806 | "long": "json-body", |
|
0 commit comments