Documentation
¶
Overview ¶
Package http facilitates communication with Intel® AMT devices to manage HTTP proxy access point configuration.
This service represents the HTTP Proxy Access Points configured for user-initiated connections through Intel AMT firmware.
Package http facilitates communication with Intel® AMT devices to manage HTTP proxy service configuration.
This service represents the HTTP Proxy Service used for managing proxy settings and access points for user-initiated connections through Intel AMT firmware.
Index ¶
- Constants
- Variables
- func GetReturnValueString(returnValue int) string
- type AddProxyAccessPoint_INPUT
- type AddProxyAccessPoint_OUTPUT
- type Body
- type HTTPProxyAccessPointItem
- type HTTPProxyServiceResponse
- type InfoFormat
- type ProxyAccessPoint
- type ProxyAccessPointBody
- type ProxyAccessPointPullResponse
- type ProxyAccessPointResponse
- type ProxyAccessPointService
- type ProxyService
- type PullResponse
- type Response
Constants ¶
const ( ValueNotFound = "Value not found in map" IPSHTTPProxyService = "IPS_HTTPProxyService" IPSHTTPProxyAccessPoint = "IPS_HTTPProxyAccessPoint" AddProxyAccessPoint = "AddProxyAccessPoint" )
const ( PTStatusSuccess = 0 // PT_STATUS_SUCCESS PTStatusInternalError = 1 // PT_STATUS_INTERNAL_ERROR PTStatusNotPermitted = 16 // PT_STATUS_NOT_PERMITTED PTStatusMaxLimitReached = 23 // PT_STATUS_MAX_LIMIT_REACHED PTStatusInvalidParameter = 36 // PT_STATUS_INVALID_PARAMETER PTStatusDuplicate = 2058 // PT_STATUS_DUPLICATE )
Return value constants for AddProxyAccessPoint method.
Variables ¶
var InfoFormatToString = map[InfoFormat]string{
InfoFormatIPv4: "IPv4 Address",
InfoFormatIPv6: "IPv6 Address",
InfoFormatFQDN: "FQDN",
}
InfoFormatToString is a map for converting InfoFormat values to their string representations.
var ReturnValueToString = map[int]string{
PTStatusSuccess: "PT_STATUS_SUCCESS",
PTStatusInternalError: "PT_STATUS_INTERNAL_ERROR",
PTStatusNotPermitted: "PT_STATUS_NOT_PERMITTED",
PTStatusMaxLimitReached: "PT_STATUS_MAX_LIMIT_REACHED",
PTStatusInvalidParameter: "PT_STATUS_INVALID_PARAMETER",
PTStatusDuplicate: "PT_STATUS_DUPLICATE",
}
ReturnValueToString is a map for converting return values to their string representations.
Functions ¶
func GetReturnValueString ¶
GetReturnValueString returns a human-readable string representation of the return value.
Types ¶
type AddProxyAccessPoint_INPUT ¶
type AddProxyAccessPoint_INPUT struct {
XMLName xml.Name `xml:"h:AddProxyAccessPoint_INPUT"`
H string `xml:"xmlns:h,attr"`
AccessInfo string `xml:"h:AccessInfo"` // IP address or FQDN of the server (max 256 chars)
InfoFormat int `xml:"h:InfoFormat"` // Format of AccessInfo: 3=IPv4, 4=IPv6, 201=FQDN
Port int `xml:"h:Port"` // Port number
NetworkDnsSuffix string `xml:"h:NetworkDnsSuffix"` // Domain name of the network (max 192 chars)
}
AddProxyAccessPoint_INPUT represents the input parameters for AddProxyAccessPoint method.
type AddProxyAccessPoint_OUTPUT ¶
type AddProxyAccessPoint_OUTPUT struct {
XMLName xml.Name `xml:"AddProxyAccessPoint_OUTPUT"`
ProxyAccessPoint ProxyAccessPoint `xml:"ProxyAccessPoint,omitempty"` // Reference to the created Proxy Access Point
ReturnValue int `xml:"ReturnValue,omitempty"` // Return value of the operation
}
AddProxyAccessPoint_OUTPUT represents the output of AddProxyAccessPoint method.
type Body ¶
type Body struct {
XMLName xml.Name `xml:"Body"`
EnumerateResponse common.EnumerateResponse
GetAndPutResponse HTTPProxyServiceResponse `xml:"IPS_HTTPProxyService"`
PullResponse PullResponse `xml:"PullResponse"`
AddProxyAccessPointResponse AddProxyAccessPoint_OUTPUT `xml:"AddProxyAccessPoint_OUTPUT"`
}
OUTPUT Response Types.
type HTTPProxyAccessPointItem ¶ added in v2.32.0
type HTTPProxyAccessPointItem struct {
XMLName xml.Name `xml:"IPS_HTTPProxyAccessPoint"`
Name string `xml:"Name,omitempty"`
CreationClassName string `xml:"CreationClassName,omitempty"`
SystemName string `xml:"SystemName,omitempty"`
SystemCreationClassName string `xml:"SystemCreationClassName,omitempty"`
ElementName string `xml:"ElementName,omitempty"`
AccessInfo string `xml:"AccessInfo,omitempty"` // The proxy address (IP or FQDN)
InfoFormat int `xml:"InfoFormat,omitempty"` // Format of AccessInfo: 3=IPv4, 4=IPv6, 201=FQDN
Port int `xml:"Port,omitempty"` // Proxy port
NetworkDnsSuffix string `xml:"NetworkDnsSuffix,omitempty"` // Domain suffix
}
HTTPProxyAccessPointItem represents an individual HTTP proxy access point configuration.
type HTTPProxyServiceResponse ¶
type HTTPProxyServiceResponse struct {
XMLName xml.Name `xml:"IPS_HTTPProxyService"`
Name string `xml:"Name,omitempty"`
CreationClassName string `xml:"CreationClassName,omitempty"`
SystemName string `xml:"SystemName,omitempty"`
SystemCreationClassName string `xml:"SystemCreationClassName,omitempty"`
ElementName string `xml:"ElementName,omitempty"`
SyncEnabled bool `xml:"SyncEnabled,omitempty"` // Defines whether HTTP proxy sync (from local) is allowed
}
OUTPUT Response Types.
type InfoFormat ¶
type InfoFormat int
InfoFormat represents the format and interpretation of the AccessInfo property.
const ( InfoFormatIPv4 InfoFormat = 3 // IPv4 Address InfoFormatIPv6 InfoFormat = 4 // IPv6 Address InfoFormatFQDN InfoFormat = 201 // FQDN )
InfoFormat enumeration constants.
func (InfoFormat) String ¶
func (i InfoFormat) String() string
String returns a human-readable string representation of the InfoFormat enumeration.
type ProxyAccessPoint ¶
type ProxyAccessPoint struct {
XMLName xml.Name `xml:"ProxyAccessPoint,omitempty"`
Address string `xml:"Address,omitempty"`
ReferenceParameters models.ReferenceParameters_OUTPUT `xml:"ReferenceParameters,omitempty"`
}
ProxyAccessPoint represents an endpoint reference to a proxy access point.
type ProxyAccessPointBody ¶ added in v2.32.0
type ProxyAccessPointBody struct {
XMLName xml.Name `xml:"Body"`
EnumerateResponse common.EnumerateResponse `xml:"EnumerateResponse"`
PullResponse ProxyAccessPointPullResponse `xml:"PullResponse"`
GetAndPutResponse HTTPProxyAccessPointItem `xml:"IPS_HTTPProxyAccessPoint"`
}
ProxyAccessPointBody represents the body of IPS_HTTPProxyAccessPoint responses.
type ProxyAccessPointPullResponse ¶ added in v2.32.0
type ProxyAccessPointPullResponse struct {
XMLName xml.Name `xml:"PullResponse"`
Items []HTTPProxyAccessPointItem `xml:"Items>IPS_HTTPProxyAccessPoint"`
}
ProxyAccessPointPullResponse represents the pull response for proxy access points.
type ProxyAccessPointResponse ¶ added in v2.32.0
type ProxyAccessPointResponse struct {
*client.Message
XMLName xml.Name `xml:"Envelope"`
Header message.Header `xml:"Header"`
Body ProxyAccessPointBody `xml:"Body"`
}
ProxyAccessPointResponse represents responses for IPS_HTTPProxyAccessPoint operations.
type ProxyAccessPointService ¶ added in v2.32.0
type ProxyAccessPointService struct {
base.WSManService[ProxyAccessPointResponse]
}
ProxyAccessPointService struct represents the HTTP Proxy Access Point Service.
func NewHTTPProxyAccessPointServiceWithClient ¶ added in v2.32.0
func NewHTTPProxyAccessPointServiceWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) ProxyAccessPointService
NewHTTPProxyAccessPointServiceWithClient returns a new instance of the ProxyAccessPointService struct.
func (ProxyAccessPointService) Delete ¶ added in v2.32.0
func (service ProxyAccessPointService) Delete(name string) (response ProxyAccessPointResponse, err error)
Delete removes the specified HTTP proxy access point instance.
type ProxyService ¶
type ProxyService struct {
base.WSManService[Response]
}
ProxyService struct represents the HTTP Proxy Service.
func NewHTTPProxyServiceWithClient ¶
func NewHTTPProxyServiceWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) ProxyService
NewHTTPProxyServiceWithClient returns a new instance of the HTTPProxyService struct.
func (ProxyService) AddProxyAccessPoint ¶
func (service ProxyService) AddProxyAccessPoint(accessInfo string, infoFormat InfoFormat, port int, networkDnsSuffix string) (response Response, err error)
AddProxyAccessPoint adds a Proxy access point that will be used when the Intel AMT firmware needs to open a user-initiated connection.
type PullResponse ¶
type PullResponse struct {
XMLName xml.Name `xml:"PullResponse"`
Items []HTTPProxyServiceResponse `xml:"Items>IPS_HTTPProxyService"`
}
OUTPUT Response Types.
Source Files