Categorygithub.com/haproxytech/models
modulepackage
1.2.4
Repository: https://github.com/haproxytech/models.git
Documentation: pkg.go.dev
Overview
Versions
3
Dependencies
6
Dependents
97
Files
9.2k SLOC

# README

HAProxy

HAProxy Swagger Models

This project contains structs and validation methods that are autogenerated using go-swagger from the swagger spec found here.These structs and are used in the DataPlaneAPI and client-native.

Contributing

You can generate the models using the following command in build directory:

swagger generate model -f haproxy_spec.yaml \
    -r ../copyright.txt \
    -m models \
    -t $GOPATH/src/github.com/haproxytech/

For commit messages and general style please follow the haproxy project's CONTRIBUTING guide and use that where applicable.

# Constants

BackendAdvCheckLdapCheck captures enum value "ldap-check".
BackendAdvCheckMysqlCheck captures enum value "mysql-check".
BackendAdvCheckPgsqlCheck captures enum value "pgsql-check".
BackendAdvCheckRedisCheck captures enum value "redis-check".
BackendAdvCheckSmtpchk captures enum value "smtpchk".
BackendAdvCheckSslHelloChk captures enum value "ssl-hello-chk".
BackendAdvCheckTCPCheck captures enum value "tcp-check".
BackendExternalCheckDisabled captures enum value "disabled".
BackendExternalCheckEnabled captures enum value "enabled".
BackendHashTypeFunctionCrc32 captures enum value "crc32".
BackendHashTypeFunctionDjb2 captures enum value "djb2".
BackendHashTypeFunctionSdbm captures enum value "sdbm".
BackendHashTypeFunctionWt6 captures enum value "wt6".
BackendHashTypeMethodConsistent captures enum value "consistent".
BackendHashTypeMethodMapBased captures enum value "map-based".
BackendHashTypeModifierAvalanche captures enum value "avalanche".
BackendHTTPConnectionModeHttpclose captures enum value "httpclose".
BackendHTTPConnectionModeHTTPKeepAlive captures enum value "http-keep-alive".
BackendHTTPConnectionModeHTTPServerClose captures enum value "http-server-close".
BackendHTTPPretendKeepaliveDisabled captures enum value "disabled".
BackendHTTPPretendKeepaliveEnabled captures enum value "enabled".
BackendHTTPUseHtxDisabled captures enum value "disabled".
BackendHTTPUseHtxEnabled captures enum value "enabled".
BackendModeHTTP captures enum value "http".
BackendModeTCP captures enum value "tcp".
BackendStickTableTypeBinary captures enum value "binary".
BackendStickTableTypeInteger captures enum value "integer".
BackendStickTableTypeIP captures enum value "ip".
BackendStickTableTypeIPV6 captures enum value "ipv6".
BackendStickTableTypeString captures enum value "string".
BackendSwitchingRuleCondIf captures enum value "if".
BackendSwitchingRuleCondUnless captures enum value "unless".
BalanceAlgorithmFirst captures enum value "first".
BalanceAlgorithmLeastconn captures enum value "leastconn".
BalanceAlgorithmRandom captures enum value "random".
BalanceAlgorithmRoundrobin captures enum value "roundrobin".
BalanceAlgorithmSource captures enum value "source".
BalanceAlgorithmStaticRr captures enum value "static-rr".
BalanceAlgorithmURI captures enum value "uri".
BalanceAlgorithmURLParam captures enum value "url_param".
BindVerifyNone captures enum value "none".
BindVerifyOptional captures enum value "optional".
BindVerifyRequired captures enum value "required".
DefaultsAdvCheckLdapCheck captures enum value "ldap-check".
DefaultsAdvCheckMysqlCheck captures enum value "mysql-check".
DefaultsAdvCheckPgsqlCheck captures enum value "pgsql-check".
DefaultsAdvCheckRedisCheck captures enum value "redis-check".
DefaultsAdvCheckSmtpchk captures enum value "smtpchk".
DefaultsAdvCheckSslHelloChk captures enum value "ssl-hello-chk".
DefaultsAdvCheckTCPCheck captures enum value "tcp-check".
DefaultsClitcpkaDisabled captures enum value "disabled".
DefaultsClitcpkaEnabled captures enum value "enabled".
DefaultsContstatsEnabled captures enum value "enabled".
DefaultsDontlognullDisabled captures enum value "disabled".
DefaultsDontlognullEnabled captures enum value "enabled".
DefaultsExternalCheckDisabled captures enum value "disabled".
DefaultsExternalCheckEnabled captures enum value "enabled".
DefaultsHTTPConnectionModeHttpclose captures enum value "httpclose".
DefaultsHTTPConnectionModeHTTPKeepAlive captures enum value "http-keep-alive".
DefaultsHTTPConnectionModeHTTPServerClose captures enum value "http-server-close".
DefaultsHTTPPretendKeepaliveDisabled captures enum value "disabled".
DefaultsHTTPPretendKeepaliveEnabled captures enum value "enabled".
DefaultsHTTPUseHtxDisabled captures enum value "disabled".
DefaultsHTTPUseHtxEnabled captures enum value "enabled".
DefaultsLogSeparateErrorsDisabled captures enum value "disabled".
DefaultsLogSeparateErrorsEnabled captures enum value "enabled".
DefaultsModeHTTP captures enum value "http".
DefaultsModeTCP captures enum value "tcp".
FilterTypeCache captures enum value "cache".
FilterTypeCompression captures enum value "compression".
FilterTypeSpoe captures enum value "spoe".
FilterTypeTrace captures enum value "trace".
ForwardforEnabledEnabled captures enum value "enabled".
FrontendClitcpkaDisabled captures enum value "disabled".
FrontendClitcpkaEnabled captures enum value "enabled".
FrontendContstatsEnabled captures enum value "enabled".
FrontendDontlognullDisabled captures enum value "disabled".
FrontendDontlognullEnabled captures enum value "enabled".
FrontendHTTPConnectionModeHttpclose captures enum value "httpclose".
FrontendHTTPConnectionModeHTTPKeepAlive captures enum value "http-keep-alive".
FrontendHTTPConnectionModeHTTPServerClose captures enum value "http-server-close".
FrontendHTTPUseHtxDisabled captures enum value "disabled".
FrontendHTTPUseHtxEnabled captures enum value "enabled".
FrontendLogSeparateErrorsDisabled captures enum value "disabled".
FrontendLogSeparateErrorsEnabled captures enum value "enabled".
FrontendModeHTTP captures enum value "http".
FrontendModeTCP captures enum value "tcp".
GlobalDaemonDisabled captures enum value "disabled".
GlobalDaemonEnabled captures enum value "enabled".
HttpchkMethodGET captures enum value "GET".
HttpchkMethodHEAD captures enum value "HEAD".
HttpchkMethodPATCH captures enum value "PATCH".
HttpchkMethodPOST captures enum value "POST".
HttpchkMethodPUT captures enum value "PUT".
HttpchkMethodTRACE captures enum value "TRACE".
HTTPRequestRuleCondIf captures enum value "if".
HTTPRequestRuleCondUnless captures enum value "unless".
HTTPRequestRuleLogLevelAlert captures enum value "alert".
HTTPRequestRuleLogLevelCrit captures enum value "crit".
HTTPRequestRuleLogLevelDebug captures enum value "debug".
HTTPRequestRuleLogLevelEmerg captures enum value "emerg".
HTTPRequestRuleLogLevelErr captures enum value "err".
HTTPRequestRuleLogLevelInfo captures enum value "info".
HTTPRequestRuleLogLevelNotice captures enum value "notice".
HTTPRequestRuleLogLevelSilent captures enum value "silent".
HTTPRequestRuleLogLevelWarning captures enum value "warning".
HTTPRequestRuleRedirTypeLocation captures enum value "location".
HTTPRequestRuleRedirTypePrefix captures enum value "prefix".
HTTPRequestRuleRedirTypeScheme captures enum value "scheme".
HTTPRequestRuleTypeAddACL captures enum value "add-acl".
HTTPRequestRuleTypeAddHeader captures enum value "add-header".
HTTPRequestRuleTypeAllow captures enum value "allow".
HTTPRequestRuleTypeAuth captures enum value "auth".
HTTPRequestRuleTypeDelACL captures enum value "del-acl".
HTTPRequestRuleTypeDelHeader captures enum value "del-header".
HTTPRequestRuleTypeDeny captures enum value "deny".
HTTPRequestRuleTypeRedirect captures enum value "redirect".
HTTPRequestRuleTypeReplaceHeader captures enum value "replace-header".
HTTPRequestRuleTypeReplaceValue captures enum value "replace-value".
HTTPRequestRuleTypeSendSpoeGroup captures enum value "send-spoe-group".
HTTPRequestRuleTypeSetHeader captures enum value "set-header".
HTTPRequestRuleTypeSetLogLevel captures enum value "set-log-level".
HTTPRequestRuleTypeSetPath captures enum value "set-path".
HTTPRequestRuleTypeSetQuery captures enum value "set-query".
HTTPRequestRuleTypeSetURI captures enum value "set-uri".
HTTPRequestRuleTypeSetVar captures enum value "set-var".
HTTPRequestRuleTypeTarpit captures enum value "tarpit".
HTTPResponseRuleCondIf captures enum value "if".
HTTPResponseRuleCondUnless captures enum value "unless".
HTTPResponseRuleLogLevelAlert captures enum value "alert".
HTTPResponseRuleLogLevelCrit captures enum value "crit".
HTTPResponseRuleLogLevelDebug captures enum value "debug".
HTTPResponseRuleLogLevelEmerg captures enum value "emerg".
HTTPResponseRuleLogLevelErr captures enum value "err".
HTTPResponseRuleLogLevelInfo captures enum value "info".
HTTPResponseRuleLogLevelNotice captures enum value "notice".
HTTPResponseRuleLogLevelSilent captures enum value "silent".
HTTPResponseRuleLogLevelWarning captures enum value "warning".
HTTPResponseRuleRedirTypeLocation captures enum value "location".
HTTPResponseRuleRedirTypePrefix captures enum value "prefix".
HTTPResponseRuleRedirTypeScheme captures enum value "scheme".
HTTPResponseRuleTypeAddACL captures enum value "add-acl".
HTTPResponseRuleTypeAddHeader captures enum value "add-header".
HTTPResponseRuleTypeAllow captures enum value "allow".
HTTPResponseRuleTypeDelACL captures enum value "del-acl".
HTTPResponseRuleTypeDelHeader captures enum value "del-header".
HTTPResponseRuleTypeDeny captures enum value "deny".
HTTPResponseRuleTypeRedirect captures enum value "redirect".
HTTPResponseRuleTypeReplaceHeader captures enum value "replace-header".
HTTPResponseRuleTypeReplaceValue captures enum value "replace-value".
HTTPResponseRuleTypeSendSpoeGroup captures enum value "send-spoe-group".
HTTPResponseRuleTypeSetHeader captures enum value "set-header".
HTTPResponseRuleTypeSetLogLevel captures enum value "set-log-level".
HTTPResponseRuleTypeSetStatus captures enum value "set-status".
HTTPResponseRuleTypeSetVar captures enum value "set-var".
LogTargetFacilityAlert captures enum value "alert".
LogTargetFacilityAudit captures enum value "audit".
LogTargetFacilityAuth captures enum value "auth".
LogTargetFacilityAuth2 captures enum value "auth2".
LogTargetFacilityCron captures enum value "cron".
LogTargetFacilityCron2 captures enum value "cron2".
LogTargetFacilityDaemon captures enum value "daemon".
LogTargetFacilityFtp captures enum value "ftp".
LogTargetFacilityKern captures enum value "kern".
LogTargetFacilityLocal0 captures enum value "local0".
LogTargetFacilityLocal1 captures enum value "local1".
LogTargetFacilityLocal2 captures enum value "local2".
LogTargetFacilityLocal3 captures enum value "local3".
LogTargetFacilityLocal4 captures enum value "local4".
LogTargetFacilityLocal5 captures enum value "local5".
LogTargetFacilityLocal6 captures enum value "local6".
LogTargetFacilityLocal7 captures enum value "local7".
LogTargetFacilityLpr captures enum value "lpr".
LogTargetFacilityMail captures enum value "mail".
LogTargetFacilityNews captures enum value "news".
LogTargetFacilityNtp captures enum value "ntp".
LogTargetFacilitySyslog captures enum value "syslog".
LogTargetFacilityUser captures enum value "user".
LogTargetFacilityUucp captures enum value "uucp".
LogTargetFormatRaw captures enum value "raw".
LogTargetFormatRfc3164 captures enum value "rfc3164".
LogTargetFormatRfc5424 captures enum value "rfc5424".
LogTargetFormatShort captures enum value "short".
LogTargetLevelAlert captures enum value "alert".
LogTargetLevelCrit captures enum value "crit".
LogTargetLevelDebug captures enum value "debug".
LogTargetLevelEmerg captures enum value "emerg".
LogTargetLevelErr captures enum value "err".
LogTargetLevelInfo captures enum value "info".
LogTargetLevelNotice captures enum value "notice".
LogTargetLevelWarning captures enum value "warning".
LogTargetMinlevelAlert captures enum value "alert".
LogTargetMinlevelCrit captures enum value "crit".
LogTargetMinlevelDebug captures enum value "debug".
LogTargetMinlevelEmerg captures enum value "emerg".
LogTargetMinlevelErr captures enum value "err".
LogTargetMinlevelInfo captures enum value "info".
LogTargetMinlevelNotice captures enum value "notice".
LogTargetMinlevelWarning captures enum value "warning".
NativeStatStatsAgentStatusINI captures enum value "INI".
NativeStatStatsAgentStatusL40K captures enum value "L40K".
NativeStatStatsAgentStatusL4CON captures enum value "L4CON".
NativeStatStatsAgentStatusL4TOUT captures enum value "L4TOUT".
NativeStatStatsAgentStatusL7OK captures enum value "L7OK".
NativeStatStatsAgentStatusL7STS captures enum value "L7STS".
NativeStatStatsAgentStatusSOCKERR captures enum value "SOCKERR".
NativeStatStatsAgentStatusUNK captures enum value "UNK".
NativeStatStatsCheckStatusINI captures enum value "INI".
NativeStatStatsCheckStatusL40K captures enum value "L40K".
NativeStatStatsCheckStatusL4CON captures enum value "L4CON".
NativeStatStatsCheckStatusL4TOUT captures enum value "L4TOUT".
NativeStatStatsCheckStatusL6OK captures enum value "L6OK".
NativeStatStatsCheckStatusL6RSP captures enum value "L6RSP".
NativeStatStatsCheckStatusL6TOUT captures enum value "L6TOUT".
NativeStatStatsCheckStatusL7OK captures enum value "L7OK".
NativeStatStatsCheckStatusL7OKC captures enum value "L7OKC".
NativeStatStatsCheckStatusL7RSP captures enum value "L7RSP".
NativeStatStatsCheckStatusL7STS captures enum value "L7STS".
NativeStatStatsCheckStatusL7TOUT captures enum value "L7TOUT".
NativeStatStatsCheckStatusSOCKERR captures enum value "SOCKERR".
NativeStatStatsCheckStatusUNK captures enum value "UNK".
NativeStatStatsModeHealth captures enum value "health".
NativeStatStatsModeHTTP captures enum value "http".
NativeStatStatsModeTCP captures enum value "tcp".
NativeStatStatsModeUnknown captures enum value "unknown".
NativeStatStatsStatusDOWN captures enum value "DOWN".
NativeStatStatsStatusMAINT captures enum value "MAINT".
NativeStatStatsStatusNoCheck captures enum value "no check".
NativeStatStatsStatusNOLB captures enum value "NOLB".
NativeStatStatsStatusUP captures enum value "UP".
NativeStatTypeBackend captures enum value "backend".
NativeStatTypeFrontend captures enum value "frontend".
NativeStatTypeServer captures enum value "server".
RedispatchEnabledDisabled captures enum value "disabled".
RedispatchEnabledEnabled captures enum value "enabled".
ReloadStatusFailed captures enum value "failed".
ReloadStatusInProgress captures enum value "in_progress".
ReloadStatusSucceeded captures enum value "succeeded".
RuntimeAPILevelAdmin captures enum value "admin".
RuntimeAPILevelOperator captures enum value "operator".
RuntimeAPILevelUser captures enum value "user".
ServerBackupDisabled captures enum value "disabled".
ServerBackupEnabled captures enum value "enabled".
ServerCheckDisabled captures enum value "disabled".
ServerCheckEnabled captures enum value "enabled".
ServerMaintenanceDisabled captures enum value "disabled".
ServerMaintenanceEnabled captures enum value "enabled".
ServerOnErrorFailCheck captures enum value "fail-check".
ServerOnErrorFastinter captures enum value "fastinter".
ServerOnErrorMarkDown captures enum value "mark-down".
ServerOnErrorSuddenDeath captures enum value "sudden-death".
ServerOnMarkedDownShutdownSessions captures enum value "shutdown-sessions".
ServerOnMarkedUpShutdownBackupSessions captures enum value "shutdown-backup-sessions".
ServerSendProxyDisabled captures enum value "disabled".
ServerSendProxyEnabled captures enum value "enabled".
ServerSendProxyV2Disabled captures enum value "disabled".
ServerSendProxyV2Enabled captures enum value "enabled".
ServerSslDisabled captures enum value "disabled".
ServerSslEnabled captures enum value "enabled".
ServerSwitchingRuleCondIf captures enum value "if".
ServerSwitchingRuleCondUnless captures enum value "unless".
ServerTLSTicketsDisabled captures enum value "disabled".
ServerTLSTicketsEnabled captures enum value "enabled".
ServerVerifyNone captures enum value "none".
ServerVerifyRequired captures enum value "required".
SiteFarmCondIf captures enum value "if".
SiteFarmCondUnless captures enum value "unless".
SiteFarmModeHTTP captures enum value "http".
SiteFarmModeTCP captures enum value "tcp".
SiteFarmUseAsConditional captures enum value "conditional".
SiteFarmUseAsDefault captures enum value "default".
SiteServiceHTTPConnectionModeForcedClose captures enum value "forced-close".
SiteServiceHTTPConnectionModeHttpclose captures enum value "httpclose".
SiteServiceHTTPConnectionModeHTTPKeepAlive captures enum value "http-keep-alive".
SiteServiceHTTPConnectionModeHTTPServerClose captures enum value "http-server-close".
SiteServiceHTTPConnectionModeHTTPTunnel captures enum value "http-tunnel".
SiteServiceModeHTTP captures enum value "http".
SiteServiceModeTCP captures enum value "tcp".
StickRuleCondIf captures enum value "if".
StickRuleCondUnless captures enum value "unless".
StickRuleTypeMatch captures enum value "match".
StickRuleTypeOn captures enum value "on".
StickRuleTypeStoreRequest captures enum value "store-request".
StickRuleTypeStoreResponse captures enum value "store-response".
TCPRequestRuleActionAccept captures enum value "accept".
TCPRequestRuleActionReject captures enum value "reject".
TCPRequestRuleCondIf captures enum value "if".
TCPRequestRuleCondUnless captures enum value "unless".
TCPRequestRuleTypeConnection captures enum value "connection".
TCPRequestRuleTypeContent captures enum value "content".
TCPRequestRuleTypeInspectDelay captures enum value "inspect-delay".
TCPRequestRuleTypeSession captures enum value "session".
TCPResponseRuleActionAccept captures enum value "accept".
TCPResponseRuleActionReject captures enum value "reject".
TCPResponseRuleCondIf captures enum value "if".
TCPResponseRuleCondUnless captures enum value "unless".
TCPResponseRuleTypeContent captures enum value "content".
TCPResponseRuleTypeInspectDelay captures enum value "inspect-delay".
TransactionStatusFailed captures enum value "failed".
TransactionStatusInProgress captures enum value "in_progress".
TransactionStatusSuccess captures enum value "success".

