From 20ee2b7a2397d6b56dfddbbf1385a276a061e321 Mon Sep 17 00:00:00 2001 From: Mark Sanders Date: Tue, 10 Oct 2023 21:16:34 +0000 Subject: [PATCH] refactor(common): split inventory from common Signed-off-by: Mark Sanders --- buf.gen.yaml | 6 +- buf.work.yaml | 1 + common/v1/autogen.md | 225 ---------------- inventory/Makefile | 21 ++ inventory/buf.lock | 13 + inventory/buf.yaml | 8 + inventory/v1/__init__.py | 0 inventory/v1/autogen.md | 254 ++++++++++++++++++ inventory/v1/gen/__init__.py | 0 .../v1/gen/cpp/inventory.grpc.pb.cc | 0 .../v1/gen/cpp/inventory.grpc.pb.h | 0 .../v1/gen/cpp/inventory.pb.cc | 0 .../v1/gen/cpp/inventory.pb.h | 0 .../v1/gen/go/inventory.pb.go | 0 .../v1/gen/go/inventory.pb.gw.go | 0 .../v1/gen/go/inventory.swagger.json | 0 .../v1/gen/go/inventory_grpc.pb.go | 0 .../java/opi_api/inventory/v1/BIOSInfo.java | 0 .../inventory/v1/BIOSInfoOrBuilder.java | 0 .../opi_api/inventory/v1/BaseboardInfo.java | 0 .../inventory/v1/BaseboardInfoOrBuilder.java | 0 .../java/opi_api/inventory/v1/CPUInfo.java | 0 .../inventory/v1/CPUInfoOrBuilder.java | 0 .../opi_api/inventory/v1/ChassisInfo.java | 0 .../inventory/v1/ChassisInfoOrBuilder.java | 0 .../inventory/v1/GetInventoryRequest.java | 0 .../v1/GetInventoryRequestOrBuilder.java | 0 .../java/opi_api/inventory/v1/Inventory.java | 0 .../inventory/v1/InventoryOrBuilder.java | 0 .../opi_api/inventory/v1/InventoryProto.java | 0 .../inventory/v1/InventorySvcGrpc.java | 0 .../java/opi_api/inventory/v1/MemoryInfo.java | 0 .../inventory/v1/MemoryInfoOrBuilder.java | 0 .../opi_api/inventory/v1/PCIeDeviceInfo.java | 0 .../inventory/v1/PCIeDeviceInfoOrBuilder.java | 0 .../java/opi_api/inventory/v1/SystemInfo.java | 0 .../inventory/v1/SystemInfoOrBuilder.java | 0 inventory/v1/gen/python/__init__.py | 0 .../v1/gen/python/inventory_pb2.py | 0 .../v1/gen/python/inventory_pb2_grpc.py | 0 {common => inventory}/v1/inventory.proto | 0 network/cloud/v1alpha1/autogen.md | 225 ---------------- network/evpn-gw/v1alpha1/autogen.md | 225 ---------------- network/k8s/v1alpha1/autogen.md | 225 ---------------- network/opinetcommon/v1alpha1/autogen.md | 225 ---------------- network/telco/v1alpha1/autogen.md | 225 ---------------- security/v1/autogen.md | 225 ---------------- storage/v1alpha1/autogen.md | 225 ---------------- 48 files changed, 300 insertions(+), 1803 deletions(-) create mode 100644 inventory/Makefile create mode 100644 inventory/buf.lock create mode 100644 inventory/buf.yaml create mode 100644 inventory/v1/__init__.py create mode 100644 inventory/v1/autogen.md create mode 100644 inventory/v1/gen/__init__.py rename {common => inventory}/v1/gen/cpp/inventory.grpc.pb.cc (100%) rename {common => inventory}/v1/gen/cpp/inventory.grpc.pb.h (100%) rename {common => inventory}/v1/gen/cpp/inventory.pb.cc (100%) rename {common => inventory}/v1/gen/cpp/inventory.pb.h (100%) rename {common => inventory}/v1/gen/go/inventory.pb.go (100%) rename {common => inventory}/v1/gen/go/inventory.pb.gw.go (100%) rename {common => inventory}/v1/gen/go/inventory.swagger.json (100%) rename {common => inventory}/v1/gen/go/inventory_grpc.pb.go (100%) rename {common => inventory}/v1/gen/java/opi_api/inventory/v1/BIOSInfo.java (100%) rename {common => inventory}/v1/gen/java/opi_api/inventory/v1/BIOSInfoOrBuilder.java (100%) rename {common => inventory}/v1/gen/java/opi_api/inventory/v1/BaseboardInfo.java (100%) rename {common => inventory}/v1/gen/java/opi_api/inventory/v1/BaseboardInfoOrBuilder.java (100%) rename {common => inventory}/v1/gen/java/opi_api/inventory/v1/CPUInfo.java (100%) rename {common => inventory}/v1/gen/java/opi_api/inventory/v1/CPUInfoOrBuilder.java (100%) rename {common => inventory}/v1/gen/java/opi_api/inventory/v1/ChassisInfo.java (100%) rename {common => inventory}/v1/gen/java/opi_api/inventory/v1/ChassisInfoOrBuilder.java (100%) rename {common => inventory}/v1/gen/java/opi_api/inventory/v1/GetInventoryRequest.java (100%) rename {common => inventory}/v1/gen/java/opi_api/inventory/v1/GetInventoryRequestOrBuilder.java (100%) rename {common => inventory}/v1/gen/java/opi_api/inventory/v1/Inventory.java (100%) rename {common => inventory}/v1/gen/java/opi_api/inventory/v1/InventoryOrBuilder.java (100%) rename {common => inventory}/v1/gen/java/opi_api/inventory/v1/InventoryProto.java (100%) rename {common => inventory}/v1/gen/java/opi_api/inventory/v1/InventorySvcGrpc.java (100%) rename {common => inventory}/v1/gen/java/opi_api/inventory/v1/MemoryInfo.java (100%) rename {common => inventory}/v1/gen/java/opi_api/inventory/v1/MemoryInfoOrBuilder.java (100%) rename {common => inventory}/v1/gen/java/opi_api/inventory/v1/PCIeDeviceInfo.java (100%) rename {common => inventory}/v1/gen/java/opi_api/inventory/v1/PCIeDeviceInfoOrBuilder.java (100%) rename {common => inventory}/v1/gen/java/opi_api/inventory/v1/SystemInfo.java (100%) rename {common => inventory}/v1/gen/java/opi_api/inventory/v1/SystemInfoOrBuilder.java (100%) create mode 100644 inventory/v1/gen/python/__init__.py rename {common => inventory}/v1/gen/python/inventory_pb2.py (100%) rename {common => inventory}/v1/gen/python/inventory_pb2_grpc.py (100%) rename {common => inventory}/v1/inventory.proto (100%) diff --git a/buf.gen.yaml b/buf.gen.yaml index 075cb65c..4255173f 100644 --- a/buf.gen.yaml +++ b/buf.gen.yaml @@ -1,13 +1,13 @@ version: v1 plugins: - plugin: go - out: proto + out: proto/go opt: paths=source_relative - plugin: go-grpc - out: proto + out: proto/go opt: paths=source_relative - name: grpc-gateway - out: ./proto + out: ./proto/go opt: - paths=source_relative diff --git a/buf.work.yaml b/buf.work.yaml index 076d4eda..7ddb5da1 100644 --- a/buf.work.yaml +++ b/buf.work.yaml @@ -1,6 +1,7 @@ version: v1 directories: - common +- inventory - security # - storage # - network/opinetcommon diff --git a/common/v1/autogen.md b/common/v1/autogen.md index 95d9b254..7707cfb2 100644 --- a/common/v1/autogen.md +++ b/common/v1/autogen.md @@ -3,19 +3,6 @@ ## Table of Contents -- [inventory.proto](#inventory-proto) - - [BIOSInfo](#opi_api-inventory-v1-BIOSInfo) - - [BaseboardInfo](#opi_api-inventory-v1-BaseboardInfo) - - [CPUInfo](#opi_api-inventory-v1-CPUInfo) - - [ChassisInfo](#opi_api-inventory-v1-ChassisInfo) - - [GetInventoryRequest](#opi_api-inventory-v1-GetInventoryRequest) - - [Inventory](#opi_api-inventory-v1-Inventory) - - [MemoryInfo](#opi_api-inventory-v1-MemoryInfo) - - [PCIeDeviceInfo](#opi_api-inventory-v1-PCIeDeviceInfo) - - [SystemInfo](#opi_api-inventory-v1-SystemInfo) - - - [InventorySvc](#opi_api-inventory-v1-InventorySvc) - - [uuid.proto](#uuid-proto) - [Uuid](#opi_api-common-v1-Uuid) @@ -23,218 +10,6 @@ - -

Top

