Equipment model base-1 (c0e91c53) · Commits · SA5 – Management & Orchestration and Charging / Management and Orchestration APIs

yang-models/_3gpp-common-equipment.yang

0 → 100644

+173 −0

Original line number	Diff line number	Diff line
		module _3gpp-common-equipment {
		yang-version 1.1;
		namespace "urn:3gpp:sa5:_3gpp-common-equipment";
		prefix "equip3gpp";

		import _3gpp-common-top { prefix top3gpp; }
		import _3gpp-common-yang-types { prefix types3gpp; }
		import _3gpp-common-yang-extensions { prefix yext3gpp; }
		import _3gpp-common-managed-element { prefix me3gpp; }

		organization "3GPP SA5";
		contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464";

		description "Defines a HW Equipment model
		Copyright 2026, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI,
		TTA, TTC). All rights reserved.";
		reference "3GPP TS 28.622
		3GPP TS 28.623";

		revision 2026-06-14 { reference "CR-xxxx"; }

		grouping FRULinkGrp {
		description "Represents the attributes of the FRULink IOC.";

		leaf-list portRefList {
		type types3gpp:DistinguishedName;
		min-elements 2;
		description "The DNs of FRUPort MOIs connected to this FRULink.
		The value may be auto-detected and not writable, but to facilitate
		equipment without auto-detection it might allow operator input.";
		}
		}

		grouping FRUPortGrp {
		description "Represents the attributes of the FRUPort IOC.";

		leaf administrativeState {
		type types3gpp:AdministrativeState;
		default LOCKED;
		description "Administrative state of the port.
		The administrative state describes the permission to use or
		prohibition against using the object instance. The administrative
		state is set by the MnS consumer.";
		}

		leaf operationalState {
		type types3gpp:OperationalState;
		config false;
		default DISABLED;
		description "The operational state of the port.";
		}

		leaf-list availabilityStatus {
		type types3gpp:AvailabilityStatus;
		config false;
		description "The availability status provides additional information
		about the operational state.";
		}

		leaf portType {
		type string;
		mandatory true;
		description "A description of the port type.
		The value may be auto-detected and not writable, but to facilitate
		equipment without auto-detection it might allow operator input.";
		}

		leaf userLabel {
		type string;
		description "A user-friendly (and user assignable) name of this
		object.";
		}
		}

		grouping FieldReplaceableUnitGrp {
		description "Represents the attributes of the FieldReplaceableUnit IOC.";

		leaf administrativeState {
		type types3gpp:AdministrativeState;
		default LOCKED;
		description "Administrative state of the field replaceable unit.
		The administrative state describes the permission to use or
		prohibition against using the object instance. The administrative
		state is set by the MnS consumer.";
		}

		leaf operationalState {
		type types3gpp:OperationalState;
		config false;
		default DISABLED;
		description "The operational state of the field replaceable unit.";
		}

		leaf-list availabilityStatus {
		type types3gpp:AvailabilityStatus;
		config false;
		description "The availability status provides additional information
		about the operational state.";
		}

		leaf fruType {
		type string;
		mandatory true;
		description "A descriptive type name for the field replaceable unit.
		The value may be auto-detected and not writable, but to facilitate
		equipment without auto-detection it might allow operator input.";
		}

		leaf inventoryUnitRef {
		type types3gpp:DistinguishedName;
		mandatory true;
		description "DN reference to an InventoryUnit MOI.";
		}

		leaf userLabel {
		type string;
		description "A user-friendly (and user assignable) name of this
		object.";
		}
		}

		grouping EquipmentGrp {
		description "Represents the attributes of the Equipment IOC.";
		}

		augment "/me3gpp:ManagedElement" {
		list Equipment {
		key id;
		max-elements 1;
		yext3gpp:only-system-created;
		uses top3gpp:Top_Grp;
		description "Acts as a container for physical equipment related IOCs
		managed via the network element. The corresponding MOI is created
		automatically by the system and cannot be deleted.";
		container attributes {
		uses EquipmentGrp;
		}

		list FieldReplaceableUnit {
		description "Models a field replaceable HW Unit.";
		key id;
		uses top3gpp:Top_Grp;
		container attributes {
		uses FieldReplaceableUnitGrp;
		}

		list FRUPort {
		description "Models a port on a Field Replaceable Unit.
		An FRUPort represents a physical interface that can be connected to.
		Examples include Ethernet, RF, GPIO.";
		key id;
		uses top3gpp:Top_Grp;
		container attributes {
		uses FRUPortGrp;
		}
		}
		}

		list FRULink {
		description "Models a point-to-point or point-to-multipoint FRULink
		between two or more FRUPorts.
		A FRULink can represent a point-to-point link if it contains only
		two references, or it may represent a multipoint link if it contains
		more than two references";
		key id;
		uses top3gpp:Top_Grp;
		container attributes {
		uses FRULinkGrp;
		}
		}
		}
		}
		}
		No newline at end of file