openstack_cli_compute/v2/server/rebuild_263.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.63]
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_263;
35use openstack_types::compute::v2::server::response;
36
37/// Command without description in OpenAPI
38#[derive(Args)]
39#[command(about = "Rebuild Server (rebuild Action) (microversion = 2.63)")]
40pub struct ServerCommand {
41 /// Request Query parameters
42 #[command(flatten)]
43 query: QueryParameters,
44
45 /// Path parameters
46 #[command(flatten)]
47 path: PathParameters,
48
49 /// The action to rebuild a server.
50 #[command(flatten)]
51 rebuild: Rebuild,
52}
53
54/// Query parameters
55#[derive(Args)]
56struct QueryParameters {}
57
58/// Path parameters
59#[derive(Args)]
60struct PathParameters {
61 /// id parameter for /v2.1/servers/{id}/action API
62 #[arg(
63 help_heading = "Path parameters",
64 id = "path_param_id",
65 value_name = "ID"
66 )]
67 id: String,
68}
69
70#[derive(Clone, Eq, Ord, PartialEq, PartialOrd, ValueEnum)]
71enum OsDcfDiskConfig {
72 Auto,
73 Manual,
74}
75
76/// Rebuild Body data
77#[derive(Args, Clone)]
78struct Rebuild {
79 /// IPv4 address that should be used to access this server.
80 #[arg(help_heading = "Body parameters", long)]
81 access_ipv4: Option<String>,
82
83 /// IPv6 address that should be used to access this server.
84 #[arg(help_heading = "Body parameters", long)]
85 access_ipv6: Option<String>,
86
87 /// The administrative password of the server. If you omit this parameter,
88 /// the operation generates a new password.
89 #[arg(help_heading = "Body parameters", long)]
90 admin_pass: Option<String>,
91
92 /// A free form description of the server. Limited to 255 characters in
93 /// length. Before microversion 2.19 this was set to the server name.
94 ///
95 /// **New in version 2.19**
96 #[arg(help_heading = "Body parameters", long)]
97 description: Option<String>,
98
99 /// Set explicit NULL for the description
100 #[arg(help_heading = "Body parameters", long, action = clap::ArgAction::SetTrue, conflicts_with = "description")]
101 no_description: bool,
102
103 /// The UUID of the image to rebuild for your server instance. It must be a
104 /// valid UUID otherwise API will return 400. To rebuild a volume-backed
105 /// server with a new image, at least microversion 2.93 needs to be
106 /// provided in the request else the request will fall back to old
107 /// behaviour i.e. the API will return 400 (for an image different from the
108 /// image used when creating the volume). For non-volume-backed servers,
109 /// specifying a new image will result in validating that the image is
110 /// acceptable for the current compute host on which the server exists. If
111 /// the new image is not valid, the server will go into `ERROR` status.
112 #[arg(help_heading = "Body parameters", long)]
113 image_ref: String,
114
115 /// Key pair name for rebuild API. If `null` is specified, the existing
116 /// keypair is unset.
117 ///
118 /// Note
119 ///
120 /// Users within the same project are able to rebuild other user’s
121 /// instances in that project with a new keypair. Keys are owned by users
122 /// (which is the only resource that’s true of). Servers are owned by
123 /// projects. Because of this a rebuild with a key_name is looking up the
124 /// keypair by the user calling rebuild.
125 ///
126 /// **New in version 2.54**
127 #[arg(help_heading = "Body parameters", long)]
128 key_name: Option<String>,
129
130 /// Set explicit NULL for the key_name
131 #[arg(help_heading = "Body parameters", long, action = clap::ArgAction::SetTrue, conflicts_with = "key_name")]
132 no_key_name: bool,
133
134 /// Metadata key and value pairs. The maximum size of the metadata key and
135 /// value is 255 bytes each.
136 #[arg(help_heading = "Body parameters", long, value_name="key=value", value_parser=parse_key_val::<String, String>)]
137 metadata: Option<Vec<(String, String)>>,
138
139 /// The server name.
140 #[arg(help_heading = "Body parameters", long)]
141 name: Option<String>,
142
143 /// Controls how the API partitions the disk when you create, rebuild, or
144 /// resize servers. A server inherits the `OS-DCF:diskConfig` value from
145 /// the image from which it was created, and an image inherits the
146 /// `OS-DCF:diskConfig` value from the server from which it was created. To
147 /// override the inherited setting, you can include this attribute in the
148 /// request body of a server create, rebuild, or resize request. If the
149 /// `OS-DCF:diskConfig` value for an image is `MANUAL`, you cannot create a
150 /// server from that image and set its `OS-DCF:diskConfig` value to `AUTO`.
151 /// A valid value is:
152 ///
153 /// - `AUTO`. The API builds the server with a single partition the size of
154 /// the target flavor disk. The API automatically adjusts the file system
155 /// to fit the entire partition.
156 /// - `MANUAL`. The API builds the server by using whatever partition
157 /// scheme and file system is in the source image. If the target flavor
158 /// disk is larger, the API does not partition the remaining disk space.
159 #[arg(help_heading = "Body parameters", long)]
160 os_dcf_disk_config: Option<OsDcfDiskConfig>,
161
162 /// Indicates whether the server is rebuilt with the preservation of the
163 /// ephemeral partition (`true`).
164 ///
165 /// Note
166 ///
167 /// This only works with baremetal servers provided by Ironic. Passing it
168 /// to any other server instance results in a fault and will prevent the
169 /// rebuild from happening.
170 #[arg(action=clap::ArgAction::Set, help_heading = "Body parameters", long)]
171 preserve_ephemeral: Option<bool>,
172
173 /// A list of trusted certificate IDs, which are used during image
174 /// signature verification to verify the signing certificate. The list is
175 /// restricted to a maximum of 50 IDs. This parameter is optional in server
176 /// rebuild requests if allowed by policy, and is not supported for
177 /// volume-backed instances.
178 ///
179 /// If `null` is specified, the existing trusted certificate IDs are either
180 /// unset or reset to the configured defaults.
181 ///
182 /// **New in version 2.63**
183 ///
184 /// Parameter is an array, may be provided multiple times.
185 #[arg(action=clap::ArgAction::Append, help_heading = "Body parameters", long)]
186 trusted_image_certificates: Option<Vec<String>>,
187
188 /// Configuration information or scripts to use upon rebuild. Must be
189 /// Base64 encoded. Restricted to 65535 bytes. If `null` is specified, the
190 /// existing user_data is unset.
191 ///
192 /// **New in version 2.57**
193 #[arg(help_heading = "Body parameters", long)]
194 user_data: Option<String>,
195
196 /// Set explicit NULL for the user_data
197 #[arg(help_heading = "Body parameters", long, action = clap::ArgAction::SetTrue, conflicts_with = "user_data")]
198 no_user_data: bool,
199}
200
201impl ServerCommand {
202 /// Perform command action
203 pub async fn take_action<C: CliArgs>(
204 &self,
205 parsed_args: &C,
206 client: &mut AsyncOpenStack,
207 ) -> Result<(), OpenStackCliError> {
208 info!("Action Server");
209
210 let op = OutputProcessor::from_args(parsed_args, Some("compute.server"), Some("rebuild"));
211 op.validate_args(parsed_args)?;
212
213 let mut ep_builder = rebuild_263::Request::builder();
214 ep_builder.header(
215 http::header::HeaderName::from_static("openstack-api-version"),
216 http::header::HeaderValue::from_static("compute 2.63"),
217 );
218
219 ep_builder.id(&self.path.id);
220
221 // Set body parameters
222 // Set Request.rebuild data
223 let args = &self.rebuild;
224 let mut rebuild_builder = rebuild_263::RebuildBuilder::default();
225 if let Some(val) = &args.os_dcf_disk_config {
226 let tmp = match val {
227 OsDcfDiskConfig::Auto => rebuild_263::OsDcfDiskConfig::Auto,
228 OsDcfDiskConfig::Manual => rebuild_263::OsDcfDiskConfig::Manual,
229 };
230 rebuild_builder.os_dcf_disk_config(tmp);
231 }
232
233 if let Some(val) = &args.access_ipv4 {
234 rebuild_builder.access_ipv4(val);
235 }
236
237 if let Some(val) = &args.access_ipv6 {
238 rebuild_builder.access_ipv6(val);
239 }
240
241 if let Some(val) = &args.admin_pass {
242 rebuild_builder.admin_pass(val);
243 }
244
245 if let Some(val) = &args.description {
246 rebuild_builder.description(Some(val.into()));
247 } else if args.no_description {
248 rebuild_builder.description(None);
249 }
250
251 rebuild_builder.image_ref(&args.image_ref);
252
253 if let Some(val) = &args.key_name {
254 rebuild_builder.key_name(Some(val.into()));
255 } else if args.no_key_name {
256 rebuild_builder.key_name(None);
257 }
258
259 if let Some(val) = &args.metadata {
260 rebuild_builder.metadata(val.iter().cloned());
261 }
262
263 if let Some(val) = &args.name {
264 rebuild_builder.name(val);
265 }
266
267 if let Some(val) = &args.preserve_ephemeral {
268 rebuild_builder.preserve_ephemeral(*val);
269 }
270
271 if let Some(val) = &args.trusted_image_certificates {
272 rebuild_builder
273 .trusted_image_certificates(val.iter().map(Into::into).collect::<Vec<_>>());
274 }
275
276 if let Some(val) = &args.user_data {
277 rebuild_builder.user_data(Some(val.into()));
278 } else if args.no_user_data {
279 rebuild_builder.user_data(None);
280 }
281
282 ep_builder.rebuild(
283 rebuild_builder
284 .build()
285 .wrap_err("error preparing the request data")?,
286 );
287
288 let ep = ep_builder
289 .build()
290 .map_err(|x| OpenStackCliError::EndpointBuild(x.to_string()))?;
291
292 let data: serde_json::Value = ep.query_async(client).await?;
293
294 op.output_single::<response::rebuild_263::ServerResponse>(data.clone())?;
295 // Show command specific hints
296 op.show_command_hint()?;
297 Ok(())
298 }
299}