Schema Docs
1. Property root > manufacturer
2. Property root > model
3. Property root > hardware-type
|
|
Type |
enum (of string) |
Required |
Yes |
Defined in |
types.json#/definitions/hardware-type |
Must be one of:
- "Cabinet"
- "Chassis"
- "ChassisManagementModule"
- "CabinetEnvironmentalController"
- "NodeBlade"
- "NodeCard"
- "NodeController"
- "Node"
- "ManagementSwitchEnclosure"
- "ManagementSwitch"
- "ManagementSwitchController"
- "HighSpeedSwitchEnclosure"
- "HighSpeedSwitch"
- "HighSpeedSwitchController"
- "CabinetPDUController"
- "CabinetPDU"
- "CoolingDistributionUnit"
4. Property root > slug
|
|
Type |
string |
Required |
Yes |
Defined in |
components.json#/definitions/slug |
Restrictions |
|
Must match regular expression |
^[-a-z0-9_]+$ Test |
5. Property root > part_number
6. Property root > u_height
Restrictions |
|
Multiple of |
0.5 |
Minimum |
≥ 0 |
7. Property root > is_full_depth
8. Property root > airflow
|
|
Type |
enum (of string) |
Required |
No |
Must be one of:
- "front-to-rear"
- "rear-to-front"
- "left-to-right"
- "right-to-left"
- "side-to-rear"
- "passive"
9. Property root > weight
Restrictions |
|
Multiple of |
0.01 |
Minimum |
≥ 0 |
10. Property root > weight_unit
|
|
Type |
enum (of string) |
Required |
No |
Must be one of:
11. Property root > front_image
12. Property root > rear_image
13. Property root > subdevice_role
|
|
Type |
enum (of string) |
Required |
No |
Must be one of:
14. Property root > console-ports
|
Array restrictions |
Min items |
N/A |
Max items |
N/A |
Items unicity |
False |
Additional items |
False |
Tuple validation |
See below |
14.1. root > console-ports > console-port
|
|
Type |
object |
Required |
No |
Additional properties |
[Not allowed] |
Defined in |
components.json#/definitions/console-port |
Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
+ name |
No |
string |
No |
- |
- |
- label |
No |
string |
No |
- |
- |
+ type |
No |
enum (of string) |
No |
- |
- |
14.1.1. Property root > console-ports > console-ports items > name
14.1.2. Property root > console-ports > console-ports items > label
14.1.3. Property root > console-ports > console-ports items > type
|
|
Type |
enum (of string) |
Required |
Yes |
Must be one of:
- "de-9"
- "db-25"
- "rj-11"
- "rj-12"
- "rj-45"
- "mini-din-8"
- "usb-a"
- "usb-b"
- "usb-c"
- "usb-mini-a"
- "usb-mini-b"
- "usb-micro-a"
- "usb-micro-b"
- "usb-micro-ab"
- "other"
15. Property root > console-server-ports
|
Array restrictions |
Min items |
N/A |
Max items |
N/A |
Items unicity |
False |
Additional items |
False |
Tuple validation |
See below |
15.1. root > console-server-ports > console-server-port
|
|
Type |
object |
Required |
No |
Additional properties |
[Not allowed] |
Defined in |
components.json#/definitions/console-server-port |
Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
+ name |
No |
string |
No |
- |
- |
- label |
No |
string |
No |
- |
- |
+ type |
No |
enum (of string) |
No |
- |
- |
15.1.1. Property root > console-server-ports > console-server-ports items > name
15.1.2. Property root > console-server-ports > console-server-ports items > label
15.1.3. Property root > console-server-ports > console-server-ports items > type
|
|
Type |
enum (of string) |
Required |
Yes |
Must be one of:
- "de-9"
- "db-25"
- "rj-12"
- "rj-45"
- "mini-din-8"
- "usb-a"
- "usb-b"
- "usb-c"
- "usb-mini-a"
- "usb-mini-b"
- "usb-micro-a"
- "usb-micro-b"
- "usb-micro-ab"
- "other"
16. Property root > power-ports
|
Array restrictions |
Min items |
N/A |
Max items |
N/A |
Items unicity |
False |
Additional items |
False |
Tuple validation |
See below |
Each item of this array must be |
Description |
power-port |
- |
16.1. root > power-ports > power-port
|
|
Type |
object |
Required |
No |
Additional properties |
[Not allowed] |
Defined in |
components.json#/definitions/power-port |
Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
+ name |
No |
string |
No |
- |
- |
- label |
No |
string |
No |
- |
- |
+ type |
No |
enum (of string) |
No |
- |
- |
- maximum_draw |
No |
integer |
No |
- |
- |
- allocated_draw |
No |
integer |
No |
- |
- |
16.1.1. Property root > power-ports > power-ports items > name
16.1.2. Property root > power-ports > power-ports items > label
16.1.3. Property root > power-ports > power-ports items > type
|
|
Type |
enum (of string) |
Required |
Yes |
Must be one of:
- "iec-60320-c6"
- "iec-60320-c8"
- "iec-60320-c14"
- "iec-60320-c16"
- "iec-60320-c20"
- "iec-60320-c22"
- "iec-60309-p-n-e-4h"
- "iec-60309-p-n-e-6h"
- "iec-60309-p-n-e-9h"
- "iec-60309-2p-e-4h"
- "iec-60309-2p-e-6h"
- "iec-60309-2p-e-9h"
- "iec-60309-3p-e-4h"
- "iec-60309-3p-e-6h"
- "iec-60309-3p-e-9h"
- "iec-60309-3p-n-e-4h"
- "iec-60309-3p-n-e-6h"
- "iec-60309-3p-n-e-9h"
- "nema-1-15p"
- "nema-5-15p"
- "nema-5-20p"
- "nema-5-30p"
- "nema-5-50p"
- "nema-6-15p"
- "nema-6-20p"
- "nema-6-30p"
- "nema-6-50p"
- "nema-10-30p"
- "nema-10-50p"
- "nema-14-20p"
- "nema-14-30p"
- "nema-14-50p"
- "nema-14-60p"
- "nema-15-15p"
- "nema-15-20p"
- "nema-15-30p"
- "nema-15-50p"
- "nema-15-60p"
- "nema-l1-15p"
- "nema-l5-15p"
- "nema-l5-20p"
- "nema-l5-30p"
- "nema-l5-50p"
- "nema-l6-15p"
- "nema-l6-20p"
- "nema-l6-30p"
- "nema-l6-50p"
- "nema-l10-30p"
- "nema-l14-20p"
- "nema-l14-30p"
- "nema-l14-50p"
- "nema-l14-60p"
- "nema-l15-20p"
- "nema-l15-30p"
- "nema-l15-50p"
- "nema-l15-60p"
- "nema-l21-20p"
- "nema-l21-30p"
- "nema-l22-30p"
- "cs6361c"
- "cs6365c"
- "cs8165c"
- "cs8265c"
- "cs8365c"
- "cs8465c"
- "ita-c"
- "ita-e"
- "ita-f"
- "ita-ef"
- "ita-g"
- "ita-h"
- "ita-i"
- "ita-j"
- "ita-k"
- "ita-l"
- "ita-m"
- "ita-n"
- "ita-o"
- "usb-a"
- "usb-b"
- "usb-c"
- "usb-mini-a"
- "usb-mini-b"
- "usb-micro-a"
- "usb-micro-b"
- "usb-micro-ab"
- "usb-3-b"
- "usb-3-micro-b"
- "dc-terminal"
- "saf-d-grid"
- "ubiquiti-smartpower"
- "hardwired"
- "other"
16.1.4. Property root > power-ports > power-ports items > maximum_draw
16.1.5. Property root > power-ports > power-ports items > allocated_draw
17. Property root > power-outlets
|
Array restrictions |
Min items |
N/A |
Max items |
N/A |
Items unicity |
False |
Additional items |
False |
Tuple validation |
See below |
17.1. root > power-outlets > power-outlet
|
|
Type |
object |
Required |
No |
Additional properties |
[Not allowed] |
Defined in |
components.json#/definitions/power-outlet |
Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
+ name |
No |
string |
No |
- |
- |
- label |
No |
string |
No |
- |
- |
+ type |
No |
enum (of string) |
No |
- |
- |
- power_port |
No |
string |
No |
- |
- |
- feed_leg |
No |
enum (of string) |
No |
- |
- |
17.1.1. Property root > power-outlets > power-outlets items > name
17.1.2. Property root > power-outlets > power-outlets items > label
17.1.3. Property root > power-outlets > power-outlets items > type
|
|
Type |
enum (of string) |
Required |
Yes |
Must be one of:
- "iec-60320-c5"
- "iec-60320-c7"
- "iec-60320-c13"
- "iec-60320-c15"
- "iec-60320-c19"
- "iec-60320-c21"
- "iec-60309-p-n-e-4h"
- "iec-60309-p-n-e-6h"
- "iec-60309-p-n-e-9h"
- "iec-60309-2p-e-4h"
- "iec-60309-2p-e-6h"
- "iec-60309-2p-e-9h"
- "iec-60309-3p-e-4h"
- "iec-60309-3p-e-6h"
- "iec-60309-3p-e-9h"
- "iec-60309-3p-n-e-4h"
- "iec-60309-3p-n-e-6h"
- "iec-60309-3p-n-e-9h"
- "nema-1-15r"
- "nema-5-15r"
- "nema-5-20r"
- "nema-5-30r"
- "nema-5-50r"
- "nema-6-15r"
- "nema-6-20r"
- "nema-6-30r"
- "nema-6-50r"
- "nema-10-30r"
- "nema-10-50r"
- "nema-14-20r"
- "nema-14-30r"
- "nema-14-50r"
- "nema-14-60r"
- "nema-15-15r"
- "nema-15-20r"
- "nema-15-30r"
- "nema-15-50r"
- "nema-15-60r"
- "nema-l1-15r"
- "nema-l5-15r"
- "nema-l5-20r"
- "nema-l5-30r"
- "nema-l5-50r"
- "nema-l6-15r"
- "nema-l6-20r"
- "nema-l6-30r"
- "nema-l6-50r"
- "nema-l10-30r"
- "nema-l14-20r"
- "nema-l14-30r"
- "nema-l14-50r"
- "nema-l14-60r"
- "nema-l15-20r"
- "nema-l15-30r"
- "nema-l15-50r"
- "nema-l15-60r"
- "nema-l21-20r"
- "nema-l21-30r"
- "nema-l22-30r"
- "CS6360C"
- "CS6364C"
- "CS8164C"
- "CS8264C"
- "CS8364C"
- "CS8464C"
- "ita-e"
- "ita-f"
- "ita-g"
- "ita-h"
- "ita-i"
- "ita-j"
- "ita-k"
- "ita-l"
- "ita-m"
- "ita-n"
- "ita-o"
- "ita-multistandard"
- "usb-a"
- "usb-micro-b"
- "usb-c"
- "dc-terminal"
- "hdot-cx"
- "saf-d-grid"
- "ubiquiti-smartpower"
- "hardwired"
- "other"
17.1.4. Property root > power-outlets > power-outlets items > power_port
17.1.5. Property root > power-outlets > power-outlets items > feed_leg
|
|
Type |
enum (of string) |
Required |
No |
Must be one of:
18. Property root > interfaces
|
Array restrictions |
Min items |
N/A |
Max items |
N/A |
Items unicity |
False |
Additional items |
False |
Tuple validation |
See below |
Each item of this array must be |
Description |
interface |
- |
18.1. root > interfaces > interface
|
|
Type |
object |
Required |
No |
Additional properties |
[Not allowed] |
Defined in |
components.json#/definitions/interface |
Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
+ name |
No |
string |
No |
- |
- |
- label |
No |
string |
No |
- |
- |
+ type |
No |
enum (of string) |
No |
- |
- |
- poe_mode |
No |
enum (of string) |
No |
- |
- |
- poe_type |
No |
enum (of string) |
No |
- |
- |
- mgmt_only |
No |
boolean |
No |
- |
- |
18.1.1. Property root > interfaces > interfaces items > name
18.1.2. Property root > interfaces > interfaces items > label
18.1.3. Property root > interfaces > interfaces items > type
|
|
Type |
enum (of string) |
Required |
Yes |
Must be one of:
- "virtual"
- "bridge"
- "lag"
- "100base-fx"
- "100base-lfx"
- "100base-tx"
- "100base-t1"
- "1000base-t"
- "1000base-x-gbic"
- "1000base-x-sfp"
- "2.5gbase-t"
- "5gbase-t"
- "10gbase-t"
- "10gbase-cx4"
- "10gbase-x-sfpp"
- "10gbase-x-xfp"
- "10gbase-x-xenpak"
- "10gbase-x-x2"
- "25gbase-x-sfp28"
- "40gbase-x-qsfpp"
- "50gbase-x-sfp28"
- "100gbase-x-cfp"
- "100gbase-x-cfp2"
- "100gbase-x-cfp4"
- "100gbase-x-cpak"
- "100gbase-x-qsfp28"
- "200gbase-x-cfp2"
- "200gbase-x-qsfp56"
- "400gbase-x-qsfpdd"
- "400gbase-x-osfp"
- "ieee802.11a"
- "ieee802.11g"
- "ieee802.11n"
- "ieee802.11ac"
- "ieee802.11ad"
- "ieee802.11ax"
- "ieee802.15.1"
- "gsm"
- "cdma"
- "lte"
- "sonet-oc3"
- "sonet-oc12"
- "sonet-oc48"
- "sonet-oc192"
- "sonet-oc768"
- "sonet-oc1920"
- "sonet-oc3840"
- "1gfc-sfp"
- "2gfc-sfp"
- "4gfc-sfp"
- "8gfc-sfpp"
- "16gfc-sfpp"
- "32gfc-sfp28"
- "64gfc-qsfpp"
- "128gfc-qsfp28"
- "infiniband-sdr"
- "infiniband-ddr"
- "infiniband-qdr"
- "infiniband-fdr10"
- "infiniband-fdr"
- "infiniband-edr"
- "infiniband-hdr"
- "infiniband-ndr"
- "infiniband-xdr"
- "t1"
- "e1"
- "t3"
- "e3"
- "xdsl"
- "docsis"
- "cisco-stackwise"
- "cisco-stackwise-plus"
- "cisco-flexstack"
- "cisco-flexstack-plus"
- "cisco-stackwise-80"
- "cisco-stackwise-160"
- "cisco-stackwise-320"
- "cisco-stackwise-480"
- "juniper-vcp"
- "extreme-summitstack"
- "extreme-summitstack-128"
- "extreme-summitstack-256"
- "extreme-summitstack-512"
- "gpon"
- "xg-pon"
- "xgs-pon"
- "ng-pon2"
- "epon"
- "10g-epon"
- "other"
18.1.4. Property root > interfaces > interfaces items > poe_mode
|
|
Type |
enum (of string) |
Required |
No |
Must be one of:
18.1.5. Property root > interfaces > interfaces items > poe_type
|
|
Type |
enum (of string) |
Required |
No |
Must be one of:
- "type1-ieee802.3af"
- "type2-ieee802.3at"
- "type3-ieee802.3bt"
- "type4-ieee802.3bt"
- "passive-24v-2pair"
- "passive-24v-4pair"
- "passive-48v-2pair"
- "passive-48v-4pair"
18.1.6. Property root > interfaces > interfaces items > mgmt_only
19. Property root > front-ports
|
Array restrictions |
Min items |
N/A |
Max items |
N/A |
Items unicity |
False |
Additional items |
False |
Tuple validation |
See below |
Each item of this array must be |
Description |
front-port |
- |
19.1. root > front-ports > front-port
|
|
Type |
object |
Required |
No |
Additional properties |
[Any type: allowed] |
Defined in |
components.json#/definitions/front-port |
Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
+ name |
No |
string |
No |
- |
- |
- label |
No |
string |
No |
- |
- |
+ type |
No |
enum (of string) |
No |
- |
- |
- color |
No |
string |
No |
- |
- |
+ rear_port |
No |
string |
No |
- |
- |
- rear_port_position |
No |
integer |
No |
- |
- |
19.1.1. Property root > front-ports > front-ports items > name
19.1.2. Property root > front-ports > front-ports items > label
19.1.3. Property root > front-ports > front-ports items > type
|
|
Type |
enum (of string) |
Required |
Yes |
Must be one of:
- "8p8c"
- "8p6c"
- "8p4c"
- "8p2c"
- "6p6c"
- "6p4c"
- "6p2c"
- "4p4c"
- "4p2c"
- "gg45"
- "tera-4p"
- "tera-2p"
- "tera-1p"
- "110-punch"
- "bnc"
- "f"
- "n"
- "mrj21"
- "st"
- "sc"
- "sc-apc"
- "fc"
- "lc"
- "lc-apc"
- "mtrj"
- "mpo"
- "lsh"
- "lsh-apc"
- "splice"
- "cs"
- "sn"
- "sma-905"
- "sma-906"
- "urm-p2"
- "urm-p4"
- "urm-p8"
- "other"
19.1.4. Property root > front-ports > front-ports items > color
Restrictions |
|
Must match regular expression |
^[a-f0-9]{6}$ Test |
19.1.5. Property root > front-ports > front-ports items > rear_port
19.1.6. Property root > front-ports > front-ports items > rear_port_position
20. Property root > rear-ports
|
Array restrictions |
Min items |
N/A |
Max items |
N/A |
Items unicity |
False |
Additional items |
False |
Tuple validation |
See below |
Each item of this array must be |
Description |
rear-port |
- |
20.1. root > rear-ports > rear-port
|
|
Type |
object |
Required |
No |
Additional properties |
[Not allowed] |
Defined in |
components.json#/definitions/rear-port |
Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
+ name |
No |
string |
No |
- |
- |
- label |
No |
string |
No |
- |
- |
+ type |
No |
enum (of string) |
No |
- |
- |
- color |
No |
string |
No |
- |
- |
- positions |
No |
integer |
No |
- |
- |
20.1.1. Property root > rear-ports > rear-ports items > name
20.1.2. Property root > rear-ports > rear-ports items > label
20.1.3. Property root > rear-ports > rear-ports items > type
|
|
Type |
enum (of string) |
Required |
Yes |
Must be one of:
- "8p8c"
- "8p6c"
- "8p4c"
- "8p2c"
- "6p6c"
- "6p4c"
- "6p2c"
- "4p4c"
- "4p2c"
- "gg45"
- "tera-4p"
- "tera-2p"
- "tera-1p"
- "110-punch"
- "bnc"
- "f"
- "n"
- "mrj21"
- "st"
- "sc"
- "sc-apc"
- "fc"
- "lc"
- "lc-apc"
- "mtrj"
- "mpo"
- "lsh"
- "lsh-apc"
- "splice"
- "cs"
- "sn"
- "sma-905"
- "sma-906"
- "urm-p2"
- "urm-p4"
- "urm-p8"
20.1.4. Property root > rear-ports > rear-ports items > color
Restrictions |
|
Must match regular expression |
^[a-f0-9]{6}$ Test |
20.1.5. Property root > rear-ports > rear-ports items > positions
21. Property root > module-bays
|
Array restrictions |
Min items |
N/A |
Max items |
N/A |
Items unicity |
False |
Additional items |
False |
Tuple validation |
See below |
Each item of this array must be |
Description |
module-bay |
- |
21.1. root > module-bays > module-bay
|
|
Type |
object |
Required |
No |
Additional properties |
[Any type: allowed] |
Defined in |
components.json#/definitions/module-bay |
Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
+ name |
No |
string |
No |
- |
- |
- label |
No |
string |
No |
- |
- |
- position |
No |
string |
No |
- |
- |
21.1.1. Property root > module-bays > module-bays items > name
21.1.2. Property root > module-bays > module-bays items > label
21.1.3. Property root > module-bays > module-bays items > position
22. Property root > device-bays
|
Array restrictions |
Min items |
N/A |
Max items |
N/A |
Items unicity |
False |
Additional items |
False |
Tuple validation |
See below |
Each item of this array must be |
Description |
device-bay |
- |
22.1. root > device-bays > device-bay
|
|
Type |
object |
Required |
No |
Additional properties |
[Not allowed] |
Defined in |
components.json#/definitions/device-bay |
Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
+ name |
No |
string |
No |
- |
- |
- label |
No |
string |
No |
- |
- |
+ ordinal |
No |
integer |
No |
- |
- |
- allowed |
No |
object |
No |
- |
- |
- default |
No |
object |
No |
- |
- |
22.1.1. Property root > device-bays > device-bays items > name
22.1.2. Property root > device-bays > device-bays items > label
22.1.3. Property root > device-bays > device-bays items > ordinal
|
|
Type |
integer |
Required |
Yes |
22.1.4. Property root > device-bays > device-bays items > allowed
Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
- slug |
No |
array |
No |
- |
- |
- hardware-type |
No |
array |
No |
- |
- |
22.1.4.1. Property root > device-bays > device-bays items > allowed > slug
|
Array restrictions |
Min items |
N/A |
Max items |
N/A |
Items unicity |
False |
Additional items |
False |
Tuple validation |
See below |
Each item of this array must be |
Description |
slug |
- |
22.1.4.1.1. root > device-bays > device-bays items > allowed > slug > slug
|
|
Type |
string |
Required |
No |
Same definition as |
slug |
22.1.4.2. Property root > device-bays > device-bays items > allowed > hardware-type
|
Array restrictions |
Min items |
N/A |
Max items |
N/A |
Items unicity |
False |
Additional items |
False |
Tuple validation |
See below |
22.1.4.2.1. root > device-bays > device-bays items > allowed > hardware-type > hardware-type
|
|
Type |
enum (of string) |
Required |
No |
Same definition as |
hardware-type |
22.1.5. Property root > device-bays > device-bays items > default
Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
- slug |
No |
string |
No |
Same as slug |
- |
22.1.5.1. Property root > device-bays > device-bays items > default > slug
|
|
Type |
string |
Required |
No |
Same definition as |
slug |
23. Property root > identifications
|
Array restrictions |
Min items |
N/A |
Max items |
N/A |
Items unicity |
False |
Additional items |
False |
Tuple validation |
See below |
23.1. root > identifications > identifications
|
|
Type |
object |
Required |
No |
Additional properties |
[Not allowed] |
Defined in |
components.json#/definitions/identifications |
Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
+ manufacturer |
No |
string |
No |
- |
- |
+ model |
No |
string |
No |
- |
- |
- part-number |
No |
string |
No |
- |
- |
23.1.1. Property root > identifications > identifications > manufacturer
23.1.2. Property root > identifications > identifications > model
23.1.3. Property root > identifications > identifications > part-number
24. Property root > inventory-items
|
Array restrictions |
Min items |
N/A |
Max items |
N/A |
Items unicity |
False |
Additional items |
False |
Tuple validation |
See below |
24.1. root > inventory-items > inventory-item
|
|
Type |
object |
Required |
No |
Additional properties |
[Not allowed] |
Defined in |
components.json#/definitions/inventory-item |
Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
+ name |
No |
string |
No |
- |
- |
- label |
No |
string |
No |
- |
- |
- manufacturer |
No |
string |
No |
- |
- |
- part_id |
No |
string |
No |
- |
- |
24.1.1. Property root > inventory-items > inventory-items items > name
24.1.2. Property root > inventory-items > inventory-items items > label
24.1.3. Property root > inventory-items > inventory-items items > manufacturer
24.1.4. Property root > inventory-items > inventory-items items > part_id
26. Property root > provider_defaults
Property |
Pattern |
Type |
Deprecated |
Definition |
Title/Description |
- csm |
No |
object |
No |
- |
- |
26.1. Property root > provider_defaults > csm
26.1.1. Property root > provider_defaults > csm > Class
26.1.2. Property root > provider_defaults > csm > Ordinal
26.1.3. Property root > provider_defaults > csm > StartingHmnVlan
26.1.4. Property root > provider_defaults > csm > EndingHmnVlan
Generated using json-schema-for-humans on 2023-12-12 at 20:59:51 +0000