[netmod] Re: vendor proprietary YANG modules: how are they named?

Qin Wu <bill.wu@huawei.com> Tue, 11 August 2026 00:56 UTC

Return-Path: <bill.wu@huawei.com>
X-Original-To: netmod@mail2.ietf.org
Delivered-To: netmod@mail2.ietf.org
Received: from localhost (localhost [127.0.0.1]) by mail2.ietf.org (Postfix) with ESMTP id 930C412778CE8 for <netmod@mail2.ietf.org>; Mon, 10 Aug 2026 17:56:03 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ietf.org; s=ietf1; t=1786409763; bh=AHFKKdcsp7P2+Wf3atrKXDiKbyeCbw4VQ3jMeG9jsJs=; h=From:To:CC:Subject:Date; b=kxU9sqzEWvctiE0o8Xpeh7cLwEOfAKAde8mcYOj/A1fOu9CLhtEnvdmsxl+onE+my pJhzu2Gjdef5U90zbdT3uwGz7iErSg3hr+y/nGMvbIsroKVBCGWAZeZVJJyV3okUl2 HZ1XOg9NKjVgrVjKh55gWuPrxY0Yss8vkD1L8/4k=
X-Virus-Scanned: amavisd-new at ietf.org
X-Spam-Flag: NO
X-Spam-Score: -4.394
X-Spam-Level:
X-Spam-Status: No, score=-4.394 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_MSPIKE_H5=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_NONE=0.001] autolearn=ham autolearn_force=no
Authentication-Results: mail2.ietf.org (amavisd-new); dkim=pass (1024-bit key) header.d=huawei.com
Received: from mail2.ietf.org ([166.84.6.31]) by localhost (mail2.ietf.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id Oe1TKqBRVNmD for <netmod@mail2.ietf.org>; Mon, 10 Aug 2026 17:56:02 -0700 (PDT)
Received: from frasgout.his.huawei.com (frasgout.his.huawei.com [185.176.79.56]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-256) server-digest SHA256) (No client certificate requested) by mail2.ietf.org (Postfix) with ESMTPS id 110A712778CE3 for <netmod@ietf.org>; Mon, 10 Aug 2026 17:56:02 -0700 (PDT)
dkim-signature: v=1; a=rsa-sha256; d=huawei.com; s=dkim; c=relaxed/relaxed; q=dns/txt; h=From; bh=AHFKKdcsp7P2+Wf3atrKXDiKbyeCbw4VQ3jMeG9jsJs=; b=XcYABgpJzSBReFk/twkgeenpGAtLRDGsKPPMPM5XwhCB64ccz+J8VJNs/buO1w1S8HvLYIKtQ BcM+gevIHuuN632sPPEkRiESJCkoGB4igRrWV5aUy/OHrytkTWtFBI1TCDb8Y980bdusD4VVYqh +6lNYXi1pFREHNo6ChzO1mM=
Received: from mail.maildlp.com (unknown [172.18.224.83]) by frasgout.his.huawei.com (SkyGuard) with ESMTPS id 4hJtTh0Pm6zHnGcV; Tue, 11 Aug 2026 08:55:52 +0800 (CST)
Received: from kwepemh500011.china.huawei.com (unknown [7.202.181.142]) by mail.maildlp.com (Postfix) with ESMTPS id AA10840569; Tue, 11 Aug 2026 08:55:54 +0800 (CST)
Received: from kwepemf100006.china.huawei.com (7.202.181.220) by kwepemh500011.china.huawei.com (7.202.181.142) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.1544.11; Tue, 11 Aug 2026 08:55:53 +0800
Received: from kwepemf200004.china.huawei.com (7.202.181.230) by kwepemf100006.china.huawei.com (7.202.181.220) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.1544.36; Tue, 11 Aug 2026 08:55:52 +0800
Received: from kwepemf200004.china.huawei.com ([7.202.181.230]) by kwepemf200004.china.huawei.com ([7.202.181.230]) with mapi id 15.02.1544.011; Tue, 11 Aug 2026 08:55:52 +0800
From: Qin Wu <bill.wu@huawei.com>
To: Michael Richardson <mcr+ietf@sandelman.ca>
Thread-Topic: [netmod] Re: vendor proprietary YANG modules: how are they named?
Thread-Index: Ad0pLCNaX/EM+tuwTsm8AROsSF4mpw==
Date: Tue, 11 Aug 2026 00:55:52 +0000
Message-ID: <74fee4bb949049c785f8150a2f09546b@huawei.com>
Accept-Language: zh-CN, en-US
Content-Language: zh-CN
X-MS-Has-Attach:
X-MS-TNEF-Correlator:
x-originating-ip: [10.136.132.204]
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: base64
MIME-Version: 1.0
Message-ID-Hash: ID67XJKD5K2MFXH66AJUPBVML7ITH2K7
X-Message-ID-Hash: ID67XJKD5K2MFXH66AJUPBVML7ITH2K7
X-MailFrom: bill.wu@huawei.com
X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-netmod.ietf.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header
CC: netmod <netmod@ietf.org>
X-Mailman-Version: 3.3.9rc6
Precedence: list
Subject: [netmod] Re: vendor proprietary YANG modules: how are they named?
List-Id: NETMOD WG list <netmod.ietf.org>
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/Ch9YDZA0TWlqBtorktYQtGKzebU>
List-Archive: <https://mailarchive.ietf.org/arch/browse/netmod>
List-Help: <mailto:netmod-request@ietf.org?subject=help>
List-Owner: <mailto:netmod-owner@ietf.org>
List-Post: <mailto:netmod@ietf.org>
List-Subscribe: <mailto:netmod-join@ietf.org>
List-Unsubscribe: <mailto:netmod-leave@ietf.org>

-----邮件原件-----
发件人: Michael Richardson [mailto:mcr+ietf@sandelman.ca] 
发送时间: 2026年8月11日 3:32
收件人: Qin Wu <bill.wu@huawei.com>
抄送: Mahesh Jethanandani <mjethanandani@gmail.com>; netmod <netmod@ietf.org>
主题: Re: [netmod] Re: vendor proprietary YANG modules: how are they named?


Qin Wu <bill.wu@huawei.com> wrote:
    > For vendor specific module, I think the enterprise or organization-name should be used,
    > Similar to example modules, organization specific module.

Can you give me an example?
The YANG module name: "example.org-bgp-obscure-types" seems valid.
The only caveat is maybe org.example-obscure-types would be a better convention.

[Qin Wu] The typical example is enterprise or organization-name following by product-name or platform-name and/or network function or network feature name,
Or enterprise or organization-name following directly with network function or network feature name
e.g., Cisco-IOS-XR-8000-fib-platform-cfg.yang, huawei-bgp-mvpn-deviations-NE8000.yang

Also based on identifiers rule in section 4.3 of RFC9907,
"
   All YANG identifiers in published modules MUST be between 1 and 64
   characters in length.
"
I think this rule should also be applied to module name.

    > the vendor include extra identification in the tag to avoid collisions, such as using the
    > enterprise or organization name following the "vendor:" prefix (e.g.,
    > vendor:example.com:vendor-defined-classifier).

I'm not sure how this relates to the YANG module name, as this seems to be about the XML name, right?

[Qin Wu] You are correct.
--
Michael Richardson <mcr+IETF@sandelman.ca>   . o O ( IPv6 IøT consulting )
           Sandelman Software Works Inc, Ottawa and Worldwide

**       My working hours and your working hours may be different.         **
** Please do not feel obligated to reply outside your normal working hours **