openstack_cli 0.13.5

// 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`.

//! List Ports command
//!
//! Wraps invoking of the `v2.0/ports` with `GET` 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::network::v2::port::list;
use openstack_sdk::api::{Pagination, paged};
use openstack_types::network::v2::port::response::list::PortResponse;

/// Lists ports to which the user has access.
///
/// Default policy settings return only those ports that are owned by the
/// project of the user who submits the request, unless the request is
/// submitted by a user with administrative rights.
///
/// Standard query parameters are supported on the URI. For more information,
/// see [Filtering and Column Selection](#filtering).
///
/// Use the `fields` query parameter to control which fields are returned in
/// the response body. For more information, see [Fields](#fields).
///
/// Pagination query parameters are supported if Neutron configuration supports
/// it by overriding `allow_pagination=false`. For more information, see
/// [Pagination](#pagination).
///
/// Sorting query parameters are supported if Neutron configuration supports it
/// with `allow_sorting=true`. For more information, see [Sorting](#sorting).
///
/// If the `ip-substring-filtering` extension is enabled, the Neutron API
/// supports IP address substring filtering on the `fixed_ips` attribute. If
/// you specify an IP address substring (`ip_address_substr`) in an entry of
/// the `fixed_ips` attribute, the Neutron API will list all ports that have an
/// IP address matching the substring.
///
/// Normal response codes: 200
///
/// Error response codes: 401
#[derive(Args)]
#[command(about = "List ports")]
pub struct PortsCommand {
    /// Request Query parameters
    #[command(flatten)]
    query: QueryParameters,

    /// Path parameters
    #[command(flatten)]
    path: PathParameters,

    /// Total limit of entities count to return. Use this when there are too many entries.
    #[arg(long, default_value_t = 10000)]
    max_items: usize,
}

/// Query parameters
#[derive(Args)]
struct QueryParameters {
    /// admin_state_up query parameter for /v2.0/ports API
    #[arg(action=clap::ArgAction::Set, help_heading = "Query parameters", long)]
    admin_state_up: Option<bool>,

    /// binding:host_id query parameter for /v2.0/ports API
    #[arg(help_heading = "Query parameters", long)]
    binding_host_id: Option<String>,

    /// description query parameter for /v2.0/ports API
    #[arg(help_heading = "Query parameters", long)]
    description: Option<String>,

    /// device_id query parameter for /v2.0/ports API
    #[arg(help_heading = "Query parameters", long)]
    device_id: Option<String>,

    /// device_owner query parameter for /v2.0/ports API
    #[arg(help_heading = "Query parameters", long)]
    device_owner: Option<String>,

    /// fixed_ips query parameter for /v2.0/ports API
    #[arg(action=clap::ArgAction::Append, help_heading = "Query parameters", long)]
    fixed_ips: Option<Vec<String>>,

    /// id query parameter for /v2.0/ports API
    #[arg(help_heading = "Query parameters", long)]
    id: Option<String>,

    /// ip_allocation query parameter for /v2.0/ports API
    #[arg(help_heading = "Query parameters", long)]
    ip_allocation: Option<String>,

    /// Requests a page size of items. Returns a number of items up to a limit
    /// value. Use the limit parameter to make an initial limited request and
    /// use the ID of the last-seen item from the response as the marker
    /// parameter value in a subsequent limited request.
    #[arg(
        help_heading = "Query parameters",
        long("page-size"),
        visible_alias("limit")
    )]
    limit: Option<u32>,

    /// mac_address query parameter for /v2.0/ports API
    #[arg(help_heading = "Query parameters", long)]
    mac_address: Option<String>,

    /// The ID of the last-seen item. Use the limit parameter to make an
    /// initial limited request and use the ID of the last-seen item from the
    /// response as the marker parameter value in a subsequent limited request.
    #[arg(help_heading = "Query parameters", long)]
    marker: Option<String>,

    /// name query parameter for /v2.0/ports API
    #[arg(help_heading = "Query parameters", long)]
    name: Option<String>,

    /// network_id query parameter for /v2.0/ports API
    #[arg(help_heading = "Query parameters", long)]
    network_id: Option<String>,

    /// not-tags query parameter for /v2.0/ports API
    #[arg(action=clap::ArgAction::Append, help_heading = "Query parameters", long)]
    not_tags: Option<Vec<String>>,

    /// not-tags-any query parameter for /v2.0/ports API
    #[arg(action=clap::ArgAction::Append, help_heading = "Query parameters", long)]
    not_tags_any: Option<Vec<String>>,

    /// Reverse the page direction
    #[arg(action=clap::ArgAction::Set, help_heading = "Query parameters", long)]
    page_reverse: Option<bool>,

    /// revision_number query parameter for /v2.0/ports API
    #[arg(help_heading = "Query parameters", long)]
    revision_number: Option<String>,

    /// security_groups query parameter for /v2.0/ports API
    #[arg(action=clap::ArgAction::Append, help_heading = "Query parameters", long)]
    security_groups: Option<Vec<String>>,

    /// Sort direction. This is an optional feature and may be silently ignored
    /// by the server.
    #[arg(action=clap::ArgAction::Append, help_heading = "Query parameters", long)]
    sort_dir: Option<Vec<String>>,

    /// Sort results by the attribute. This is an optional feature and may be
    /// silently ignored by the server.
    #[arg(action=clap::ArgAction::Append, help_heading = "Query parameters", long)]
    sort_key: Option<Vec<String>>,

    /// status query parameter for /v2.0/ports API
    #[arg(help_heading = "Query parameters", long)]
    status: Option<String>,

    /// tags query parameter for /v2.0/ports API
    #[arg(action=clap::ArgAction::Append, help_heading = "Query parameters", long)]
    tags: Option<Vec<String>>,

    /// tags-any query parameter for /v2.0/ports API
    #[arg(action=clap::ArgAction::Append, help_heading = "Query parameters", long)]
    tags_any: Option<Vec<String>>,

    /// tenant_id query parameter for /v2.0/ports API
    #[arg(help_heading = "Query parameters", long)]
    tenant_id: Option<String>,
}

/// Path parameters
#[derive(Args)]
struct PathParameters {}

impl PortsCommand {
    /// Perform command action
    pub async fn take_action(
        &self,
        parsed_args: &Cli,
        client: &mut AsyncOpenStack,
    ) -> Result<(), OpenStackCliError> {
        info!("List Ports");

        let op = OutputProcessor::from_args(parsed_args, Some("network.port"), Some("list"));
        op.validate_args(parsed_args)?;

        let mut ep_builder = list::Request::builder();

        // Set query parameters
        if let Some(val) = &self.query.limit {
            ep_builder.limit(*val);
        }
        if let Some(val) = &self.query.marker {
            ep_builder.marker(val);
        }
        if let Some(val) = &self.query.page_reverse {
            ep_builder.page_reverse(*val);
        }
        if let Some(val) = &self.query.admin_state_up {
            ep_builder.admin_state_up(*val);
        }
        if let Some(val) = &self.query.binding_host_id {
            ep_builder.binding_host_id(val);
        }
        if let Some(val) = &self.query.description {
            ep_builder.description(val);
        }
        if let Some(val) = &self.query.device_id {
            ep_builder.device_id(val);
        }
        if let Some(val) = &self.query.device_owner {
            ep_builder.device_owner(val);
        }
        if let Some(val) = &self.query.fixed_ips {
            ep_builder.fixed_ips(val.iter());
        }
        if let Some(val) = &self.query.id {
            ep_builder.id(val);
        }
        if let Some(val) = &self.query.ip_allocation {
            ep_builder.ip_allocation(val);
        }
        if let Some(val) = &self.query.mac_address {
            ep_builder.mac_address(val);
        }
        if let Some(val) = &self.query.name {
            ep_builder.name(val);
        }
        if let Some(val) = &self.query.network_id {
            ep_builder.network_id(val);
        }
        if let Some(val) = &self.query.not_tags {
            ep_builder.not_tags(val.iter());
        }
        if let Some(val) = &self.query.not_tags_any {
            ep_builder.not_tags_any(val.iter());
        }
        if let Some(val) = &self.query.revision_number {
            ep_builder.revision_number(val);
        }
        if let Some(val) = &self.query.security_groups {
            ep_builder.security_groups(val.iter());
        }
        if let Some(val) = &self.query.status {
            ep_builder.status(val);
        }
        if let Some(val) = &self.query.tags {
            ep_builder.tags(val.iter());
        }
        if let Some(val) = &self.query.tags_any {
            ep_builder.tags_any(val.iter());
        }
        if let Some(val) = &self.query.tenant_id {
            ep_builder.tenant_id(val);
        }
        if let Some(val) = &self.query.sort_dir {
            ep_builder.sort_dir(val.iter());
        }
        if let Some(val) = &self.query.sort_key {
            ep_builder.sort_key(val.iter());
        }

        let ep = ep_builder
            .build()
            .map_err(|x| OpenStackCliError::EndpointBuild(x.to_string()))?;

        let data: Vec<serde_json::Value> = paged(ep, Pagination::Limit(self.max_items))
            .query_async(client)
            .await?;
        op.output_list::<PortResponse>(data)?;
        // Show command specific hints
        op.show_command_hint()?;
        Ok(())
    }
}