- -## inventory.proto - - - - - -### BIOSInfo -BIOS Information (Type 0) - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| vendor | [string](#string) | | String number of the BIOS Vendor’s Name. | -| version | [string](#string) | | String number of the BIOS Version. This value is a free-form string that may contain Core and OEM version information. | -| date | [string](#string) | | String number of the BIOS release date. The date string, if supplied, is in either mm/dd/yy or mm/dd/yyyy format. If the year portion of the string is two digits, the year is assumed to be 19yy. NOTE: In version 2.3 and later of SMBIOS the mm/dd/yyyy format is only used. | - - - - - - - - -### BaseboardInfo -Baseboard (or Module) Information (Type 2) - The information in this structure defines attributes of a system baseboard (for - example, a motherboard, planar, server blade, or other standard system module) - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| asset_tag | [string](#string) | | Number of a null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| version | [string](#string) | | Number of null-terminated string | -| product | [string](#string) | | Number of null-terminated string | - - - - - - - - -### CPUInfo -Processor Information (Type 4) - The information in this structure (see Table 21) defines the attributes of a single processor; a separate - structure instance is provided for each system processor socket/slot. For example, a system with an - IntelDX2™ processor would have a single structure instance while a system with an IntelSX2™ processor - would have a structure to describe the main CPU and a second structure to describe the 80487 co1054 processor. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| total_cores | [int32](#int32) | | Number of cores per processor socket See 7.5.6. If the value is unknown, the field is set to 0. For core counts of 256 or greater, the Core Count field is set to FFh and the Core Count 2 field is set to the number of cores. | -| total_threads | [int32](#int32) | | Number of threads per processor socket See 7.5.8. If the value is unknown, the field is set to 0. For thread counts of 256 or greater, the Thread Count field is set to FFh and the Thread Count 2 field is set to the number of threads. | - - - - - - - - -### ChassisInfo -System Enclosure or Chassis (Type 3) - The information in this structure (see Table 16) defines attributes of the system’s mechanical - enclosure(s). For example, if a system included a separate enclosure for its peripheral devices, two - structures would be returned: one for the main system enclosure and the second for the peripheral device - enclosure. The additions to this structure in version 2.1 of this specification support the population of the - CIM_Chassis class. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| asset_tag | [string](#string) | | Number of null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| type | [string](#string) | | Bit 7 Chassis lock is present if 1. Otherwise, either a lock is not present, or it is unknown if the enclosure has a lock. Bits 6:0 Enumeration value; see below. | -| type_description | [string](#string) | | Table 17 shows the byte values for the System Enclosure or Chassis Types field Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| version | [string](#string) | | Number of null-terminated string | - - - - - - - - -### GetInventoryRequest -Request for Retrieving Inventory data from a device - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| name | [string](#string) | | The name of the inventory to retrieve - blank for the full inventory | - - - - - - - - -### Inventory -Response for device inventory data - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| bios | [BIOSInfo](#opi_api-inventory-v1-BIOSInfo) | | BIOS Inventory | -| system | [SystemInfo](#opi_api-inventory-v1-SystemInfo) | | System Inventory | -| baseboard | [BaseboardInfo](#opi_api-inventory-v1-BaseboardInfo) | | Baseboard Inventory | -| chassis | [ChassisInfo](#opi_api-inventory-v1-ChassisInfo) | | Chassis Inventory | -| processor | [CPUInfo](#opi_api-inventory-v1-CPUInfo) | | CPU Inventory | -| memory | [MemoryInfo](#opi_api-inventory-v1-MemoryInfo) | | Memory Inventory | -| pci | [PCIeDeviceInfo](#opi_api-inventory-v1-PCIeDeviceInfo) | repeated | PCI Devices Inventory | - - - - - - - - -### MemoryInfo -Physical Memory Array (Type 16) - This structure describes a collection of memory devices that operate together to form a memory address - space. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| total_physical_bytes | [int64](#int64) | | Maximum memory capacity, in kilobytes, for this array If the capacity is not represented in this field, then this field contains 8000 0000h and the Extended Maximum Capacity field should be used. Values 2 TB (8000 0000h) or greater must be represented in the Extended Maximum Capacity field. | -| total_usable_bytes | [int64](#int64) | | TBD | - - - - - - - - -### PCIeDeviceInfo -PCI device information - TBD: Type 9 or Type 41 ? - This structure describes a collection of PCI devices. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| driver | [string](#string) | | Driver assiociated with the device | -| address | [string](#string) | | BDF address in a string format, for example "0000:00:17.7" | -| vendor | [string](#string) | | string vendor info | -| product | [string](#string) | | string product info | -| revision | [string](#string) | | string revision info | -| subsystem | [string](#string) | | string subsystem info | -| class | [string](#string) | | string class info | -| subclass | [string](#string) | | string subclass info | - - - - - - - - -### SystemInfo -System Information (Type 1) - The information in this structure defines attributes of the overall system and is intended to be associated - with the Component ID group of the system’s MIF. An SMBIOS implementation is associated with a single - system instance and contains one and only one System Information (Type 1) structure. Table 10 shows - the contents of this structure. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| family | [string](#string) | | Number of null-terminated string This text string identifies the family to which a particular computer belongs. A family refers to a set of computers that are similar but not identical from a hardware or software point of view. Typically, a family is composed of different computer models, which have different configurations and pricing points. Computers in the same family often have similar branding and cosmetic features. | -| name | [string](#string) | | Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| uuid | [string](#string) | | A UUID is an identifier that is designed to be unique across both time and space. It requires no central registration process. The UUID is 128 bits long. Its format is described in RFC4122, but the actual field contents are opaque and not significant to the SMBIOS specification, which is only concerned with the byte order. Table 11 shows the field names; these field names, particularly for multiplexed fields, follow historical practice. | -| sku | [string](#string) | | Number of null-terminated string This text string identifies a particular computer configuration for sale. It is sometimes also called a product ID or purchase order number. This number is frequently found in existing fields, but there is no standard format. Typically for a given system board from a given OEM, there are tens of unique processor, memory, hard drive, and optical drive configurations. | -| version | [string](#string) | | Number of null-terminated string | - - - - - - - - - - - - - - -### InventorySvc -Service functions for the device inventory data - -| Method Name | Request Type | Response Type | Description | -| ----------- | ------------ | ------------- | ------------| -| GetInventory | [GetInventoryRequest](#opi_api-inventory-v1-GetInventoryRequest) | [Inventory](#opi_api-inventory-v1-Inventory) | retrieves the inventory data for the device | - - - - -

Top

diff --git a/inventory/Makefile b/inventory/Makefile new file mode 100644 index 00000000..a957f0ed --- /dev/null +++ b/inventory/Makefile @@ -0,0 +1,21 @@ +# SPDX-License-Identifier: Apache-2.0 +# Copyright (C) 2022 Intel Corporation +# Copyright (c) 2022 Dell Inc, or its subsidiaries. + +all: + rm -rf ./v1/{autogen.md,gen} + mkdir -p ./v1/gen/{go,cpp,python,java} + + docker run --user=$$(id -u):$$(id -g) --rm -v "${PWD}":/defs namely/protoc-all:1.51_2 --lint -d v1 -l go -o ./v1/gen/go/ --go-source-relative --with-gateway + docker run --user=$$(id -u):$$(id -g) --rm -v "${PWD}":/defs namely/protoc-all:1.51_2 --lint -d v1 -l cpp -o ./v1/gen/cpp/ --go-source-relative + docker run --user=$$(id -u):$$(id -g) --rm -v "${PWD}":/defs namely/protoc-all:1.51_2 --lint -d v1 -l python -o ./v1/gen/python/ --go-source-relative + docker run --user=$$(id -u):$$(id -g) --rm -v "${PWD}":/defs namely/protoc-all:1.51_2 --lint -d v1 -l java -o ./v1/gen/java/ --go-source-relative + + # protoc doesn't include the googleapis, so we have to get them here + curl -kL https://github.com/googleapis/googleapis/archive/master.tar.gz | tar --strip=1 -zxvf - googleapis-master/google/api + mv google "${PWD}"/v1/ + docker run --user=$$(id -u):$$(id -g) --rm -v "${PWD}"/v1/:/out -v "${PWD}"/v1:/protos pseudomuto/protoc-gen-doc:1.5.1 --doc_opt=markdown,autogen.md + docker run --user=$$(id -u):$$(id -g) --rm -v "${PWD}"/v1/:/out -w /out --entrypoint=sh ghcr.io/docker-multiarch/google-api-linter:1.56.1 -c "api-linter /out/*.proto --output-format summary" + docker run --user=$$(id -u):$$(id -g) --rm -v "${PWD}"/v1/:/out -w /out --entrypoint=sh ghcr.io/docker-multiarch/google-api-linter:1.56.1 -c "api-linter /out/*.proto --output-format github --set-exit-status" + rm -rf "${PWD}"/v1/google + diff --git a/inventory/buf.lock b/inventory/buf.lock new file mode 100644 index 00000000..fccbfb89 --- /dev/null +++ b/inventory/buf.lock @@ -0,0 +1,13 @@ +# Generated by buf. DO NOT EDIT. +version: v1 +deps: + - remote: buf.build + owner: googleapis + repository: googleapis + commit: 28151c0d0a1641bf938a7672c500e01d + digest: shake256:49215edf8ef57f7863004539deff8834cfb2195113f0b890dd1f67815d9353e28e668019165b9d872395871eeafcbab3ccfdb2b5f11734d3cca95be9e8d139de + - remote: buf.build + owner: grpc-ecosystem + repository: grpc-gateway + commit: 048ae6ff94ca4476b3225904b1078fad + digest: shake256:e5250bf2d999516c02206d757502b902e406f35c099d0e869dc3e4f923f6870fe0805a9974c27df0695462937eae90cd4d9db90bb9a03489412560baa74a87b6 diff --git a/inventory/buf.yaml b/inventory/buf.yaml new file mode 100644 index 00000000..c79b3a51 --- /dev/null +++ b/inventory/buf.yaml @@ -0,0 +1,8 @@ +version: v1 +name: buf.build/opiproject/inventory +deps: + - buf.build/googleapis/googleapis + - buf.build/grpc-ecosystem/grpc-gateway +lint: + except: + - PACKAGE_DIRECTORY_MATCH diff --git a/inventory/v1/__init__.py b/inventory/v1/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/inventory/v1/autogen.md b/inventory/v1/autogen.md new file mode 100644 index 00000000..13a786e7 --- /dev/null +++ b/inventory/v1/autogen.md @@ -0,0 +1,254 @@ +# Protocol Documentation + + +## Table of Contents + +- [inventory.proto](#inventory-proto) + - [BIOSInfo](#opi_api-inventory-v1-BIOSInfo) + - [BaseboardInfo](#opi_api-inventory-v1-BaseboardInfo) + - [CPUInfo](#opi_api-inventory-v1-CPUInfo) + - [ChassisInfo](#opi_api-inventory-v1-ChassisInfo) + - [GetInventoryRequest](#opi_api-inventory-v1-GetInventoryRequest) + - [Inventory](#opi_api-inventory-v1-Inventory) + - [MemoryInfo](#opi_api-inventory-v1-MemoryInfo) + - [PCIeDeviceInfo](#opi_api-inventory-v1-PCIeDeviceInfo) + - [SystemInfo](#opi_api-inventory-v1-SystemInfo) + + - [InventorySvc](#opi_api-inventory-v1-InventorySvc) + +- [Scalar Value Types](#scalar-value-types) + + + + +

Top

