openstack_cli_compute/v2/server/rebuild_254.rs
1// Licensed under the Apache License, Version 2.0 (the "License");
2// you may not use this file except in compliance with the License.
3// You may obtain a copy of the License at
4//
5// http://www.apache.org/licenses/LICENSE-2.0
6//
7// Unless required by applicable law or agreed to in writing, software
8// distributed under the License is distributed on an "AS IS" BASIS,
9// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10// See the License for the specific language governing permissions and
11// limitations under the License.
12//
13// SPDX-License-Identifier: Apache-2.0
14//
15// WARNING: This file is automatically generated from OpenAPI schema using
16// `openstack-codegenerator`.
17
18//! Action Server command [microversion = 2.54]
19//!
20//! Wraps invoking of the `v2.1/servers/{id}/action` with `POST` method
21
22use clap::Args;
23use eyre::WrapErr;
24use tracing::info;
25
26use openstack_cli_core::cli::CliArgs;
27use openstack_cli_core::error::OpenStackCliError;
28use openstack_cli_core::output::OutputProcessor;
29use openstack_sdk::AsyncOpenStack;
30
31use clap::ValueEnum;
32use openstack_cli_core::common::parse_key_val;
33use openstack_sdk::api::QueryAsync;
34use openstack_sdk::api::compute::v2::server::rebuild_254;
35use openstack_types::compute::v2::server::response;
36use serde_json::Value;
37
38/// Command without description in OpenAPI
39#[derive(Args)]
40#[command(about = "Rebuild Server (rebuild Action) (microversion = 2.54)")]
41pub struct ServerCommand {
42 /// Request Query parameters
43 #[command(flatten)]
44 query: QueryParameters,
45
46 /// Path parameters
47 #[command(flatten)]
48 path: PathParameters,
49
50 /// The action to rebuild a server.
51 #[command(flatten)]
52 rebuild: Rebuild,
53}
54
55/// Query parameters
56#[derive(Args)]
57struct QueryParameters {}
58
59/// Path parameters
60#[derive(Args)]
61struct PathParameters {
62 /// id parameter for /v2.1/servers/{id}/action API
63 #[arg(
64 help_heading = "Path parameters",
65 id = "path_param_id",
66 value_name = "ID"
67 )]
68 id: String,
69}
70
71#[derive(Clone, Eq, Ord, PartialEq, PartialOrd, ValueEnum)]
72enum OsDcfDiskConfig {
73 Auto,
74 Manual,
75}
76
77/// Rebuild Body data
78#[derive(Args, Clone)]
79struct Rebuild {
80 /// IPv4 address that should be used to access this server.
81 #[arg(help_heading = "Body parameters", long)]
82 access_ipv4: Option<String>,
83
84 /// IPv6 address that should be used to access this server.
85 #[arg(help_heading = "Body parameters", long)]
86 access_ipv6: Option<String>,
87
88 /// The administrative password of the server. If you omit this parameter,
89 /// the operation generates a new password.
90 #[arg(help_heading = "Body parameters", long)]
91 admin_pass: Option<String>,
92
93 /// A free form description of the server. Limited to 255 characters in
94 /// length. Before microversion 2.19 this was set to the server name.
95 ///
96 /// **New in version 2.19**
97 #[arg(help_heading = "Body parameters", long)]
98 description: Option<String>,
99
100 /// Set explicit NULL for the description
101 #[arg(help_heading = "Body parameters", long, action = clap::ArgAction::SetTrue, conflicts_with = "description")]
102 no_description: bool,
103
104 /// The UUID of the image to rebuild for your server instance. It must be a
105 /// valid UUID otherwise API will return 400. To rebuild a volume-backed
106 /// server with a new image, at least microversion 2.93 needs to be
107 /// provided in the request else the request will fall back to old
108 /// behaviour i.e. the API will return 400 (for an image different from the
109 /// image used when creating the volume). For non-volume-backed servers,
110 /// specifying a new image will result in validating that the image is
111 /// acceptable for the current compute host on which the server exists. If
112 /// the new image is not valid, the server will go into `ERROR` status.
113 #[arg(help_heading = "Body parameters", long)]
114 image_ref: String,
115
116 /// Key pair name for rebuild API. If `null` is specified, the existing
117 /// keypair is unset.
118 ///
119 /// Note
120 ///
121 /// Users within the same project are able to rebuild other user’s
122 /// instances in that project with a new keypair. Keys are owned by users
123 /// (which is the only resource that’s true of). Servers are owned by
124 /// projects. Because of this a rebuild with a key_name is looking up the
125 /// keypair by the user calling rebuild.
126 ///
127 /// **New in version 2.54**
128 #[arg(help_heading = "Body parameters", long)]
129 key_name: Option<String>,
130
131 /// Set explicit NULL for the key_name
132 #[arg(help_heading = "Body parameters", long, action = clap::ArgAction::SetTrue, conflicts_with = "key_name")]
133 no_key_name: bool,
134
135 /// Metadata key and value pairs. The maximum size of the metadata key and
136 /// value is 255 bytes each.
137 #[arg(help_heading = "Body parameters", long, value_name="key=value", value_parser=parse_key_val::<String, String>)]
138 metadata: Option<Vec<(String, String)>>,
139
140 /// The server name.
141 #[arg(help_heading = "Body parameters", long)]
142 name: Option<String>,
143
144 /// Controls how the API partitions the disk when you create, rebuild, or
145 /// resize servers. A server inherits the `OS-DCF:diskConfig` value from
146 /// the image from which it was created, and an image inherits the
147 /// `OS-DCF:diskConfig` value from the server from which it was created. To
148 /// override the inherited setting, you can include this attribute in the
149 /// request body of a server create, rebuild, or resize request. If the
150 /// `OS-DCF:diskConfig` value for an image is `MANUAL`, you cannot create a
151 /// server from that image and set its `OS-DCF:diskConfig` value to `AUTO`.
152 /// A valid value is:
153 ///
154 /// - `AUTO`. The API builds the server with a single partition the size of
155 /// the target flavor disk. The API automatically adjusts the file system
156 /// to fit the entire partition.
157 /// - `MANUAL`. The API builds the server by using whatever partition
158 /// scheme and file system is in the source image. If the target flavor
159 /// disk is larger, the API does not partition the remaining disk space.
160 #[arg(help_heading = "Body parameters", long)]
161 os_dcf_disk_config: Option<OsDcfDiskConfig>,
162
163 /// The file path and contents, text only, to inject into the server at
164 /// launch. The maximum size of the file path data is 255 bytes. The
165 /// maximum limit is the number of allowed bytes in the decoded, rather
166 /// than encoded, data.
167 ///
168 /// **Available until version 2.56**
169 ///
170 /// Parameter is an array, may be provided multiple times.
171 #[arg(action=clap::ArgAction::Append, help_heading = "Body parameters", long, value_name="JSON", value_parser=openstack_cli_core::common::parse_json)]
172 personality: Option<Vec<Value>>,
173
174 /// Indicates whether the server is rebuilt with the preservation of the
175 /// ephemeral partition (`true`).
176 ///
177 /// Note
178 ///
179 /// This only works with baremetal servers provided by Ironic. Passing it
180 /// to any other server instance results in a fault and will prevent the
181 /// rebuild from happening.
182 #[arg(action=clap::ArgAction::Set, help_heading = "Body parameters", long)]
183 preserve_ephemeral: Option<bool>,
184}
185
186impl ServerCommand {
187 /// Perform command action
188 pub async fn take_action<C: CliArgs>(
189 &self,
190 parsed_args: &C,
191 client: &mut AsyncOpenStack,
192 ) -> Result<(), OpenStackCliError> {
193 info!("Action Server");
194
195 let op = OutputProcessor::from_args(parsed_args, Some("compute.server"), Some("rebuild"));
196 op.validate_args(parsed_args)?;
197
198 let mut ep_builder = rebuild_254::Request::builder();
199 ep_builder.header(
200 http::header::HeaderName::from_static("openstack-api-version"),
201 http::header::HeaderValue::from_static("compute 2.54"),
202 );
203
204 ep_builder.id(&self.path.id);
205
206 // Set body parameters
207 // Set Request.rebuild data
208 let args = &self.rebuild;
209 let mut rebuild_builder = rebuild_254::RebuildBuilder::default();
210 if let Some(val) = &args.os_dcf_disk_config {
211 let tmp = match val {
212 OsDcfDiskConfig::Auto => rebuild_254::OsDcfDiskConfig::Auto,
213 OsDcfDiskConfig::Manual => rebuild_254::OsDcfDiskConfig::Manual,
214 };
215 rebuild_builder.os_dcf_disk_config(tmp);
216 }
217
218 if let Some(val) = &args.access_ipv4 {
219 rebuild_builder.access_ipv4(val);
220 }
221
222 if let Some(val) = &args.access_ipv6 {
223 rebuild_builder.access_ipv6(val);
224 }
225
226 if let Some(val) = &args.admin_pass {
227 rebuild_builder.admin_pass(val);
228 }
229
230 if let Some(val) = &args.description {
231 rebuild_builder.description(Some(val.into()));
232 } else if args.no_description {
233 rebuild_builder.description(None);
234 }
235
236 rebuild_builder.image_ref(&args.image_ref);
237
238 if let Some(val) = &args.key_name {
239 rebuild_builder.key_name(Some(val.into()));
240 } else if args.no_key_name {
241 rebuild_builder.key_name(None);
242 }
243
244 if let Some(val) = &args.metadata {
245 rebuild_builder.metadata(val.iter().cloned());
246 }
247
248 if let Some(val) = &args.name {
249 rebuild_builder.name(val);
250 }
251
252 if let Some(val) = &args.personality {
253 let personality_builder: Vec<rebuild_254::Personality> = val
254 .iter()
255 .flat_map(|v| serde_json::from_value::<rebuild_254::Personality>(v.to_owned()))
256 .collect::<Vec<rebuild_254::Personality>>();
257 rebuild_builder.personality(personality_builder);
258 }
259
260 if let Some(val) = &args.preserve_ephemeral {
261 rebuild_builder.preserve_ephemeral(*val);
262 }
263
264 ep_builder.rebuild(
265 rebuild_builder
266 .build()
267 .wrap_err("error preparing the request data")?,
268 );
269
270 let ep = ep_builder
271 .build()
272 .map_err(|x| OpenStackCliError::EndpointBuild(x.to_string()))?;
273
274 let data: serde_json::Value = ep.query_async(client).await?;
275
276 op.output_single::<response::rebuild_254::ServerResponse>(data.clone())?;
277 // Show command specific hints
278 op.show_command_hint()?;
279 Ok(())
280 }
281}