dto

package
v1.19.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 22, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const (
	ServerAddressFormatIPv4 = 3
	ServerAddressFormatIPv6 = 4
	ServerAddressFormatURL  = 201
)
View Source
const (
	LinkPreferenceME   = 1 // Management Engine
	LinkPreferenceHost = 2 // Host
)

LinkPreference enumeration values.

View Source
const ReturnValueNoWiFiPort = -1

Console-specific return value for no WiFi interface found.

Variables

View Source
var ValidateAMTPassOrGenRan validator.Func = func(fl validator.FieldLevel) bool {
	amtPass := fl.Parent().FieldByName("AMTPassword").String()

	return amtPass == ""
}
View Source
var ValidateAuthandIEEE validator.Func = func(fl validator.FieldLevel) bool {
	authMethod, _ := fl.Parent().FieldByName("AuthenticationMethod").Interface().(int)
	profName, _ := fl.Parent().FieldByName("IEEE8021xProfileName").Interface().(*string)
	if authMethod == 5 || authMethod == 7 {
		if profName == nil || *profName == "" {
			return false
		}
	}

	if authMethod == 4 || authMethod == 6 {
		if profName != nil && *profName != "" {
			return false
		}
	}

	return true
}
View Source
var ValidateCIRAOrTLS validator.Func = func(fl validator.FieldLevel) bool {
	ciraConfigField := fl.Parent().FieldByName("CIRAConfigName")
	tlsModeField := fl.Parent().FieldByName("TLSMode")

	ciraConfigName, _ := ciraConfigField.Interface().(*string)
	tlsMode, _ := tlsModeField.Interface().(int)

	if ciraConfigName != nil && *ciraConfigName != "" && tlsMode != 0 {
		return false
	}

	return true
}
View Source
var ValidateUserConsent validator.Func = func(fl validator.FieldLevel) bool {
	userConsent := strings.ToLower(fl.Field().String())
	activation := fl.Parent().FieldByName("Activation").String()
	if activation == "ccmactivate" && userConsent != "All" {
		return false
	}

	return userConsent == "none" || userConsent == "kvm" || userConsent == "all"
}

Functions

func AuthProtocolValidator

func AuthProtocolValidator(fl validator.FieldLevel) bool

func ValidateAlphaNumHyphenUnderscore added in v1.14.0

func ValidateAlphaNumHyphenUnderscore(fl validator.FieldLevel) bool

ValidateAlphaNumHyphenUnderscore validates that a field contains only alphanumeric characters, hyphens, and underscores.

Types

type AddAlarmOutput

type AddAlarmOutput struct {
	ReturnValue int `json:"ReturnValue" example:"0"` // Return code. 0 indicates success
}

type AlarmClockOccurrence

type AlarmClockOccurrence struct {
	ElementName        string    `json:"ElementName" binding:"required" example:"test"`
	InstanceID         string    `json:"InstanceID" binding:"" example:"test"`
	StartTime          StartTime `json:"StartTime" binding:"required"`
	Interval           int       `json:"Interval" default:"0" example:"1"`
	IntervalInMinutes  int       `json:"IntervalInMinutes" example:"1"`
	DeleteOnCompletion bool      `json:"DeleteOnCompletion" binding:"" example:"true"`
}

type AlarmClockOccurrenceInput

type AlarmClockOccurrenceInput struct {
	ElementName        string    `json:"ElementName" binding:"required" example:"test"`
	InstanceID         string    `json:"InstanceID" binding:"" example:"test"`
	StartTime          time.Time `json:"StartTime" binding:"required"`
	Interval           int       `json:"Interval" default:"0" example:"1"`
	DeleteOnCompletion bool      `json:"DeleteOnCompletion" binding:"" example:"true"`
}

type AuditLog

type AuditLog struct {
	TotalCount int                       `json:"totalCnt" binding:"required" example:"0"`
	Records    []auditlog.AuditLogRecord `json:"records" binding:"required"`
}

type BootDetails

type BootDetails struct {
	URL               string `json:"url" example:"https://"`
	Username          string `json:"username" example:"admin"`
	Password          string `json:"password" example:"password"`
	BootPath          string `json:"bootPath" example:"\\OemPba.efi"`
	EnforceSecureBoot bool   `json:"enforceSecureBoot" example:"true"`
}

type BootParams added in v1.9.0

type BootParams struct {
	BIOSBootString string `json:"biosBootString" example:"string"`
	BootString     string `json:"bootString" example:"string"`
	InstanceID     string `json:"instanceID" example:"string"`
}

type BootSetting

type BootSetting struct {
	Action      int         `json:"action" binding:"required" example:"8"`
	BootDetails BootDetails `json:"bootDetails" binding:"omitempty"`
	UseSOL      bool        `json:"useSOL" binding:"omitempty,required" example:"true"`
}

type BootSettings added in v1.9.0

type BootSettings struct {
	IsHTTPSBootExists bool `json:"isHTTPSBootExists" example:"true"`
	IsPBAExists       bool `json:"isPBAExists" example:"true"`
	IsWinREExists     bool `json:"isWinREExists" example:"true"`
}

type BootSources added in v1.9.0