+ +## inventory.proto + + + + + +### BIOSInfo +BIOS Information (Type 0) + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| vendor | [string](#string) | | String number of the BIOS Vendor’s Name. | +| version | [string](#string) | | String number of the BIOS Version. This value is a free-form string that may contain Core and OEM version information. | +| date | [string](#string) | | String number of the BIOS release date. The date string, if supplied, is in either mm/dd/yy or mm/dd/yyyy format. If the year portion of the string is two digits, the year is assumed to be 19yy. NOTE: In version 2.3 and later of SMBIOS the mm/dd/yyyy format is only used. | + + + + + + + + +### BaseboardInfo +Baseboard (or Module) Information (Type 2) + The information in this structure defines attributes of a system baseboard (for + example, a motherboard, planar, server blade, or other standard system module) + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| asset_tag | [string](#string) | | Number of a null-terminated string | +| serial_number | [string](#string) | | Number of null-terminated string | +| vendor | [string](#string) | | Number of null-terminated string | +| version | [string](#string) | | Number of null-terminated string | +| product | [string](#string) | | Number of null-terminated string | + + + + + + + + +### CPUInfo +Processor Information (Type 4) + The information in this structure (see Table 21) defines the attributes of a single processor; a separate + structure instance is provided for each system processor socket/slot. For example, a system with an + IntelDX2™ processor would have a single structure instance while a system with an IntelSX2™ processor + would have a structure to describe the main CPU and a second structure to describe the 80487 co1054 processor. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| total_cores | [int32](#int32) | | Number of cores per processor socket See 7.5.6. If the value is unknown, the field is set to 0. For core counts of 256 or greater, the Core Count field is set to FFh and the Core Count 2 field is set to the number of cores. | +| total_threads | [int32](#int32) | | Number of threads per processor socket See 7.5.8. If the value is unknown, the field is set to 0. For thread counts of 256 or greater, the Thread Count field is set to FFh and the Thread Count 2 field is set to the number of threads. | + + + + + + + + +### ChassisInfo +System Enclosure or Chassis (Type 3) + The information in this structure (see Table 16) defines attributes of the system’s mechanical + enclosure(s). For example, if a system included a separate enclosure for its peripheral devices, two + structures would be returned: one for the main system enclosure and the second for the peripheral device + enclosure. The additions to this structure in version 2.1 of this specification support the population of the + CIM_Chassis class. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| asset_tag | [string](#string) | | Number of null-terminated string | +| serial_number | [string](#string) | | Number of null-terminated string | +| type | [string](#string) | | Bit 7 Chassis lock is present if 1. Otherwise, either a lock is not present, or it is unknown if the enclosure has a lock. Bits 6:0 Enumeration value; see below. | +| type_description | [string](#string) | | Table 17 shows the byte values for the System Enclosure or Chassis Types field Number of null-terminated string | +| vendor | [string](#string) | | Number of null-terminated string | +| version | [string](#string) | | Number of null-terminated string | + + + + + + + + +### GetInventoryRequest +Request for Retrieving Inventory data from a device + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | The name of the inventory to retrieve - blank for the full inventory | + + + + + + + + +### Inventory +Response for device inventory data + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| bios | [BIOSInfo](#opi_api-inventory-v1-BIOSInfo) | | BIOS Inventory | +| system | [SystemInfo](#opi_api-inventory-v1-SystemInfo) | | System Inventory | +| baseboard | [BaseboardInfo](#opi_api-inventory-v1-BaseboardInfo) | | Baseboard Inventory | +| chassis | [ChassisInfo](#opi_api-inventory-v1-ChassisInfo) | | Chassis Inventory | +| processor | [CPUInfo](#opi_api-inventory-v1-CPUInfo) | | CPU Inventory | +| memory | [MemoryInfo](#opi_api-inventory-v1-MemoryInfo) | | Memory Inventory | +| pci | [PCIeDeviceInfo](#opi_api-inventory-v1-PCIeDeviceInfo) | repeated | PCI Devices Inventory | + + + + + + + + +### MemoryInfo +Physical Memory Array (Type 16) + This structure describes a collection of memory devices that operate together to form a memory address + space. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| total_physical_bytes | [int64](#int64) | | Maximum memory capacity, in kilobytes, for this array If the capacity is not represented in this field, then this field contains 8000 0000h and the Extended Maximum Capacity field should be used. Values 2 TB (8000 0000h) or greater must be represented in the Extended Maximum Capacity field. | +| total_usable_bytes | [int64](#int64) | | TBD | + + + + + + + + +### PCIeDeviceInfo +PCI device information + TBD: Type 9 or Type 41 ? + This structure describes a collection of PCI devices. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| driver | [string](#string) | | Driver assiociated with the device | +| address | [string](#string) | | BDF address in a string format, for example "0000:00:17.7" | +| vendor | [string](#string) | | string vendor info | +| product | [string](#string) | | string product info | +| revision | [string](#string) | | string revision info | +| subsystem | [string](#string) | | string subsystem info | +| class | [string](#string) | | string class info | +| subclass | [string](#string) | | string subclass info | + + + + + + + + +### SystemInfo +System Information (Type 1) + The information in this structure defines attributes of the overall system and is intended to be associated + with the Component ID group of the system’s MIF. An SMBIOS implementation is associated with a single + system instance and contains one and only one System Information (Type 1) structure. Table 10 shows + the contents of this structure. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| family | [string](#string) | | Number of null-terminated string This text string identifies the family to which a particular computer belongs. A family refers to a set of computers that are similar but not identical from a hardware or software point of view. Typically, a family is composed of different computer models, which have different configurations and pricing points. Computers in the same family often have similar branding and cosmetic features. | +| name | [string](#string) | | Number of null-terminated string | +| vendor | [string](#string) | | Number of null-terminated string | +| serial_number | [string](#string) | | Number of null-terminated string | +| uuid | [string](#string) | | A UUID is an identifier that is designed to be unique across both time and space. It requires no central registration process. The UUID is 128 bits long. Its format is described in RFC4122, but the actual field contents are opaque and not significant to the SMBIOS specification, which is only concerned with the byte order. Table 11 shows the field names; these field names, particularly for multiplexed fields, follow historical practice. | +| sku | [string](#string) | | Number of null-terminated string This text string identifies a particular computer configuration for sale. It is sometimes also called a product ID or purchase order number. This number is frequently found in existing fields, but there is no standard format. Typically for a given system board from a given OEM, there are tens of unique processor, memory, hard drive, and optical drive configurations. | +| version | [string](#string) | | Number of null-terminated string | + + + + + + + + + + + + + + +### InventorySvc +Service functions for the device inventory data + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetInventory | [GetInventoryRequest](#opi_api-inventory-v1-GetInventoryRequest) | [Inventory](#opi_api-inventory-v1-Inventory) | retrieves the inventory data for the device | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | float | float | Float | +| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/inventory/v1/gen/__init__.py b/inventory/v1/gen/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/common/v1/gen/cpp/inventory.grpc.pb.cc b/inventory/v1/gen/cpp/inventory.grpc.pb.cc similarity index 100% rename from common/v1/gen/cpp/inventory.grpc.pb.cc rename to inventory/v1/gen/cpp/inventory.grpc.pb.cc diff --git a/common/v1/gen/cpp/inventory.grpc.pb.h b/inventory/v1/gen/cpp/inventory.grpc.pb.h similarity index 100% rename from common/v1/gen/cpp/inventory.grpc.pb.h rename to inventory/v1/gen/cpp/inventory.grpc.pb.h diff --git a/common/v1/gen/cpp/inventory.pb.cc b/inventory/v1/gen/cpp/inventory.pb.cc similarity index 100% rename from common/v1/gen/cpp/inventory.pb.cc rename to inventory/v1/gen/cpp/inventory.pb.cc diff --git a/common/v1/gen/cpp/inventory.pb.h b/inventory/v1/gen/cpp/inventory.pb.h similarity index 100% rename from common/v1/gen/cpp/inventory.pb.h rename to inventory/v1/gen/cpp/inventory.pb.h diff --git a/common/v1/gen/go/inventory.pb.go b/inventory/v1/gen/go/inventory.pb.go similarity index 100% rename from common/v1/gen/go/inventory.pb.go rename to inventory/v1/gen/go/inventory.pb.go diff --git a/common/v1/gen/go/inventory.pb.gw.go b/inventory/v1/gen/go/inventory.pb.gw.go similarity index 100% rename from common/v1/gen/go/inventory.pb.gw.go rename to inventory/v1/gen/go/inventory.pb.gw.go diff --git a/common/v1/gen/go/inventory.swagger.json b/inventory/v1/gen/go/inventory.swagger.json similarity index 100% rename from common/v1/gen/go/inventory.swagger.json rename to inventory/v1/gen/go/inventory.swagger.json diff --git a/common/v1/gen/go/inventory_grpc.pb.go b/inventory/v1/gen/go/inventory_grpc.pb.go similarity index 100% rename from common/v1/gen/go/inventory_grpc.pb.go rename to inventory/v1/gen/go/inventory_grpc.pb.go diff --git a/common/v1/gen/java/opi_api/inventory/v1/BIOSInfo.java b/inventory/v1/gen/java/opi_api/inventory/v1/BIOSInfo.java similarity index 100% rename from common/v1/gen/java/opi_api/inventory/v1/BIOSInfo.java rename to inventory/v1/gen/java/opi_api/inventory/v1/BIOSInfo.java diff --git a/common/v1/gen/java/opi_api/inventory/v1/BIOSInfoOrBuilder.java b/inventory/v1/gen/java/opi_api/inventory/v1/BIOSInfoOrBuilder.java similarity index 100% rename from common/v1/gen/java/opi_api/inventory/v1/BIOSInfoOrBuilder.java rename to inventory/v1/gen/java/opi_api/inventory/v1/BIOSInfoOrBuilder.java diff --git a/common/v1/gen/java/opi_api/inventory/v1/BaseboardInfo.java b/inventory/v1/gen/java/opi_api/inventory/v1/BaseboardInfo.java similarity index 100% rename from common/v1/gen/java/opi_api/inventory/v1/BaseboardInfo.java rename to inventory/v1/gen/java/opi_api/inventory/v1/BaseboardInfo.java diff --git a/common/v1/gen/java/opi_api/inventory/v1/BaseboardInfoOrBuilder.java b/inventory/v1/gen/java/opi_api/inventory/v1/BaseboardInfoOrBuilder.java similarity index 100% rename from common/v1/gen/java/opi_api/inventory/v1/BaseboardInfoOrBuilder.java rename to inventory/v1/gen/java/opi_api/inventory/v1/BaseboardInfoOrBuilder.java diff --git a/common/v1/gen/java/opi_api/inventory/v1/CPUInfo.java b/inventory/v1/gen/java/opi_api/inventory/v1/CPUInfo.java similarity index 100% rename from common/v1/gen/java/opi_api/inventory/v1/CPUInfo.java rename to inventory/v1/gen/java/opi_api/inventory/v1/CPUInfo.java diff --git a/common/v1/gen/java/opi_api/inventory/v1/CPUInfoOrBuilder.java b/inventory/v1/gen/java/opi_api/inventory/v1/CPUInfoOrBuilder.java similarity index 100% rename from common/v1/gen/java/opi_api/inventory/v1/CPUInfoOrBuilder.java rename to inventory/v1/gen/java/opi_api/inventory/v1/CPUInfoOrBuilder.java diff --git a/common/v1/gen/java/opi_api/inventory/v1/ChassisInfo.java b/inventory/v1/gen/java/opi_api/inventory/v1/ChassisInfo.java similarity index 100% rename from common/v1/gen/java/opi_api/inventory/v1/ChassisInfo.java rename to inventory/v1/gen/java/opi_api/inventory/v1/ChassisInfo.java diff --git a/common/v1/gen/java/opi_api/inventory/v1/ChassisInfoOrBuilder.java b/inventory/v1/gen/java/opi_api/inventory/v1/ChassisInfoOrBuilder.java similarity index 100% rename from common/v1/gen/java/opi_api/inventory/v1/ChassisInfoOrBuilder.java rename to inventory/v1/gen/java/opi_api/inventory/v1/ChassisInfoOrBuilder.java diff --git a/common/v1/gen/java/opi_api/inventory/v1/GetInventoryRequest.java b/inventory/v1/gen/java/opi_api/inventory/v1/GetInventoryRequest.java similarity index 100% rename from common/v1/gen/java/opi_api/inventory/v1/GetInventoryRequest.java rename to inventory/v1/gen/java/opi_api/inventory/v1/GetInventoryRequest.java diff --git a/common/v1/gen/java/opi_api/inventory/v1/GetInventoryRequestOrBuilder.java b/inventory/v1/gen/java/opi_api/inventory/v1/GetInventoryRequestOrBuilder.java similarity index 100% rename from common/v1/gen/java/opi_api/inventory/v1/GetInventoryRequestOrBuilder.java rename to inventory/v1/gen/java/opi_api/inventory/v1/GetInventoryRequestOrBuilder.java diff --git a/common/v1/gen/java/opi_api/inventory/v1/Inventory.java b/inventory/v1/gen/java/opi_api/inventory/v1/Inventory.java similarity index 100% rename from common/v1/gen/java/opi_api/inventory/v1/Inventory.java rename to inventory/v1/gen/java/opi_api/inventory/v1/Inventory.java diff --git a/common/v1/gen/java/opi_api/inventory/v1/InventoryOrBuilder.java b/inventory/v1/gen/java/opi_api/inventory/v1/InventoryOrBuilder.java similarity index 100% rename from common/v1/gen/java/opi_api/inventory/v1/InventoryOrBuilder.java rename to inventory/v1/gen/java/opi_api/inventory/v1/InventoryOrBuilder.java diff --git a/common/v1/gen/java/opi_api/inventory/v1/InventoryProto.java b/inventory/v1/gen/java/opi_api/inventory/v1/InventoryProto.java similarity index 100% rename from common/v1/gen/java/opi_api/inventory/v1/InventoryProto.java rename to inventory/v1/gen/java/opi_api/inventory/v1/InventoryProto.java diff --git a/common/v1/gen/java/opi_api/inventory/v1/InventorySvcGrpc.java b/inventory/v1/gen/java/opi_api/inventory/v1/InventorySvcGrpc.java similarity index 100% rename from common/v1/gen/java/opi_api/inventory/v1/InventorySvcGrpc.java rename to inventory/v1/gen/java/opi_api/inventory/v1/InventorySvcGrpc.java diff --git a/common/v1/gen/java/opi_api/inventory/v1/MemoryInfo.java b/inventory/v1/gen/java/opi_api/inventory/v1/MemoryInfo.java similarity index 100% rename from common/v1/gen/java/opi_api/inventory/v1/MemoryInfo.java rename to inventory/v1/gen/java/opi_api/inventory/v1/MemoryInfo.java diff --git a/common/v1/gen/java/opi_api/inventory/v1/MemoryInfoOrBuilder.java b/inventory/v1/gen/java/opi_api/inventory/v1/MemoryInfoOrBuilder.java similarity index 100% rename from common/v1/gen/java/opi_api/inventory/v1/MemoryInfoOrBuilder.java rename to inventory/v1/gen/java/opi_api/inventory/v1/MemoryInfoOrBuilder.java diff --git a/common/v1/gen/java/opi_api/inventory/v1/PCIeDeviceInfo.java b/inventory/v1/gen/java/opi_api/inventory/v1/PCIeDeviceInfo.java similarity index 100% rename from common/v1/gen/java/opi_api/inventory/v1/PCIeDeviceInfo.java rename to inventory/v1/gen/java/opi_api/inventory/v1/PCIeDeviceInfo.java diff --git a/common/v1/gen/java/opi_api/inventory/v1/PCIeDeviceInfoOrBuilder.java b/inventory/v1/gen/java/opi_api/inventory/v1/PCIeDeviceInfoOrBuilder.java similarity index 100% rename from common/v1/gen/java/opi_api/inventory/v1/PCIeDeviceInfoOrBuilder.java rename to inventory/v1/gen/java/opi_api/inventory/v1/PCIeDeviceInfoOrBuilder.java diff --git a/common/v1/gen/java/opi_api/inventory/v1/SystemInfo.java b/inventory/v1/gen/java/opi_api/inventory/v1/SystemInfo.java similarity index 100% rename from common/v1/gen/java/opi_api/inventory/v1/SystemInfo.java rename to inventory/v1/gen/java/opi_api/inventory/v1/SystemInfo.java diff --git a/common/v1/gen/java/opi_api/inventory/v1/SystemInfoOrBuilder.java b/inventory/v1/gen/java/opi_api/inventory/v1/SystemInfoOrBuilder.java similarity index 100% rename from common/v1/gen/java/opi_api/inventory/v1/SystemInfoOrBuilder.java rename to inventory/v1/gen/java/opi_api/inventory/v1/SystemInfoOrBuilder.java diff --git a/inventory/v1/gen/python/__init__.py b/inventory/v1/gen/python/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/common/v1/gen/python/inventory_pb2.py b/inventory/v1/gen/python/inventory_pb2.py similarity index 100% rename from common/v1/gen/python/inventory_pb2.py rename to inventory/v1/gen/python/inventory_pb2.py diff --git a/common/v1/gen/python/inventory_pb2_grpc.py b/inventory/v1/gen/python/inventory_pb2_grpc.py similarity index 100% rename from common/v1/gen/python/inventory_pb2_grpc.py rename to inventory/v1/gen/python/inventory_pb2_grpc.py diff --git a/common/v1/inventory.proto b/inventory/v1/inventory.proto similarity index 100% rename from common/v1/inventory.proto rename to inventory/v1/inventory.proto diff --git a/network/cloud/v1alpha1/autogen.md b/network/cloud/v1alpha1/autogen.md index 862e9c43..9ced25b5 100644 --- a/network/cloud/v1alpha1/autogen.md +++ b/network/cloud/v1alpha1/autogen.md @@ -314,19 +314,6 @@ - [VPCType](#opi_api-network-cloud-v1alpha1-VPCType) -- [inventory.proto](#inventory-proto) - - [BIOSInfo](#opi_api-inventory-v1-BIOSInfo) - - [BaseboardInfo](#opi_api-inventory-v1-BaseboardInfo) - - [CPUInfo](#opi_api-inventory-v1-CPUInfo) - - [ChassisInfo](#opi_api-inventory-v1-ChassisInfo) - - [GetInventoryRequest](#opi_api-inventory-v1-GetInventoryRequest) - - [Inventory](#opi_api-inventory-v1-Inventory) - - [MemoryInfo](#opi_api-inventory-v1-MemoryInfo) - - [PCIeDeviceInfo](#opi_api-inventory-v1-PCIeDeviceInfo) - - [SystemInfo](#opi_api-inventory-v1-SystemInfo) - - - [InventorySvc](#opi_api-inventory-v1-InventorySvc) - - [uuid.proto](#uuid-proto) - [Uuid](#opi_api-common-v1-Uuid) @@ -5423,218 +5410,6 @@ type of the virtual private cloud - -

