openamt

Documentation

Index

• Constants
• type ActionResponse
• type CIRAConfig
• type Device
• type DeviceEnabledFeatures
• type DevicePowerState
• type Domain
• type Profile
• type ProfileWifiConfig
• type Service
  • func NewService() *Service
  • func (service *Service) Authorization(configuration portainer.OpenAMTConfiguration) (string, error)
  • func (service *Service) Configure(configuration portainer.OpenAMTConfiguration) error
  • func (service *Service) DeviceInformation(configuration portainer.OpenAMTConfiguration, deviceGUID string) (*portainer.OpenAMTDeviceInformation, error)
  • func (service *Service) EnableDeviceFeatures(configuration portainer.OpenAMTConfiguration, deviceGUID string, ...) (string, error)
  • func (service *Service) ExecuteDeviceAction(configuration portainer.OpenAMTConfiguration, deviceGUID string, action string) error

Constants

const (
	DefaultCIRAConfigName = "ciraConfigDefault"
	DefaultProfileName    = "profileAMTDefault"
)

Types

type ActionResponse

type ActionResponse struct {
	Body struct {
		ReturnValue    int    `json:"ReturnValue"`
		ReturnValueStr string `json:"ReturnValueStr"`
	} `json:"Body"`
}

type CIRAConfig

type CIRAConfig struct {
	ConfigName          string `json:"configName"`
	MPSServerAddress    string `json:"mpsServerAddress"`
	ServerAddressFormat int    `json:"serverAddressFormat"`
	CommonName          string `json:"commonName"`
	MPSPort             int    `json:"mpsPort"`
	Username            string `json:"username"`
	MPSRootCertificate  string `json:"mpsRootCertificate"`
	RegeneratePassword  bool   `json:"regeneratePassword"`
	AuthMethod          int    `json:"authMethod"`
}

type Device

type Device struct {
	GUID             string `json:"guid"`
	HostName         string `json:"hostname"`
	ConnectionStatus bool   `json:"connectionStatus"`
}

type DeviceEnabledFeatures

type DeviceEnabledFeatures struct {
	Redirection bool   `json:"redirection"`
	KVM         bool   `json:"KVM"`
	SOL         bool   `json:"SOL"`
	IDER        bool   `json:"IDER"`
	UserConsent string `json:"userConsent"`
}

type DevicePowerState

type DevicePowerState struct {
	State portainer.PowerState `json:"powerstate"`
}

type Domain

type Domain struct {
	DomainName                    string `json:"profileName"`
	DomainSuffix                  string `json:"domainSuffix"`
	ProvisioningCert              string `json:"provisioningCert"`
	ProvisioningCertPassword      string `json:"provisioningCertPassword"`
	ProvisioningCertStorageFormat string `json:"provisioningCertStorageFormat"`
}

type Profile

type Profile struct {
	ProfileName                string              `json:"profileName"`
	Activation                 string              `json:"activation"`
	CIRAConfigName             *string             `json:"ciraConfigName"`
	GenerateRandomAMTPassword  bool                `json:"generateRandomPassword"`
	AMTPassword                string              `json:"amtPassword"`
	GenerateRandomMEBxPassword bool                `json:"generateRandomMEBxPassword"`
	MEBXPassword               string              `json:"mebxPassword"`
	Tags                       []string            `json:"tags"`
	DHCPEnabled                bool                `json:"dhcpEnabled"`
	TenantId                   string              `json:"tenantId"`
	WIFIConfigs                []ProfileWifiConfig `json:"wifiConfigs"`
}

type ProfileWifiConfig

type ProfileWifiConfig struct {
	Priority    int    `json:"priority"`
	ProfileName string `json:"profileName"`
}

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service represents a service for managing an OpenAMT server.

func NewService

func NewService() *Service

NewService initializes a new service.

func (*Service) Authorization

func (service *Service) Authorization(configuration portainer.OpenAMTConfiguration) (string, error)

func (*Service) Configure

func (service *Service) Configure(configuration portainer.OpenAMTConfiguration) error

func (*Service) DeviceInformation

func (service *Service) DeviceInformation(configuration portainer.OpenAMTConfiguration, deviceGUID string) (*portainer.OpenAMTDeviceInformation, error)

func (*Service) EnableDeviceFeatures

func (service *Service) EnableDeviceFeatures(configuration portainer.OpenAMTConfiguration, deviceGUID string, features portainer.OpenAMTDeviceEnabledFeatures) (string, error)

func (*Service) ExecuteDeviceAction

func (service *Service) ExecuteDeviceAction(configuration portainer.OpenAMTConfiguration, deviceGUID string, action string) error