type BootSources struct {
	BIOSBootString       string `json:"biosBootString" example:"string"`
	BootString           string `json:"bootString" example:"string"`
	ElementName          string `json:"elementName" example:"Intel® AMT: Boot Source"`
	FailThroughSupported int    `json:"failThroughSupported" example:"2"`
	InstanceID           string `json:"instanceID" example:"Intel® AMT: Force Hard-drive Boot"`
	StructuredBootString string `json:"structuredBiosBootString" example:"CIM:Hard-Disk:1"`
}

type CIMResponse added in v1.13.0

type CIMResponse struct {
	Response  interface{}   `json:"response,omitempty"`
	Responses []interface{} `json:"responses,omitempty"`
	Status    int           `json:"status,omitempty"`
}

type CIRAConfig

type CIRAConfig struct {
	ConfigName             string `json:"configName" example:"My CIRA Config"`
	MPSAddress             string `json:"mpsServerAddress" binding:"required,url|ipv4|ipv6" example:"https://example.com"`
	MPSPort                int    `json:"mpsPort" binding:"required,gt=1024,lt=49151" example:"4433"`
	Username               string `json:"username" binding:"required,alphanum" example:"my_username"`
	Password               string `json:"password,omitempty" example:"my_password"`
	CommonName             string `json:"commonName" binding:"required_if=ServerAddressFormat 3" example:"example.com"`
	ServerAddressFormat    int    `json:"serverAddressFormat" binding:"required,oneof=3 4 201" example:"201"` // 3 = IPV4, 4= IPV6, 201 = FQDN
	AuthMethod             int    `json:"authMethod" binding:"required,oneof=1 2" example:"2"`                // 1 = Mutal Auth, 2 = Username and Password
	MPSRootCertificate     string `json:"mpsRootCertificate" binding:"required" example:"-----BEGIN CERTIFICATE-----\n..."`
	ProxyDetails           string `json:"proxyDetails" example:"http://example.com"`
	TenantID               string `json:"tenantId" example:"abc123"`
	GenerateRandomPassword bool   `json:"generateRandomPassword" example:"true"`
	Version                string `json:"version,omitempty" example:"1.0.0"`
}

type CIRAConfigCountResponse added in v1.12.0

type CIRAConfigCountResponse struct {
	Count int          `json:"totalCount"`
	Data  []CIRAConfig `json:"data"`
}

type CertCreationResult

type CertCreationResult struct {
	H             string `json:"h:"`
	Cert          string `json:"cert"`
	PEM           string `json:"pem"`
	CertBin       string `json:"certBin"`
	PrivateKey    string `json:"privateKey"`
	PrivateKeyBin string `json:"privateKeyBin"`
	Checked       bool   `json:"checked" example:"true"`
	Key           []byte `json:"key"`
}

type CertInfo

type CertInfo struct {
	Cert      string `json:"cert" binding:"required" example:"-----BEGIN CERTIFICATE-----\n..."`
	IsTrusted bool   `json:"isTrusted" example:"true"`
}

type Certificate

type Certificate struct {
	GUID               string    `json:"guid"`
	CommonName         string    `json:"commonName"`
	IssuerName         string    `json:"issuerName"`
	SerialNumber       string    `json:"serialNumber"`
	NotBefore          time.Time `json:"notBefore"`
	NotAfter           time.Time `json:"notAfter"`
	DNSNames           []string  `json:"dnsNames"`
	SHA1Fingerprint    string    `json:"sha1Fingerprint"`
	SHA256Fingerprint  string    `json:"sha256Fingerprint"`
	PublicKeyAlgorithm string    `json:"publicKeyAlgorithm"`
	PublicKeySize      int       `json:"publicKeySize"`
}

type CertificatePullResponse

type CertificatePullResponse struct {
	KeyManagementItems []RefinedKeyManagementResponse `json:"keyManagementItems,omitempty"`
	Certificates       []RefinedCertificate           `json:"publicKeyCertificateItems,omitempty"`
}

type Credentials

type Credentials struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

type DeleteAlarmOccurrenceRequest

type DeleteAlarmOccurrenceRequest struct {
	Name string `json:"Name" binding:"required" example:"test"`
}

type DeleteCertificateRequest added in v1.14.0

type DeleteCertificateRequest struct {
	InstanceID string `json:"instanceID" binding:"required" example:"cert-instance-123"`
}

type Device

type Device struct {
	ConnectionStatus bool        `json:"connectionStatus"`
	MPSInstance      string      `json:"mpsInstance"`
	Hostname         string      `json:"hostname"`
	GUID             string      `json:"guid"`
	MPSUsername      string      `json:"mpsusername"`
	Tags             []string    `json:"tags"`
	TenantID         string      `json:"tenantId"`
	FriendlyName     string      `json:"friendlyName"`
	DNSSuffix        string      `json:"dnsSuffix"`
	LastConnected    *time.Time  `json:"lastConnected,omitempty"`
	LastSeen         *time.Time  `json:"lastSeen,omitempty"`
	LastDisconnected *time.Time  `json:"lastDisconnected,omitempty"`
	DeviceInfo       *DeviceInfo `json:"deviceInfo,omitempty"`
	Username         string      `json:"username" binding:"max=16"`
	Password         string      `json:"password"`
	MPSPassword      string      `json:"mpspassword"`
	MEBXPassword     string      `json:"mebxpassword"`
	UseTLS           bool        `json:"useTLS"`
	AllowSelfSigned  bool        `json:"allowSelfSigned"`
	CertHash         string      `json:"certHash"`
}

type DeviceCountResponse added in v1.12.0