Top

- -## inventory.proto - - - - - -### BIOSInfo -BIOS Information (Type 0) - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| vendor | [string](#string) | | String number of the BIOS Vendor’s Name. | -| version | [string](#string) | | String number of the BIOS Version. This value is a free-form string that may contain Core and OEM version information. | -| date | [string](#string) | | String number of the BIOS release date. The date string, if supplied, is in either mm/dd/yy or mm/dd/yyyy format. If the year portion of the string is two digits, the year is assumed to be 19yy. NOTE: In version 2.3 and later of SMBIOS the mm/dd/yyyy format is only used. | - - - - - - - - -### BaseboardInfo -Baseboard (or Module) Information (Type 2) - The information in this structure defines attributes of a system baseboard (for - example, a motherboard, planar, server blade, or other standard system module) - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| asset_tag | [string](#string) | | Number of a null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| version | [string](#string) | | Number of null-terminated string | -| product | [string](#string) | | Number of null-terminated string | - - - - - - - - -### CPUInfo -Processor Information (Type 4) - The information in this structure (see Table 21) defines the attributes of a single processor; a separate - structure instance is provided for each system processor socket/slot. For example, a system with an - IntelDX2™ processor would have a single structure instance while a system with an IntelSX2™ processor - would have a structure to describe the main CPU and a second structure to describe the 80487 co1054 processor. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| total_cores | [int32](#int32) | | Number of cores per processor socket See 7.5.6. If the value is unknown, the field is set to 0. For core counts of 256 or greater, the Core Count field is set to FFh and the Core Count 2 field is set to the number of cores. | -| total_threads | [int32](#int32) | | Number of threads per processor socket See 7.5.8. If the value is unknown, the field is set to 0. For thread counts of 256 or greater, the Thread Count field is set to FFh and the Thread Count 2 field is set to the number of threads. | - - - - - - - - -### ChassisInfo -System Enclosure or Chassis (Type 3) - The information in this structure (see Table 16) defines attributes of the system’s mechanical - enclosure(s). For example, if a system included a separate enclosure for its peripheral devices, two - structures would be returned: one for the main system enclosure and the second for the peripheral device - enclosure. The additions to this structure in version 2.1 of this specification support the population of the - CIM_Chassis class. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| asset_tag | [string](#string) | | Number of null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| type | [string](#string) | | Bit 7 Chassis lock is present if 1. Otherwise, either a lock is not present, or it is unknown if the enclosure has a lock. Bits 6:0 Enumeration value; see below. | -| type_description | [string](#string) | | Table 17 shows the byte values for the System Enclosure or Chassis Types field Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| version | [string](#string) | | Number of null-terminated string | - - - - - - - - -### GetInventoryRequest -Request for Retrieving Inventory data from a device - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| name | [string](#string) | | The name of the inventory to retrieve - blank for the full inventory | - - - - - - - - -### Inventory -Response for device inventory data - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| bios | [BIOSInfo](#opi_api-inventory-v1-BIOSInfo) | | BIOS Inventory | -| system | [SystemInfo](#opi_api-inventory-v1-SystemInfo) | | System Inventory | -| baseboard | [BaseboardInfo](#opi_api-inventory-v1-BaseboardInfo) | | Baseboard Inventory | -| chassis | [ChassisInfo](#opi_api-inventory-v1-ChassisInfo) | | Chassis Inventory | -| processor | [CPUInfo](#opi_api-inventory-v1-CPUInfo) | | CPU Inventory | -| memory | [MemoryInfo](#opi_api-inventory-v1-MemoryInfo) | | Memory Inventory | -| pci | [PCIeDeviceInfo](#opi_api-inventory-v1-PCIeDeviceInfo) | repeated | PCI Devices Inventory | - - - - - - - - -### MemoryInfo -Physical Memory Array (Type 16) - This structure describes a collection of memory devices that operate together to form a memory address - space. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| total_physical_bytes | [int64](#int64) | | Maximum memory capacity, in kilobytes, for this array If the capacity is not represented in this field, then this field contains 8000 0000h and the Extended Maximum Capacity field should be used. Values 2 TB (8000 0000h) or greater must be represented in the Extended Maximum Capacity field. | -| total_usable_bytes | [int64](#int64) | | TBD | - - - - - - - - -### PCIeDeviceInfo -PCI device information - TBD: Type 9 or Type 41 ? - This structure describes a collection of PCI devices. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| driver | [string](#string) | | Driver assiociated with the device | -| address | [string](#string) | | BDF address in a string format, for example "0000:00:17.7" | -| vendor | [string](#string) | | string vendor info | -| product | [string](#string) | | string product info | -| revision | [string](#string) | | string revision info | -| subsystem | [string](#string) | | string subsystem info | -| class | [string](#string) | | string class info | -| subclass | [string](#string) | | string subclass info | - - - - - - - - -### SystemInfo -System Information (Type 1) - The information in this structure defines attributes of the overall system and is intended to be associated - with the Component ID group of the system’s MIF. An SMBIOS implementation is associated with a single - system instance and contains one and only one System Information (Type 1) structure. Table 10 shows - the contents of this structure. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| family | [string](#string) | | Number of null-terminated string This text string identifies the family to which a particular computer belongs. A family refers to a set of computers that are similar but not identical from a hardware or software point of view. Typically, a family is composed of different computer models, which have different configurations and pricing points. Computers in the same family often have similar branding and cosmetic features. | -| name | [string](#string) | | Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| uuid | [string](#string) | | A UUID is an identifier that is designed to be unique across both time and space. It requires no central registration process. The UUID is 128 bits long. Its format is described in RFC4122, but the actual field contents are opaque and not significant to the SMBIOS specification, which is only concerned with the byte order. Table 11 shows the field names; these field names, particularly for multiplexed fields, follow historical practice. | -| sku | [string](#string) | | Number of null-terminated string This text string identifies a particular computer configuration for sale. It is sometimes also called a product ID or purchase order number. This number is frequently found in existing fields, but there is no standard format. Typically for a given system board from a given OEM, there are tens of unique processor, memory, hard drive, and optical drive configurations. | -| version | [string](#string) | | Number of null-terminated string | - - - - - - - - - - - - - - -### InventorySvc -Service functions for the device inventory data - -| Method Name | Request Type | Response Type | Description | -| ----------- | ------------ | ------------- | ------------| -| GetInventory | [GetInventoryRequest](#opi_api-inventory-v1-GetInventoryRequest) | [Inventory](#opi_api-inventory-v1-Inventory) | retrieves the inventory data for the device | - - - - -

Top

diff --git a/network/evpn-gw/v1alpha1/autogen.md b/network/evpn-gw/v1alpha1/autogen.md index 4e71b36f..988b9097 100644 --- a/network/evpn-gw/v1alpha1/autogen.md +++ b/network/evpn-gw/v1alpha1/autogen.md @@ -56,19 +56,6 @@ - [SviService](#opi_api-network-evpn_gw-v1alpha1-SviService) - [VrfService](#opi_api-network-evpn_gw-v1alpha1-VrfService) -- [inventory.proto](#inventory-proto) - - [BIOSInfo](#opi_api-inventory-v1-BIOSInfo) - - [BaseboardInfo](#opi_api-inventory-v1-BaseboardInfo) - - [CPUInfo](#opi_api-inventory-v1-CPUInfo) - - [ChassisInfo](#opi_api-inventory-v1-ChassisInfo) - - [GetInventoryRequest](#opi_api-inventory-v1-GetInventoryRequest) - - [Inventory](#opi_api-inventory-v1-Inventory) - - [MemoryInfo](#opi_api-inventory-v1-MemoryInfo) - - [PCIeDeviceInfo](#opi_api-inventory-v1-PCIeDeviceInfo) - - [SystemInfo](#opi_api-inventory-v1-SystemInfo) - - - [InventorySvc](#opi_api-inventory-v1-InventorySvc) - - [uuid.proto](#uuid-proto) - [Uuid](#opi_api-common-v1-Uuid) @@ -827,218 +814,6 @@ Management of Vrf Resources - -

Top

- -## inventory.proto - - - - - -### BIOSInfo -BIOS Information (Type 0) - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| vendor | [string](#string) | | String number of the BIOS Vendor’s Name. | -| version | [string](#string) | | String number of the BIOS Version. This value is a free-form string that may contain Core and OEM version information. | -| date | [string](#string) | | String number of the BIOS release date. The date string, if supplied, is in either mm/dd/yy or mm/dd/yyyy format. If the year portion of the string is two digits, the year is assumed to be 19yy. NOTE: In version 2.3 and later of SMBIOS the mm/dd/yyyy format is only used. | - - - - - - - - -### BaseboardInfo -Baseboard (or Module) Information (Type 2) - The information in this structure defines attributes of a system baseboard (for - example, a motherboard, planar, server blade, or other standard system module) - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| asset_tag | [string](#string) | | Number of a null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| version | [string](#string) | | Number of null-terminated string | -| product | [string](#string) | | Number of null-terminated string | - - - - - - - - -### CPUInfo -Processor Information (Type 4) - The information in this structure (see Table 21) defines the attributes of a single processor; a separate - structure instance is provided for each system processor socket/slot. For example, a system with an - IntelDX2™ processor would have a single structure instance while a system with an IntelSX2™ processor - would have a structure to describe the main CPU and a second structure to describe the 80487 co1054 processor. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| total_cores | [int32](#int32) | | Number of cores per processor socket See 7.5.6. If the value is unknown, the field is set to 0. For core counts of 256 or greater, the Core Count field is set to FFh and the Core Count 2 field is set to the number of cores. | -| total_threads | [int32](#int32) | | Number of threads per processor socket See 7.5.8. If the value is unknown, the field is set to 0. For thread counts of 256 or greater, the Thread Count field is set to FFh and the Thread Count 2 field is set to the number of threads. | - - - - - - - - -### ChassisInfo -System Enclosure or Chassis (Type 3) - The information in this structure (see Table 16) defines attributes of the system’s mechanical - enclosure(s). For example, if a system included a separate enclosure for its peripheral devices, two - structures would be returned: one for the main system enclosure and the second for the peripheral device - enclosure. The additions to this structure in version 2.1 of this specification support the population of the - CIM_Chassis class. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| asset_tag | [string](#string) | | Number of null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| type | [string](#string) | | Bit 7 Chassis lock is present if 1. Otherwise, either a lock is not present, or it is unknown if the enclosure has a lock. Bits 6:0 Enumeration value; see below. | -| type_description | [string](#string) | | Table 17 shows the byte values for the System Enclosure or Chassis Types field Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| version | [string](#string) | | Number of null-terminated string | - - - - - - - - -### GetInventoryRequest -Request for Retrieving Inventory data from a device - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| name | [string](#string) | | The name of the inventory to retrieve - blank for the full inventory | - - - - - - - - -### Inventory -Response for device inventory data - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| bios | [BIOSInfo](#opi_api-inventory-v1-BIOSInfo) | | BIOS Inventory | -| system | [SystemInfo](#opi_api-inventory-v1-SystemInfo) | | System Inventory | -| baseboard | [BaseboardInfo](#opi_api-inventory-v1-BaseboardInfo) | | Baseboard Inventory | -| chassis | [ChassisInfo](#opi_api-inventory-v1-ChassisInfo) | | Chassis Inventory | -| processor | [CPUInfo](#opi_api-inventory-v1-CPUInfo) | | CPU Inventory | -| memory | [MemoryInfo](#opi_api-inventory-v1-MemoryInfo) | | Memory Inventory | -| pci | [PCIeDeviceInfo](#opi_api-inventory-v1-PCIeDeviceInfo) | repeated | PCI Devices Inventory | - - - - - - - - -### MemoryInfo -Physical Memory Array (Type 16) - This structure describes a collection of memory devices that operate together to form a memory address - space. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| total_physical_bytes | [int64](#int64) | | Maximum memory capacity, in kilobytes, for this array If the capacity is not represented in this field, then this field contains 8000 0000h and the Extended Maximum Capacity field should be used. Values 2 TB (8000 0000h) or greater must be represented in the Extended Maximum Capacity field. | -| total_usable_bytes | [int64](#int64) | | TBD | - - - - - - - - -### PCIeDeviceInfo -PCI device information - TBD: Type 9 or Type 41 ? - This structure describes a collection of PCI devices. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| driver | [string](#string) | | Driver assiociated with the device | -| address | [string](#string) | | BDF address in a string format, for example "0000:00:17.7" | -| vendor | [string](#string) | | string vendor info | -| product | [string](#string) | | string product info | -| revision | [string](#string) | | string revision info | -| subsystem | [string](#string) | | string subsystem info | -| class | [string](#string) | | string class info | -| subclass | [string](#string) | | string subclass info | - - - - - - - - -### SystemInfo -System Information (Type 1) - The information in this structure defines attributes of the overall system and is intended to be associated - with the Component ID group of the system’s MIF. An SMBIOS implementation is associated with a single - system instance and contains one and only one System Information (Type 1) structure. Table 10 shows - the contents of this structure. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| family | [string](#string) | | Number of null-terminated string This text string identifies the family to which a particular computer belongs. A family refers to a set of computers that are similar but not identical from a hardware or software point of view. Typically, a family is composed of different computer models, which have different configurations and pricing points. Computers in the same family often have similar branding and cosmetic features. | -| name | [string](#string) | | Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| uuid | [string](#string) | | A UUID is an identifier that is designed to be unique across both time and space. It requires no central registration process. The UUID is 128 bits long. Its format is described in RFC4122, but the actual field contents are opaque and not significant to the SMBIOS specification, which is only concerned with the byte order. Table 11 shows the field names; these field names, particularly for multiplexed fields, follow historical practice. | -| sku | [string](#string) | | Number of null-terminated string This text string identifies a particular computer configuration for sale. It is sometimes also called a product ID or purchase order number. This number is frequently found in existing fields, but there is no standard format. Typically for a given system board from a given OEM, there are tens of unique processor, memory, hard drive, and optical drive configurations. | -| version | [string](#string) | | Number of null-terminated string | - - - - - - - - - - - - - - -### InventorySvc -Service functions for the device inventory data - -| Method Name | Request Type | Response Type | Description | -| ----------- | ------------ | ------------- | ------------| -| GetInventory | [GetInventoryRequest](#opi_api-inventory-v1-GetInventoryRequest) | [Inventory](#opi_api-inventory-v1-Inventory) | retrieves the inventory data for the device | - - - - -

Top

diff --git a/network/k8s/v1alpha1/autogen.md b/network/k8s/v1alpha1/autogen.md index 258b6857..fe7c8257 100644 --- a/network/k8s/v1alpha1/autogen.md +++ b/network/k8s/v1alpha1/autogen.md @@ -4,19 +4,6 @@ ## Table of Contents - [ip.proto](#ip-proto) -- [inventory.proto](#inventory-proto) - - [BIOSInfo](#opi_api-inventory-v1-BIOSInfo) - - [BaseboardInfo](#opi_api-inventory-v1-BaseboardInfo) - - [CPUInfo](#opi_api-inventory-v1-CPUInfo) - - [ChassisInfo](#opi_api-inventory-v1-ChassisInfo) - - [GetInventoryRequest](#opi_api-inventory-v1-GetInventoryRequest) - - [Inventory](#opi_api-inventory-v1-Inventory) - - [MemoryInfo](#opi_api-inventory-v1-MemoryInfo) - - [PCIeDeviceInfo](#opi_api-inventory-v1-PCIeDeviceInfo) - - [SystemInfo](#opi_api-inventory-v1-SystemInfo) - - - [InventorySvc](#opi_api-inventory-v1-InventorySvc) - - [uuid.proto](#uuid-proto) - [Uuid](#opi_api-common-v1-Uuid) @@ -40,218 +27,6 @@ - -

Top

- -## inventory.proto - - - - - -### BIOSInfo -BIOS Information (Type 0) - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| vendor | [string](#string) | | String number of the BIOS Vendor’s Name. | -| version | [string](#string) | | String number of the BIOS Version. This value is a free-form string that may contain Core and OEM version information. | -| date | [string](#string) | | String number of the BIOS release date. The date string, if supplied, is in either mm/dd/yy or mm/dd/yyyy format. If the year portion of the string is two digits, the year is assumed to be 19yy. NOTE: In version 2.3 and later of SMBIOS the mm/dd/yyyy format is only used. | - - - - - - - - -### BaseboardInfo -Baseboard (or Module) Information (Type 2) - The information in this structure defines attributes of a system baseboard (for - example, a motherboard, planar, server blade, or other standard system module) - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| asset_tag | [string](#string) | | Number of a null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| version | [string](#string) | | Number of null-terminated string | -| product | [string](#string) | | Number of null-terminated string | - - - - - - - - -### CPUInfo -Processor Information (Type 4) - The information in this structure (see Table 21) defines the attributes of a single processor; a separate - structure instance is provided for each system processor socket/slot. For example, a system with an - IntelDX2™ processor would have a single structure instance while a system with an IntelSX2™ processor - would have a structure to describe the main CPU and a second structure to describe the 80487 co1054 processor. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| total_cores | [int32](#int32) | | Number of cores per processor socket See 7.5.6. If the value is unknown, the field is set to 0. For core counts of 256 or greater, the Core Count field is set to FFh and the Core Count 2 field is set to the number of cores. | -| total_threads | [int32](#int32) | | Number of threads per processor socket See 7.5.8. If the value is unknown, the field is set to 0. For thread counts of 256 or greater, the Thread Count field is set to FFh and the Thread Count 2 field is set to the number of threads. | - - - - - - - - -### ChassisInfo -System Enclosure or Chassis (Type 3) - The information in this structure (see Table 16) defines attributes of the system’s mechanical - enclosure(s). For example, if a system included a separate enclosure for its peripheral devices, two - structures would be returned: one for the main system enclosure and the second for the peripheral device - enclosure. The additions to this structure in version 2.1 of this specification support the population of the - CIM_Chassis class. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| asset_tag | [string](#string) | | Number of null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| type | [string](#string) | | Bit 7 Chassis lock is present if 1. Otherwise, either a lock is not present, or it is unknown if the enclosure has a lock. Bits 6:0 Enumeration value; see below. | -| type_description | [string](#string) | | Table 17 shows the byte values for the System Enclosure or Chassis Types field Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| version | [string](#string) | | Number of null-terminated string | - - - - - - - - -### GetInventoryRequest -Request for Retrieving Inventory data from a device - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| name | [string](#string) | | The name of the inventory to retrieve - blank for the full inventory | - - - - - - - - -### Inventory -Response for device inventory data - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| bios | [BIOSInfo](#opi_api-inventory-v1-BIOSInfo) | | BIOS Inventory | -| system | [SystemInfo](#opi_api-inventory-v1-SystemInfo) | | System Inventory | -| baseboard | [BaseboardInfo](#opi_api-inventory-v1-BaseboardInfo) | | Baseboard Inventory | -| chassis | [ChassisInfo](#opi_api-inventory-v1-ChassisInfo) | | Chassis Inventory | -| processor | [CPUInfo](#opi_api-inventory-v1-CPUInfo) | | CPU Inventory | -| memory | [MemoryInfo](#opi_api-inventory-v1-MemoryInfo) | | Memory Inventory | -| pci | [PCIeDeviceInfo](#opi_api-inventory-v1-PCIeDeviceInfo) | repeated | PCI Devices Inventory | - - - - - - - - -### MemoryInfo -Physical Memory Array (Type 16) - This structure describes a collection of memory devices that operate together to form a memory address - space. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| total_physical_bytes | [int64](#int64) | | Maximum memory capacity, in kilobytes, for this array If the capacity is not represented in this field, then this field contains 8000 0000h and the Extended Maximum Capacity field should be used. Values 2 TB (8000 0000h) or greater must be represented in the Extended Maximum Capacity field. | -| total_usable_bytes | [int64](#int64) | | TBD | - - - - - - - - -### PCIeDeviceInfo -PCI device information - TBD: Type 9 or Type 41 ? - This structure describes a collection of PCI devices. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| driver | [string](#string) | | Driver assiociated with the device | -| address | [string](#string) | | BDF address in a string format, for example "0000:00:17.7" | -| vendor | [string](#string) | | string vendor info | -| product | [string](#string) | | string product info | -| revision | [string](#string) | | string revision info | -| subsystem | [string](#string) | | string subsystem info | -| class | [string](#string) | | string class info | -| subclass | [string](#string) | | string subclass info | - - - - - - - - -### SystemInfo -System Information (Type 1) - The information in this structure defines attributes of the overall system and is intended to be associated - with the Component ID group of the system’s MIF. An SMBIOS implementation is associated with a single - system instance and contains one and only one System Information (Type 1) structure. Table 10 shows - the contents of this structure. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| family | [string](#string) | | Number of null-terminated string This text string identifies the family to which a particular computer belongs. A family refers to a set of computers that are similar but not identical from a hardware or software point of view. Typically, a family is composed of different computer models, which have different configurations and pricing points. Computers in the same family often have similar branding and cosmetic features. | -| name | [string](#string) | | Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| uuid | [string](#string) | | A UUID is an identifier that is designed to be unique across both time and space. It requires no central registration process. The UUID is 128 bits long. Its format is described in RFC4122, but the actual field contents are opaque and not significant to the SMBIOS specification, which is only concerned with the byte order. Table 11 shows the field names; these field names, particularly for multiplexed fields, follow historical practice. | -| sku | [string](#string) | | Number of null-terminated string This text string identifies a particular computer configuration for sale. It is sometimes also called a product ID or purchase order number. This number is frequently found in existing fields, but there is no standard format. Typically for a given system board from a given OEM, there are tens of unique processor, memory, hard drive, and optical drive configurations. | -| version | [string](#string) | | Number of null-terminated string | - - - - - - - - - - - - - - -### InventorySvc -Service functions for the device inventory data - -| Method Name | Request Type | Response Type | Description | -| ----------- | ------------ | ------------- | ------------| -| GetInventory | [GetInventoryRequest](#opi_api-inventory-v1-GetInventoryRequest) | [Inventory](#opi_api-inventory-v1-Inventory) | retrieves the inventory data for the device | - - - - -

Top

diff --git a/network/opinetcommon/v1alpha1/autogen.md b/network/opinetcommon/v1alpha1/autogen.md index ae29e18c..7cb638c5 100644 --- a/network/opinetcommon/v1alpha1/autogen.md +++ b/network/opinetcommon/v1alpha1/autogen.md @@ -54,19 +54,6 @@ - [NetInterfaceService](#opi_api-network-v1alpha1-NetInterfaceService) -- [inventory.proto](#inventory-proto) - - [BIOSInfo](#opi_api-inventory-v1-BIOSInfo) - - [BaseboardInfo](#opi_api-inventory-v1-BaseboardInfo) - - [CPUInfo](#opi_api-inventory-v1-CPUInfo) - - [ChassisInfo](#opi_api-inventory-v1-ChassisInfo) - - [GetInventoryRequest](#opi_api-inventory-v1-GetInventoryRequest) - - [Inventory](#opi_api-inventory-v1-Inventory) - - [MemoryInfo](#opi_api-inventory-v1-MemoryInfo) - - [PCIeDeviceInfo](#opi_api-inventory-v1-PCIeDeviceInfo) - - [SystemInfo](#opi_api-inventory-v1-SystemInfo) - - - [InventorySvc](#opi_api-inventory-v1-InventorySvc) - - [uuid.proto](#uuid-proto) - [Uuid](#opi_api-common-v1-Uuid) @@ -848,218 +835,6 @@ Service functions for Network Interface exported by the server - -

Top

- -## inventory.proto - - - - - -### BIOSInfo -BIOS Information (Type 0) - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| vendor | [string](#string) | | String number of the BIOS Vendor’s Name. | -| version | [string](#string) | | String number of the BIOS Version. This value is a free-form string that may contain Core and OEM version information. | -| date | [string](#string) | | String number of the BIOS release date. The date string, if supplied, is in either mm/dd/yy or mm/dd/yyyy format. If the year portion of the string is two digits, the year is assumed to be 19yy. NOTE: In version 2.3 and later of SMBIOS the mm/dd/yyyy format is only used. | - - - - - - - - -### BaseboardInfo -Baseboard (or Module) Information (Type 2) - The information in this structure defines attributes of a system baseboard (for - example, a motherboard, planar, server blade, or other standard system module) - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| asset_tag | [string](#string) | | Number of a null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| version | [string](#string) | | Number of null-terminated string | -| product | [string](#string) | | Number of null-terminated string | - - - - - - - - -### CPUInfo -Processor Information (Type 4) - The information in this structure (see Table 21) defines the attributes of a single processor; a separate - structure instance is provided for each system processor socket/slot. For example, a system with an - IntelDX2™ processor would have a single structure instance while a system with an IntelSX2™ processor - would have a structure to describe the main CPU and a second structure to describe the 80487 co1054 processor. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| total_cores | [int32](#int32) | | Number of cores per processor socket See 7.5.6. If the value is unknown, the field is set to 0. For core counts of 256 or greater, the Core Count field is set to FFh and the Core Count 2 field is set to the number of cores. | -| total_threads | [int32](#int32) | | Number of threads per processor socket See 7.5.8. If the value is unknown, the field is set to 0. For thread counts of 256 or greater, the Thread Count field is set to FFh and the Thread Count 2 field is set to the number of threads. | - - - - - - - - -### ChassisInfo -System Enclosure or Chassis (Type 3) - The information in this structure (see Table 16) defines attributes of the system’s mechanical - enclosure(s). For example, if a system included a separate enclosure for its peripheral devices, two - structures would be returned: one for the main system enclosure and the second for the peripheral device - enclosure. The additions to this structure in version 2.1 of this specification support the population of the - CIM_Chassis class. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| asset_tag | [string](#string) | | Number of null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| type | [string](#string) | | Bit 7 Chassis lock is present if 1. Otherwise, either a lock is not present, or it is unknown if the enclosure has a lock. Bits 6:0 Enumeration value; see below. | -| type_description | [string](#string) | | Table 17 shows the byte values for the System Enclosure or Chassis Types field Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| version | [string](#string) | | Number of null-terminated string | - - - - - - - - -### GetInventoryRequest -Request for Retrieving Inventory data from a device - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| name | [string](#string) | | The name of the inventory to retrieve - blank for the full inventory | - - - - - - - - -### Inventory -Response for device inventory data - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| bios | [BIOSInfo](#opi_api-inventory-v1-BIOSInfo) | | BIOS Inventory | -| system | [SystemInfo](#opi_api-inventory-v1-SystemInfo) | | System Inventory | -| baseboard | [BaseboardInfo](#opi_api-inventory-v1-BaseboardInfo) | | Baseboard Inventory | -| chassis | [ChassisInfo](#opi_api-inventory-v1-ChassisInfo) | | Chassis Inventory | -| processor | [CPUInfo](#opi_api-inventory-v1-CPUInfo) | | CPU Inventory | -| memory | [MemoryInfo](#opi_api-inventory-v1-MemoryInfo) | | Memory Inventory | -| pci | [PCIeDeviceInfo](#opi_api-inventory-v1-PCIeDeviceInfo) | repeated | PCI Devices Inventory | - - - - - - - - -### MemoryInfo -Physical Memory Array (Type 16) - This structure describes a collection of memory devices that operate together to form a memory address - space. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| total_physical_bytes | [int64](#int64) | | Maximum memory capacity, in kilobytes, for this array If the capacity is not represented in this field, then this field contains 8000 0000h and the Extended Maximum Capacity field should be used. Values 2 TB (8000 0000h) or greater must be represented in the Extended Maximum Capacity field. | -| total_usable_bytes | [int64](#int64) | | TBD | - - - - - - - - -### PCIeDeviceInfo -PCI device information - TBD: Type 9 or Type 41 ? - This structure describes a collection of PCI devices. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| driver | [string](#string) | | Driver assiociated with the device | -| address | [string](#string) | | BDF address in a string format, for example "0000:00:17.7" | -| vendor | [string](#string) | | string vendor info | -| product | [string](#string) | | string product info | -| revision | [string](#string) | | string revision info | -| subsystem | [string](#string) | | string subsystem info | -| class | [string](#string) | | string class info | -| subclass | [string](#string) | | string subclass info | - - - - - - - - -### SystemInfo -System Information (Type 1) - The information in this structure defines attributes of the overall system and is intended to be associated - with the Component ID group of the system’s MIF. An SMBIOS implementation is associated with a single - system instance and contains one and only one System Information (Type 1) structure. Table 10 shows - the contents of this structure. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| family | [string](#string) | | Number of null-terminated string This text string identifies the family to which a particular computer belongs. A family refers to a set of computers that are similar but not identical from a hardware or software point of view. Typically, a family is composed of different computer models, which have different configurations and pricing points. Computers in the same family often have similar branding and cosmetic features. | -| name | [string](#string) | | Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| uuid | [string](#string) | | A UUID is an identifier that is designed to be unique across both time and space. It requires no central registration process. The UUID is 128 bits long. Its format is described in RFC4122, but the actual field contents are opaque and not significant to the SMBIOS specification, which is only concerned with the byte order. Table 11 shows the field names; these field names, particularly for multiplexed fields, follow historical practice. | -| sku | [string](#string) | | Number of null-terminated string This text string identifies a particular computer configuration for sale. It is sometimes also called a product ID or purchase order number. This number is frequently found in existing fields, but there is no standard format. Typically for a given system board from a given OEM, there are tens of unique processor, memory, hard drive, and optical drive configurations. | -| version | [string](#string) | | Number of null-terminated string | - - - - - - - - - - - - - - -### InventorySvc -Service functions for the device inventory data - -| Method Name | Request Type | Response Type | Description | -| ----------- | ------------ | ------------- | ------------| -| GetInventory | [GetInventoryRequest](#opi_api-inventory-v1-GetInventoryRequest) | [Inventory](#opi_api-inventory-v1-Inventory) | retrieves the inventory data for the device | - - - - -

Top

diff --git a/network/telco/v1alpha1/autogen.md b/network/telco/v1alpha1/autogen.md index 258b6857..fe7c8257 100644 --- a/network/telco/v1alpha1/autogen.md +++ b/network/telco/v1alpha1/autogen.md @@ -4,19 +4,6 @@ ## Table of Contents - [ip.proto](#ip-proto) -- [inventory.proto](#inventory-proto) - - [BIOSInfo](#opi_api-inventory-v1-BIOSInfo) - - [BaseboardInfo](#opi_api-inventory-v1-BaseboardInfo) - - [CPUInfo](#opi_api-inventory-v1-CPUInfo) - - [ChassisInfo](#opi_api-inventory-v1-ChassisInfo) - - [GetInventoryRequest](#opi_api-inventory-v1-GetInventoryRequest) - - [Inventory](#opi_api-inventory-v1-Inventory) - - [MemoryInfo](#opi_api-inventory-v1-MemoryInfo) - - [PCIeDeviceInfo](#opi_api-inventory-v1-PCIeDeviceInfo) - - [SystemInfo](#opi_api-inventory-v1-SystemInfo) - - - [InventorySvc](#opi_api-inventory-v1-InventorySvc) - - [uuid.proto](#uuid-proto) - [Uuid](#opi_api-common-v1-Uuid) @@ -40,218 +27,6 @@ - -

Top

- -## inventory.proto - - - - - -### BIOSInfo -BIOS Information (Type 0) - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| vendor | [string](#string) | | String number of the BIOS Vendor’s Name. | -| version | [string](#string) | | String number of the BIOS Version. This value is a free-form string that may contain Core and OEM version information. | -| date | [string](#string) | | String number of the BIOS release date. The date string, if supplied, is in either mm/dd/yy or mm/dd/yyyy format. If the year portion of the string is two digits, the year is assumed to be 19yy. NOTE: In version 2.3 and later of SMBIOS the mm/dd/yyyy format is only used. | - - - - - - - - -### BaseboardInfo -Baseboard (or Module) Information (Type 2) - The information in this structure defines attributes of a system baseboard (for - example, a motherboard, planar, server blade, or other standard system module) - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| asset_tag | [string](#string) | | Number of a null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| version | [string](#string) | | Number of null-terminated string | -| product | [string](#string) | | Number of null-terminated string | - - - - - - - - -### CPUInfo -Processor Information (Type 4) - The information in this structure (see Table 21) defines the attributes of a single processor; a separate - structure instance is provided for each system processor socket/slot. For example, a system with an - IntelDX2™ processor would have a single structure instance while a system with an IntelSX2™ processor - would have a structure to describe the main CPU and a second structure to describe the 80487 co1054 processor. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| total_cores | [int32](#int32) | | Number of cores per processor socket See 7.5.6. If the value is unknown, the field is set to 0. For core counts of 256 or greater, the Core Count field is set to FFh and the Core Count 2 field is set to the number of cores. | -| total_threads | [int32](#int32) | | Number of threads per processor socket See 7.5.8. If the value is unknown, the field is set to 0. For thread counts of 256 or greater, the Thread Count field is set to FFh and the Thread Count 2 field is set to the number of threads. | - - - - - - - - -### ChassisInfo -System Enclosure or Chassis (Type 3) - The information in this structure (see Table 16) defines attributes of the system’s mechanical - enclosure(s). For example, if a system included a separate enclosure for its peripheral devices, two - structures would be returned: one for the main system enclosure and the second for the peripheral device - enclosure. The additions to this structure in version 2.1 of this specification support the population of the - CIM_Chassis class. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| asset_tag | [string](#string) | | Number of null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| type | [string](#string) | | Bit 7 Chassis lock is present if 1. Otherwise, either a lock is not present, or it is unknown if the enclosure has a lock. Bits 6:0 Enumeration value; see below. | -| type_description | [string](#string) | | Table 17 shows the byte values for the System Enclosure or Chassis Types field Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| version | [string](#string) | | Number of null-terminated string | - - - - - - - - -### GetInventoryRequest -Request for Retrieving Inventory data from a device - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| name | [string](#string) | | The name of the inventory to retrieve - blank for the full inventory | - - - - - - - - -### Inventory -Response for device inventory data - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| bios | [BIOSInfo](#opi_api-inventory-v1-BIOSInfo) | | BIOS Inventory | -| system | [SystemInfo](#opi_api-inventory-v1-SystemInfo) | | System Inventory | -| baseboard | [BaseboardInfo](#opi_api-inventory-v1-BaseboardInfo) | | Baseboard Inventory | -| chassis | [ChassisInfo](#opi_api-inventory-v1-ChassisInfo) | | Chassis Inventory | -| processor | [CPUInfo](#opi_api-inventory-v1-CPUInfo) | | CPU Inventory | -| memory | [MemoryInfo](#opi_api-inventory-v1-MemoryInfo) | | Memory Inventory | -| pci | [PCIeDeviceInfo](#opi_api-inventory-v1-PCIeDeviceInfo) | repeated | PCI Devices Inventory | - - - - - - - - -### MemoryInfo -Physical Memory Array (Type 16) - This structure describes a collection of memory devices that operate together to form a memory address - space. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| total_physical_bytes | [int64](#int64) | | Maximum memory capacity, in kilobytes, for this array If the capacity is not represented in this field, then this field contains 8000 0000h and the Extended Maximum Capacity field should be used. Values 2 TB (8000 0000h) or greater must be represented in the Extended Maximum Capacity field. | -| total_usable_bytes | [int64](#int64) | | TBD | - - - - - - - - -### PCIeDeviceInfo -PCI device information - TBD: Type 9 or Type 41 ? - This structure describes a collection of PCI devices. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| driver | [string](#string) | | Driver assiociated with the device | -| address | [string](#string) | | BDF address in a string format, for example "0000:00:17.7" | -| vendor | [string](#string) | | string vendor info | -| product | [string](#string) | | string product info | -| revision | [string](#string) | | string revision info | -| subsystem | [string](#string) | | string subsystem info | -| class | [string](#string) | | string class info | -| subclass | [string](#string) | | string subclass info | - - - - - - - - -### SystemInfo -System Information (Type 1) - The information in this structure defines attributes of the overall system and is intended to be associated - with the Component ID group of the system’s MIF. An SMBIOS implementation is associated with a single - system instance and contains one and only one System Information (Type 1) structure. Table 10 shows - the contents of this structure. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| family | [string](#string) | | Number of null-terminated string This text string identifies the family to which a particular computer belongs. A family refers to a set of computers that are similar but not identical from a hardware or software point of view. Typically, a family is composed of different computer models, which have different configurations and pricing points. Computers in the same family often have similar branding and cosmetic features. | -| name | [string](#string) | | Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| uuid | [string](#string) | | A UUID is an identifier that is designed to be unique across both time and space. It requires no central registration process. The UUID is 128 bits long. Its format is described in RFC4122, but the actual field contents are opaque and not significant to the SMBIOS specification, which is only concerned with the byte order. Table 11 shows the field names; these field names, particularly for multiplexed fields, follow historical practice. | -| sku | [string](#string) | | Number of null-terminated string This text string identifies a particular computer configuration for sale. It is sometimes also called a product ID or purchase order number. This number is frequently found in existing fields, but there is no standard format. Typically for a given system board from a given OEM, there are tens of unique processor, memory, hard drive, and optical drive configurations. | -| version | [string](#string) | | Number of null-terminated string | - - - - - - - - - - - - - - -### InventorySvc -Service functions for the device inventory data - -| Method Name | Request Type | Response Type | Description | -| ----------- | ------------ | ------------- | ------------| -| GetInventory | [GetInventoryRequest](#opi_api-inventory-v1-GetInventoryRequest) | [Inventory](#opi_api-inventory-v1-Inventory) | retrieves the inventory data for the device | - - - - -

Top

diff --git a/security/v1/autogen.md b/security/v1/autogen.md index 277a8dea..b6ab3606 100644 --- a/security/v1/autogen.md +++ b/security/v1/autogen.md @@ -59,19 +59,6 @@ - [IPsec](#opi_api-security-v1-IPsec) -- [inventory.proto](#inventory-proto) - - [BIOSInfo](#opi_api-inventory-v1-BIOSInfo) - - [BaseboardInfo](#opi_api-inventory-v1-BaseboardInfo) - - [CPUInfo](#opi_api-inventory-v1-CPUInfo) - - [ChassisInfo](#opi_api-inventory-v1-ChassisInfo) - - [GetInventoryRequest](#opi_api-inventory-v1-GetInventoryRequest) - - [Inventory](#opi_api-inventory-v1-Inventory) - - [MemoryInfo](#opi_api-inventory-v1-MemoryInfo) - - [PCIeDeviceInfo](#opi_api-inventory-v1-PCIeDeviceInfo) - - [SystemInfo](#opi_api-inventory-v1-SystemInfo) - - - [InventorySvc](#opi_api-inventory-v1-InventorySvc) - - [uuid.proto](#uuid-proto) - [Uuid](#opi_api-common-v1-Uuid) @@ -1064,218 +1051,6 @@ X.509 certificate flag - -

Top

- -## inventory.proto - - - - - -### BIOSInfo -BIOS Information (Type 0) - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| vendor | [string](#string) | | String number of the BIOS Vendor’s Name. | -| version | [string](#string) | | String number of the BIOS Version. This value is a free-form string that may contain Core and OEM version information. | -| date | [string](#string) | | String number of the BIOS release date. The date string, if supplied, is in either mm/dd/yy or mm/dd/yyyy format. If the year portion of the string is two digits, the year is assumed to be 19yy. NOTE: In version 2.3 and later of SMBIOS the mm/dd/yyyy format is only used. | - - - - - - - - -### BaseboardInfo -Baseboard (or Module) Information (Type 2) - The information in this structure defines attributes of a system baseboard (for - example, a motherboard, planar, server blade, or other standard system module) - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| asset_tag | [string](#string) | | Number of a null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| version | [string](#string) | | Number of null-terminated string | -| product | [string](#string) | | Number of null-terminated string | - - - - - - - - -### CPUInfo -Processor Information (Type 4) - The information in this structure (see Table 21) defines the attributes of a single processor; a separate - structure instance is provided for each system processor socket/slot. For example, a system with an - IntelDX2™ processor would have a single structure instance while a system with an IntelSX2™ processor - would have a structure to describe the main CPU and a second structure to describe the 80487 co1054 processor. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| total_cores | [int32](#int32) | | Number of cores per processor socket See 7.5.6. If the value is unknown, the field is set to 0. For core counts of 256 or greater, the Core Count field is set to FFh and the Core Count 2 field is set to the number of cores. | -| total_threads | [int32](#int32) | | Number of threads per processor socket See 7.5.8. If the value is unknown, the field is set to 0. For thread counts of 256 or greater, the Thread Count field is set to FFh and the Thread Count 2 field is set to the number of threads. | - - - - - - - - -### ChassisInfo -System Enclosure or Chassis (Type 3) - The information in this structure (see Table 16) defines attributes of the system’s mechanical - enclosure(s). For example, if a system included a separate enclosure for its peripheral devices, two - structures would be returned: one for the main system enclosure and the second for the peripheral device - enclosure. The additions to this structure in version 2.1 of this specification support the population of the - CIM_Chassis class. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| asset_tag | [string](#string) | | Number of null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| type | [string](#string) | | Bit 7 Chassis lock is present if 1. Otherwise, either a lock is not present, or it is unknown if the enclosure has a lock. Bits 6:0 Enumeration value; see below. | -| type_description | [string](#string) | | Table 17 shows the byte values for the System Enclosure or Chassis Types field Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| version | [string](#string) | | Number of null-terminated string | - - - - - - - - -### GetInventoryRequest -Request for Retrieving Inventory data from a device - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| name | [string](#string) | | The name of the inventory to retrieve - blank for the full inventory | - - - - - - - - -### Inventory -Response for device inventory data - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| bios | [BIOSInfo](#opi_api-inventory-v1-BIOSInfo) | | BIOS Inventory | -| system | [SystemInfo](#opi_api-inventory-v1-SystemInfo) | | System Inventory | -| baseboard | [BaseboardInfo](#opi_api-inventory-v1-BaseboardInfo) | | Baseboard Inventory | -| chassis | [ChassisInfo](#opi_api-inventory-v1-ChassisInfo) | | Chassis Inventory | -| processor | [CPUInfo](#opi_api-inventory-v1-CPUInfo) | | CPU Inventory | -| memory | [MemoryInfo](#opi_api-inventory-v1-MemoryInfo) | | Memory Inventory | -| pci | [PCIeDeviceInfo](#opi_api-inventory-v1-PCIeDeviceInfo) | repeated | PCI Devices Inventory | - - - - - - - - -### MemoryInfo -Physical Memory Array (Type 16) - This structure describes a collection of memory devices that operate together to form a memory address - space. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| total_physical_bytes | [int64](#int64) | | Maximum memory capacity, in kilobytes, for this array If the capacity is not represented in this field, then this field contains 8000 0000h and the Extended Maximum Capacity field should be used. Values 2 TB (8000 0000h) or greater must be represented in the Extended Maximum Capacity field. | -| total_usable_bytes | [int64](#int64) | | TBD | - - - - - - - - -### PCIeDeviceInfo -PCI device information - TBD: Type 9 or Type 41 ? - This structure describes a collection of PCI devices. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| driver | [string](#string) | | Driver assiociated with the device | -| address | [string](#string) | | BDF address in a string format, for example "0000:00:17.7" | -| vendor | [string](#string) | | string vendor info | -| product | [string](#string) | | string product info | -| revision | [string](#string) | | string revision info | -| subsystem | [string](#string) | | string subsystem info | -| class | [string](#string) | | string class info | -| subclass | [string](#string) | | string subclass info | - - - - - - - - -### SystemInfo -System Information (Type 1) - The information in this structure defines attributes of the overall system and is intended to be associated - with the Component ID group of the system’s MIF. An SMBIOS implementation is associated with a single - system instance and contains one and only one System Information (Type 1) structure. Table 10 shows - the contents of this structure. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| family | [string](#string) | | Number of null-terminated string This text string identifies the family to which a particular computer belongs. A family refers to a set of computers that are similar but not identical from a hardware or software point of view. Typically, a family is composed of different computer models, which have different configurations and pricing points. Computers in the same family often have similar branding and cosmetic features. | -| name | [string](#string) | | Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| uuid | [string](#string) | | A UUID is an identifier that is designed to be unique across both time and space. It requires no central registration process. The UUID is 128 bits long. Its format is described in RFC4122, but the actual field contents are opaque and not significant to the SMBIOS specification, which is only concerned with the byte order. Table 11 shows the field names; these field names, particularly for multiplexed fields, follow historical practice. | -| sku | [string](#string) | | Number of null-terminated string This text string identifies a particular computer configuration for sale. It is sometimes also called a product ID or purchase order number. This number is frequently found in existing fields, but there is no standard format. Typically for a given system board from a given OEM, there are tens of unique processor, memory, hard drive, and optical drive configurations. | -| version | [string](#string) | | Number of null-terminated string | - - - - - - - - - - - - - - -### InventorySvc -Service functions for the device inventory data - -| Method Name | Request Type | Response Type | Description | -| ----------- | ------------ | ------------- | ------------| -| GetInventory | [GetInventoryRequest](#opi_api-inventory-v1-GetInventoryRequest) | [Inventory](#opi_api-inventory-v1-Inventory) | retrieves the inventory data for the device | - - - - -

Top

diff --git a/storage/v1alpha1/autogen.md b/storage/v1alpha1/autogen.md index 69540d56..c339b0fa 100644 --- a/storage/v1alpha1/autogen.md +++ b/storage/v1alpha1/autogen.md @@ -183,19 +183,6 @@ - [NvmeAddressFamily](#opi_api-storage-v1-NvmeAddressFamily) - [NvmeTransportType](#opi_api-storage-v1-NvmeTransportType) -- [inventory.proto](#inventory-proto) - - [BIOSInfo](#opi_api-inventory-v1-BIOSInfo) - - [BaseboardInfo](#opi_api-inventory-v1-BaseboardInfo) - - [CPUInfo](#opi_api-inventory-v1-CPUInfo) - - [ChassisInfo](#opi_api-inventory-v1-ChassisInfo) - - [GetInventoryRequest](#opi_api-inventory-v1-GetInventoryRequest) - - [Inventory](#opi_api-inventory-v1-Inventory) - - [MemoryInfo](#opi_api-inventory-v1-MemoryInfo) - - [PCIeDeviceInfo](#opi_api-inventory-v1-PCIeDeviceInfo) - - [SystemInfo](#opi_api-inventory-v1-SystemInfo) - - - [InventorySvc](#opi_api-inventory-v1-InventorySvc) - - [uuid.proto](#uuid-proto) - [Uuid](#opi_api-common-v1-Uuid) @@ -2841,218 +2828,6 @@ Transport type value options - -

Top

- -## inventory.proto - - - - - -### BIOSInfo -BIOS Information (Type 0) - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| vendor | [string](#string) | | String number of the BIOS Vendor’s Name. | -| version | [string](#string) | | String number of the BIOS Version. This value is a free-form string that may contain Core and OEM version information. | -| date | [string](#string) | | String number of the BIOS release date. The date string, if supplied, is in either mm/dd/yy or mm/dd/yyyy format. If the year portion of the string is two digits, the year is assumed to be 19yy. NOTE: In version 2.3 and later of SMBIOS the mm/dd/yyyy format is only used. | - - - - - - - - -### BaseboardInfo -Baseboard (or Module) Information (Type 2) - The information in this structure defines attributes of a system baseboard (for - example, a motherboard, planar, server blade, or other standard system module) - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| asset_tag | [string](#string) | | Number of a null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| version | [string](#string) | | Number of null-terminated string | -| product | [string](#string) | | Number of null-terminated string | - - - - - - - - -### CPUInfo -Processor Information (Type 4) - The information in this structure (see Table 21) defines the attributes of a single processor; a separate - structure instance is provided for each system processor socket/slot. For example, a system with an - IntelDX2™ processor would have a single structure instance while a system with an IntelSX2™ processor - would have a structure to describe the main CPU and a second structure to describe the 80487 co1054 processor. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| total_cores | [int32](#int32) | | Number of cores per processor socket See 7.5.6. If the value is unknown, the field is set to 0. For core counts of 256 or greater, the Core Count field is set to FFh and the Core Count 2 field is set to the number of cores. | -| total_threads | [int32](#int32) | | Number of threads per processor socket See 7.5.8. If the value is unknown, the field is set to 0. For thread counts of 256 or greater, the Thread Count field is set to FFh and the Thread Count 2 field is set to the number of threads. | - - - - - - - - -### ChassisInfo -System Enclosure or Chassis (Type 3) - The information in this structure (see Table 16) defines attributes of the system’s mechanical - enclosure(s). For example, if a system included a separate enclosure for its peripheral devices, two - structures would be returned: one for the main system enclosure and the second for the peripheral device - enclosure. The additions to this structure in version 2.1 of this specification support the population of the - CIM_Chassis class. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| asset_tag | [string](#string) | | Number of null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| type | [string](#string) | | Bit 7 Chassis lock is present if 1. Otherwise, either a lock is not present, or it is unknown if the enclosure has a lock. Bits 6:0 Enumeration value; see below. | -| type_description | [string](#string) | | Table 17 shows the byte values for the System Enclosure or Chassis Types field Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| version | [string](#string) | | Number of null-terminated string | - - - - - - - - -### GetInventoryRequest -Request for Retrieving Inventory data from a device - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| name | [string](#string) | | The name of the inventory to retrieve - blank for the full inventory | - - - - - - - - -### Inventory -Response for device inventory data - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| bios | [BIOSInfo](#opi_api-inventory-v1-BIOSInfo) | | BIOS Inventory | -| system | [SystemInfo](#opi_api-inventory-v1-SystemInfo) | | System Inventory | -| baseboard | [BaseboardInfo](#opi_api-inventory-v1-BaseboardInfo) | | Baseboard Inventory | -| chassis | [ChassisInfo](#opi_api-inventory-v1-ChassisInfo) | | Chassis Inventory | -| processor | [CPUInfo](#opi_api-inventory-v1-CPUInfo) | | CPU Inventory | -| memory | [MemoryInfo](#opi_api-inventory-v1-MemoryInfo) | | Memory Inventory | -| pci | [PCIeDeviceInfo](#opi_api-inventory-v1-PCIeDeviceInfo) | repeated | PCI Devices Inventory | - - - - - - - - -### MemoryInfo -Physical Memory Array (Type 16) - This structure describes a collection of memory devices that operate together to form a memory address - space. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| total_physical_bytes | [int64](#int64) | | Maximum memory capacity, in kilobytes, for this array If the capacity is not represented in this field, then this field contains 8000 0000h and the Extended Maximum Capacity field should be used. Values 2 TB (8000 0000h) or greater must be represented in the Extended Maximum Capacity field. | -| total_usable_bytes | [int64](#int64) | | TBD | - - - - - - - - -### PCIeDeviceInfo -PCI device information - TBD: Type 9 or Type 41 ? - This structure describes a collection of PCI devices. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| driver | [string](#string) | | Driver assiociated with the device | -| address | [string](#string) | | BDF address in a string format, for example "0000:00:17.7" | -| vendor | [string](#string) | | string vendor info | -| product | [string](#string) | | string product info | -| revision | [string](#string) | | string revision info | -| subsystem | [string](#string) | | string subsystem info | -| class | [string](#string) | | string class info | -| subclass | [string](#string) | | string subclass info | - - - - - - - - -### SystemInfo -System Information (Type 1) - The information in this structure defines attributes of the overall system and is intended to be associated - with the Component ID group of the system’s MIF. An SMBIOS implementation is associated with a single - system instance and contains one and only one System Information (Type 1) structure. Table 10 shows - the contents of this structure. - - -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -| family | [string](#string) | | Number of null-terminated string This text string identifies the family to which a particular computer belongs. A family refers to a set of computers that are similar but not identical from a hardware or software point of view. Typically, a family is composed of different computer models, which have different configurations and pricing points. Computers in the same family often have similar branding and cosmetic features. | -| name | [string](#string) | | Number of null-terminated string | -| vendor | [string](#string) | | Number of null-terminated string | -| serial_number | [string](#string) | | Number of null-terminated string | -| uuid | [string](#string) | | A UUID is an identifier that is designed to be unique across both time and space. It requires no central registration process. The UUID is 128 bits long. Its format is described in RFC4122, but the actual field contents are opaque and not significant to the SMBIOS specification, which is only concerned with the byte order. Table 11 shows the field names; these field names, particularly for multiplexed fields, follow historical practice. | -| sku | [string](#string) | | Number of null-terminated string This text string identifies a particular computer configuration for sale. It is sometimes also called a product ID or purchase order number. This number is frequently found in existing fields, but there is no standard format. Typically for a given system board from a given OEM, there are tens of unique processor, memory, hard drive, and optical drive configurations. | -| version | [string](#string) | | Number of null-terminated string | - - - - - - - - - - - - - - -### InventorySvc -Service functions for the device inventory data - -| Method Name | Request Type | Response Type | Description | -| ----------- | ------------ | ------------- | ------------| -| GetInventory | [GetInventoryRequest](#opi_api-inventory-v1-GetInventoryRequest) | [Inventory](#opi_api-inventory-v1-Inventory) | retrieves the inventory data for the device | - - - - -

Top