response

Documentation

Overview

Package response ...

Package response ...

Package response defines the response structs

Package response ...

Package response ...

Index

• type AccountService
• type Accounts
• type ActiveDirectory
• type CommonError
• type Error
• type ErrorClass
• type ExtendedInfo
• type LDAP
• type Links
• type ListMember
• type ListResponse
• type Location
• type MessageRegistryFileID
• type MsgExtendedInfo
• type OAuth2
• type OEM
• type RedfishSessionResponse
• type Role
• type Session
• type SessionService
• type Sessions
• type Status
• type TACACSplus
• type User

Types

type AccountService

type AccountService struct {
	OdataType                          string           `json:"@odata.type"`
	ID                                 string           `json:"Id"`
	Name                               string           `json:"Name"`
	Description                        string           `json:"Description"`
	Status                             Status           `json:"Status"`
	ServiceEnabled                     bool             `json:"ServiceEnabled"`
	AuthFailureLoggingThreshold        int              `json:"AuthFailureLoggingThreshold"`
	MinPasswordLength                  int              `json:"MinPasswordLength"`
	AccountLockoutThreshold            int              `json:"AccountLockoutThreshold"`
	AccountLockoutDuration             int              `json:"AccountLockoutDuration"`
	AccountLockoutCounterResetAfter    int              `json:"AccountLockoutCounterResetAfter"`
	Accounts                           Accounts         `json:"Accounts"`
	Roles                              Accounts         `json:"Roles"`
	OdataContext                       string           `json:"@odata.context"`
	OdataID                            string           `json:"@odata.id"`
	AccountLockoutCounterResetEnabled  bool             `json:"AccountLockoutCounterResetEnabled,omitempty"`
	Actions                            *dmtf.Actions    `json:"Actions,omitempty"`
	ActiveDirectory                    *ActiveDirectory `json:"ActiveDirectory,omitempty"`
	AdditionalExternalAccountProviders *dmtf.Link       `json:"AdditionalExternalAccountProviders,omitempty"`
	LDAP                               *LDAP            `json:"LDAP,omitempty"`
	LocalAccountAuth                   string           `json:"LocalAccountAuth,omitempty"`
	MaxPasswordLength                  int              `json:"MaxPasswordLength,omitempty"`
	OAuth2                             *OAuth2          `json:"OAuth2,omitempty"`
	Oem                                *OEM             `json:"Oem,omitempty"`
	PasswordExpirationDays             int              `json:"PasswordExpirationDays,omitempty"`
	PrivilegeMap                       *dmtf.Link       `json:"PrivilegeMap,omitempty"`
	RestrictedOemPrivileges            []string         `json:"RestrictedOemPrivileges,omitempty"`
	RestrictedPrivileges               []string         `json:"RestrictedPrivileges,omitempty"`
	SupportedAccountTypes              []string         `json:"SupportedAccountTypes,omitempty"`
	SupportedOEMAccountTypes           []string         `json:"SupportedOEMAccountTypes,omitempty"`
	TACACSplus                         *TACACSplus      `json:"TACACSplus,omitempty"`
}

AccountService struct definition

type Accounts

type Accounts struct {
	OdataID string `json:"@odata.id"`
}

Accounts struct definition

type ActiveDirectory

type ActiveDirectory struct {
}

ActiveDirectory struct definition

type CommonError

type CommonError struct {
	Error ErrorClass `json:"error"`
}

CommonError struct definition

type Error

type Error struct {
	Code          string         `json:"code"`
	Message       string         `json:"message"`
	ExtendedInfos []ExtendedInfo `json:"@Message.ExtendedInfo"`
}

Error is the internal structure of RedfishSessionResponse

type ErrorClass

type ErrorClass struct {
	Code                string            `json:"code"`
	Message             string            `json:"message"`
	MessageExtendedInfo []MsgExtendedInfo `json:"@Message.ExtendedInfo"`
}

ErrorClass struct definition

type ExtendedInfo

type ExtendedInfo struct {
	MessageID string `json:"MessageId"`
}

ExtendedInfo is the extended version of RedfishSessionResponse message

type LDAP

type LDAP struct {
}

LDAP struct definition

type Links

type Links struct {
	Role Role `json:"Role"`
}

Links struct definition

type ListMember

type ListMember struct {
	OdataID string `json:"@odata.id"`
}

ListMember define the links for each account present in odimra

type ListResponse

type ListResponse struct {
	OdataContext string       `json:"@odata.context"`
	Etag         string       `json:"@odata.etag,omitempty"`
	OdataID      string       `json:"@odata.id"`
	OdataType    string       `json:"@odata.type"`
	Name         string       `json:"Name"`
	Description  string       `json:"Description"`
	MembersCount int          `json:"Members@odata.count"`
	Members      []ListMember `json:"Members"`
}

ListResponse define list for odimra

type Location

type Location struct {
	ArchiveFile    string `json:"ArchiveFile,omitempty"`
	ArchiveURI     string `json:"ArchiveUri,omitempty"`
	Language       string `json:"Language"`
	PublicationURI string `json:"PublicationUri,omitempty"`
	URI            string `json:"Uri"`
}

Location defines the locations/Paths of the file to retrieve.

type MessageRegistryFileID

type MessageRegistryFileID struct {
	ID           string     `json:"Id"`
	OdataContext string     `json:"@odata.context"`
	Etag         string     `json:"@odata.etag,omitempty"`
	OdataID      string     `json:"@odata.id"`
	OdataType    string     `json:"@odata.type"`
	Name         string     `json:"Name"`
	Description  string     `json:"Description"`
	Languages    []string   `json:"Languages"`
	Location     []Location `json:"Location"`
	Registry     string     `json:"Registry"`
}

MessageRegistryFileID defines the message registry file id

type MsgExtendedInfo

type MsgExtendedInfo struct {
	OdataType  string `json:"@odata.type"`
	MessageID  string `json:"MessageId"`
	Message    string `json:"Message"`
	Severity   string `json:"Severity"`
	Resolution string `json:"Resolution"`
}

MsgExtendedInfo struct definition

type OAuth2

type OAuth2 struct {
}

OAuth2 struct definition

type OEM

type OEM struct {
}

OEM struct definition

type RedfishSessionResponse

type RedfishSessionResponse struct {
	Error Error `json:"error"`
}

RedfishSessionResponse will have all the

type Role

type Role struct {
	OdataID string `json:"@odata.id"`
}

Role struct definition

type Session

type Session struct {
	OdataContext string `json:"@odata.context"`
	Etag         string `json:"@odata.etag,omitempty"`
	OdataID      string `json:"@odata.id"`
	OdataType    string `json:"@odata.type"`
	ID           string `json:"ID"`
	Description  string `json:"Description"`
	Name         string `json:"Name"`
	OEM          OEM    `json:"Oem"`
	UserName     string `json:"UserName"`
}

Session struct is used to ommit password for display purposes

type SessionService

type SessionService struct {
	OdataType      string   `json:"@odata.type"`
	ID             string   `json:"Id"`
	Name           string   `json:"Name"`
	Description    string   `json:"Description,omitempty"`
	Status         Status   `json:"Status,omitempty"`
	ServiceEnabled bool     `json:"ServiceEnabled,omitempty"`
	SessionTimeout float64  `json:"SessionTimeout,omitempty"`
	Sessions       Sessions `json:"Sessions,omitempty"`
	OdataContext   string   `json:"@odata.context,omitempty"`
	OdataID        string   `json:"@odata.id"`
	Etag           string   `json:"@odata.etag,omitempty"`
}

SessionService struct definition

type Sessions

type Sessions struct {
	OdataID string `json:"@odata.id"`
}

Sessions struct definition

type Status

type Status struct {
	State  string `json:"State"`
	Health string `json:"Health"`
}

Status struct definition

type TACACSplus

type TACACSplus struct {
}

TACACSplus struct definition

type User

type User struct {
	OdataContext string  `json:"@odata.context"`
	Etag         string  `json:"@odata.etag,omitempty"`
	OdataID      string  `json:"@odata.id"`
	OdataType    string  `json:"@odata.type"`
	UserName     string  `json:"UserName"`
	RoleID       string  `json:"RoleID"`
	Password     *string `json:"Password"`
	ID           string  `json:"ID"`
	Name         string  `json:"Name"`
	Description  string  `json:"Description"`
	Links        Links   `json:"Links"`
	OEM          OEM     `json:"Oem"`
}

User struct is used to ommit password for display purposes