type DeviceCountResponse struct {
	Count int      `json:"totalCount"`
	Data  []Device `json:"data"`
}

type DeviceInfo

type DeviceInfo struct {
	FWVersion   string    `json:"fwVersion"`
	FWBuild     string    `json:"fwBuild"`
	FWSku       string    `json:"fwSku"`
	CurrentMode string    `json:"currentMode"`
	Features    string    `json:"features"`
	IPAddress   string    `json:"ipAddress"`
	LastUpdated time.Time `json:"lastUpdated"`
}

type DeviceStatResponse added in v1.12.0

type DeviceStatResponse struct {
	TotalCount        int `json:"totalCount"`
	ConnectedCount    int `json:"connectedCount"`
	DisconnectedCount int `json:"disconnectedCount"`
}

type DiskInfo added in v1.13.0

type DiskInfo struct {
	CIMMediaAccessDevice CIMResponse `json:"CIM_MediaAccessDevice,omitempty"`
	CIMPhysicalPackage   CIMResponse `json:"CIM_PhysicalPackage,omitempty"`
}

type Domain

type Domain struct {
	// ProfileName is the unique identifier for the domain profile.
	// Only alphanumeric characters, hyphens (-), and underscores (_) are allowed.
	// Spaces are not permitted.
	ProfileName                   string    `json:"profileName" binding:"required,alphanumhyphenunderscore" example:"my-profile_1"`
	DomainSuffix                  string    `json:"domainSuffix" binding:"required" example:"example.com"`
	ProvisioningCert              string    `json:"provisioningCert,omitempty" binding:"required" example:"-----BEGIN CERTIFICATE-----\n..."`
	ProvisioningCertStorageFormat string    `json:"provisioningCertStorageFormat" binding:"required,oneof=raw string" example:"string"`
	ProvisioningCertPassword      string    `json:"provisioningCertPassword,omitempty" binding:"required,lte=64" example:"my_password"`
	ExpirationDate                time.Time `json:"expirationDate,omitempty" example:"2022-01-01T00:00:00Z"`
	TenantID                      string    `json:"tenantId" example:"abc123"`
	Version                       string    `json:"version,omitempty" example:"1.0.0"`
}

type EventLog

type EventLog struct {
	DeviceAddress   int    `json:"DeviceAddress"`
	EventSensorType int    `json:"EventSensorType"`
	EventType       int    `json:"EventType"`
	EventOffset     int    `json:"EventOffset"`
	EventSourceType int    `json:"EventSourceType"`
	EventSeverity   string `json:"EventSeverity"`
	SensorNumber    int    `json:"SensorNumber"`
	Entity          string `json:"Entity"`
	EntityInstance  int    `json:"EntityInstance"`
	EventData       []int  `json:"EventData"`
	Time            string `json:"Time"`
	EntityStr       string `json:"EntityStr"`
	Description     string `json:"Desc"`
	EventTypeDesc   string `json:"eventTypeDesc"`
}

type EventLogs

type EventLogs struct {
	Records        []EventLog `json:"records"`
	HasMoreRecords bool       `json:"hasMoreRecords"`
}

EventLog defines the structure of an event log.

type Explorer

type Explorer struct {
	XMLInput  string `json:"xmlInput"`
	XMLOutput string `json:"xmlOutput"`
}

type Features

type Features struct {
	UserConsent           string `json:"userConsent" example:"kvm"`
	EnableSOL             bool   `json:"enableSOL" example:"true"`
	EnableIDER            bool   `json:"enableIDER" example:"true"`
	EnableKVM             bool   `json:"enableKVM" example:"true"`
	Redirection           bool   `json:"redirection" example:"true"`
	OptInState            int    `json:"optInState" example:"0"`
	KVMAvailable          bool   `json:"kvmAvailable" example:"true"`
	OCR                   bool   `json:"ocr" example:"true"`
	HTTPSBootSupported    bool   `json:"httpsBootSupported" example:"true"`
	WinREBootSupported    bool   `json:"winREBootSupported" example:"true"`
	LocalPBABootSupported bool   `json:"localPBABootSupported" example:"true"`
	RemoteErase           bool   `json:"remoteErase" example:"true"`
}

type FeaturesRequest

type FeaturesRequest struct {
	UserConsent string `json:"userConsent" example:"kvm"`
	EnableSOL   bool   `json:"enableSOL" example:"true"`
	EnableIDER  bool   `json:"enableIDER" example:"true"`
	EnableKVM   bool   `json:"enableKVM" example:"true"`
	OCR         bool   `json:"ocr" example:"true"`
	RemoteErase bool   `json:"remoteErase" example:"true"`
}

type GeneralSettings added in v1.13.0

type GeneralSettings struct {
	Header interface{} `json:"header,omitempty"`
	Body   interface{} `json:"body,omitempty"`
}

type GetFeaturesResponse added in v1.14.1

type GetFeaturesResponse struct {
	Redirection           bool   `json:"redirection" binding:"required" example:"true"`
	KVM                   bool   `json:"KVM" binding:"required" example:"true"`
	SOL                   bool   `json:"SOL" binding:"required" example:"true"`
	IDER                  bool   `json:"IDER" binding:"required" example:"true"`
	OptInState            int    `json:"optInState" binding:"required" example:"0"`
	UserConsent           string `json:"userConsent" binding:"required" example:"none"`
	KVMAvailable          bool   `json:"kvmAvailable" binding:"required" example:"true"`
	OCR                   bool   `json:"ocr" binding:"required" example:"false"`
	HTTPSBootSupported    bool   `json:"httpsBootSupported" binding:"required" example:"false"`
	WinREBootSupported    bool   `json:"winREBootSupported" binding:"required" example:"false"`
	LocalPBABootSupported bool   `json:"localPBABootSupported" binding:"required" example:"false"`
	RemoteErase           bool   `json:"remoteErase" binding:"required" example:"false"`
}

