1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// SPDX-License-Identifier: Apache-2.0
//
// WARNING: This file is automatically generated from OpenAPI schema using
// `openstack-codegenerator`.
//! Action Server command
//!
//! Wraps invoking of the `v2.1/servers/{id}/action` with `POST` method
use clap::Args;
use tracing::info;
use openstack_sdk::AsyncOpenStack;
use crate::Cli;
use crate::OpenStackCliError;
use crate::output::OutputProcessor;
use openstack_sdk::api::QueryAsync;
use openstack_sdk::api::compute::v2::server::shelve;
use serde_json::Value;
/// Shelves a server.
///
/// Specify the `shelve` action in the request body.
///
/// All associated data and resources are kept but anything still in memory is
/// not retained. To restore a shelved instance, use the `unshelve` action. To
/// remove a shelved instance, use the `shelveOffload` action.
///
/// Policy defaults enable only users with the administrative role or the owner
/// of the server to perform this operation. Cloud providers can change these
/// permissions through the `policy.yaml` file.
///
/// **Preconditions**
///
/// The server status must be `ACTIVE`, `SHUTOFF`, `PAUSED`, or `SUSPENDED`.
///
/// If the server is locked, you must have administrator privileges to shelve
/// the server.
///
/// **Asynchronous Postconditions**
///
/// After you successfully shelve a server, its status changes to `SHELVED` and
/// the image status is `ACTIVE`. The server instance data appears on the
/// compute node that the Compute service manages.
///
/// If you boot the server from volumes or set the `shelved_offload_time`
/// option to 0, the Compute service automatically deletes the instance on
/// compute nodes and changes the server status to `SHELVED_OFFLOADED`.
///
/// **Troubleshooting**
///
/// If the server status does not change to `SHELVED` or `SHELVED_OFFLOADED`,
/// the shelve operation failed. Ensure that you meet the preconditions and run
/// the request again. If the request fails again, investigate whether another
/// operation is running that causes a race condition.
///
/// Normal response codes: 202
///
/// Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
/// conflict(409)
#[derive(Args)]
#[command(about = "Shelve Server (shelve Action)")]
pub struct ServerCommand {
/// Request Query parameters
#[command(flatten)]
query: QueryParameters,
/// Path parameters
#[command(flatten)]
path: PathParameters,
/// OpenAPI specifies the field as '{}'.
#[arg(default_value_t=Value::Null, help_heading = "Body parameters", long, value_name="JSON", value_parser=crate::common::parse_json)]
shelve: Value,
}
/// Query parameters
#[derive(Args)]
struct QueryParameters {}
/// Path parameters
#[derive(Args)]
struct PathParameters {
/// id parameter for /v2.1/servers/{id}/action API
#[arg(
help_heading = "Path parameters",
id = "path_param_id",
value_name = "ID"
)]
id: String,
}
impl ServerCommand {
/// Perform command action
pub async fn take_action(
&self,
parsed_args: &Cli,
client: &mut AsyncOpenStack,
) -> Result<(), OpenStackCliError> {
info!("Action Server");
let op = OutputProcessor::from_args(parsed_args, Some("compute.server"), Some("shelve"));
op.validate_args(parsed_args)?;
let mut ep_builder = shelve::Request::builder();
ep_builder.id(&self.path.id);
// Set body parameters
// Set Request.shelve data
ep_builder.shelve(self.shelve.clone());
let ep = ep_builder
.build()
.map_err(|x| OpenStackCliError::EndpointBuild(x.to_string()))?;
openstack_sdk::api::ignore(ep).query_async(client).await?;
// Show command specific hints
op.show_command_hint()?;
Ok(())
}
}