openstack_cli_network/v2/network/
list.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//! List Networks command
19//!
20//! Wraps invoking of the `v2.0/networks` with `GET` method
21
22use clap::Args;
23use tracing::info;
24
25use openstack_cli_core::cli::CliArgs;
26use openstack_cli_core::error::OpenStackCliError;
27use openstack_cli_core::output::OutputProcessor;
28use openstack_sdk::AsyncOpenStack;
29
30use openstack_sdk::api::QueryAsync;
31use openstack_sdk::api::network::v2::network::list;
32use openstack_sdk::api::{Pagination, paged};
33use openstack_types::network::v2::network::response;
34
35/// Lists networks to which the project has access.
36///
37/// Default policy settings return only networks that the project who submits
38/// the request owns, unless an administrative user submits the request. In
39/// addition, networks shared with the project who submits the request are also
40/// returned.
41///
42/// Standard query parameters are supported on the URI. For more information,
43/// see [Filtering and Column Selection](#filtering).
44///
45/// Use the `fields` query parameter to control which fields are returned in
46/// the response body. For more information, see [Fields](#fields).
47///
48/// Pagination query parameters are supported if Neutron configuration supports
49/// it by overriding `allow_pagination=false`. For more information, see
50/// [Pagination](#pagination).
51///
52/// Sorting query parameters are supported if Neutron configuration supports it
53/// with `allow_sorting=true`. For more information, see [Sorting](#sorting).
54///
55/// You can also use the `tags`, `tags-any`, `not-tags`, `not-tags-any` query
56/// parameter to filter the response with tags. For information, see
57/// [REST API Impact](http://specs.openstack.org/openstack/neutron-specs/specs/mitaka/add-tags-to-core-resources.html#rest-api-impact).
58///
59/// Normal response codes: 200
60///
61/// Error response codes: 401
62#[derive(Args)]
63#[command(about = "List networks")]
64pub struct NetworksCommand {
65    /// Request Query parameters
66    #[command(flatten)]
67    query: QueryParameters,
68
69    /// Path parameters
70    #[command(flatten)]
71    path: PathParameters,
72
73    /// Total limit of entities count to return. Use this when there are too many entries.
74    #[arg(long, default_value_t = 10000)]
75    max_items: usize,
76}
77
78/// Query parameters
79#[derive(Args)]
80struct QueryParameters {
81    /// admin_state_up query parameter for /v2.0/networks API
82    #[arg(action=clap::ArgAction::Set, help_heading = "Query parameters", long)]
83    admin_state_up: Option<bool>,
84
85    /// description query parameter for /v2.0/networks API
86    #[arg(help_heading = "Query parameters", long)]
87    description: Option<String>,
88
89    /// id query parameter for /v2.0/networks API
90    #[arg(help_heading = "Query parameters", long)]
91    id: Option<String>,
92
93    /// is_default query parameter for /v2.0/networks API
94    #[arg(action=clap::ArgAction::Set, help_heading = "Query parameters", long)]
95    is_default: Option<bool>,
96
97    /// Requests a page size of items. Returns a number of items up to a limit
98    /// value. Use the limit parameter to make an initial limited request and
99    /// use the ID of the last-seen item from the response as the marker
100    /// parameter value in a subsequent limited request.
101    #[arg(
102        help_heading = "Query parameters",
103        long("page-size"),
104        visible_alias("limit")
105    )]
106    limit: Option<u32>,
107
108    /// The ID of the last-seen item. Use the limit parameter to make an
109    /// initial limited request and use the ID of the last-seen item from the
110    /// response as the marker parameter value in a subsequent limited request.
111    #[arg(help_heading = "Query parameters", long)]
112    marker: Option<String>,
113
114    /// mtu query parameter for /v2.0/networks API
115    #[arg(help_heading = "Query parameters", long)]
116    mtu: Option<u32>,
117
118    /// name query parameter for /v2.0/networks API
119    #[arg(help_heading = "Query parameters", long)]
120    name: Option<String>,
121
122    /// not-tags query parameter for /v2.0/networks API
123    #[arg(action=clap::ArgAction::Append, help_heading = "Query parameters", long)]
124    not_tags: Option<Vec<String>>,
125
126    /// not-tags-any query parameter for /v2.0/networks API
127    #[arg(action=clap::ArgAction::Append, help_heading = "Query parameters", long)]
128    not_tags_any: Option<Vec<String>>,
129
130    /// Reverse the page direction
131    #[arg(action=clap::ArgAction::Set, help_heading = "Query parameters", long)]
132    page_reverse: Option<bool>,
133
134    /// provider:network_type query parameter for /v2.0/networks API
135    #[arg(help_heading = "Query parameters", long)]
136    provider_network_type: Option<String>,
137
138    /// provider:physical_network query parameter for /v2.0/networks API
139    #[arg(help_heading = "Query parameters", long)]
140    provider_physical_network: Option<String>,
141
142    /// provider:segmentation_id query parameter for /v2.0/networks API
143    #[arg(help_heading = "Query parameters", long)]
144    provider_segmentation_id: Option<i32>,
145
146    /// qinq query parameter for /v2.0/networks API
147    #[arg(action=clap::ArgAction::Set, help_heading = "Query parameters", long)]
148    qinq: Option<bool>,
149
150    /// revision_number query parameter for /v2.0/networks API
151    #[arg(help_heading = "Query parameters", long)]
152    revision_number: Option<String>,
153
154    /// router:external query parameter for /v2.0/networks API
155    #[arg(action=clap::ArgAction::Set, help_heading = "Query parameters", long)]
156    router_external: Option<bool>,
157
158    /// shared query parameter for /v2.0/networks API
159    #[arg(action=clap::ArgAction::Set, help_heading = "Query parameters", long)]
160    shared: Option<bool>,
161
162    /// Sort direction. This is an optional feature and may be silently ignored
163    /// by the server.
164    #[arg(action=clap::ArgAction::Append, help_heading = "Query parameters", long)]
165    sort_dir: Option<Vec<String>>,
166
167    /// Sort results by the attribute. This is an optional feature and may be
168    /// silently ignored by the server.
169    #[arg(action=clap::ArgAction::Append, help_heading = "Query parameters", long)]
170    sort_key: Option<Vec<String>>,
171
172    /// status query parameter for /v2.0/networks API
173    #[arg(help_heading = "Query parameters", long)]
174    status: Option<String>,
175
176    /// tags query parameter for /v2.0/networks API
177    #[arg(action=clap::ArgAction::Append, help_heading = "Query parameters", long)]
178    tags: Option<Vec<String>>,
179
180    /// tags-any query parameter for /v2.0/networks API
181    #[arg(action=clap::ArgAction::Append, help_heading = "Query parameters", long)]
182    tags_any: Option<Vec<String>>,
183
184    /// tenant_id query parameter for /v2.0/networks API
185    #[arg(help_heading = "Query parameters", long)]
186    tenant_id: Option<String>,
187
188    /// vlan_transparent query parameter for /v2.0/networks API
189    #[arg(action=clap::ArgAction::Set, help_heading = "Query parameters", long)]
190    vlan_transparent: Option<bool>,
191}
192
193/// Path parameters
194#[derive(Args)]
195struct PathParameters {}
196
197impl NetworksCommand {
198    /// Perform command action
199    pub async fn take_action<C: CliArgs>(
200        &self,
201        parsed_args: &C,
202        client: &mut AsyncOpenStack,
203    ) -> Result<(), OpenStackCliError> {
204        info!("List Networks");
205
206        let op = OutputProcessor::from_args(parsed_args, Some("network.network"), Some("list"));
207        op.validate_args(parsed_args)?;
208
209        let mut ep_builder = list::Request::builder();
210
211        // Set query parameters
212        if let Some(val) = &self.query.limit {
213            ep_builder.limit(*val);
214        }
215        if let Some(val) = &self.query.marker {
216            ep_builder.marker(val);
217        }
218        if let Some(val) = &self.query.admin_state_up {
219            ep_builder.admin_state_up(*val);
220        }
221        if let Some(val) = &self.query.description {
222            ep_builder.description(val);
223        }
224        if let Some(val) = &self.query.id {
225            ep_builder.id(val);
226        }
227        if let Some(val) = &self.query.is_default {
228            ep_builder.is_default(*val);
229        }
230        if let Some(val) = &self.query.mtu {
231            ep_builder.mtu(*val);
232        }
233        if let Some(val) = &self.query.name {
234            ep_builder.name(val);
235        }
236        if let Some(val) = &self.query.not_tags {
237            ep_builder.not_tags(val.iter());
238        }
239        if let Some(val) = &self.query.not_tags_any {
240            ep_builder.not_tags_any(val.iter());
241        }
242        if let Some(val) = &self.query.provider_network_type {
243            ep_builder.provider_network_type(val);
244        }
245        if let Some(val) = &self.query.provider_physical_network {
246            ep_builder.provider_physical_network(val);
247        }
248        if let Some(val) = &self.query.provider_segmentation_id {
249            ep_builder.provider_segmentation_id(*val);
250        }
251        if let Some(val) = &self.query.qinq {
252            ep_builder.qinq(*val);
253        }
254        if let Some(val) = &self.query.revision_number {
255            ep_builder.revision_number(val);
256        }
257        if let Some(val) = &self.query.router_external {
258            ep_builder.router_external(*val);
259        }
260        if let Some(val) = &self.query.shared {
261            ep_builder.shared(*val);
262        }
263        if let Some(val) = &self.query.status {
264            ep_builder.status(val);
265        }
266        if let Some(val) = &self.query.tags {
267            ep_builder.tags(val.iter());
268        }
269        if let Some(val) = &self.query.tags_any {
270            ep_builder.tags_any(val.iter());
271        }
272        if let Some(val) = &self.query.tenant_id {
273            ep_builder.tenant_id(val);
274        }
275        if let Some(val) = &self.query.vlan_transparent {
276            ep_builder.vlan_transparent(*val);
277        }
278        if let Some(val) = &self.query.page_reverse {
279            ep_builder.page_reverse(*val);
280        }
281        if let Some(val) = &self.query.sort_dir {
282            ep_builder.sort_dir(val.iter());
283        }
284        if let Some(val) = &self.query.sort_key {
285            ep_builder.sort_key(val.iter());
286        }
287
288        let ep = ep_builder
289            .build()
290            .map_err(|x| OpenStackCliError::EndpointBuild(x.to_string()))?;
291
292        let data: Vec<serde_json::Value> = paged(ep, Pagination::Limit(self.max_items))
293            .query_async(client)
294            .await?;
295
296        op.output_list::<response::list::NetworkResponse>(data.clone())?;
297        // Show command specific hints
298        op.show_command_hint()?;
299        Ok(())
300    }
301}
openstack_cli_network/v2/network/list.rs

openstack_cli_network/v2/network/
list.rs