type HardwareInfo added in v1.13.0

type HardwareInfo struct {
	CIMComputerSystemPackage CIMResponse `json:"CIM_ComputerSystemPackage,omitempty"`
	CIMSystemPackaging       CIMResponse `json:"CIM_SystemPackaging,omitempty"`
	CIMChassis               CIMResponse `json:"CIM_Chassis,omitempty"`
	CIMChip                  CIMResponse `json:"CIM_Chip,omitempty"`
	CIMCard                  CIMResponse `json:"CIM_Card,omitempty"`
	CIMBIOSElement           CIMResponse `json:"CIM_BIOSElement,omitempty"`
	CIMProcessor             CIMResponse `json:"CIM_Processor,omitempty"`
	CIMPhysicalMemory        CIMResponse `json:"CIM_PhysicalMemory,omitempty"`
}

type IEEE8021x

type IEEE8021x struct {
	Enabled       string `json:"enabled"`
	AvailableInS0 bool   `json:"availableInS0"`
	PxeTimeout    int    `json:"pxeTimeout"`
}

type IEEE8021xConfig

type IEEE8021xConfig struct {
	ProfileName            string `json:"profileName" binding:"required,max=32,alphanum" example:"My Profile"`
	AuthenticationProtocol int    `json:"authenticationProtocol" binding:"authProtocolValidator" example:"1"`
	PXETimeout             *int   `json:"pxeTimeout" binding:"required,number,gte=0,lte=86400" example:"60"`
	WiredInterface         bool   `json:"wiredInterface" example:"false"`
	TenantID               string `json:"tenantId" example:"abc123"`
	Version                string `json:"version,omitempty" example:"1.0.0"`
}

type IEEE8021xConfigCountResponse added in v1.12.0

type IEEE8021xConfigCountResponse struct {
	Count int               `json:"totalCount"`
	Data  []IEEE8021xConfig `json:"data"`
}

type IEEE8021xSettings

type IEEE8021xSettings struct {
	AuthenticationProtocol          int    `json:"authenticationProtocol"`
	RoamingIdentity                 string `json:"roamingIdentity"`
	ServerCertificateName           string `json:"serverCertificateName"`
	ServerCertificateNameComparison int    `json:"serverCertificateNameComparison"`
	Username                        string `json:"username"`
	Password                        string `json:"password"`
	Domain                          string `json:"domain"`
	ProtectedAccessCredential       string `json:"protectedAccessCredential"`
	PACPassword                     string `json:"pacPassword"`
	PSK                             string `json:"psk"`
}

type KVMScreenDisplay added in v1.10.0

type KVMScreenDisplay struct {
	DisplayIndex int    `json:"displayIndex"`
	IsActive     bool   `json:"isActive"`
	ResolutionX  int    `json:"resolutionX"`
	ResolutionY  int    `json:"resolutionY"`
	UpperLeftX   int    `json:"upperLeftX"`
	UpperLeftY   int    `json:"upperLeftY"`
	Role         string `json:"role,omitempty"` // primary, secondary, tertiary, quaternary
	IsDefault    bool   `json:"isDefault"`
}

KVMScreenDisplay represents one display's status and geometry.

type KVMScreenSettings added in v1.10.0

type KVMScreenSettings struct {
	Displays []KVMScreenDisplay `json:"displays"`
}

KVMScreenSettings represents a simplified view of IPS_ScreenSettingData Displays contains a flattened view across all returned ScreenSettingData items.

type KVMScreenSettingsRequest added in v1.10.0

type KVMScreenSettingsRequest struct {
	DisplayIndex int `json:"displayIndex,omitempty"`
}

KVMScreenSettingsRequest allows updating screen settings; schema may vary by platform. Keep it generic for now until wsman Put support exists.

type Key

type Key struct {
	ElementName       string `json:"elementName,omitempty"`
	InstanceID        string `json:"instanceID,omitempty"`
	DERKey            string `json:"derKey,omitempty"`
	CertificateHandle string `json:"certificateHandle,omitempty"`
}

type KeyPullResponse

type KeyPullResponse struct {
	Keys []Key `json:"publicPrivateKeyPairItems,omitempty"`
}

type LinkPreferenceRequest added in v1.17.0

type LinkPreferenceRequest struct {
	LinkPreference uint32 `json:"linkPreference" binding:"required,min=1,max=2"` // 1 for ME, 2 for HOST
	Timeout        uint32 `json:"timeout" binding:"required,min=0,max=65535"`    // Timeout in seconds
}

LinkPreferenceRequest represents the request to set link preference on a device.

type LinkPreferenceResponse added in v1.17.0

type LinkPreferenceResponse struct {
	ReturnValue int `json:"returnValue" example:"0"` // Return code. 0 indicates success, -1 for no WiFi interface
}

LinkPreferenceResponse represents the response from setting link preference.

type NetworkInfo

