cmdhelp

Documentation

Index

• Variables
• func CronTriggerAvailableJobsString() string
• func ServoFwChannelAllowedValuesString() string
• func ServoSetupTypeAllowedValuesString() string

Variables

var (
	// ListPageSizeDesc description for List PageSize
	ListPageSizeDesc string = `number of items to get. The service may return fewer than this value.`

	//AddSwitchLongDesc long description for AddSwitchCmd
	AddSwitchLongDesc string = `` /* 437-byte string literal not displayed */

	// AddAssetLongDesc long description for AddAssetCmd
	AddAssetLongDesc string = `` /* 437-byte string literal not displayed */

	// UpdateAssetLongDesc long description for UpdateAssetCmd
	UpdateAssetLongDesc string = `` /* 267-byte string literal not displayed */

	// AddDUTLongDesc long description for AddDUTCmd
	AddDUTLongDesc string = `` /* 666-byte string literal not displayed */

	// AddLabstationLongDesc long description for AddLabstationCmd
	AddLabstationLongDesc string = `` /* 485-byte string literal not displayed */

	// UpdateLabstationLongDesc long description for UpdateLabstationCmd
	UpdateLabstationLongDesc string = `` /* 459-byte string literal not displayed */

	// DUTRegistrationFileText description for json file input
	DUTRegistrationFileText string = `` /* 2707-byte string literal not displayed */

	// DUTUpdateFileText description for json file input
	DUTUpdateFileText string = `` /* 3452-byte string literal not displayed */

	// LabstationRegistrationFileText description for json file input
	LabstationRegistrationFileText string = `` /* 1859-byte string literal not displayed */

	// LabstationUpdateFileText description for json file input
	LabstationUpdateFileText string = `` /* 1902-byte string literal not displayed */

	// UpdateDUTLongDesc long description for UpdateDUTCmd
	UpdateDUTLongDesc string = `` /* 1090-byte string literal not displayed */

	// UpdateSwitchLongDesc long description for UpdateSwitchCmd
	UpdateSwitchLongDesc string = `` /* 491-byte string literal not displayed */

	// ListSwitchLongDesc long description for ListSwitchCmd
	ListSwitchLongDesc string = `` /* 364-byte string literal not displayed */

	// SwitchFileText description for switch file input
	SwitchFileText string = `` /* 756-byte string literal not displayed */

	// VMFileText description for VM file input
	VMFileText string = `` /* 517-byte string literal not displayed */

	// ListVMLongDesc long description for ListVMCmd
	ListVMLongDesc string = `` /* 233-byte string literal not displayed */

	// ListKVMLongDesc long description for ListKVMCmd
	ListKVMLongDesc string = `` /* 332-byte string literal not displayed */

	// ListRPMLongDesc long description for ListRPMCmd
	ListRPMLongDesc string = `` /* 332-byte string literal not displayed */

	// ListDracLongDesc long description for ListDracCmd
	ListDracLongDesc string = `` /* 341-byte string literal not displayed */

	// ListNicLongDesc long description for ListNicCmd
	ListNicLongDesc string = `` /* 332-byte string literal not displayed */

	// AddMachineLongDesc long description for AddMachineCmd
	AddMachineLongDesc string = `` /* 627-byte string literal not displayed */

	// UpdateMachineLongDesc long description for UpdateMachineCmd
	UpdateMachineLongDesc string = `` /* 425-byte string literal not displayed */

	// ListMachineLongDesc long description for ListMachineCmd
	ListMachineLongDesc string = `` /* 178-byte string literal not displayed */

	// MachineRegistrationFileText description for machine registration file input
	MachineRegistrationFileText string = `` /* 2155-byte string literal not displayed */

	// AddAssetFileText description for asset file input for add asset cmd
	AddAssetFileText string = `` /* 1312-byte string literal not displayed */

	// AssetFileText description for asset file input
	AssetFileText string = `` /* 915-byte string literal not displayed */

	// MachineFileText description for machine file input
	MachineFileText string = `` /* 1168-byte string literal not displayed */

	// AddHostLongDesc long description for AddHostCmd
	AddHostLongDesc string = `` /* 587-byte string literal not displayed */

	// UpdateHostLongDesc long description for UpdateHostCmd
	UpdateHostLongDesc string = `` /* 731-byte string literal not displayed */

	// MachineLSEFileText description for machinelse/host file input
	MachineLSEFileText string = `` /* 4974-byte string literal not displayed */

	// ListHostLongDesc long description for ListHostCmd
	ListHostLongDesc string = `` /* 202-byte string literal not displayed */

	// AddMachineLSEPrototypeLongDesc long description for AddMachineLSEPrototypeCmd
	AddMachineLSEPrototypeLongDesc string = `` /* 258-byte string literal not displayed */

	// UpdateMachineLSEPrototypeLongDesc long description for UpdateMachineLSEPrototypeCmd
	UpdateMachineLSEPrototypeLongDesc string = `` /* 273-byte string literal not displayed */

	// ListMachineLSEPrototypeLongDesc long description for ListMachineLSEPrototypeCmd
	ListMachineLSEPrototypeLongDesc string = `` /* 375-byte string literal not displayed */

	// MachineLSEPrototypeFileText description for MachineLSEPrototype file input
	MachineLSEPrototypeFileText string = `` /* 718-byte string literal not displayed */

	// AddRackLSEPrototypeLongDesc long description for AddRackLSEPrototypeCmd
	AddRackLSEPrototypeLongDesc string = `` /* 240-byte string literal not displayed */

	// UpdateRackLSEPrototypeLongDesc long description for UpdateRackLSEPrototypeCmd
	UpdateRackLSEPrototypeLongDesc string = `` /* 255-byte string literal not displayed */

	// ListRackLSEPrototypeLongDesc long description for ListRackLSEPrototypeCmd
	ListRackLSEPrototypeLongDesc string = `` /* 344-byte string literal not displayed */

	// RackLSEPrototypeFileText description for RackLSEPrototype file input
	RackLSEPrototypeFileText string = `` /* 558-byte string literal not displayed */

	// AddChromePlatformLongDesc long description for AddChromePlatformCmd
	AddChromePlatformLongDesc string = `` /* 376-byte string literal not displayed */

	// AddVlanLongDesc long description for AddVlanCmd
	AddVlanLongDesc string = `` /* 151-byte string literal not displayed */

	// UpdateChromePlatformLongDesc long description for UpdateChromePlatformCmd
	UpdateChromePlatformLongDesc string = `` /* 500-byte string literal not displayed */

	// ListChromePlatformLongDesc long description for ListChromePlatformCmd
	ListChromePlatformLongDesc string = `` /* 357-byte string literal not displayed */

	// UpdateVlanLongDesc long description for UpdateVlanCmd
	UpdateVlanLongDesc string = `` /* 414-byte string literal not displayed */

	// ListVlanLongDesc long description for ListVlanCmd
	ListVlanLongDesc string = `` /* 273-byte string literal not displayed */

	// ChromePlatformFileText description for ChromePlatform file input
	ChromePlatformFileText string = `` /* 514-byte string literal not displayed */

	// AddNicLongDesc long description for AddNicCmd
	AddNicLongDesc string = `` /* 411-byte string literal not displayed */

	// UpdateNicLongDesc long description for UpdateNicCmd
	UpdateNicLongDesc string = `` /* 433-byte string literal not displayed */

	// NicFileText description for nic file input
	NicFileText string = `` /* 476-byte string literal not displayed */

	// AddDracLongDesc long description for AddDracCmd
	AddDracLongDesc string = `` /* 420-byte string literal not displayed */

	// UpdateDracLongDesc long description for UpdateDracCmd
	UpdateDracLongDesc string = `` /* 583-byte string literal not displayed */

	// DracFileText description for drac file input
	DracFileText string = `` /* 552-byte string literal not displayed */

	// AddKVMLongDesc long description for AddKVMCmd
	AddKVMLongDesc string = `` /* 394-byte string literal not displayed */

	// UpdateKVMLongDesc long description for UpdateKVMCmd
	UpdateKVMLongDesc string = `` /* 544-byte string literal not displayed */

	// KVMFileText description for kvm file input
	KVMFileText string = `` /* 476-byte string literal not displayed */

	// AddRackLongDesc long description for AddRackCmd
	AddRackLongDesc string = `` /* 536-byte string literal not displayed */

	// UpdateRackLongDesc long description for UpdateRackCmd
	UpdateRackLongDesc string = `` /* 342-byte string literal not displayed */

	// ListRackLongDesc long description for ListRackCmd
	ListRackLongDesc string = `` /* 170-byte string literal not displayed */

	// RackRegistrationFileText description for rack registration file input
	RackRegistrationFileText string = `` /* 1839-byte string literal not displayed */

	// RackFileText description for rack file input
	RackFileText string = `` /* 676-byte string literal not displayed */

	// ZoneFilterHelpText help text for zone filters for list command
	ZoneFilterHelpText string = fmt.Sprintf("\nValid zone filters: [%s]\n", strings.Join(ufsUtil.ValidZoneStr(), ", "))

	// DeviceTypeFilterHelpText help text for devicetype filters for list command
	DeviceTypeFilterHelpText string = fmt.Sprintf("\nValid devicetype filters: [%s]\n", strings.Join(ufsUtil.ValidDeviceTypeStr(), ", "))

	// AssetTypesHelpText help text for asset type filters
	AssetTypesHelpText string = fmt.Sprintf("\nValid type filters [%s]", strings.Join(ufsUtil.ValidAssetTypeStr(), ", "))

	// StateFilterHelpText help text for state filters for list command
	StateFilterHelpText string = fmt.Sprintf("Valid state filters: [%s]\n", strings.Join(ufsUtil.ValidStateStr(), ", "))

	// DeploymentEnvFilterHelpText help text for deployment env filters for list command
	DeploymentEnvFilterHelpText string = fmt.Sprintf("\nValid deployment env filters: [%s]\n", strings.Join(ufsUtil.ValidDeploymentEnvStr(), ", "))

	// KeysOnlyText help text for keysOnly option
	KeysOnlyText string = `` /* 302-byte string literal not displayed */

	// StateHelp help text for filter '-state'
	StateHelp string = "the state to assign this entity to. Valid state strings: [" + strings.Join(ufsUtil.ValidStateStr(), ", ") + "]"

	//ClearFieldHelpText help text to clear field using field mask in update cmds
	ClearFieldHelpText string = "To clear this field and set it to empty, assign '" + utils.ClearFieldValue + "'"

	//ZoneHelpText help text for zone command line options
	ZoneHelpText string = fmt.Sprintf("the name of the zone. "+
		"You can either use the below strings or prefix \"ZONE_\" to the below strings(for JSON input) to specify the exact enum name. "+
		"Valid zone strings: [%s]", strings.Join(ufsUtil.ValidZoneStr(), ", "))

	//LicenseTypeHelpText help text for chameleontype command line options
	LicenseTypeHelpText string = fmt.Sprintf("the name of the license type. Can specify multiple comma separated values. "+
		"Valid LicenseType strings: [%s]", strings.Join(ufsUtil.ValidLicenseTypeStr(), ", "))

	//ChameleonTypeHelpText help text for chameleontype command line options
	ChameleonTypeHelpText string = fmt.Sprintf("the name of the chameleontype. Can specify multiple comma separated values. "+
		"Valid ChameleonType strings: [%s]", strings.Join(ufsUtil.ValidChameleonTypeStr(), ", "))

	//CameraTypeHelpText help text for cameratype command line options
	CameraTypeHelpText string = fmt.Sprintf("the name of the cameratype. Can specify multiple comma separated values. "+
		"Valid CameraType strings: [%s]", strings.Join(ufsUtil.ValidCameraTypeStr(), ", "))

	//AntennaConnectionHelpText help text for antennaconnection command line options
	AntennaConnectionHelpText string = fmt.Sprintf("the name of the wifi antennaconnection. "+
		"Valid AntennaConnection strings: [%s]", strings.Join(ufsUtil.ValidAntennaConnectionStr(), ", "))

	//RouterHelpText help text for router command line options
	RouterHelpText string = fmt.Sprintf("the name of the wifi router. "+
		"Valid Router strings: [%s]", strings.Join(ufsUtil.ValidRouterStr(), ", "))

	//FacingHelpText help text for facing command line options
	FacingHelpText string = fmt.Sprintf("the name of the camerabox info facing. "+
		"Valid Facing strings: [%s]", strings.Join(ufsUtil.ValidFacingStr(), ", "))

	//LightHelpText help text for light command line options
	LightHelpText string = fmt.Sprintf("the name of the camerabox info light. "+
		"Valid Light strings: [%s]", strings.Join(ufsUtil.ValidLightStr(), ", "))

	//CableTypeHelpText help text for cabletype command line options
	CableTypeHelpText string = fmt.Sprintf("the name of the cabletype. Can specify multiple comma separated values. "+
		"Valid CableType strings: [%s]", strings.Join(ufsUtil.ValidCableTypeStr(), ", "))

	// SchedulingUnitTypesHelpText help text for asset type filters
	SchedulingUnitTypesHelpText string = fmt.Sprintf("\nValid type filters [%s]", strings.Join(ufsUtil.ValidSchedulingUnitTypeStr(), ", "))

	// AddRPMLongDesc long description for AddRPMCmd
	AddRPMLongDesc string = `` /* 408-byte string literal not displayed */

	// UpdateRPMLongDesc long description for UpdateRPMCmd
	UpdateRPMLongDesc string = `` /* 523-byte string literal not displayed */

	// RPMFileText description for rpm file input
	RPMFileText string = `` /* 787-byte string literal not displayed */

	// GetStableVersionText description for GetStableVersionCmd
	GetStableVersionText string = `` /* 258-byte string literal not displayed */

	//AddCachingServiceLongDesc long description for AddCachingServiceCmd
	AddCachingServiceLongDesc string = `` /* 438-byte string literal not displayed */

	// UpdateCachingServiceLongDesc long description for UpdateCachingServiceCmd
	UpdateCachingServiceLongDesc string = `` /* 346-byte string literal not displayed */

	// CachingServiceFileText description for CachingService file input
	CachingServiceFileText string = `` /* 949-byte string literal not displayed */

	// CachingServiceUpdateFileText description for CachingService file input
	CachingServiceUpdateFileText string = `` /* 570-byte string literal not displayed */

	//AddSchedulingUnitLongDesc long description for AddSchedulingUnitCmd
	AddSchedulingUnitLongDesc string = `` /* 398-byte string literal not displayed */

	// SchedulingUnitFileText description for SchedulingUnit file input
	SchedulingUnitFileText string = `` /* 830-byte string literal not displayed */

	// UpdateSchedulingUnitLongDesc long description for UpdateSchedulingUnitCmd
	UpdateSchedulingUnitLongDesc string = `` /* 384-byte string literal not displayed */

	// SchedulingUnitUpdateFileText description for SchedulingUnit file input
	SchedulingUnitUpdateFileText string = `` /* 587-byte string literal not displayed */

	TriggerCronDescription string = `Triggers a cron job on UFS. Available jobs: ` + CronTriggerAvailableJobsString()
)

Functions

func CronTriggerAvailableJobsString

func CronTriggerAvailableJobsString() string

func ServoFwChannelAllowedValuesString

func ServoFwChannelAllowedValuesString() string

ServoFwChannelAllowedValuesString returns a string description of all allowed values for servo firmware channel.

func ServoSetupTypeAllowedValuesString

func ServoSetupTypeAllowedValuesString() string

ServoSetupTypeAllowedValuesString returns a string description of all allowed values for servo setup type.