internal/pkg/commands/devices.go - voltctl - Gitiles

 /*
  * Copyright 2019-present Ciena Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  * http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 package commands

 import (
 	"context"
 	"fmt"
 	"os"
 	"strconv"
 	"strings"

 	"github.com/golang/protobuf/ptypes/empty"
 	flags "github.com/jessevdk/go-flags"
 	"github.com/opencord/voltctl/pkg/format"
 	"github.com/opencord/voltha-protos/v3/go/common"
 	"github.com/opencord/voltha-protos/v3/go/voltha"
 )

 const (
 	DEFAULT_DEVICE_FORMAT         = "table{{ .Id }}\t{{.Type}}\t{{.Root}}\t{{.ParentId}}\t{{.SerialNumber}}\t{{.AdminState}}\t{{.OperStatus}}\t{{.ConnectStatus}}\t{{.Reason}}"
 	DEFAULT_DEVICE_PORTS_FORMAT   = "table{{.PortNo}}\t{{.Label}}\t{{.Type}}\t{{.AdminState}}\t{{.OperStatus}}\t{{.DeviceId}}\t{{.Peers}}"
 	DEFAULT_DEVICE_INSPECT_FORMAT = `ID: {{.Id}}
   TYPE:          {{.Type}}
   ROOT:          {{.Root}}
   PARENTID:      {{.ParentId}}
   SERIALNUMBER:  {{.SerialNumber}}
   VLAN:          {{.Vlan}}
   ADMINSTATE:    {{.AdminState}}
   OPERSTATUS:    {{.OperStatus}}
   CONNECTSTATUS: {{.ConnectStatus}}`
 	DEFAULT_DEVICE_VALUE_GET_FORMAT = "table{{.Name}}\t{{.Result}}"
 )

 type DeviceList struct {
 	ListOutputOptions
 }

 type DeviceCreate struct {
 	DeviceType  string `short:"t" long:"devicetype" default:"" description:"Device type"`
 	MACAddress  string `short:"m" long:"macaddress" default:"" description:"MAC Address"`
 	IPAddress   string `short:"i" long:"ipaddress" default:"" description:"IP Address"`
 	HostAndPort string `short:"H" long:"hostandport" default:"" description:"Host and port"`
 }

 type DeviceId string

 type PortNum uint32
 type ValueFlag string

 type DeviceDelete struct {
 	Args struct {
 		Ids []DeviceId `positional-arg-name:"DEVICE_ID" required:"yes"`
 	} `positional-args:"yes"`
 }

 type DeviceEnable struct {
 	Args struct {
 		Ids []DeviceId `positional-arg-name:"DEVICE_ID" required:"yes"`
 	} `positional-args:"yes"`
 }

 type DeviceDisable struct {
 	Args struct {
 		Ids []DeviceId `positional-arg-name:"DEVICE_ID" required:"yes"`
 	} `positional-args:"yes"`
 }

 type DeviceReboot struct {
 	Args struct {
 		Ids []DeviceId `positional-arg-name:"DEVICE_ID" required:"yes"`
 	} `positional-args:"yes"`
 }

 type DeviceFlowList struct {
 	ListOutputOptions
 	Args struct {
 		Id DeviceId `positional-arg-name:"DEVICE_ID" required:"yes"`
 	} `positional-args:"yes"`
 }

 type DevicePortList struct {
 	ListOutputOptions
 	Args struct {
 		Id DeviceId `positional-arg-name:"DEVICE_ID" required:"yes"`
 	} `positional-args:"yes"`
 }

 type DeviceInspect struct {
 	OutputOptionsJson
 	Args struct {
 		Id DeviceId `positional-arg-name:"DEVICE_ID" required:"yes"`
 	} `positional-args:"yes"`
 }

 type DevicePortEnable struct {
 	Args struct {
 		Id     DeviceId `positional-arg-name:"DEVICE_ID" required:"yes"`
 		PortId PortNum  `positional-arg-name:"PORT_NUMBER" required:"yes"`
 	} `positional-args:"yes"`
 }

 type DevicePortDisable struct {
 	Args struct {
 		Id     DeviceId `positional-arg-name:"DEVICE_ID" required:"yes"`
 		PortId PortNum  `positional-arg-name:"PORT_NUMBER" required:"yes"`
 	} `positional-args:"yes"`
 }

 type DeviceGetExtValue struct {
 	ListOutputOptions
 	Args struct {
 		Id        DeviceId  `positional-arg-name:"DEVICE_ID" required:"yes"`
 		Valueflag ValueFlag `positional-arg-name:"VALUE_FLAG" required:"yes"`
 	} `positional-args:"yes"`
 }
 type DeviceOpts struct {
 	List    DeviceList     `command:"list"`
 	Create  DeviceCreate   `command:"create"`
 	Delete  DeviceDelete   `command:"delete"`
 	Enable  DeviceEnable   `command:"enable"`
 	Disable DeviceDisable  `command:"disable"`
 	Flows   DeviceFlowList `command:"flows"`
 	Port    struct {
 		List    DevicePortList    `command:"list"`
 		Enable  DevicePortEnable  `command:"enable"`
 		Disable DevicePortDisable `command:"disable"`
 	} `command:"port"`
 	Inspect DeviceInspect `command:"inspect"`
 	Reboot  DeviceReboot  `command:"reboot"`
 	Value   struct {
 		Get DeviceGetExtValue `command:"get"`
 	} `command:"value"`
 }

 var deviceOpts = DeviceOpts{}

 func RegisterDeviceCommands(parser *flags.Parser) {
 	if _, err := parser.AddCommand("device", "device commands", "Commands to query and manipulate VOLTHA devices", &deviceOpts); err != nil {
 		Error.Fatalf("Unexpected error while attempting to register device commands : %s", err)
 	}
 }

 func (i *PortNum) Complete(match string) []flags.Completion {
 	conn, err := NewConnection()
 	if err != nil {
 		return nil
 	}
 	defer conn.Close()

 	client := voltha.NewVolthaServiceClient(conn)

 	/*
 	 * The command line args when completing for PortNum will be a DeviceId
 	 * followed by one or more PortNums. So walk the argument list from the
 	 * end and find the first argument that is enable/disable as those are
 	 * the subcommands that come before the positional arguments. It would
 	 * be nice if this package gave us the list of optional arguments
 	 * already parsed.
 	 */
 	var deviceId string
 found:
 	for i := len(os.Args) - 1; i >= 0; i -= 1 {
 		switch os.Args[i] {
 		case "enable":
 			fallthrough
 		case "disable":
 			if len(os.Args) > i+1 {
 				deviceId = os.Args[i+1]
 			} else {
 				return nil
 			}
 			break found
 		default:
 		}
 	}

 	if len(deviceId) == 0 {
 		return nil
 	}

 	ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
 	defer cancel()

 	id := voltha.ID{Id: string(deviceId)}

 	ports, err := client.ListDevicePorts(ctx, &id)
 	if err != nil {
 		return nil
 	}

 	list := make([]flags.Completion, 0)
 	for _, item := range ports.Items {
 		pn := strconv.FormatUint(uint64(item.PortNo), 10)
 		if strings.HasPrefix(pn, match) {
 			list = append(list, flags.Completion{Item: pn})
 		}
 	}

 	return list
 }

 func (i *DeviceId) Complete(match string) []flags.Completion {
 	conn, err := NewConnection()
 	if err != nil {
 		return nil
 	}
 	defer conn.Close()

 	client := voltha.NewVolthaServiceClient(conn)

 	ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
 	defer cancel()

 	devices, err := client.ListDevices(ctx, &empty.Empty{})
 	if err != nil {
 		return nil
 	}

 	list := make([]flags.Completion, 0)
 	for _, item := range devices.Items {
 		if strings.HasPrefix(item.Id, match) {
 			list = append(list, flags.Completion{Item: item.Id})
 		}
 	}

 	return list
 }

 func (options *DeviceList) Execute(args []string) error {

 	conn, err := NewConnection()
 	if err != nil {
 		return err
 	}
 	defer conn.Close()

 	client := voltha.NewVolthaServiceClient(conn)

 	ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
 	defer cancel()

 	devices, err := client.ListDevices(ctx, &empty.Empty{})
 	if err != nil {
 		return err
 	}

 	outputFormat := CharReplacer.Replace(options.Format)
 	if outputFormat == "" {
 		outputFormat = GetCommandOptionWithDefault("device-list", "format", DEFAULT_DEVICE_FORMAT)
 	}
 	if options.Quiet {
 		outputFormat = "{{.Id}}"
 	}

 	orderBy := options.OrderBy
 	if orderBy == "" {
 		orderBy = GetCommandOptionWithDefault("device-list", "order", "")
 	}

 	// Make sure json output prints an empty list, not "null"
 	if devices.Items == nil {
 		devices.Items = make([]*voltha.Device, 0)
 	}

 	result := CommandResult{
 		Format:    format.Format(outputFormat),
 		Filter:    options.Filter,
 		OrderBy:   orderBy,
 		OutputAs:  toOutputType(options.OutputAs),
 		NameLimit: options.NameLimit,
 		Data:      devices.Items,
 	}

 	GenerateOutput(&result)
 	return nil
 }

 func (options *DeviceCreate) Execute(args []string) error {

 	device := voltha.Device{}
 	if options.HostAndPort != "" {
 		device.Address = &voltha.Device_HostAndPort{HostAndPort: options.HostAndPort}
 	} else if options.IPAddress != "" {
 		device.Address = &voltha.Device_Ipv4Address{Ipv4Address: options.IPAddress}
 	}
 	if options.MACAddress != "" {
 		device.MacAddress = strings.ToLower(options.MACAddress)
 	}
 	if options.DeviceType != "" {
 		device.Type = options.DeviceType
 	}

 	conn, err := NewConnection()
 	if err != nil {
 		return err
 	}
 	defer conn.Close()

 	client := voltha.NewVolthaServiceClient(conn)

 	ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
 	defer cancel()

 	createdDevice, err := client.CreateDevice(ctx, &device)
 	if err != nil {
 		return err
 	}

 	fmt.Printf("%s\n", createdDevice.Id)

 	return nil
 }

 func (options *DeviceDelete) Execute(args []string) error {

 	conn, err := NewConnection()
 	if err != nil {
 		return err
 	}
 	defer conn.Close()

 	client := voltha.NewVolthaServiceClient(conn)

 	var lastErr error
 	for _, i := range options.Args.Ids {
 		ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
 		defer cancel()

 		id := voltha.ID{Id: string(i)}

 		_, err := client.DeleteDevice(ctx, &id)
 		if err != nil {
 			Error.Printf("Error while deleting '%s': %s\n", i, err)
 			lastErr = err
 			continue
 		}
 		fmt.Printf("%s\n", i)
 	}

 	if lastErr != nil {
 		return NoReportErr
 	}
 	return nil
 }

 func (options *DeviceEnable) Execute(args []string) error {
 	conn, err := NewConnection()
 	if err != nil {
 		return err
 	}
 	defer conn.Close()

 	client := voltha.NewVolthaServiceClient(conn)

 	var lastErr error
 	for _, i := range options.Args.Ids {
 		ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
 		defer cancel()

 		id := voltha.ID{Id: string(i)}

 		_, err := client.EnableDevice(ctx, &id)
 		if err != nil {
 			Error.Printf("Error while enabling '%s': %s\n", i, err)
 			lastErr = err
 			continue
 		}
 		fmt.Printf("%s\n", i)
 	}

 	if lastErr != nil {
 		return NoReportErr
 	}
 	return nil
 }

 func (options *DeviceDisable) Execute(args []string) error {
 	conn, err := NewConnection()
 	if err != nil {
 		return err
 	}
 	defer conn.Close()

 	client := voltha.NewVolthaServiceClient(conn)

 	var lastErr error
 	for _, i := range options.Args.Ids {
 		ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
 		defer cancel()

 		id := voltha.ID{Id: string(i)}

 		_, err := client.DisableDevice(ctx, &id)
 		if err != nil {
 			Error.Printf("Error while disabling '%s': %s\n", i, err)
 			lastErr = err
 			continue
 		}
 		fmt.Printf("%s\n", i)
 	}

 	if lastErr != nil {
 		return NoReportErr
 	}
 	return nil
 }

 func (options *DeviceReboot) Execute(args []string) error {
 	conn, err := NewConnection()
 	if err != nil {
 		return err
 	}
 	defer conn.Close()

 	client := voltha.NewVolthaServiceClient(conn)

 	var lastErr error
 	for _, i := range options.Args.Ids {
 		ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
 		defer cancel()

 		id := voltha.ID{Id: string(i)}

 		_, err := client.RebootDevice(ctx, &id)
 		if err != nil {
 			Error.Printf("Error while rebooting '%s': %s\n", i, err)
 			lastErr = err
 			continue
 		}
 		fmt.Printf("%s\n", i)
 	}

 	if lastErr != nil {
 		return NoReportErr
 	}
 	return nil
 }

 func (options *DevicePortList) Execute(args []string) error {

 	conn, err := NewConnection()
 	if err != nil {
 		return err
 	}
 	defer conn.Close()

 	client := voltha.NewVolthaServiceClient(conn)

 	ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
 	defer cancel()

 	id := voltha.ID{Id: string(options.Args.Id)}

 	ports, err := client.ListDevicePorts(ctx, &id)
 	if err != nil {
 		return err
 	}

 	outputFormat := CharReplacer.Replace(options.Format)
 	if outputFormat == "" {
 		outputFormat = GetCommandOptionWithDefault("device-ports", "format", DEFAULT_DEVICE_PORTS_FORMAT)
 	}
 	if options.Quiet {
 		outputFormat = "{{.Id}}"
 	}

 	orderBy := options.OrderBy
 	if orderBy == "" {
 		orderBy = GetCommandOptionWithDefault("device-ports", "order", "")
 	}

 	result := CommandResult{
 		Format:    format.Format(outputFormat),
 		Filter:    options.Filter,
 		OrderBy:   orderBy,
 		OutputAs:  toOutputType(options.OutputAs),
 		NameLimit: options.NameLimit,
 		Data:      ports.Items,
 	}

 	GenerateOutput(&result)
 	return nil
 }

 func (options *DeviceFlowList) Execute(args []string) error {
 	fl := &FlowList{}
 	fl.ListOutputOptions = options.ListOutputOptions
 	fl.Args.Id = string(options.Args.Id)
 	fl.Method = "device-flows"
 	return fl.Execute(args)
 }

 func (options *DeviceInspect) Execute(args []string) error {
 	if len(args) > 0 {
 		return fmt.Errorf("only a single argument 'DEVICE_ID' can be provided")
 	}

 	conn, err := NewConnection()
 	if err != nil {
 		return err
 	}
 	defer conn.Close()

 	client := voltha.NewVolthaServiceClient(conn)

 	ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
 	defer cancel()

 	id := voltha.ID{Id: string(options.Args.Id)}

 	device, err := client.GetDevice(ctx, &id)
 	if err != nil {
 		return err
 	}

 	outputFormat := CharReplacer.Replace(options.Format)
 	if outputFormat == "" {
 		outputFormat = GetCommandOptionWithDefault("device-inspect", "format", DEFAULT_DEVICE_INSPECT_FORMAT)
 	}
 	if options.Quiet {
 		outputFormat = "{{.Id}}"
 	}

 	result := CommandResult{
 		Format:    format.Format(outputFormat),
 		OutputAs:  toOutputType(options.OutputAs),
 		NameLimit: options.NameLimit,
 		Data:      device,
 	}
 	GenerateOutput(&result)
 	return nil
 }

 /*Device  Port Enable */
 func (options *DevicePortEnable) Execute(args []string) error {
 	conn, err := NewConnection()
 	if err != nil {
 		return err
 	}
 	defer conn.Close()

 	client := voltha.NewVolthaServiceClient(conn)

 	ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
 	defer cancel()

 	port := voltha.Port{DeviceId: string(options.Args.Id), PortNo: uint32(options.Args.PortId)}

 	_, err = client.EnablePort(ctx, &port)
 	if err != nil {
 		Error.Printf("Error enabling port number %v on device Id %s,err=%s\n", options.Args.PortId, options.Args.Id, ErrorToString(err))
 		return err
 	}

 	return nil
 }

 /*Device  Port Disable */
 func (options *DevicePortDisable) Execute(args []string) error {
 	conn, err := NewConnection()
 	if err != nil {
 		return err
 	}
 	defer conn.Close()

 	client := voltha.NewVolthaServiceClient(conn)

 	ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
 	defer cancel()

 	port := voltha.Port{DeviceId: string(options.Args.Id), PortNo: uint32(options.Args.PortId)}

 	_, err = client.DisablePort(ctx, &port)
 	if err != nil {
 		Error.Printf("Error enabling port number %v on device Id %s,err=%s\n", options.Args.PortId, options.Args.Id, ErrorToString(err))
 		return err
 	}

 	return nil
 }

 type ReturnValueRow struct {
 	Name   string      `json:"name"`
 	Result interface{} `json:"result"`
 }

 /*Device  get Onu Distance */
 func (options *DeviceGetExtValue) Execute(args []string) error {
 	conn, err := NewConnection()
 	if err != nil {
 		return err
 	}
 	defer conn.Close()

 	client := voltha.NewVolthaServiceClient(conn)

 	valueflag, okay := common.ValueType_Type_value[string(options.Args.Valueflag)]
 	if !okay {
 		Error.Printf("Unknown valueflag %s\n", options.Args.Valueflag)
 	}

 	val := voltha.ValueSpecifier{Id: string(options.Args.Id), Value: common.ValueType_Type(valueflag)}

 	ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
 	defer cancel()

 	rv, err := client.GetExtValue(ctx, &val)
 	if err != nil {
 		Error.Printf("Error getting value on device Id %s,err=%s\n", options.Args.Id, ErrorToString(err))
 		return err
 	}

 	var rows []ReturnValueRow
 	for name, num := range common.ValueType_Type_value {
 		if num == 0 {
 			// EMPTY is not a real value
 			continue
 		}
 		if (rv.Error & uint32(num)) != 0 {
 			row := ReturnValueRow{Name: name, Result: "Error"}
 			rows = append(rows, row)
 		}
 		if (rv.Unsupported & uint32(num)) != 0 {
 			row := ReturnValueRow{Name: name, Result: "Unsupported"}
 			rows = append(rows, row)
 		}
 		if (rv.Set & uint32(num)) != 0 {
 			switch name {
 			case "DISTANCE":
 				row := ReturnValueRow{Name: name, Result: rv.Distance}
 				rows = append(rows, row)
 			default:
 				row := ReturnValueRow{Name: name, Result: "Unimplemented-in-voltctl"}
 				rows = append(rows, row)
 			}
 		}
 	}

 	outputFormat := CharReplacer.Replace(options.Format)
 	if outputFormat == "" {
 		outputFormat = GetCommandOptionWithDefault("device-value-get", "format", DEFAULT_DEVICE_VALUE_GET_FORMAT)
 	}

 	result := CommandResult{
 		Format:    format.Format(outputFormat),
 		OutputAs:  toOutputType(options.OutputAs),
 		NameLimit: options.NameLimit,
 		Data:      rows,
 	}
 	GenerateOutput(&result)
 	return nil
 }
	/*
	* Copyright 2019-present Ciena Corporation
	*
	* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.
	* You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/
	package commands

	import (
	"context"
	"fmt"
	"os"
	"strconv"
	"strings"

	"github.com/golang/protobuf/ptypes/empty"
	flags "github.com/jessevdk/go-flags"
	"github.com/opencord/voltctl/pkg/format"
	"github.com/opencord/voltha-protos/v3/go/common"
	"github.com/opencord/voltha-protos/v3/go/voltha"
	)

	const (
	DEFAULT_DEVICE_FORMAT = "table{{ .Id }}\t{{.Type}}\t{{.Root}}\t{{.ParentId}}\t{{.SerialNumber}}\t{{.AdminState}}\t{{.OperStatus}}\t{{.ConnectStatus}}\t{{.Reason}}"
	DEFAULT_DEVICE_PORTS_FORMAT = "table{{.PortNo}}\t{{.Label}}\t{{.Type}}\t{{.AdminState}}\t{{.OperStatus}}\t{{.DeviceId}}\t{{.Peers}}"
	DEFAULT_DEVICE_INSPECT_FORMAT = `ID: {{.Id}}
	TYPE: {{.Type}}
	ROOT: {{.Root}}
	PARENTID: {{.ParentId}}
	SERIALNUMBER: {{.SerialNumber}}
	VLAN: {{.Vlan}}
	ADMINSTATE: {{.AdminState}}
	OPERSTATUS: {{.OperStatus}}
	CONNECTSTATUS: {{.ConnectStatus}}`
	DEFAULT_DEVICE_VALUE_GET_FORMAT = "table{{.Name}}\t{{.Result}}"
	)

	type DeviceList struct {
	ListOutputOptions
	}

	type DeviceCreate struct {
	DeviceType string `short:"t" long:"devicetype" default:"" description:"Device type"`
	MACAddress string `short:"m" long:"macaddress" default:"" description:"MAC Address"`
	IPAddress string `short:"i" long:"ipaddress" default:"" description:"IP Address"`
	HostAndPort string `short:"H" long:"hostandport" default:"" description:"Host and port"`
	}

	type DeviceId string

	type PortNum uint32
	type ValueFlag string

	type DeviceDelete struct {
	Args struct {
	Ids []DeviceId `positional-arg-name:"DEVICE_ID" required:"yes"`
	} `positional-args:"yes"`
	}

	type DeviceEnable struct {
	Args struct {
	Ids []DeviceId `positional-arg-name:"DEVICE_ID" required:"yes"`
	} `positional-args:"yes"`
	}

	type DeviceDisable struct {
	Args struct {
	Ids []DeviceId `positional-arg-name:"DEVICE_ID" required:"yes"`
	} `positional-args:"yes"`
	}

	type DeviceReboot struct {
	Args struct {
	Ids []DeviceId `positional-arg-name:"DEVICE_ID" required:"yes"`
	} `positional-args:"yes"`
	}

	type DeviceFlowList struct {
	ListOutputOptions
	Args struct {
	Id DeviceId `positional-arg-name:"DEVICE_ID" required:"yes"`
	} `positional-args:"yes"`
	}

	type DevicePortList struct {
	ListOutputOptions
	Args struct {
	Id DeviceId `positional-arg-name:"DEVICE_ID" required:"yes"`
	} `positional-args:"yes"`
	}

	type DeviceInspect struct {
	OutputOptionsJson
	Args struct {
	Id DeviceId `positional-arg-name:"DEVICE_ID" required:"yes"`
	} `positional-args:"yes"`
	}

	type DevicePortEnable struct {
	Args struct {
	Id DeviceId `positional-arg-name:"DEVICE_ID" required:"yes"`
	PortId PortNum `positional-arg-name:"PORT_NUMBER" required:"yes"`
	} `positional-args:"yes"`
	}

	type DevicePortDisable struct {
	Args struct {
	Id DeviceId `positional-arg-name:"DEVICE_ID" required:"yes"`
	PortId PortNum `positional-arg-name:"PORT_NUMBER" required:"yes"`
	} `positional-args:"yes"`
	}

	type DeviceGetExtValue struct {
	ListOutputOptions
	Args struct {
	Id DeviceId `positional-arg-name:"DEVICE_ID" required:"yes"`
	Valueflag ValueFlag `positional-arg-name:"VALUE_FLAG" required:"yes"`
	} `positional-args:"yes"`
	}
	type DeviceOpts struct {
	List DeviceList `command:"list"`
	Create DeviceCreate `command:"create"`
	Delete DeviceDelete `command:"delete"`
	Enable DeviceEnable `command:"enable"`
	Disable DeviceDisable `command:"disable"`
	Flows DeviceFlowList `command:"flows"`
	Port struct {
	List DevicePortList `command:"list"`
	Enable DevicePortEnable `command:"enable"`
	Disable DevicePortDisable `command:"disable"`
	} `command:"port"`
	Inspect DeviceInspect `command:"inspect"`
	Reboot DeviceReboot `command:"reboot"`
	Value struct {
	Get DeviceGetExtValue `command:"get"`
	} `command:"value"`
	}

	var deviceOpts = DeviceOpts{}

	func RegisterDeviceCommands(parser *flags.Parser) {
	if _, err := parser.AddCommand("device", "device commands", "Commands to query and manipulate VOLTHA devices", &deviceOpts); err != nil {
	Error.Fatalf("Unexpected error while attempting to register device commands : %s", err)
	}
	}

	func (i *PortNum) Complete(match string) []flags.Completion {
	conn, err := NewConnection()
	if err != nil {
	return nil
	}
	defer conn.Close()

	client := voltha.NewVolthaServiceClient(conn)

	/*
	* The command line args when completing for PortNum will be a DeviceId
	* followed by one or more PortNums. So walk the argument list from the
	* end and find the first argument that is enable/disable as those are
	* the subcommands that come before the positional arguments. It would
	* be nice if this package gave us the list of optional arguments
	* already parsed.
	*/
	var deviceId string
	found:
	for i := len(os.Args) - 1; i >= 0; i -= 1 {
	switch os.Args[i] {
	case "enable":
	fallthrough
	case "disable":
	if len(os.Args) > i+1 {
	deviceId = os.Args[i+1]
	} else {
	return nil
	}
	break found
	default:
	}
	}

	if len(deviceId) == 0 {
	return nil
	}

	ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
	defer cancel()

	id := voltha.ID{Id: string(deviceId)}

	ports, err := client.ListDevicePorts(ctx, &id)
	if err != nil {
	return nil
	}

	list := make([]flags.Completion, 0)
	for _, item := range ports.Items {
	pn := strconv.FormatUint(uint64(item.PortNo), 10)
	if strings.HasPrefix(pn, match) {
	list = append(list, flags.Completion{Item: pn})
	}
	}

	return list
	}

	func (i *DeviceId) Complete(match string) []flags.Completion {
	conn, err := NewConnection()
	if err != nil {
	return nil
	}
	defer conn.Close()

	client := voltha.NewVolthaServiceClient(conn)

	ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
	defer cancel()

	devices, err := client.ListDevices(ctx, &empty.Empty{})
	if err != nil {
	return nil
	}

	list := make([]flags.Completion, 0)
	for _, item := range devices.Items {
	if strings.HasPrefix(item.Id, match) {
	list = append(list, flags.Completion{Item: item.Id})
	}
	}

	return list
	}

	func (options *DeviceList) Execute(args []string) error {

	conn, err := NewConnection()
	if err != nil {
	return err
	}
	defer conn.Close()

	client := voltha.NewVolthaServiceClient(conn)

	ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
	defer cancel()

	devices, err := client.ListDevices(ctx, &empty.Empty{})
	if err != nil {
	return err
	}

	outputFormat := CharReplacer.Replace(options.Format)
	if outputFormat == "" {
	outputFormat = GetCommandOptionWithDefault("device-list", "format", DEFAULT_DEVICE_FORMAT)
	}
	if options.Quiet {
	outputFormat = "{{.Id}}"
	}

	orderBy := options.OrderBy
	if orderBy == "" {
	orderBy = GetCommandOptionWithDefault("device-list", "order", "")
	}

	// Make sure json output prints an empty list, not "null"
	if devices.Items == nil {
	devices.Items = make([]*voltha.Device, 0)
	}

	result := CommandResult{
	Format: format.Format(outputFormat),
	Filter: options.Filter,
	OrderBy: orderBy,
	OutputAs: toOutputType(options.OutputAs),
	NameLimit: options.NameLimit,
	Data: devices.Items,
	}

	GenerateOutput(&result)
	return nil
	}

	func (options *DeviceCreate) Execute(args []string) error {

	device := voltha.Device{}
	if options.HostAndPort != "" {
	device.Address = &voltha.Device_HostAndPort{HostAndPort: options.HostAndPort}
	} else if options.IPAddress != "" {
	device.Address = &voltha.Device_Ipv4Address{Ipv4Address: options.IPAddress}
	}
	if options.MACAddress != "" {
	device.MacAddress = strings.ToLower(options.MACAddress)
	}
	if options.DeviceType != "" {
	device.Type = options.DeviceType
	}

	conn, err := NewConnection()
	if err != nil {
	return err
	}
	defer conn.Close()

	client := voltha.NewVolthaServiceClient(conn)

	ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
	defer cancel()

	createdDevice, err := client.CreateDevice(ctx, &device)
	if err != nil {
	return err
	}

	fmt.Printf("%s\n", createdDevice.Id)

	return nil
	}

	func (options *DeviceDelete) Execute(args []string) error {

	conn, err := NewConnection()
	if err != nil {
	return err
	}
	defer conn.Close()

	client := voltha.NewVolthaServiceClient(conn)

	var lastErr error
	for _, i := range options.Args.Ids {
	ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
	defer cancel()

	id := voltha.ID{Id: string(i)}

	_, err := client.DeleteDevice(ctx, &id)
	if err != nil {
	Error.Printf("Error while deleting '%s': %s\n", i, err)
	lastErr = err
	continue
	}
	fmt.Printf("%s\n", i)
	}

	if lastErr != nil {
	return NoReportErr
	}
	return nil
	}

	func (options *DeviceEnable) Execute(args []string) error {
	conn, err := NewConnection()
	if err != nil {
	return err
	}
	defer conn.Close()

	client := voltha.NewVolthaServiceClient(conn)

	var lastErr error
	for _, i := range options.Args.Ids {
	ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
	defer cancel()

	id := voltha.ID{Id: string(i)}

	_, err := client.EnableDevice(ctx, &id)
	if err != nil {
	Error.Printf("Error while enabling '%s': %s\n", i, err)
	lastErr = err
	continue
	}
	fmt.Printf("%s\n", i)
	}

	if lastErr != nil {
	return NoReportErr
	}
	return nil
	}

	func (options *DeviceDisable) Execute(args []string) error {
	conn, err := NewConnection()
	if err != nil {
	return err
	}
	defer conn.Close()

	client := voltha.NewVolthaServiceClient(conn)

	var lastErr error
	for _, i := range options.Args.Ids {
	ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
	defer cancel()

	id := voltha.ID{Id: string(i)}

	_, err := client.DisableDevice(ctx, &id)
	if err != nil {
	Error.Printf("Error while disabling '%s': %s\n", i, err)
	lastErr = err
	continue
	}
	fmt.Printf("%s\n", i)
	}

	if lastErr != nil {
	return NoReportErr
	}
	return nil
	}

	func (options *DeviceReboot) Execute(args []string) error {
	conn, err := NewConnection()
	if err != nil {
	return err
	}
	defer conn.Close()

	client := voltha.NewVolthaServiceClient(conn)

	var lastErr error
	for _, i := range options.Args.Ids {
	ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
	defer cancel()

	id := voltha.ID{Id: string(i)}

	_, err := client.RebootDevice(ctx, &id)
	if err != nil {
	Error.Printf("Error while rebooting '%s': %s\n", i, err)
	lastErr = err
	continue
	}
	fmt.Printf("%s\n", i)
	}

	if lastErr != nil {
	return NoReportErr
	}
	return nil
	}

	func (options *DevicePortList) Execute(args []string) error {

	conn, err := NewConnection()
	if err != nil {
	return err
	}
	defer conn.Close()

	client := voltha.NewVolthaServiceClient(conn)

	ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
	defer cancel()

	id := voltha.ID{Id: string(options.Args.Id)}

	ports, err := client.ListDevicePorts(ctx, &id)
	if err != nil {
	return err
	}

	outputFormat := CharReplacer.Replace(options.Format)
	if outputFormat == "" {
	outputFormat = GetCommandOptionWithDefault("device-ports", "format", DEFAULT_DEVICE_PORTS_FORMAT)
	}
	if options.Quiet {
	outputFormat = "{{.Id}}"
	}

	orderBy := options.OrderBy
	if orderBy == "" {
	orderBy = GetCommandOptionWithDefault("device-ports", "order", "")
	}

	result := CommandResult{
	Format: format.Format(outputFormat),
	Filter: options.Filter,
	OrderBy: orderBy,
	OutputAs: toOutputType(options.OutputAs),
	NameLimit: options.NameLimit,
	Data: ports.Items,
	}

	GenerateOutput(&result)
	return nil
	}

	func (options *DeviceFlowList) Execute(args []string) error {
	fl := &FlowList{}
	fl.ListOutputOptions = options.ListOutputOptions
	fl.Args.Id = string(options.Args.Id)
	fl.Method = "device-flows"
	return fl.Execute(args)
	}

	func (options *DeviceInspect) Execute(args []string) error {
	if len(args) > 0 {
	return fmt.Errorf("only a single argument 'DEVICE_ID' can be provided")
	}

	conn, err := NewConnection()
	if err != nil {
	return err
	}
	defer conn.Close()

	client := voltha.NewVolthaServiceClient(conn)

	ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
	defer cancel()

	id := voltha.ID{Id: string(options.Args.Id)}

	device, err := client.GetDevice(ctx, &id)
	if err != nil {
	return err
	}

	outputFormat := CharReplacer.Replace(options.Format)
	if outputFormat == "" {
	outputFormat = GetCommandOptionWithDefault("device-inspect", "format", DEFAULT_DEVICE_INSPECT_FORMAT)
	}
	if options.Quiet {
	outputFormat = "{{.Id}}"
	}

	result := CommandResult{
	Format: format.Format(outputFormat),
	OutputAs: toOutputType(options.OutputAs),
	NameLimit: options.NameLimit,
	Data: device,
	}
	GenerateOutput(&result)
	return nil
	}

	/Device Port Enable /
	func (options *DevicePortEnable) Execute(args []string) error {
	conn, err := NewConnection()
	if err != nil {
	return err
	}
	defer conn.Close()

	client := voltha.NewVolthaServiceClient(conn)

	ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
	defer cancel()

	port := voltha.Port{DeviceId: string(options.Args.Id), PortNo: uint32(options.Args.PortId)}

	_, err = client.EnablePort(ctx, &port)
	if err != nil {
	Error.Printf("Error enabling port number %v on device Id %s,err=%s\n", options.Args.PortId, options.Args.Id, ErrorToString(err))
	return err
	}

	return nil
	}

	/Device Port Disable /
	func (options *DevicePortDisable) Execute(args []string) error {
	conn, err := NewConnection()
	if err != nil {
	return err
	}
	defer conn.Close()

	client := voltha.NewVolthaServiceClient(conn)

	ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
	defer cancel()

	port := voltha.Port{DeviceId: string(options.Args.Id), PortNo: uint32(options.Args.PortId)}

	_, err = client.DisablePort(ctx, &port)
	if err != nil {
	Error.Printf("Error enabling port number %v on device Id %s,err=%s\n", options.Args.PortId, options.Args.Id, ErrorToString(err))
	return err
	}

	return nil
	}

	type ReturnValueRow struct {
	Name string `json:"name"`
	Result interface{} `json:"result"`
	}

	/Device get Onu Distance /
	func (options *DeviceGetExtValue) Execute(args []string) error {
	conn, err := NewConnection()
	if err != nil {
	return err
	}
	defer conn.Close()

	client := voltha.NewVolthaServiceClient(conn)

	valueflag, okay := common.ValueType_Type_value[string(options.Args.Valueflag)]
	if !okay {
	Error.Printf("Unknown valueflag %s\n", options.Args.Valueflag)
	}

	val := voltha.ValueSpecifier{Id: string(options.Args.Id), Value: common.ValueType_Type(valueflag)}

	ctx, cancel := context.WithTimeout(context.Background(), GlobalConfig.Grpc.Timeout)
	defer cancel()

	rv, err := client.GetExtValue(ctx, &val)
	if err != nil {
	Error.Printf("Error getting value on device Id %s,err=%s\n", options.Args.Id, ErrorToString(err))
	return err
	}

	var rows []ReturnValueRow
	for name, num := range common.ValueType_Type_value {
	if num == 0 {
	// EMPTY is not a real value
	continue
	}
	if (rv.Error & uint32(num)) != 0 {
	row := ReturnValueRow{Name: name, Result: "Error"}
	rows = append(rows, row)
	}
	if (rv.Unsupported & uint32(num)) != 0 {
	row := ReturnValueRow{Name: name, Result: "Unsupported"}
	rows = append(rows, row)
	}
	if (rv.Set & uint32(num)) != 0 {
	switch name {
	case "DISTANCE":
	row := ReturnValueRow{Name: name, Result: rv.Distance}
	rows = append(rows, row)
	default:
	row := ReturnValueRow{Name: name, Result: "Unimplemented-in-voltctl"}
	rows = append(rows, row)
	}
	}
	}

	outputFormat := CharReplacer.Replace(options.Format)
	if outputFormat == "" {
	outputFormat = GetCommandOptionWithDefault("device-value-get", "format", DEFAULT_DEVICE_VALUE_GET_FORMAT)
	}

	result := CommandResult{
	Format: format.Format(outputFormat),
	OutputAs: toOutputType(options.OutputAs),
	NameLimit: options.NameLimit,
	Data: rows,
	}
	GenerateOutput(&result)
	return nil
	}