type NetworkInfo struct {
	ElementName                  string   `json:"elementName"`                            // The user-friendly name for this instance of SettingData. In addition, the user-friendly name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.)
	InstanceID                   string   `json:"instanceID"`                             // Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class.
	VLANTag                      int      `json:"vlanTag"`                                // Indicates whether VLAN is in use and what is the VLAN tag when used.
	SharedMAC                    bool     `json:"sharedMAC"`                              // Indicates whether Intel® AMT shares it's MAC address with the host system.
	MACAddress                   string   `json:"macAddress"`                             // The MAC address used by Intel® AMT in a string format. For Example: 01-02-3f-b0-99-99. (This property can only be read and can't be changed.)
	LinkIsUp                     bool     `json:"linkIsUp"`                               // Indicates whether the network link is up
	LinkPolicy                   []string `json:"linkPolicy"`                             // Enumeration values for link policy restrictions for better power consumption. If Intel® AMT will not be able to determine the exact power state, the more restrictive closest configuration applies.
	LinkPreference               string   `json:"linkPreference,omitempty"`               // Determines whether the link is preferred to be owned by ME or host
	LinkControl                  string   `json:"linkControl,omitempty"`                  // Determines whether the link is owned by ME or host.  Additional Notes: This property is read-only.
	SharedStaticIP               bool     `json:"sharedStaticIP"`                         // Indicates whether the static host IP is shared with ME.
	SharedDynamicIP              bool     `json:"sharedDynamicIP"`                        // Indicates whether the dynamic host IP is shared with ME. This property is read only.
	IPSyncEnabled                bool     `json:"ipSyncEnabled"`                          // Indicates whether the IP synchronization between host and ME is enabled.
	DHCPEnabled                  bool     `json:"dhcpEnabled"`                            // Indicates whether DHCP is in use. Additional Notes: 'DHCPEnabled' is a required field for the Put command.
	IPAddress                    string   `json:"ipAddress"`                              // String representation of IP address. Get operation - reports the acquired IP address (whether in static or DHCP mode). Put operation - sets the IP address (in static mode only).
	SubnetMask                   string   `json:"subnetMask"`                             // Subnet mask in a string format.For example: 255.255.0.0
	DefaultGateway               string   `json:"defaultGateway"`                         // Default Gateway in a string format. For example: 10.12.232.1
	PrimaryDNS                   string   `json:"primaryDNS"`                             // Primary DNS in a string format. For example: 10.12.232.1
	SecondaryDNS                 string   `json:"secondaryDNS"`                           // Secondary DNS in a string format. For example: 10.12.232.1
	ConsoleTCPMaxRetransmissions int      `json:"consoleTCPMaxRetransmissions,omitempty"` // Indicates the number of retransmissions host TCP SW tries ifno ack is accepted
	WLANLinkProtectionLevel      string   `json:"wlanLinkProtectionLevel,omitempty"`      // Defines the level of the link protection feature activation. Read only property.
	PhysicalConnectionType       string   `json:"physicalConnectionType"`                 // Indicates the physical connection type of this network interface. Note: Applicable in Intel AMT 15.0 and later.
	PhysicalNicMedium            string   `json:"physicalNICMedium"`                      // Indicates which medium is currently used by Intel® AMT to communicate with the NIC. Note: Applicable in Intel AMT 15.0 and later.
}

NetworkResults defines the network results for a device.

type NetworkSettings

type NetworkSettings struct {
	Wired    *WiredNetworkInfo    `json:"wired"`
	Wireless *WirelessNetworkInfo `json:"wireless"`
}

NetworkSettings defines the network settings for a device.

type NotValidError

type NotValidError struct {
	Console consoleerrors.InternalError
}

func (NotValidError) Error

func (e NotValidError) Error() string

func (NotValidError) Wrap

func (e NotValidError) Wrap(function, call string, err error) error

type PinCertificate

type PinCertificate struct {
	SHA256Fingerprint string `json:"sha256Fingerprint"`
}

type PowerAction

type PowerAction struct {
	Action int `json:"action" binding:"required" example:"8"`
}

type PowerActionResponse added in v1.13.0

type PowerActionResponse struct {
	ReturnValue int `json:"ReturnValue" example:"0"` // Return code. 0 indicates success
}

type PowerCapabilities

type PowerCapabilities struct {
	PowerUp    int `json:"Power up,omitempty" example:"0"`
	PowerCycle int `json:"Power cycle,omitempty" example:"0"`
	PowerDown  int `json:"Power down,omitempty" example:"0"`
	Reset      int `json:"Reset,omitempty" example:"0"`

	SoftOff   int `json:"Soft-off,omitempty" example:"0"`
	SoftReset int `json:"Soft-reset,omitempty" example:"0"`
	Sleep     int `json:"Sleep,omitempty" example:"0"`
	Hibernate int `json:"Hibernate,omitempty" example:"0"`

	PowerOnToBIOS int `json:"Power up to BIOS,omitempty" example:"0"`
	ResetToBIOS   int `json:"Reset to BIOS,omitempty" example:"0"`

	ResetToSecureErase int `json:"Reset to Secure Erase,omitempty" example:"0"`

	ResetToIDERFloppy   int `json:"Reset to IDE-R Floppy,omitempty" example:"0"`
	PowerOnToIDERFloppy int `json:"Power on to IDE-R Floppy,omitempty" example:"0"`
	ResetToIDERCDROM    int `json:"Reset to IDE-R CDROM,omitempty" example:"0"`
	PowerOnToIDERCDROM  int `json:"Power on to IDE-R CDROM,omitempty" example:"0"`

	PowerOnToDiagnostic int `json:"Power on to diagnostic,omitempty" example:"0"`
	ResetToDiagnostic   int `json:"Reset to diagnostic,omitempty" example:"0"`

	ResetToPXE   int `json:"Reset to PXE,omitempty" example:"0"`
	PowerOnToPXE int `json:"Power on to PXE,omitempty" example:"0"`
}

type PowerState

type PowerState struct {
	PowerState         int `json:"powerstate" example:"0"`
	OSPowerSavingState int `json:"osPowerSavingState" example:"0"`
}

type Profile

type Profile struct {
	ProfileName                string               `json:"profileName,omitempty" binding:"required" example:"My Profile"`
	AMTPassword                string               `` /* 156-byte string literal not displayed */
	CreationDate               string               `json:"creationDate,omitempty" example:"2021-07-01T00:00:00Z"`
	CreatedBy                  string               `json:"created_by,omitempty" example:"admin"`
	GenerateRandomPassword     bool                 `json:"generateRandomPassword" binding:"omitempty,genpasswordwone" example:"true"`
	CIRAConfigName             *string              `json:"ciraConfigName,omitempty" example:"My CIRA Config"`
	Activation                 string               `json:"activation" binding:"required,oneof=ccmactivate acmactivate" example:"activate"`
	MEBXPassword               string               `` /* 196-byte string literal not displayed */
	GenerateRandomMEBxPassword bool                 `json:"generateRandomMEBxPassword" example:"true"`
	CIRAConfigObject           *CIRAConfig          `json:"ciraConfigObject,omitempty"`
	Tags                       []string             `json:"tags,omitempty"`
	DHCPEnabled                bool                 `json:"dhcpEnabled" example:"true"`
	IPSyncEnabled              bool                 `json:"ipSyncEnabled" example:"true"`
	LocalWiFiSyncEnabled       bool                 `json:"localWifiSyncEnabled" example:"true"`
	WiFiConfigs                []ProfileWiFiConfigs `json:"wifiConfigs,omitempty" binding:"excluded_if=DHCPEnabled false,dive"`
	TenantID                   string               `json:"tenantId" example:"abc123"`
	TLSMode                    int                  `json:"tlsMode,omitempty" binding:"omitempty,min=1,max=4,ciraortls" example:"1"`
	TLSCerts                   *TLSCerts            `json:"tlsCerts,omitempty"`
	TLSSigningAuthority        string               `json:"tlsSigningAuthority,omitempty" binding:"omitempty,oneof=SelfSigned MicrosoftCA" example:"SelfSigned"`
	UserConsent                string               `json:"userConsent,omitempty" binding:"omitempty" default:"All" example:"All"`
	IDEREnabled                bool                 `json:"iderEnabled" example:"true"`
	KVMEnabled                 bool                 `json:"kvmEnabled" example:"true"`
	SOLEnabled                 bool                 `json:"solEnabled" example:"true"`
	IEEE8021xProfileName       *string              `json:"ieee8021xProfileName,omitempty" example:"My Profile"`
	IEEE8021xProfile           *IEEE8021xConfig     `json:"ieee8021xProfile,omitempty"`
	Version                    string               `json:"version,omitempty" example:"1.0.0"`
	UEFIWiFiSyncEnabled        bool                 `json:"uefiWifiSyncEnabled" example:"true"`
}

type ProfileAssociation

type ProfileAssociation struct {
	Type              string              `json:"type"`
	ProfileID         string              `json:"profileID"`
	RootCertificate   *RefinedCertificate `json:"rootCertificate,omitempty"`
	ClientCertificate *RefinedCertificate `json:"clientCertificate,omitempty"`
	Key               *Key                `json:"publicKey,omitempty"`
}

type ProfileCountResponse added in v1.12.0

type ProfileCountResponse struct {
	Count int       `json:"totalCount"`
	Data  []Profile `json:"data"`
}

type ProfileExportResponse added in v1.12.0

type ProfileExportResponse struct {
	Content  string `json:"content"`
	Filename string `json:"filename"`
	Key      string `json:"key"`
}

type ProfileWiFiConfigs

type ProfileWiFiConfigs struct {
	Priority            int    `json:"priority,omitempty" binding:"min=1,max=255" example:"1"`
	WirelessProfileName string `json:"profileName" example:"My Profile"`
	ProfileName         string `json:"profileProfileName" example:"My Wireless Profile"`
	TenantID            string `json:"tenantId" example:"abc123"`
}

type RefinedCertificate

type RefinedCertificate struct {
	ElementName            string   `json:"elementName,omitempty"`
	InstanceID             string   `json:"instanceID,omitempty"`
	X509Certificate        string   `json:"x509Certificate,omitempty"`
	TrustedRootCertificate bool     `json:"trustedRootCertificate"`
	Issuer                 string   `json:"issuer,omitempty"`
	Subject                string   `json:"subject,omitempty"`
	ReadOnlyCertificate    bool     `json:"readOnlyCertificate"`
	PublicKeyHandle        string   `json:"publicKeyHandle,omitempty"`
	AssociatedProfiles     []string `json:"associatedProfiles,omitempty"`
	DisplayName            string   `json:"displayName,omitempty"`
}

type RefinedKeyManagementResponse

type RefinedKeyManagementResponse struct {
	CreationClassName       string `json:"creationClassName,omitempty"`
	ElementName             string `json:"elementName,omitempty"`
	EnabledDefault          int    `json:"enabledDefault,omitempty"`
	EnabledState            int    `json:"enabledState,omitempty"`
	Name                    string `json:"name,omitempty"`
	RequestedState          int    `json:"requestedState,omitempty"`
	SystemCreationClassName string `json:"systemCreationClassName,omitempty"`
	SystemName              string `json:"systemName,omitempty"`
}

type SecuritySettings

type SecuritySettings struct {
	ProfileAssociation  []ProfileAssociation    `json:"profileAssociation"`
	CertificateResponse CertificatePullResponse `json:"certificates"`
	KeyResponse         KeyPullResponse         `json:"publicKeys"`
}

type SettingDataResponse

type SettingDataResponse struct {
	ElementName                   string   `json:"ElementName,omitempty"`
	InstanceID                    string   `json:"InstanceID,omitempty"`
	MutualAuthentication          bool     `json:"MutualAuthentication"`
	Enabled                       bool     `json:"Enabled"`
	TrustedCN                     []string `json:"TrustedCN,omitempty"`
	AcceptNonSecureConnections    bool     `json:"AcceptNonSecureConnections"`
	NonSecureConnectionsSupported *bool    `json:"NonSecureConnectionsSupported"`
}

type SetupAndConfigurationServiceResponse

type SetupAndConfigurationServiceResponse struct {
	RequestedState                setupandconfiguration.RequestedState         `xml:"RequestedState,omitempty" json:"RequestedState,omitempty"`                               // RequestedState is an integer enumeration that indicates the last requested or desired state for the element, irrespective of the mechanism through which it was requested.
	EnabledState                  setupandconfiguration.EnabledState           `xml:"EnabledState,omitempty" json:"EnabledState,omitempty"`                                   // EnabledState is an integer enumeration that indicates the enabled and disabled states of an element.
	ElementName                   string                                       `xml:"ElementName,omitempty" json:"ElementName,omitempty"`                                     // A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information. Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. Note that if there is an associated instance of CIM_EnabledLogicalElementCapabilities, restrictions on this properties may exist as defined in ElementNameMask and MaxElementNameLen properties defined in that class.
	SystemCreationClassName       string                                       `xml:"SystemCreationClassName,omitempty" json:"SystemCreationClassName,omitempty"`             // The CreationClassName of the scoping System.
	SystemName                    string                                       `xml:"SystemName,omitempty" json:"SystemName,omitempty"`                                       // The Name of the scoping System.
	CreationClassName             string                                       `xml:"CreationClassName,omitempty" json:"CreationClassName,omitempty"`                         // CreationClassName indicates the name of the class or the subclass that is used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.
	Name                          string                                       `xml:"Name,omitempty" json:"Name,omitempty"`                                                   // The Name property uniquely identifies the Service and provides an indication of the functionality that is managed. This functionality is described in more detail in the Description property of the object.
	ProvisioningMode              setupandconfiguration.ProvisioningModeValue  `xml:"ProvisioningMode,omitempty" json:"ProvisioningMode,omitempty"`                           // A Read-Only enumeration value that determines the behavior of Intel® AMT when it is deployed.
	ProvisioningState             setupandconfiguration.ProvisioningStateValue `xml:"ProvisioningState,omitempty" json:"ProvisioningState,omitempty"`                         // An enumeration value that indicates the state of the Intel® AMT subsystem in the provisioning process"Pre" - the setup operation has not started."In" - the setup operation is in progress."Post" - Intel® AMT is configured.
	ZeroTouchConfigurationEnabled bool                                         `xml:"ZeroTouchConfigurationEnabled,omitempty" json:"ZeroTouchConfigurationEnabled,omitempty"` // Indicates if Zero Touch Configuration (Remote Configuration) is enabled or disabled. This property affects only enterprise mode. It can be modified while in SMB mode
	ProvisioningServerOTP         string                                       `xml:"ProvisioningServerOTP,omitempty" json:"ProvisioningServerOTP,omitempty"`                 // A optional binary data value containing 8-32 characters,that represents a one-time password (OTP), used to authenticate the Intel® AMT to the configuration server. This property can be retrieved only in IN Provisioning state, nevertheless, it is settable also in POST provisioning state.
	ConfigurationServerFQDN       string                                       `xml:"ConfigurationServerFQDN,omitempty" json:"ConfigurationServerFQDN,omitempty"`             // The FQDN of the configuration server.
	PasswordModel                 setupandconfiguration.PasswordModelValue     `xml:"PasswordModel,omitempty" json:"PasswordModel,omitempty"`                                 // An enumeration value that determines the password model of Intel® AMT.
	DhcpDNSSuffix                 string                                       `xml:"DhcpDNSSuffix,omitempty" json:"DhcpDNSSuffix,omitempty"`                                 // Domain name received from DHCP
	TrustedDNSSuffix              string                                       `xml:"TrustedDNSSuffix,omitempty" json:"TrustedDNSSuffix,omitempty"`                           // Trusted domain name configured in MEBX
}

type SetupAndConfigurationServiceResponses

type SetupAndConfigurationServiceResponses struct {
	Response SetupAndConfigurationServiceResponse `json:"response"`
}

