canu

Documentation

Overview

* * MIT License * * (C) Copyright 2023 Hewlett Packard Enterprise Development LP * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. *

Index

• type Paddle
  • func LoadPaddle(path string) (ccj *Paddle, err error)
  • func (ccj *Paddle) UnmarshalJSON(b []byte) error
• type PaddleTopologyElem
• type PaddleTopologyElemLocation
• type PaddleTopologyElemPortsElem

Types

type Paddle

type Paddle struct {
	Architecture string               `json:"architecture" yaml:"architecture" mapstructure:"architecture"`
	CanuVersion  string               `json:"canu_version" yaml:"canu_version" mapstructure:"canu_version"`
	ShcdFile     string               `json:"shcd_file" yaml:"shcd_file" mapstructure:"shcd_file"`
	Topology     []PaddleTopologyElem `json:"topology" yaml:"topology" mapstructure:"topology"`
	UpdatedAt    *string              `json:"updated_at,omitempty" yaml:"updated_at,omitempty" mapstructure:"updated_at,omitempty"`
}

func LoadPaddle

func LoadPaddle(path string) (ccj *Paddle, err error)

func (*Paddle) UnmarshalJSON

func (ccj *Paddle) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler.

type PaddleTopologyElem

type PaddleTopologyElem struct {
	Architecture  *string                       `json:"architecture,omitempty" yaml:"architecture,omitempty" mapstructure:"architecture,omitempty"`
	CommonName    *string                       `json:"common_name,omitempty" yaml:"common_name,omitempty" mapstructure:"common_name,omitempty"`
	Id            *int                          `json:"id,omitempty" yaml:"id,omitempty" mapstructure:"id,omitempty"`
	Location      *PaddleTopologyElemLocation   `json:"location,omitempty" yaml:"location,omitempty" mapstructure:"location,omitempty"`
	Model         *string                       `json:"model,omitempty" yaml:"model,omitempty" mapstructure:"model,omitempty"`
	Ports         []PaddleTopologyElemPortsElem `json:"ports,omitempty" yaml:"ports,omitempty" mapstructure:"ports,omitempty"`
	RackElevation *string                       `json:"rack_elevation,omitempty" yaml:"rack_elevation,omitempty" mapstructure:"rack_elevation,omitempty"`
	RackNumber    *string                       `json:"rack_number,omitempty" yaml:"rack_number,omitempty" mapstructure:"rack_number,omitempty"`
	Type          *string                       `json:"type,omitempty" yaml:"type,omitempty" mapstructure:"type,omitempty"`
	Vendor        *string                       `json:"vendor,omitempty" yaml:"vendor,omitempty" mapstructure:"vendor,omitempty"`
}

type PaddleTopologyElemLocation

type PaddleTopologyElemLocation struct {
	Elevation   *string `json:"elevation,omitempty" yaml:"elevation,omitempty" mapstructure:"elevation,omitempty"`
	Parent      *string `json:"parent,omitempty" yaml:"parent,omitempty" mapstructure:"parent,omitempty"`
	Rack        *string `json:"rack,omitempty" yaml:"rack,omitempty" mapstructure:"rack,omitempty"`
	SubLocation *string `json:"sub_location,omitempty" yaml:"sub_location,omitempty" mapstructure:"sub_location,omitempty"`
}

type PaddleTopologyElemPortsElem

type PaddleTopologyElemPortsElem struct {
	DestinationNodeId *int    `json:"destination_node_id,omitempty" yaml:"destination_node_id,omitempty" mapstructure:"destination_node_id,omitempty"`
	DestinationPort   *int    `json:"destination_port,omitempty" yaml:"destination_port,omitempty" mapstructure:"destination_port,omitempty"`
	DestinationSlot   *string `json:"destination_slot,omitempty" yaml:"destination_slot,omitempty" mapstructure:"destination_slot,omitempty"`
	Port              *int    `json:"port,omitempty" yaml:"port,omitempty" mapstructure:"port,omitempty"`
	Slot              *string `json:"slot,omitempty" yaml:"slot,omitempty" mapstructure:"slot,omitempty"`
	Speed             *int    `json:"speed,omitempty" yaml:"speed,omitempty" mapstructure:"speed,omitempty"`
}