# Structs

ACL ACL Lines The use of Access Control Lists (ACL) provides a flexible solution to perform content switching and generally to take decisions based on content extracted from the request, the response or any environmental status.
Backend Backend HAProxy backend configuration swagger:model backend.
BackendHashType backend hash type swagger:model BackendHashType.
BackendStickTable backend stick table swagger:model BackendStickTable.
BackendSwitchingRule Backend Switching Rule HAProxy backend switching rule configuration (corresponds to use_backend directive) swagger:model backend_switching_rule.
Balance balance swagger:model balance.
Bind Bind HAProxy frontend bind configuration swagger:model bind.
CPUMap CPU map swagger:model CPUMap.
Defaults Defaults HAProxy defaults configuration swagger:model defaults.
DefaultServer default server swagger:model default_server.
Endpoint Endpoint Endpoint definition swagger:model endpoint.
Error Error API Error swagger:model error.
Errorfile errorfile swagger:model errorfile.
Filter Filter HAProxy filters swagger:model filter.
Forwardfor forwardfor swagger:model forwardfor.
Frontend Frontend HAProxy frontend configuration swagger:model frontend.
Global Global HAProxy global configuration swagger:model global.
Httpchk httpchk swagger:model httpchk.
HTTPRequestRule HTTP Request Rule HAProxy HTTP request rule configuration (corresponds to http-request directives) swagger:model http_request_rule.
HTTPResponseRule HTTP Response Rule HAProxy HTTP response rule configuration (corresponds to http-response directives) swagger:model http_response_rule.
Info Information General API, OS and hardware information swagger:model info.
InfoAPI info API swagger:model InfoAPI.
InfoSystem info system swagger:model InfoSystem.
InfoSystemCPUInfo info system CPU info swagger:model InfoSystemCPUInfo.
InfoSystemMemInfo info system mem info swagger:model InfoSystemMemInfo.
LogTarget Log Target Per-instance logging of events and traffic.
NativeStat Stats Current stats for one object.
NativeStatsCollection Stats collection Stats from one runtime API swagger:model NativeStatsCollection.
NativeStatStats native stat stats swagger:model NativeStatStats.
ProcessInfo HAProxy Information General HAProxy process information swagger:model process_info.
ProcessInfoHaproxy process info haproxy swagger:model ProcessInfoHaproxy.
Redispatch redispatch swagger:model redispatch.
Reload HAProxy reload HAProxy reload swagger:model reload.
RuntimeAPI runtime API swagger:model RuntimeAPI.
Server Server HAProxy backend server configuration swagger:model server.
ServerSwitchingRule Server Switching Rule HAProxy server switching rule configuration (corresponds to use-server directive) swagger:model server_switching_rule.
Site Site Site configuration.
SiteFarm site farm swagger:model SiteFarm.
SiteService site service swagger:model SiteService.
StickRule Stick Rule Define a pattern used to create an entry in a stickiness table or matching condition or associate a user to a server.
TCPRequestRule TCP Request Rule HAProxy TCP Request Rule configuration (corresponds to tcp-request) swagger:model tcp_request_rule.
TCPResponseRule TCP Response Rule HAProxy TCP Response Rule configuration (corresponds to tcp-response) swagger:model tcp_response_rule.
Transaction Configuration transaction HAProxy configuration transaction swagger:model transaction.

# Type aliases

Acls ACL Lines Array HAProxy ACL lines array (corresponds to acl directives) swagger:model acls.
Backends Backends HAProxy backends array swagger:model backends.
BackendSwitchingRules Backend Switching Rules Array HAProxy backend switching rules array (corresponds to use_backend directives) swagger:model backend_switching_rules.
Binds Binds HAProxy frontend binds array (corresponds to bind directives) swagger:model binds.
Endpoints Endpoints Array Collection of endpoints swagger:model endpoints.
Filters Filters Array HAProxy filters array (corresponds to filter directive) swagger:model filters.
Frontends Frontends HAProxy frontends array swagger:model frontends.
HTTPRequestRules HTTP Request Rules Array HAProxy HTTP request rules array (corresponds to http-request directives) swagger:model http_request_rules.
HTTPResponseRules HTTP Response Rules Array HAProxy HTTP response rules array (corresponds to http-response directives) swagger:model http_response_rules.
LogTargets Log Target Array HAProxy log target array (corresponds to log directives) swagger:model log_targets.
NativeStats Stats Array HAProxy stats array swagger:model NativeStats.
Reloads HAProxy Reloads Array HAProxy reloads array swagger:model reloads.
Servers Servers HAProxy backend servers array swagger:model servers.
ServerSwitchingRules Server Switching Rules Array HAProxy backend server switching rules array (corresponds to use-server directives) swagger:model server_switching_rules.
Sites Sites Sites array.
StickRules Stick Rules Array HAProxy backend stick rules array (corresponds to stick store-request, stick match, stick on, stick store-response) swagger:model stick_rules.
TCPRequestRules TCP Request Rules Array HAProxy TCP request rules array (corresponds to tcp-request directive) swagger:model tcp_request_rules.
TCPResponseRules TCP Response Rules Array HAProxy TCP response rules array (corresponds to tcp-response directive) swagger:model tcp_response_rules.
Transactions Transactions array Configuration transactions array swagger:model transactions.