From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9]) by lore.proxmox.com (Postfix) with ESMTPS id 18A2B1FF164 for ; Fri, 6 Dec 2024 10:24:12 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 22CFC9CE; Fri, 6 Dec 2024 10:24:11 +0100 (CET) From: Dominik Csapak To: pve-devel@lists.proxmox.com Date: Fri, 6 Dec 2024 10:24:07 +0100 Message-Id: <20241206092407.960823-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] [PATCH manager v2] 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 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pve-devel-bounces@lists.proxmox.com Sender: "pve-devel" Most options 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 --- changes from rfc: * added missing fields * fixed typos * reordered fields to be sorted alphabetically PVE/API2/Network.pm | 122 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 120 insertions(+), 2 deletions(-) diff --git a/PVE/API2/Network.pm b/PVE/API2/Network.pm index b9db9b27..cfccdd9e 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,125 @@ __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 true if the interface is active.", + }, + 'bridge-access' => { + type => 'integer', + optional => 1, + description => "The bridge port access VLAN.", + }, + 'bridge-learning' => { + type => 'boolean', + optional => 1, + description => "Bridge port learning flag.", + }, + 'bridge-arp-nd-suppress' => { + type => 'boolean', + optional => 1, + description => "Bridge port ARP/ND suppress flag.", + }, + 'bridge-unicast-flood' => { + type => 'boolean', + optional => 1, + description => "Bridge port unicast flood flag.", + }, + 'bridge-multicast-flood' => { + type => 'boolean', + optional => 1, + description => "Bridge port multicast flood flag.", + }, + exists => { + type => 'boolean', + optional => 1, + description => "Set to true if the interface physically exists.", + }, + families => { + type => "array", + description => "The network families.", + items => { + type => "string", + description => "A network family.", + enum => ["inet", "inet6"], + }, + optional => 1, + }, + 'link-type' => { + type => 'string', + optional => 1, + description => "The link type.", + }, + 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, + }, + 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.", + }, + }, + priority => { + type => 'integer', + description => "The order of the interface.", + optional => 1, + }, + 'uplink-id' => { + type => 'string', + optional => 1, + description => "The uplink ID.", + }, + '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.", + }, + '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