asresponse

Documentation

Overview

Package asresponse ...

Package asresponse ...

Package asresponse ...

Package asresponse ...

Package asresponse ...

Package asresponse ...

Index

• type Account
• type AccountService
• type Accounts
• type ActiveDirectory
• type CommonError
• type Error
• type ErrorClass
• type ExtendedInfo
• type LDAP
• type Links
• type List
• type ListMember
• type ListResponse
• type MsgExtendedInfo
• type OAuth2
• type OEM
• type Privileges
• type RedfishSessionResponse
• type Role
• type Session
• type SessionService
• type Sessions
• type Status
• type TACACSplus
• type UserRole

Types

type Account

type Account struct {
	response.Response
	UserName     string   `json:"UserName"`
	RoleID       string   `json:"RoleId"`
	AccountTypes []string `json:"AccountTypes"`
	Password     *string  `json:"Password"`
	Links        Links    `json:"Links"`
	OEM          *OEM     `json:"Oem,omitempty"`
}

Account struct is used to ommit password for display purposes

type AccountService

type AccountService struct {
	response.Response
	Status                             Status           `json:"Status,omitempty"`
	ServiceEnabled                     bool             `json:"ServiceEnabled,omitempty"`
	AuthFailureLoggingThreshold        int              `json:"AuthFailureLoggingThreshold,omitempty"`
	MinPasswordLength                  int              `json:"MinPasswordLength,omitempty"`
	AccountLockoutThreshold            int              `json:"AccountLockoutThreshold,omitempty"`
	AccountLockoutDuration             int              `json:"AccountLockoutDuration,omitempty"`
	AccountLockoutCounterResetAfter    int              `json:"AccountLockoutCounterResetAfter,omitempty"`
	Accounts                           Accounts         `json:"Accounts,omitempty"`
	Roles                              Accounts         `json:"Roles,omitempty"`
	AccountLockoutCounterResetEnabled  bool             `json:"AccountLockoutCounterResetEnabled,omitempty"`
	Actions                            *dmtf.OemActions `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 List

type List struct {
	response.Response
	MembersCount int          `json:"Members@odata.count"`
	Members      []ListMember `json:"Members"`
}

List defines the collection of resources like accounts, sessions, roles etc in svc-account-session

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 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 Privileges

type Privileges struct {
	response.Response
	PrivilegesUsed []string `json:"PrivilegesUsed"`
}

Privileges strcut definition used to build response

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 {
	response.Response
	UserName    string `json:"UserName"`
	CreatedTime string `json:"CreatedTime,omitempty"`
}

Session struct is used to omit password for display purposes

type SessionService

type SessionService struct {
	response.Response
	Status         Status   `json:"Status,omitempty"`
	ServiceEnabled bool     `json:"ServiceEnabled,omitempty"`
	SessionTimeout float64  `json:"SessionTimeout,omitempty"`
	Sessions       Sessions `json:"Sessions,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 UserRole

type UserRole struct {
	response.Response
	IsPredefined       bool     `json:"IsPredefined"`
	AssignedPrivileges []string `json:"AssignedPrivileges"`
	OEMPrivileges      []string `json:"OemPrivileges,omitempty"`
}

UserRole defines the response given back to the user regarding roles