type SoftwareIdentity

type SoftwareIdentity struct {
	InstanceID    string `json:"InstanceID"`
	VersionString string `json:"VersionString" example:"<major>.<minor>.<revision>.<build>"`
	IsEntity      bool   `json:"IsEntity" example:"true"`
}

type SoftwareIdentityResponses

type SoftwareIdentityResponses struct {
	Responses []SoftwareIdentity `json:"responses"`
}

type StartTime

type StartTime struct {
	Datetime time.Time `json:"Datetime" binding:"required" example:"2024-01-01T00:00:00Z"`
}

type TLSCerts

type TLSCerts struct {
	RootCertificate   CertCreationResult `json:"rootCertificate"`
	IssuedCertificate CertCreationResult `json:"issuedCertificate"`
	Version           string             `json:"version"`
}

type UserConsentBody added in v1.13.0

type UserConsentBody struct {
	ReturnValue int `json:"ReturnValue" example:"0"`
}

type UserConsentCode

type UserConsentCode struct {
	ConsentCode string `json:"consentCode" binding:"required" example:"123456"`
}

type UserConsentHeader added in v1.13.0

type UserConsentHeader struct {
	Action      string `json:"Action,omitempty" example:"http://intel.com/wbem/wscim/1/ips-schema/1/IPS_OptInService/StartOptInResponse"`
	MessageID   string `json:"MessageID,omitempty" example:"uuid:00000000-8086-8086-8086-000000001ACD"`
	Method      string `json:"Method,omitempty" example:"StartOptIn"`
	RelatesTo   string `json:"RelatesTo,omitempty" example:"1"`
	ResourceURI string `json:"ResourceURI,omitempty" example:"http://intel.com/wbem/wscim/1/ips-schema/1/IPS_OptInService"`
	To          string `json:"To,omitempty" example:"http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous"`
}

type UserConsentMessage

type UserConsentMessage struct {
	Header UserConsentHeader `json:"Header,omitempty"`
	Body   UserConsentBody   `json:"Body,omitempty"`
}

type Version

type Version struct {
	CIMSoftwareIdentity             SoftwareIdentityResponses             `json:"CIM_SoftwareIdentity"`
	AMTSetupAndConfigurationService SetupAndConfigurationServiceResponses `json:"AMT_SetupAndConfigurationService"`
}

type WiFiNetwork

type WiFiNetwork struct {
	ElementName          string `json:"elementName"`
	SSID                 string `json:"ssid"`
	AuthenticationMethod string `json:"authenticationMethod"`
	EncryptionMethod     string `json:"encryptionMethod"`
	Priority             int    `json:"priority"`
	BSSType              string `json:"bsstype"`
}

type WiFiPortConfigService

type WiFiPortConfigService struct {
	RequestedState                     int    `json:"requestedState"`
	EnabledState                       int    `json:"enabledState"`
	HealthState                        int    `json:"healthState"`
	ElementName                        string `json:"elementName"`
	SystemCreationClassName            string `json:"systemCreationClassName"`
	SystemName                         string `json:"systemName"`
	CreationClassName                  string `json:"creationClassName"`
	Name                               string `json:"name"`
	LocalProfileSynchronizationEnabled int    `json:"localProfileSynchronizationEnabled"`
	LastConnectedSsidUnderMeControl    string `json:"lastConnectedSsidUnderMeControl"`
	NoHostCsmeSoftwarePolicy           int    `json:"noHostCsmeSoftwarePolicy"`
	UEFIWiFiProfileShareEnabled        bool   `json:"uefiWiFiProfileShareEnabled"`
}

type WiredNetworkInfo

type WiredNetworkInfo struct {
	NetworkInfo
	IEEE8021x IEEE8021x `json:"ieee8021x"`
}

type WirelessConfig

type WirelessConfig struct {
	ProfileName            string           `json:"profileName,omitempty" example:"My Profile"`
	AuthenticationMethod   int              `json:"authenticationMethod" binding:"required,oneof=4 5 6 7,authforieee8021x" example:"1"`
	EncryptionMethod       int              `json:"encryptionMethod" binding:"oneof=3 4" example:"3"`
	SSID                   string           `json:"ssid" binding:"max=32" example:"abc"`
	PSKValue               int              `json:"pskValue" example:"3"`
	PSKPassphrase          string           `json:"pskPassphrase,omitempty" binding:"omitempty,min=8,max=32" example:"abc"`
	LinkPolicy             []int            `json:"linkPolicy"`
	TenantID               string           `json:"tenantId" example:"abc123"`
	IEEE8021xProfileName   *string          `json:"ieee8021xProfileName,omitempty" example:"My Profile"`
	IEEE8021xProfileObject *IEEE8021xConfig `json:"ieee8021xProfileObject,omitempty"`
	Version                string           `json:"version"`
}

type WirelessConfigCountResponse

type WirelessConfigCountResponse struct {
	Count int              `json:"totalCount"`
	Data  []WirelessConfig `json:"data"`
}

type WirelessNetworkInfo

type WirelessNetworkInfo struct {
	NetworkInfo
	WiFiNetworks          []WiFiNetwork         `json:"wifiNetworks"`
	IEEE8021xSettings     []IEEE8021xSettings   `json:"ieee8021xSettings"`
	WiFiPortConfigService WiFiPortConfigService `json:"wifiPortConfigService"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL