From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <pve-devel-bounces@lists.proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68])
by lore.proxmox.com (Postfix) with ESMTPS id 795771FF163
for <inbox@lore.proxmox.com>; Thu, 5 Dec 2024 13:50:16 +0100 (CET)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id 30BA11A10D;
Thu, 5 Dec 2024 13:50:15 +0100 (CET)
Date: Thu, 5 Dec 2024 13:49:41 +0100
From: Gabriel Goller <g.goller@proxmox.com>
To: Dominik Csapak <d.csapak@proxmox.com>
Message-ID: <splkipz76ztlsljsmhqvlsue55vdyw6fnzvyatkmmq2r6fao7h@ulbodpyq3muo>
References: <20241205082743.459521-1-d.csapak@proxmox.com>
MIME-Version: 1.0
Content-Disposition: inline
In-Reply-To: <20241205082743.459521-1-d.csapak@proxmox.com>
User-Agent: NeoMutt/20241002-35-39f9a6
X-SPAM-LEVEL: Spam detection results: 0
AWL -0.035 Adjusted score from AWL reputation of From: address
BAYES_00 -1.9 Bayes spam probability is 0 to 1%
DMARC_MISSING 0.1 Missing DMARC policy
KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
RCVD_IN_VALIDITY_CERTIFIED_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
Validity was blocked. See
https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
information.
RCVD_IN_VALIDITY_RPBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
Validity was blocked. See
https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
information.
RCVD_IN_VALIDITY_SAFE_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
Validity was blocked. See
https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
information.
SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record
SPF_PASS -0.001 SPF: sender matches SPF record
URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See
http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more
information. [network.pm]
Subject: Re: [pve-devel] [RFC PATCH] api: network: add return schema for
interface listing
X-BeenThere: pve-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox VE development discussion <pve-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pve-devel>,
<mailto:pve-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pve-devel/>
List-Post: <mailto:pve-devel@lists.proxmox.com>
List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel>,
<mailto:pve-devel-request@lists.proxmox.com?subject=subscribe>
Reply-To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>
Cc: pve-devel@lists.proxmox.com
Content-Transfer-Encoding: 7bit
Content-Type: text/plain; charset="us-ascii"; Format="flowed"
Errors-To: pve-devel-bounces@lists.proxmox.com
Sender: "pve-devel" <pve-devel-bounces@lists.proxmox.com>
Just in case you haven't noticed, a few typos inline:
On 05.12.2024 09:27, Dominik Csapak wrote:
>Most optiosn come from the api call parameter list
s/optiosn/options/
>(`json_config_properties`). The description and types for the remaining
>ons are either taken from the manpages, source code or similar
>documentation where available.
> [snip]
>diff --git a/PVE/API2/Network.pm b/PVE/API2/Network.pm
>index b9db9b27..df3db5af 100644
>--- a/PVE/API2/Network.pm
>+++ b/PVE/API2/Network.pm
>@@ -38,7 +38,7 @@ my $bond_mode_enum = [
> ];
>
> my $network_type_enum = ['bridge', 'bond', 'eth', 'alias', 'vlan',
>- 'OVSBridge', 'OVSBond', 'OVSPort', 'OVSIntPort'];
>+ 'OVSBridge', 'OVSBond', 'OVSPort', 'OVSIntPort', 'vnet'];
>
> my $confdesc = {
> type => {
>@@ -223,7 +223,100 @@ __PACKAGE__->register_method({
> type => "array",
> items => {
> type => "object",
>- properties => {},
>+ properties => json_config_properties({
>+ iface => get_standard_option('pve-iface'),
>+ active => {
>+ type => 'boolean',
>+ optional => 1,
>+ description => "Set to 1 if the interface is active.",
>+ },
>+ exists => {
>+ type => 'boolean',
>+ optional => 1,
>+ description => "Set to 1 if the interface physically exists.",
>+ },
>+ families => {
>+ type => "array",
>+ description => "The network families.",
>+ items => {
>+ type => "string",
>+ description => "A ntework familiy.",
s/ntework/network/
s/familiy/family/
>+ enum => ["inet", "inet6"],
>+ },
>+ optional => 1,
>+ },
>+ method => {
>+ type => "string",
>+ description => "The network configuration method for IPv4.",
>+ enum => ["manual", "static", "auto"],
>+ optional => 1,
>+ },
>+ method6 => {
>+ type => "string",
>+ description => "The network configuration method for IPv6.",
>+ enum => ["manual", "static", "auto"],
>+ optional => 1,
>+ },
>+ priority => {
>+ type => 'integer',
>+ description => "The order of the interface.",
>+ optional => 1,
>+ },
>+ options => {
>+ type => 'array',
>+ optional => 1,
>+ description => "A list of additional interface options for IPv4.",
>+ items => {
>+ type => "string",
>+ description => "An interface property.",
>+ },
>+ },
>+ options6 => {
>+ type => 'array',
>+ optional => 1,
>+ description => "A list of additional interface options for IPv6.",
>+ items => {
>+ type => "string",
>+ description => "An interface property.",
>+ },
>+ },
>+ 'uplink-id' => {
>+ type => 'string',
>+ optional => 1,
>+ description => "The uplink ID.",
>+ },
>+ 'link-type' => {
>+ type => 'string',
>+ optional => 1,
>+ description => "The link type.",
>+ },
>+ 'vlan-protocol' => {
>+ type => 'string',
>+ optional => 1,
>+ enum => [qw(802.1ad 802.1q)],
>+ description => "The vlan protocol.",
s/vlan/VLAN/
>+ },
>+ 'vxlan-id' => {
>+ type => 'integer',
>+ optional => 1,
>+ description => "The VXLAN ID.",
>+ },
>+ 'vxlan-svcnodeip' => {
>+ type => 'string',
>+ optional => 1,
>+ description => "The VXLAN SVC node IP.",
>+ },
>+ 'vxlan-physdev' => {
>+ type => 'string',
>+ optional => 1,
>+ description => "The physical device for the VXLAN tunnel communication.",
I would remove the "communication" as it's kinda redundant IMO.
>+ },
>+ 'vxlan-local-tunnelip' => {
>+ type => 'string',
>+ optional => 1,
>+ description => "The VXLAN local tunnel IP.",
>+ },
>+ }),
> },
> links => [ { rel => 'child', href => "{iface}" } ],
> },
_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel