From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id EA5DB1FF163 for ; Thu, 5 Dec 2024 09:28:19 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id D7281155A3; Thu, 5 Dec 2024 09:28:17 +0100 (CET) From: Dominik Csapak To: pve-devel@lists.proxmox.com Date: Thu, 5 Dec 2024 09:27:43 +0100 Message-Id: <20241205082743.459521-1-d.csapak@proxmox.com> X-Mailer: git-send-email 2.39.5 MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.015 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: [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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox VE development discussion Cc: s.hahnreich@proxmox.com Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pve-devel-bounces@lists.proxmox.com Sender: "pve-devel" Most optiosn come from the api call parameter list (`json_config_properties`). The description and types for the remaining ons are either taken from the manpages, source code or similar documentation where available. Signed-off-by: Dominik Csapak --- sending as RFC because some descriptions are very barebones due to lack of documentation on the specific properties (link-type, vxlan-*, etc.) @s.hahnreich, maybe could you take a look at these and expand on some of them? PVE/API2/Network.pm | 97 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 95 insertions(+), 2 deletions(-) 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.", + 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.", + }, + '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.", + }, + 'vxlan-local-tunnelip' => { + type => 'string', + optional => 1, + description => "The VXLAN local tunnel IP.", + }, + }), }, links => [ { rel => 'child', href => "{iface}" } ], }, -- 2.39.5 _______________________________________________ pve-devel mailing list pve-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel